Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_Request class

• Introduction

Request class.

• Class synopsis

AMI_Request {
/* Properties */
// Request scope
protected array $aScope = array('_default' => array());
// Default scope source
protected mixed $defaultSource = '_default';
/* Methods */
// Returns value by specified key.
public get ( string $key, [ mixed $default = null ], [ mixed $source = '_default' ] ) returns mixed;
// Returns whole scope.
public getScope ( [ mixed $source = '_default' ] ) returns array;
// Resets scope.
public reset ( [ string $source = null ] ) returns AMI_Request;
// Sets/unsets value by key.
public set ( string $key, [ mixed $value = null ], [ string $source = '_default' ] ) returns AMI_Request;
// Sets default scope.
public setDefaultSource ( mixed $source ) returns AMI_Request;
// Sets whole scope.
public setScope ( $aScope, string $source ) returns AMI_Request;
// Replace source by default value if needed.
protected patchSource ( string &$source, [ bool $extractFirst = FALSE ] ) returns void;
}

• Class Details

Lets our stanalone script is named 'script.php' and localted in the site root folder.

  Example:
  •  require_once 'ami_env.php';
  •  $oRequest AMI::getSingleton('env/request');
  •  $oResponse AMI::getSingleton('response');
  •  $oResponse->start();
  •  $oResponse->write('my_var: ' $oRequest->get('my_var'0'<br />');
  •  $oResponse->write('my_get_var: ' $oRequest->get('my_get_var'0'g''<br />');
  •  $oResponse->write('my_post_var: ' $oRequest->get('my_post_var'0'p''<br />');
  •  $oResponse->send();

will output
  • 0, 0, 0 for http://cms.my/script.php
  • 1, 2, 0 for http://cms.my/script.php?my_var=1&my_get_var=2
  • 1, 0, ... for http://cms.my/script.php?my_var=1 if my_post_var posted

• Class Properies

protected array $aScope

Request scope

protected mixed $defaultSource

Default scope source

• Class Methods

// Returns value by specified key.
public get ( string $key, [ mixed $default = null ], [ mixed $source = '_default' ] ) returns mixed;
  • string $key
    Request key
  • mixed $default
    Default value, will be returned if there is no key in the request
  • mixed $source
    Scope source, array (several sources will be scanned) or string, if not specified, default source is used, since 5.14.8

Overridden in child classes as: AMI_RequestHTTP::get().

// Returns whole scope.
public getScope ( [ mixed $source = '_default' ] ) returns array;
  • mixed $source
    Scope source, if not specified, default source is used, since 5.14.8

Overridden in child classes as: AMI_RequestHTTP::getScope().

If $source argument is array, the sum of scopes will be returned.
// Resets scope.
public reset ( [ string $source = null ] ) returns AMI_Request;
  • string $source
    Scope source, if not specified, all scopes will be reset, since 5.14.8

Overridden in child classes as: AMI_RequestHTTP::reset().

// Sets/unsets value by key.
public set ( string $key, [ mixed $value = null ], [ string $source = '_default' ] ) returns AMI_Request;
  • string $key
    Request key
  • mixed $value
    Null to unset
  • string $source
    Scope source, if not specified, default source is used, since 5.14.8

Overridden in child classes as: AMI_RequestHTTP::set().

If $source argument is array, first source scope will be modified.
// Sets default scope.
public setDefaultSource ( mixed $source ) returns AMI_Request;
  • mixed $source
    Scope source, array or string
Tags:
since 5.14.8
// Sets whole scope.
public setScope ( $aScope, string $source ) returns AMI_Request;
  • array $aScope
    Scope
  • string $source
    Scope source, since 5.14.8
// Replace source by default value if needed.
protected patchSource ( string &$source, [ bool $extractFirst = FALSE ] ) returns void;
  • string &$source
    Scoupe source
  • bool $extractFirst
    Extract first source from array
Tags:
since 5.14.8