Class craft\console\Request

Inheritance: craft\console\Request » yii\console\Request » yii\base\Request » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Uses Traits: craft\base\RequestTrait
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/console/Request.php

Public Methods
Method	Description	Defined 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
`getIsActionRequest()`	Returns whether a specific controller action was requested. (Narrator: There wasn't.)	craft\console\Request
`getIsConsoleRequest()`	Returns a value indicating whether the current request is made via command line.	yii\base\Request
`getIsCpRequest()`	Returns whether the Control Panel was requested. (Narrator: It wasn't.)	craft\console\Request
`getIsLivePreview()`	Returns whether this is a Live Preview request. (Narrator: It isn't.)	craft\console\Request
`getIsSingleActionRequest()`	Returns whether the current request is solely an action request. (Narrator: It isn't.)	craft\console\Request
`getIsSiteRequest()`	Returns whether the front end site was requested. (Narrator: It wasn't.)	craft\console\Request
`getParams()`	Returns the command line arguments.	yii\console\Request
`getScriptFile()`	Returns entry script file path.	yii\base\Request
`getScriptFilename()`	Returns the requested script name being used to access Craft (e.g. “index.php”).	craft\base\RequestTrait
`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.	craft\console\Request
`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
`setParams()`	Sets the command line arguments.	yii\console\Request
`setScriptFile()`	Sets the entry script file path.	yii\base\Request
`trigger()`	Triggers an event.	yii\base\Component

Method Details

`getIsActionRequest()` public method #

Returns whether a specific controller action was requested. (Narrator: There wasn't.)

public boolean getIsActionRequest ( )

`getIsCpRequest()` public method #

Returns whether the Control Panel was requested. (Narrator: It wasn't.)

public boolean getIsCpRequest ( )

`getIsLivePreview()` public method #

Returns whether this is a Live Preview request. (Narrator: It isn't.)

public boolean getIsLivePreview ( )

return	boolean	Whether this is a Live Preview request.

`getIsSingleActionRequest()` public method #

Returns whether the current request is solely an action request. (Narrator: It isn't.)

public void getIsSingleActionRequest ( )

`getIsSiteRequest()` public method #

Returns whether the front end site was requested. (Narrator: It wasn't.)

public boolean getIsSiteRequest ( )

`init()` public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

Method Details

getIsActionRequest() public method #

getIsCpRequest() public method #

getIsLivePreview() public method #

getIsSingleActionRequest() public method #