Abstract Class yii\base\Request

Inheritanceyii\base\Request » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\console\Request, yii\web\Request
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/base/Request.php

Request represents a request that is handled by an yii\base\Application.

For more details and usage information on Request, see the guide article on requests.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getIsConsoleRequest() Returns a value indicating whether the current request is made via command line. yii\base\Request
getScriptFile() Returns entry script file path. yii\base\Request
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
resolve() Resolves the current request into a route and the associated parameters. yii\base\Request
setIsConsoleRequest() Sets the value indicating whether the current request is made via command line. yii\base\Request
setScriptFile() Sets the entry script file path. yii\base\Request
trigger() Triggers an event. yii\base\Component

Method Details

getIsConsoleRequest() public method

Returns a value indicating whether the current request is made via command line.

public boolean getIsConsoleRequest ( )
return boolean

The value indicating whether the current request is made via console

getScriptFile() public method

Returns entry script file path.

public string getScriptFile ( )
return string

Entry script file path (processed w/ realpath())

throws yii\base\InvalidConfigException

if the entry script file path cannot be determined automatically.

resolve() public abstract method

Resolves the current request into a route and the associated parameters.

public abstract array resolve ( )
return array

The first element is the route, and the second is the associated parameters.

setIsConsoleRequest() public method

Sets the value indicating whether the current request is made via command line.

public void setIsConsoleRequest ( $value )
$value boolean

The value indicating whether the current request is made via command line

setScriptFile() public method

Sets the entry script file path.

The entry script file path can normally be determined based on the SCRIPT_FILENAME SERVER variable. However, for some server configurations, this may not be correct or feasible. This setter is provided so that the entry script file path can be manually specified.

public void setScriptFile ( $value )
$value string

The entry script file path. This can be either a file path or a path alias.

throws yii\base\InvalidConfigException

if the provided entry script file path is invalid.