Class lispa\amos\core\components\RunConsole
| Inheritance | lispa\amos\core\components\RunConsole » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
Class Runner - a component for running console command in yii2 web applications
Basic usage:
`php
$output = '';
$runner = new Runner();
$runner->run('controller/action param1 param2 ...', $output);
echo $output; //prints the command output
`
Application component usage:
`php
//you config file
'components' => [
'consoleRunner' => [
'class' => 'lispa\amos\core\components\RunConsole'
]
]
```php
//some application file
$output = '';
Yii::$app->consoleRunner->run('controller/action param1 param2 ...', $output);
echo $output; //prints the command output
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $pHPExecutable | string | Path to php executable | lispa\amos\core\components\RunConsole |
| $phpexec | string | Path to php executable | lispa\amos\core\components\RunConsole |
| $yiiscript | string | Yii console application file that will be executed | lispa\amos\core\components\RunConsole |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| 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\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| 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 |
| getPHPExecutable() | If property $phpexec is set it will be used as php executable | lispa\amos\core\components\RunConsole |
| 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\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | lispa\amos\core\components\RunConsole |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| run() | Runs yii console command | lispa\amos\core\components\RunConsole |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| buildCommand() | Builds the command string | lispa\amos\core\components\RunConsole |
Property Details
Path to php executable
Path to php executable
Yii console application file that will be executed
Method Details
Builds the command string
| protected string buildCommand ( $cmd ) | ||
| $cmd | Yii command |
|
| return | string | Full command to execute |
|---|---|---|
If property $phpexec is set it will be used as php executable
| public string getPHPExecutable ( ) | ||
| return | string | Path to php executable |
|---|---|---|
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 ( ) |
Runs yii console command
| public integer run ( $cmd, &$output = '' ) | ||
| $cmd | Command with arguments |
|
| $output | string | Filled with the command output |
| return | integer | Termination status of the process that was run |
|---|---|---|