0 follower

Class yii\console\controllers\AssetController

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

Allows you to combine and compress your JavaScript and CSS files.

Usage:

  1. Create a configuration file using the template action:

    yii asset/template /path/to/myapp/config.php

  2. Edit the created config file, adjusting it for your web application needs.
  3. Run the 'compress' action, using created config:

    yii asset /path/to/myapp/config.php /path/to/myapp/config/assets_compressed.php

  4. Adjust your web application config to use compressed assets.

Note: in the console environment some path aliases like @webroot and @web may not exist, so corresponding paths inside the configuration should be specified directly.

Note: by default this command relies on an external tools to perform actual files compression, check $jsCompressor and $cssCompressor for more details.

Public Properties

Hide inherited properties

Property Type Description Defined By
$action yii\base\Action|null The action that is currently being executed. yii\base\Controller
$assetManager yii\web\AssetManager Asset manager instance. yii\console\controllers\AssetController
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$bundles array List of asset bundles to be compressed. yii\console\controllers\AssetController
$color boolean|null Whether to enable ANSI color in the output. yii\console\Controller
$cssCompressor string|callable CSS file compressor. yii\console\controllers\AssetController
$defaultAction string Controller default action ID. yii\console\controllers\AssetController
$deleteSource boolean Whether to delete asset source files after compression. yii\console\controllers\AssetController
$help boolean Whether to display help information about current command. yii\console\Controller
$helpSummary string yii\console\Controller
$id string The ID of this controller. yii\base\Controller
$interactive boolean Whether to run the command interactively. yii\console\Controller
$jsCompressor string|callable JavaScript file compressor. yii\console\controllers\AssetController
$layout string|null|false The name of the layout to be applied to this controller's views. yii\base\Controller
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$passedOptionValues array The properties corresponding to the passed options. yii\console\Controller
$passedOptions array The names of the options passed during execution. yii\console\Controller
$request yii\base\Request|array|string The request. yii\base\Controller
$response yii\base\Response|array|string The response. yii\base\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$silentExitOnException boolean|null If true - script finish with ExitCode::OK in case of exception. yii\console\Controller
$targets array List of asset bundles, which represents output compressed files. yii\console\controllers\AssetController
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

Public Methods

Hide inherited 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() yii\base\Controller
__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
actionCompress() Combines and compresses the asset files according to the given configuration. yii\console\controllers\AssetController
actionTemplate() Creates template of configuration file for actionCompress(). yii\console\controllers\AssetController
actions() Declares external actions for the controller. yii\base\Controller
afterAction() This method is invoked right after an action is executed. yii\base\Controller
ansiFormat() Formats a string with ANSI codes. yii\console\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() This method is invoked right before an action is executed. yii\console\Controller
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bindActionParams() Binds the parameters to the action. yii\console\Controller
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\BaseObject
combineCssFiles() Combines CSS files into a single one. yii\console\controllers\AssetController
combineJsFiles() Combines JavaScript files into a single one. yii\console\controllers\AssetController
confirm() Asks user to confirm by typing y or n. yii\console\Controller
createAction() Creates an action based on the given action ID. yii\base\Controller
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
findLayoutFile() Finds the applicable layout file. yii\base\Controller
getActionArgsHelp() Returns the help information for the anonymous arguments for the action. yii\console\Controller
getActionHelp() Returns the detailed help information for the specified action. yii\console\Controller
getActionHelpSummary() Returns a one-line short summary describing the specified action. yii\console\Controller
getActionOptionsHelp() Returns the help information for the options for the action. yii\console\Controller
getAssetManager() Returns the asset manager instance. yii\console\controllers\AssetController
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getHelp() Returns help information for this controller. yii\console\Controller
getHelpSummary() Returns one-line short summary describing this controller. yii\console\Controller
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getOptionValues() Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. yii\console\Controller
getPassedOptionValues() Returns the properties corresponding to the passed options. yii\console\Controller
getPassedOptions() Returns the names of valid options passed during execution. yii\console\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
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. yii\base\Controller
isColorEnabled() Returns a value indicating whether ANSI color is enabled. yii\console\Controller
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
optionAliases() Returns option alias names. yii\console\Controller
options() Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. yii\console\Controller
prompt() Prompts the user for input and validates it. yii\console\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() Runs an action with the specified action ID and parameters. yii\console\Controller
select() Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. yii\console\Controller
setAssetManager() Sets asset manager instance or configuration. yii\console\controllers\AssetController
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
stderr() Prints a string to STDERR. yii\console\Controller
stdout() Prints a string to STDOUT. yii\console\Controller
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

Method Description Defined By
adjustCssUrl() Adjusts CSS content allowing URL references pointing to the original resources. yii\console\controllers\AssetController
adjustDependency() Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones. yii\console\controllers\AssetController
bindInjectedParams() Fills parameters based on types and names in action method signature. yii\base\Controller
buildTarget() Builds output asset bundle. yii\console\controllers\AssetController
compressCssFiles() Compresses given CSS files and combines them into the single one. yii\console\controllers\AssetController
compressJsFiles() Compresses given JavaScript files and combines them into the single one. yii\console\controllers\AssetController
getActionMethodReflection() yii\console\Controller
loadBundles() Creates full list of source asset bundles. yii\console\controllers\AssetController
loadConfiguration() Applies configuration from the given file to self instance. yii\console\controllers\AssetController
loadDependency() Loads asset bundle dependencies recursively. yii\console\controllers\AssetController
loadTargets() Creates full list of output asset bundles. yii\console\controllers\AssetController
parseDocCommentDetail() Returns full description from the docblock. yii\console\Controller
parseDocCommentSummary() Returns the first line of docblock. yii\console\Controller
parseDocCommentTags() Parses the comment block into tags. yii\console\Controller
registerBundle() Registers asset bundles including their dependencies. yii\console\controllers\AssetController
saveTargets() Saves new asset bundles configuration. yii\console\controllers\AssetController

Events

Hide inherited events

Event Type Description Defined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Constants

Hide inherited constants

Constant Value Description Defined By
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. Use yii\console\ExitCode::UNSPECIFIED_ERROR instead. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. Use yii\console\ExitCode::OK instead. yii\console\Controller

Property Details

Hide inherited properties

$assetManager public property

Asset manager instance. Note that the type of this property differs in getter and setter. See getAssetManager() and setAssetManager() for details.

$bundles public property

List of asset bundles to be compressed.

public array $bundles = []
$cssCompressor public property

CSS file compressor. If a string, it is treated as shell command template, which should contain placeholders {from} - source file name - and {to} - output file name. Otherwise, it is treated as PHP callback, which should perform the compression.

Default value relies on usage of "YUI Compressor"

See also https://github.com/yui/yuicompressor/.

public string|callable $cssCompressor 'java -jar yuicompressor.jar --type css {from} -o {to}'
$defaultAction public property

Controller default action ID.

public string $defaultAction 'compress'
$deleteSource public property (available since version 2.0.10)

Whether to delete asset source files after compression. This option affects only those bundles, which have yii\web\AssetBundle::$sourcePath is set.

public boolean $deleteSource false
$jsCompressor public property

JavaScript file compressor. If a string, it is treated as shell command template, which should contain placeholders {from} - source file name - and {to} - output file name. Otherwise, it is treated as PHP callback, which should perform the compression.

Default value relies on usage of "Closure Compiler"

See also https://developers.google.com/closure/compiler/.

public string|callable $jsCompressor 'java -jar compiler.jar --js {from} --js_output_file {to}'
$targets public property

List of asset bundles, which represents output compressed files. You can specify the name of the output compressed file using 'css' and 'js' keys: For example:

'app\config\AllAsset' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [ ... ],
]

File names can contain placeholder "{hash}", which will be filled by the hash of the resulting file.

You may specify several target bundles in order to compress different groups of assets. In this case you should use 'depends' key to specify, which bundles should be covered with particular target bundle. You may leave 'depends' to be empty for single bundle, which will compress all remaining bundles in this case. For example:

'allShared' => [
    'js' => 'js/all-shared-{hash}.js',
    'css' => 'css/all-shared-{hash}.css',
    'depends' => [
        // Include all assets shared between 'backend' and 'frontend'
        'yii\web\YiiAsset',
        'app\assets\SharedAsset',
    ],
],
'allBackEnd' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [
        // Include only 'backend' assets:
        'app\assets\AdminAsset'
    ],
],
'allFrontEnd' => [
    'js' => 'js/all-{hash}.js',
    'css' => 'css/all-{hash}.css',
    'depends' => [], // Include all remaining assets
],
public array $targets = []

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method
public void __construct ( $id, $module, $config = [] )
$id string

The ID of this controller.

$module yii\base\Module

The module that this controller belongs to.

$config array

Name-value pairs that will be used to initialize the object properties.

                public function __construct($id, $module, $config = [])
{
    $this->id = $id;
    $this->module = $module;
    parent::__construct($config);
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
actionCompress() public method

Combines and compresses the asset files according to the given configuration.

During the process new asset bundle configuration file will be created. You should replace your original asset bundle configuration with this file in order to use compressed files.

public void actionCompress ( $configFile, $bundleFile )
$configFile string

Configuration file name.

$bundleFile string

Output asset bundles configuration file name.

                public function actionCompress($configFile, $bundleFile)
{
    $this->loadConfiguration($configFile);
    $bundles = $this->loadBundles($this->bundles);
    $targets = $this->loadTargets($this->targets, $bundles);
    foreach ($targets as $name => $target) {
        $this->stdout("Creating output bundle '{$name}':\n");
        if (!empty($target->js)) {
            $this->buildTarget($target, 'js', $bundles);
        }
        if (!empty($target->css)) {
            $this->buildTarget($target, 'css', $bundles);
        }
        $this->stdout("\n");
    }
    $targets = $this->adjustDependency($targets, $bundles);
    $this->saveTargets($targets, $bundleFile);
    if ($this->deleteSource) {
        $this->deletePublishedAssets($bundles);
    }
}

            
actionTemplate() public method

Creates template of configuration file for actionCompress().

public integer actionTemplate ( $configFile )
$configFile string

Output file name.

return integer

CLI exit code

throws yii\console\Exception

on failure.

                public function actionTemplate($configFile)
{
    $jsCompressor = VarDumper::export($this->jsCompressor);
    $cssCompressor = VarDumper::export($this->cssCompressor);
    $template = <<<EOD
p
onfiguration file for the "yii asset" console command.
n the console environment, some path aliases may not exist. Please define these:
ii::setAlias('@webroot', __DIR__ . '/../web');
ii::setAlias('@web', '/');
rn [
// Adjust command/callback for JavaScript files compressing:
'jsCompressor' => {$jsCompressor},
// Adjust command/callback for CSS files compressing:
'cssCompressor' => {$cssCompressor},
// Whether to delete asset source after compression:
'deleteSource' => false,
// The list of asset bundles to compress:
'bundles' => [
    // 'app\assets\AppAsset',
    // 'yii\web\YiiAsset',
    // 'yii\web\JqueryAsset',
],
// Asset bundle for compression output:
'targets' => [
    'all' => [
        'class' => 'yii\web\AssetBundle',
        'basePath' => '@webroot/assets',
        'baseUrl' => '@web/assets',
        'js' => 'js/all-{hash}.js',
        'css' => 'css/all-{hash}.css',
    ],
],
// Asset manager configuration:
'assetManager' => [
    //'basePath' => '@webroot/assets',
    //'baseUrl' => '@web/assets',
],

    if (file_exists($configFile)) {
        if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
            return ExitCode::OK;
        }
    }
    if (!file_put_contents($configFile, $template, LOCK_EX)) {
        throw new Exception("Unable to write template file '{$configFile}'.");
    }
    $this->stdout("Configuration file template created at '{$configFile}'.\n\n", Console::FG_GREEN);
    return ExitCode::OK;
}

            
actions() public method

Defined in: yii\base\Controller::actions()

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public array actions ( )

                public function actions()
{
    return [];
}

            
adjustCssUrl() protected method

Adjusts CSS content allowing URL references pointing to the original resources.

protected string adjustCssUrl ( $cssContent, $inputFilePath, $outputFilePath )
$cssContent string

Source CSS content.

$inputFilePath string

Input CSS file name.

$outputFilePath string

Output CSS file name.

return string

Adjusted CSS content.

                protected function adjustCssUrl($cssContent, $inputFilePath, $outputFilePath)
{
    $inputFilePath = str_replace('\\', '/', $inputFilePath);
    $outputFilePath = str_replace('\\', '/', $outputFilePath);
    $sharedPathParts = [];
    $inputFilePathParts = explode('/', $inputFilePath);
    $inputFilePathPartsCount = count($inputFilePathParts);
    $outputFilePathParts = explode('/', $outputFilePath);
    $outputFilePathPartsCount = count($outputFilePathParts);
    for ($i = 0; $i < $inputFilePathPartsCount && $i < $outputFilePathPartsCount; $i++) {
        if ($inputFilePathParts[$i] == $outputFilePathParts[$i]) {
            $sharedPathParts[] = $inputFilePathParts[$i];
        } else {
            break;
        }
    }
    $sharedPath = implode('/', $sharedPathParts);
    $inputFileRelativePath = trim(str_replace($sharedPath, '', $inputFilePath), '/');
    $outputFileRelativePath = trim(str_replace($sharedPath, '', $outputFilePath), '/');
    if (empty($inputFileRelativePath)) {
        $inputFileRelativePathParts = [];
    } else {
        $inputFileRelativePathParts = explode('/', $inputFileRelativePath);
    }
    if (empty($outputFileRelativePath)) {
        $outputFileRelativePathParts = [];
    } else {
        $outputFileRelativePathParts = explode('/', $outputFileRelativePath);
    }
    $callback = function ($matches) use ($inputFileRelativePathParts, $outputFileRelativePathParts) {
        $fullMatch = $matches[0];
        $inputUrl = $matches[1];
        if (strncmp($inputUrl, '/', 1) === 0 || strncmp($inputUrl, '#', 1) === 0 || preg_match('/^https?:\/\//i', $inputUrl) || preg_match('/^data:/i', $inputUrl)) {
            return $fullMatch;
        }
        if ($inputFileRelativePathParts === $outputFileRelativePathParts) {
            return $fullMatch;
        }
        if (empty($outputFileRelativePathParts)) {
            $outputUrlParts = [];
        } else {
            $outputUrlParts = array_fill(0, count($outputFileRelativePathParts), '..');
        }
        $outputUrlParts = array_merge($outputUrlParts, $inputFileRelativePathParts);
        if (strpos($inputUrl, '/') !== false) {
            $inputUrlParts = explode('/', $inputUrl);
            foreach ($inputUrlParts as $key => $inputUrlPart) {
                if ($inputUrlPart === '..') {
                    array_pop($outputUrlParts);
                    unset($inputUrlParts[$key]);
                }
            }
            $outputUrlParts[] = implode('/', $inputUrlParts);
        } else {
            $outputUrlParts[] = $inputUrl;
        }
        $outputUrl = implode('/', $outputUrlParts);
        return str_replace($inputUrl, $outputUrl, $fullMatch);
    };
    $cssContent = preg_replace_callback('/url\(["\']?([^)^"\']*)["\']?\)/i', $callback, $cssContent);
    return $cssContent;
}

            
adjustDependency() protected method

Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones.

protected yii\web\AssetBundle[] adjustDependency ( $targets, $bundles )
$targets yii\web\AssetBundle[]

Output asset bundles.

$bundles yii\web\AssetBundle[]

Source asset bundles.

return yii\web\AssetBundle[]

Output asset bundles.

                protected function adjustDependency($targets, $bundles)
{
    $this->stdout("Creating new bundle configuration...\n");
    $map = [];
    foreach ($targets as $name => $target) {
        foreach ($target->depends as $bundle) {
            $map[$bundle] = $name;
        }
    }
    foreach ($targets as $name => $target) {
        $depends = [];
        foreach ($target->depends as $bn) {
            foreach ($bundles[$bn]->depends as $bundle) {
                $depends[$map[$bundle]] = true;
            }
        }
        unset($depends[$name]);
        $target->depends = array_keys($depends);
    }
    // detect possible circular dependencies
    foreach ($targets as $name => $target) {
        $registered = [];
        $this->registerBundle($targets, $name, $registered);
    }
    foreach ($map as $bundle => $target) {
        $sourceBundle = $bundles[$bundle];
        $depends = $sourceBundle->depends;
        if (!$this->isBundleExternal($sourceBundle)) {
            $depends[] = $target;
        }
        $targetBundle = clone $sourceBundle;
        $targetBundle->depends = $depends;
        $targets[$bundle] = $targetBundle;
    }
    return $targets;
}

            
afterAction() public method

Defined in: yii\base\Controller::afterAction()

This method is invoked right after an action is executed.

The method will trigger the EVENT_AFTER_ACTION event. The return value of the method will be used as the action return value.

If you override this method, your code should look like the following:

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}
public mixed afterAction ( $action, $result )
$action yii\base\Action

The action just executed.

$result mixed

The action return result.

return mixed

The processed action result.

                public function afterAction($action, $result)
{
    $event = new ActionEvent($action);
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_ACTION, $event);
    return $event->result;
}

            
ansiFormat() public method

Defined in: yii\console\Controller::ansiFormat()

Formats a string with ANSI codes.

You may pass additional parameters using the constants defined in yii\helpers\Console.

Example:

echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public string ansiFormat ( $string )
$string string

The string to be formatted

                public function ansiFormat($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return $string;
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeAction() public method

Defined in: yii\console\Controller::beforeAction()

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

If you override this method, your code should look like the following:

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}
public boolean beforeAction ( $action )
$action yii\base\Action

The action to be executed.

return boolean

Whether the action should continue to run.

                public function beforeAction($action)
{
    $silentExit = $this->silentExitOnException !== null ? $this->silentExitOnException : YII_ENV_TEST;
    Yii::$app->errorHandler->silentExitOnException = $silentExit;
    return parent::beforeAction($action);
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
bindActionParams() public method

Defined in: yii\console\Controller::bindActionParams()

Binds the parameters to the action.

This method is invoked by yii\base\Action when it begins to run with the given parameters. This method will first bind the parameters with the options available to the action. It then validates the given arguments.

public array bindActionParams ( $action, $params )
$action yii\base\Action

The action to be bound with parameters

$params array

The parameters to be bound to the action

return array

The valid parameters that the action can run with.

throws yii\console\Exception

if there are unknown options or missing arguments

                public function bindActionParams($action, $params)
{
    if ($action instanceof InlineAction) {
        $method = new \ReflectionMethod($this, $action->actionMethod);
    } else {
        $method = new \ReflectionMethod($action, 'run');
    }
    $args = [];
    $missing = [];
    $actionParams = [];
    $requestedParams = [];
    foreach ($method->getParameters() as $i => $param) {
        $name = $param->getName();
        $key = null;
        if (array_key_exists($i, $params)) {
            $key = $i;
        } elseif (array_key_exists($name, $params)) {
            $key = $name;
        }
        if ($key !== null) {
            if (PHP_VERSION_ID >= 80000) {
                $isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
            } else {
                $isArray = $param->isArray();
            }
            if ($isArray) {
                $params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
            }
            $args[] = $actionParams[$key] = $params[$key];
            unset($params[$key]);
        } elseif (
            PHP_VERSION_ID >= 70100
            && ($type = $param->getType()) !== null
            && $type instanceof \ReflectionNamedType
            && !$type->isBuiltin()
        ) {
            try {
                $this->bindInjectedParams($type, $name, $args, $requestedParams);
            } catch (\yii\base\Exception $e) {
                throw new Exception($e->getMessage());
            }
        } elseif ($param->isDefaultValueAvailable()) {
            $args[] = $actionParams[$i] = $param->getDefaultValue();
        } else {
            $missing[] = $name;
        }
    }
    if (!empty($missing)) {
        throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
    }
    // We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
    if (\Yii::$app->requestedParams === null) {
        \Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
    }
    return array_merge($args, $params);
}

            
bindInjectedParams() protected method (available since version 2.0.36)

Defined in: yii\base\Controller::bindInjectedParams()

Fills parameters based on types and names in action method signature.

protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams )
$type ReflectionType

The reflected type of the action parameter.

$name string

The name of the parameter.

$args array

The array of arguments for the action, this function may append items to it.

$requestedParams array

The array with requested params, this function may write specific keys to it.

throws yii\base\ErrorException

when we cannot load a required service.

throws yii\base\InvalidConfigException

Thrown when there is an error in the DI configuration.

throws yii\di\NotInstantiableException

Thrown when a definition cannot be resolved to a concrete class (for example an interface type hint) without a proper definition in the container.

                final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
    // Since it is not a builtin type it must be DI injection.
    $typeName = $type->getName();
    if (($component = $this->module->get($name, false)) instanceof $typeName) {
        $args[] = $component;
        $requestedParams[$name] = "Component: " . get_class($component) . " \$$name";
    } elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
    } elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = "Container DI: $typeName \$$name";
    } elseif ($type->allowsNull()) {
        $args[] = null;
        $requestedParams[$name] = "Unavailable service: $name";
    } else {
        throw new Exception('Could not load required service: ' . $name);
    }
}

            
buildTarget() protected method

Builds output asset bundle.

protected void buildTarget ( $target, $type, $bundles )
$target yii\web\AssetBundle

Output asset bundle

$type string

Either 'js' or 'css'.

$bundles yii\web\AssetBundle[]

Source asset bundles.

throws yii\console\Exception

on failure.

                protected function buildTarget($target, $type, $bundles)
{
    $inputFiles = [];
    foreach ($target->depends as $name) {
        if (isset($bundles[$name])) {
            if (!$this->isBundleExternal($bundles[$name])) {
                foreach ($bundles[$name]->$type as $file) {
                    if (is_array($file)) {
                        $inputFiles[] = $bundles[$name]->basePath . '/' . $file[0];
                    } else {
                        $inputFiles[] = $bundles[$name]->basePath . '/' . $file;
                    }
                }
            }
        } else {
            throw new Exception("Unknown bundle: '{$name}'");
        }
    }
    if (empty($inputFiles)) {
        $target->$type = [];
    } else {
        FileHelper::createDirectory($target->basePath, $this->getAssetManager()->dirMode);
        $tempFile = $target->basePath . '/' . strtr($target->$type, ['{hash}' => 'temp']);
        if ($type === 'js') {
            $this->compressJsFiles($inputFiles, $tempFile);
        } else {
            $this->compressCssFiles($inputFiles, $tempFile);
        }
        $targetFile = strtr($target->$type, ['{hash}' => md5_file($tempFile)]);
        $outputFile = $target->basePath . '/' . $targetFile;
        rename($tempFile, $outputFile);
        $target->$type = [$targetFile];
    }
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
combineCssFiles() public method

Combines CSS files into a single one.

public void combineCssFiles ( $inputFiles, $outputFile )
$inputFiles array

Source file names.

$outputFile string

Output file name.

throws yii\console\Exception

on failure.

                public function combineCssFiles($inputFiles, $outputFile)
{
    $content = '';
    $outputFilePath = dirname($this->findRealPath($outputFile));
    foreach ($inputFiles as $file) {
        $content .= "/*** BEGIN FILE: $file ***/\n"
            . $this->adjustCssUrl(file_get_contents($file), dirname($this->findRealPath($file)), $outputFilePath)
            . "/*** END FILE: $file ***/\n";
    }
    if (!file_put_contents($outputFile, $content)) {
        throw new Exception("Unable to write output CSS file '{$outputFile}'.");
    }
}

            
combineJsFiles() public method

Combines JavaScript files into a single one.

public void combineJsFiles ( $inputFiles, $outputFile )
$inputFiles array

Source file names.

$outputFile string

Output file name.

throws yii\console\Exception

on failure.

                public function combineJsFiles($inputFiles, $outputFile)
{
    $content = '';
    foreach ($inputFiles as $file) {
        // Add a semicolon to source code if trailing semicolon missing.
        // Notice: It needs a new line before `;` to avoid affection of line comment. (// ...;)
        $fileContent = rtrim(file_get_contents($file));
        if (substr($fileContent, -1) !== ';') {
            $fileContent .= "\n;";
        }
        $content .= "/*** BEGIN FILE: $file ***/\n"
            . $fileContent . "\n"
            . "/*** END FILE: $file ***/\n";
    }
    if (!file_put_contents($outputFile, $content)) {
        throw new Exception("Unable to write output JavaScript file '{$outputFile}'.");
    }
}

            
compressCssFiles() protected method

Compresses given CSS files and combines them into the single one.

protected void compressCssFiles ( $inputFiles, $outputFile )
$inputFiles array

List of source file names.

$outputFile string

Output file name.

throws yii\console\Exception

on failure

                protected function compressCssFiles($inputFiles, $outputFile)
{
    if (empty($inputFiles)) {
        return;
    }
    $this->stdout("  Compressing CSS files...\n");
    if (is_string($this->cssCompressor)) {
        $tmpFile = $outputFile . '.tmp';
        $this->combineCssFiles($inputFiles, $tmpFile);
        $this->stdout((string)shell_exec(strtr($this->cssCompressor, [
            '{from}' => escapeshellarg($tmpFile),
            '{to}' => escapeshellarg($outputFile),
        ])));
        @unlink($tmpFile);
    } else {
        call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile);
    }
    if (!file_exists($outputFile)) {
        throw new Exception("Unable to compress CSS files into '{$outputFile}'.");
    }
    $this->stdout("  CSS files compressed into '{$outputFile}'.\n");
}

            
compressJsFiles() protected method

Compresses given JavaScript files and combines them into the single one.

protected void compressJsFiles ( $inputFiles, $outputFile )
$inputFiles array

List of source file names.

$outputFile string

Output file name.

throws yii\console\Exception

on failure

                protected function compressJsFiles($inputFiles, $outputFile)
{
    if (empty($inputFiles)) {
        return;
    }
    $this->stdout("  Compressing JavaScript files...\n");
    if (is_string($this->jsCompressor)) {
        $tmpFile = $outputFile . '.tmp';
        $this->combineJsFiles($inputFiles, $tmpFile);
        $this->stdout((string)shell_exec(strtr($this->jsCompressor, [
            '{from}' => escapeshellarg($tmpFile),
            '{to}' => escapeshellarg($outputFile),
        ])));
        @unlink($tmpFile);
    } else {
        call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile);
    }
    if (!file_exists($outputFile)) {
        throw new Exception("Unable to compress JavaScript files into '{$outputFile}'.");
    }
    $this->stdout("  JavaScript files compressed into '{$outputFile}'.\n");
}

            
confirm() public method

Defined in: yii\console\Controller::confirm()

Asks user to confirm by typing y or n.

A typical usage looks like the following:

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}
public boolean confirm ( $message, $default false )
$message string

To echo out before waiting for user input

$default boolean

This value is returned if no selection is made.

return boolean

Whether user confirmed. Will return true if $interactive is false.

                public function confirm($message, $default = false)
{
    if ($this->interactive) {
        return Console::confirm($message, $default);
    }
    return true;
}

            
createAction() public method

Defined in: yii\base\Controller::createAction()

Creates an action based on the given action ID.

The method first checks if the action ID has been declared in actions(). If so, it will use the configuration declared there to create the action object. If not, it will look for a controller method whose name is in the format of actionXyz where xyz is the action ID. If found, an yii\base\InlineAction representing that method will be created and returned.

public yii\base\Action|null createAction ( $id )
$id string

The action ID.

return yii\base\Action|null

The newly created action instance. Null if the ID doesn't resolve into any action.

                public function createAction($id)
{
    if ($id === '') {
        $id = $this->defaultAction;
    }
    $actionMap = $this->actions();
    if (isset($actionMap[$id])) {
        return Yii::createObject($actionMap[$id], [$id, $this]);
    }
    if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
        $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
        if (method_exists($this, $methodName)) {
            $method = new \ReflectionMethod($this, $methodName);
            if ($method->isPublic() && $method->getName() === $methodName) {
                return new InlineAction($id, $this, $methodName);
            }
        }
    }
    return null;
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
findLayoutFile() public method

Defined in: yii\base\Controller::findLayoutFile()

Finds the applicable layout file.

public string|boolean findLayoutFile ( $view )
$view yii\base\View

The view object to render the layout file.

return string|boolean

The layout file path, or false if layout is not needed. Please refer to render() on how to specify this parameter.

throws yii\base\InvalidArgumentException

if an invalid path alias is used to specify the layout.

                public function findLayoutFile($view)
{
    $module = $this->module;
    $layout = null;
    if (is_string($this->layout)) {
        $layout = $this->layout;
    } elseif ($this->layout === null) {
        while ($module !== null && $module->layout === null) {
            $module = $module->module;
        }
        if ($module !== null && is_string($module->layout)) {
            $layout = $module->layout;
        }
    }
    if ($layout === null) {
        return false;
    }
    if (strncmp($layout, '@', 1) === 0) {
        $file = Yii::getAlias($layout);
    } elseif (strncmp($layout, '/', 1) === 0) {
        $file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
    } else {
        $file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
    }
    if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
        return $file;
    }
    $path = $file . '.' . $view->defaultExtension;
    if ($view->defaultExtension !== 'php' && !is_file($path)) {
        $path = $file . '.php';
    }
    return $path;
}

            
getActionArgsHelp() public method

Defined in: yii\console\Controller::getActionArgsHelp()

Returns the help information for the anonymous arguments for the action.

The returned value should be an array. The keys are the argument names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • required: bool, whether this argument is required
  • type: string|null, the PHP type(s) of this argument
  • default: mixed, the default value of this argument
  • comment: string, the description of this argument

The default implementation will return the help information extracted from the Reflection or DocBlock of the parameters corresponding to the action method.

public array getActionArgsHelp ( $action )
$action yii\base\Action

The action instance

return array

The help information of the action arguments

                public function getActionArgsHelp($action)
{
    $method = $this->getActionMethodReflection($action);
    $tags = $this->parseDocCommentTags($method);
    $tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
    $phpDocParams = [];
    foreach ($tags['param'] as $i => $tag) {
        if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
            $key = empty($matches['name']) ? $i : $matches['name'];
            $phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
        }
    }
    unset($tags);
    $args = [];
    /** @var \ReflectionParameter $parameter */
    foreach ($method->getParameters() as $i => $parameter) {
        $type = null;
        $comment = '';
        if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
            $reflectionType = $parameter->getType();
            if (PHP_VERSION_ID >= 70100) {
                $types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
                foreach ($types as $key => $reflectionType) {
                    $types[$key] = $reflectionType->getName();
                }
                $type = implode('|', $types);
            } else {
                $type = (string) $reflectionType;
            }
        }
        // find PhpDoc tag by property name or position
        $key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
        if ($key !== null) {
            $comment = $phpDocParams[$key]['comment'];
            if ($type === null && !empty($phpDocParams[$key]['type'])) {
                $type = $phpDocParams[$key]['type'];
            }
        }
        // if type still not detected, then using type of default value
        if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
            $type = gettype($parameter->getDefaultValue());
        }
        $args[$parameter->name] = [
            'required' => !$parameter->isOptional(),
            'type' => $type,
            'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
            'comment' => $comment,
        ];
    }
    return $args;
}

            
getActionHelp() public method

Defined in: yii\console\Controller::getActionHelp()

Returns the detailed help information for the specified action.

public string getActionHelp ( $action )
$action yii\base\Action

Action to get help for

return string

The detailed help information for the specified action.

                public function getActionHelp($action)
{
    return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}

            
getActionHelpSummary() public method

Defined in: yii\console\Controller::getActionHelpSummary()

Returns a one-line short summary describing the specified action.

public string getActionHelpSummary ( $action )
$action yii\base\Action

Action to get summary for

return string

A one-line short summary describing the specified action.

                public function getActionHelpSummary($action)
{
    if ($action === null) {
        return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
    }
    return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}

            
getActionMethodReflection() protected method
protected ReflectionFunctionAbstract getActionMethodReflection ( $action )
$action yii\base\Action

                protected function getActionMethodReflection($action)
{
    if (!isset($this->_reflections[$action->id])) {
        if ($action instanceof InlineAction) {
            $this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
        } else {
            $this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
        }
    }
    return $this->_reflections[$action->id];
}

            
getActionOptionsHelp() public method

Defined in: yii\console\Controller::getActionOptionsHelp()

Returns the help information for the options for the action.

The returned value should be an array. The keys are the option names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • type: string, the PHP type of this argument.
  • default: string, the default value of this argument
  • comment: string, the comment of this argument

The default implementation will return the help information extracted from the doc-comment of the properties corresponding to the action options.

public array getActionOptionsHelp ( $action )
$action yii\base\Action
return array

The help information of the action options

                public function getActionOptionsHelp($action)
{
    $optionNames = $this->options($action->id);
    if (empty($optionNames)) {
        return [];
    }
    $class = new \ReflectionClass($this);
    $options = [];
    foreach ($class->getProperties() as $property) {
        $name = $property->getName();
        if (!in_array($name, $optionNames, true)) {
            continue;
        }
        $defaultValue = $property->getValue($this);
        $tags = $this->parseDocCommentTags($property);
        // Display camelCase options in kebab-case
        $name = Inflector::camel2id($name, '-', true);
        if (isset($tags['var']) || isset($tags['property'])) {
            $doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
            if (is_array($doc)) {
                $doc = reset($doc);
            }
            if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
                $type = $matches[1];
                $comment = $matches[2];
            } else {
                $type = null;
                $comment = $doc;
            }
            $options[$name] = [
                'type' => $type,
                'default' => $defaultValue,
                'comment' => $comment,
            ];
        } else {
            $options[$name] = [
                'type' => null,
                'default' => $defaultValue,
                'comment' => '',
            ];
        }
    }
    return $options;
}

            
getAssetManager() public method

Returns the asset manager instance.

public yii\web\AssetManager getAssetManager ( )
return yii\web\AssetManager

Asset manager instance.

throws yii\console\Exception

on invalid configuration.

                public function getAssetManager()
{
    if (!is_object($this->_assetManager)) {
        $options = $this->_assetManager;
        if (!isset($options['class'])) {
            $options['class'] = 'yii\\web\\AssetManager';
        }
        if (!isset($options['basePath'])) {
            throw new Exception("Please specify 'basePath' for the 'assetManager' option.");
        }
        if (!isset($options['baseUrl'])) {
            throw new Exception("Please specify 'baseUrl' for the 'assetManager' option.");
        }
        if (!isset($options['forceCopy'])) {
            $options['forceCopy'] = true;
        }
        $this->_assetManager = Yii::createObject($options);
    }
    return $this->_assetManager;
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getHelp() public method

Defined in: yii\console\Controller::getHelp()

Returns help information for this controller.

You may override this method to return customized help. The default implementation returns help information retrieved from the PHPDoc comment.

public string getHelp ( )

                public function getHelp()
{
    return $this->parseDocCommentDetail(new \ReflectionClass($this));
}

            
getHelpSummary() public method

Defined in: yii\console\Controller::getHelpSummary()

Returns one-line short summary describing this controller.

You may override this method to return customized summary. The default implementation returns first line from the PHPDoc comment.

public string getHelpSummary ( )

                public function getHelpSummary()
{
    return $this->parseDocCommentSummary(new \ReflectionClass($this));
}

            
getModules() public method

Defined in: yii\base\Controller::getModules()

Returns all ancestor modules of this controller.

The first module in the array is the outermost one (i.e., the application instance), while the last is the innermost one.

public yii\base\Module[] getModules ( )
return yii\base\Module[]

All ancestor modules that this controller is located within.

                public function getModules()
{
    $modules = [$this->module];
    $module = $this->module;
    while ($module->module !== null) {
        array_unshift($modules, $module->module);
        $module = $module->module;
    }
    return $modules;
}

            
getOptionValues() public method

Defined in: yii\console\Controller::getOptionValues()

Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.

public array getOptionValues ( $actionID )
$actionID string

The action id of the current request

return array

Properties corresponding to the options for the action

                public function getOptionValues($actionID)
{
    // $actionId might be used in subclasses to provide properties specific to action id
    $properties = [];
    foreach ($this->options($this->action->id) as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptionValues() public method

Defined in: yii\console\Controller::getPassedOptionValues()

Returns the properties corresponding to the passed options.

public array getPassedOptionValues ( )
return array

The properties corresponding to the passed options

                public function getPassedOptionValues()
{
    $properties = [];
    foreach ($this->_passedOptions as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptions() public method

Defined in: yii\console\Controller::getPassedOptions()

Returns the names of valid options passed during execution.

public array getPassedOptions ( )
return array

The names of the options passed during execution

                public function getPassedOptions()
{
    return $this->_passedOptions;
}

            
getRoute() public method

Defined in: yii\base\Controller::getRoute()

Returns the route of the current request.

public string getRoute ( )
return string

The route (module ID, controller ID and action ID) of the current request.

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}

            
getUniqueId() public method

Defined in: yii\base\Controller::getUniqueId()

Returns the unique ID of the controller.

public string getUniqueId ( )
return string

The controller ID that is prefixed with the module ID (if any).

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}

            
getView() public method

Defined in: yii\base\Controller::getView()

Returns the view object that can be used to render views or view files.

The render(), renderPartial() and renderFile() methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

public yii\base\View|yii\web\View getView ( )
return yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

Defined in: yii\base\Controller::getViewPath()

Returns the directory containing view files for this controller.

The default implementation returns the directory named as controller $id under the $module's $viewPath directory.

public string getViewPath ( )
return string

The directory containing the view files for this controller.

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method (available since version 2.0.36)

Defined in: yii\base\Controller::init()

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 ( )

                public function init()
{
    parent::init();
    $this->request = Instance::ensure($this->request, Request::className());
    $this->response = Instance::ensure($this->response, Response::className());
}

            
isColorEnabled() public method

Defined in: yii\console\Controller::isColorEnabled()

Returns a value indicating whether ANSI color is enabled.

ANSI color is enabled only if $color is set true or is not set and the terminal supports ANSI color.

public boolean isColorEnabled ( $stream = \STDOUT )
$stream resource

The stream to check.

return boolean

Whether to enable ANSI style in output.

                public function isColorEnabled($stream = \STDOUT)
{
    return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}

            
loadBundles() protected method

Creates full list of source asset bundles.

protected yii\web\AssetBundle[] loadBundles ( $bundles )
$bundles string[]

List of asset bundle names

return yii\web\AssetBundle[]

List of source asset bundles.

                protected function loadBundles($bundles)
{
    $this->stdout("Collecting source bundles information...\n");
    $am = $this->getAssetManager();
    $result = [];
    foreach ($bundles as $name) {
        $result[$name] = $am->getBundle($name);
    }
    foreach ($result as $bundle) {
        $this->loadDependency($bundle, $result);
    }
    return $result;
}

            
loadConfiguration() protected method

Applies configuration from the given file to self instance.

protected void loadConfiguration ( $configFile )
$configFile string

Configuration file name.

throws yii\console\Exception

on failure.

                protected function loadConfiguration($configFile)
{
    $this->stdout("Loading configuration from '{$configFile}'...\n");
    $config = require $configFile;
    foreach ($config as $name => $value) {
        if (property_exists($this, $name) || $this->canSetProperty($name)) {
            $this->$name = $value;
        } else {
            throw new Exception("Unknown configuration option: $name");
        }
    }
    $this->getAssetManager(); // check if asset manager configuration is correct
}

            
loadDependency() protected method

Loads asset bundle dependencies recursively.

protected void loadDependency ( $bundle, &$result )
$bundle yii\web\AssetBundle

Bundle instance

$result array

Already loaded bundles list.

throws yii\console\Exception

on failure.

                protected function loadDependency($bundle, &$result)
{
    $am = $this->getAssetManager();
    foreach ($bundle->depends as $name) {
        if (!isset($result[$name])) {
            $dependencyBundle = $am->getBundle($name);
            $result[$name] = false;
            $this->loadDependency($dependencyBundle, $result);
            $result[$name] = $dependencyBundle;
        } elseif ($result[$name] === false) {
            throw new Exception("A circular dependency is detected for bundle '{$name}': " . $this->composeCircularDependencyTrace($name, $result) . '.');
        }
    }
}

            
loadTargets() protected method

Creates full list of output asset bundles.

protected yii\web\AssetBundle[] loadTargets ( $targets, $bundles )
$targets array

Output asset bundles configuration.

$bundles yii\web\AssetBundle[]

List of source asset bundles.

return yii\web\AssetBundle[]

List of output asset bundles.

throws yii\console\Exception

on failure.

                protected function loadTargets($targets, $bundles)
{
    // build the dependency order of bundles
    $registered = [];
    foreach ($bundles as $name => $bundle) {
        $this->registerBundle($bundles, $name, $registered);
    }
    $bundleOrders = array_combine(array_keys($registered), range(0, count($bundles) - 1));
    // fill up the target which has empty 'depends'.
    $referenced = [];
    foreach ($targets as $name => $target) {
        if (empty($target['depends'])) {
            if (!isset($all)) {
                $all = $name;
            } else {
                throw new Exception("Only one target can have empty 'depends' option. Found two now: $all, $name");
            }
        } else {
            foreach ($target['depends'] as $bundle) {
                if (!isset($referenced[$bundle])) {
                    $referenced[$bundle] = $name;
                } else {
                    throw new Exception("Target '{$referenced[$bundle]}' and '$name' cannot contain the bundle '$bundle' at the same time.");
                }
            }
        }
    }
    if (isset($all)) {
        $targets[$all]['depends'] = array_diff(array_keys($registered), array_keys($referenced));
    }
    // adjust the 'depends' order for each target according to the dependency order of bundles
    // create an AssetBundle object for each target
    foreach ($targets as $name => $target) {
        if (!isset($target['basePath'])) {
            throw new Exception("Please specify 'basePath' for the '$name' target.");
        }
        if (!isset($target['baseUrl'])) {
            throw new Exception("Please specify 'baseUrl' for the '$name' target.");
        }
        usort($target['depends'], function ($a, $b) use ($bundleOrders) {
            if ($bundleOrders[$a] == $bundleOrders[$b]) {
                return 0;
            }
            return $bundleOrders[$a] > $bundleOrders[$b] ? 1 : -1;
        });
        if (!isset($target['class'])) {
            $target['class'] = $name;
        }
        $targets[$name] = Yii::createObject($target);
    }
    return $targets;
}

            
off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler null )
$name string

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

See also off().

public void on ( $name, $handler, $data null, $append true )
$name string

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
optionAliases() public method (available since version 2.0.8)

Defined in: yii\console\Controller::optionAliases()

Returns option alias names.

Child classes may override this method to specify alias options.

See also options().

public array optionAliases ( )
return array

The options alias names valid for the action where the keys is alias name for option and value is option name.

                public function optionAliases()
{
    return [
        'h' => 'help',
    ];
}

            
options() public method

Defined in: yii\console\Controller::options()

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

public string[] options ( $actionID )
$actionID string

The action id of the current request

return string[]

The names of the options valid for the action

                public function options($actionID)
{
    // $actionId might be used in subclasses to provide options specific to action id
    return ['color', 'interactive', 'help', 'silentExitOnException'];
}

            
parseDocCommentDetail() protected method

Defined in: yii\console\Controller::parseDocCommentDetail()

Returns full description from the docblock.

protected string parseDocCommentDetail ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentDetail($reflection)
{
    $comment = strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
    if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
        $comment = trim(substr($comment, 0, $matches[0][1]));
    }
    if ($comment !== '') {
        return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
    }
    return '';
}

            
parseDocCommentSummary() protected method

Defined in: yii\console\Controller::parseDocCommentSummary()

Returns the first line of docblock.

protected string parseDocCommentSummary ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

                protected function parseDocCommentSummary($reflection)
{
    $docLines = preg_split('~\R~u', $reflection->getDocComment());
    if (isset($docLines[1])) {
        return trim($docLines[1], "\t *");
    }
    return '';
}

            
parseDocCommentTags() protected method

Defined in: yii\console\Controller::parseDocCommentTags()

Parses the comment block into tags.

protected array parseDocCommentTags ( $reflection )
$reflection ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

The comment block

return array

The parsed tags

                protected function parseDocCommentTags($reflection)
{
    $comment = $reflection->getDocComment();
    $comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($comment, '/'))), "\r", '');
    $parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
    $tags = [];
    foreach ($parts as $part) {
        if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
            $name = $matches[1];
            if (!isset($tags[$name])) {
                $tags[$name] = trim($matches[2]);
            } elseif (is_array($tags[$name])) {
                $tags[$name][] = trim($matches[2]);
            } else {
                $tags[$name] = [$tags[$name], trim($matches[2])];
            }
        }
    }
    return $tags;
}

            
prompt() public method

Defined in: yii\console\Controller::prompt()

Prompts the user for input and validates it.

public string prompt ( $text, $options = [] )
$text string

Prompt string

$options array

The options to validate the input:

  • required: whether it is required or not
  • default: default value if no input is inserted by the user
  • pattern: regular expression pattern to validate user input
  • validator: a callable function to validate input. The function must accept two parameters:
    • $input: the user input to validate
    • $error: the error value passed by reference if validation failed.

An example of how to use the prompt method with a validator function.

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);
return string

The user input

                public function prompt($text, $options = [])
{
    if ($this->interactive) {
        return Console::prompt($text, $options);
    }
    return isset($options['default']) ? $options['default'] : '';
}

            
registerBundle() protected method

Registers asset bundles including their dependencies.

protected void registerBundle ( $bundles, $name, &$registered )
$bundles yii\web\AssetBundle[]

Asset bundles list.

$name string

Bundle name.

$registered array

Stores already registered names.

throws yii\console\Exception

if circular dependency is detected.

                protected function registerBundle($bundles, $name, &$registered)
{
    if (!isset($registered[$name])) {
        $registered[$name] = false;
        $bundle = $bundles[$name];
        foreach ($bundle->depends as $depend) {
            $this->registerBundle($bundles, $depend, $registered);
        }
        unset($registered[$name]);
        $registered[$name] = $bundle;
    } elseif ($registered[$name] === false) {
        throw new Exception("A circular dependency is detected for target '{$name}': " . $this->composeCircularDependencyTrace($name, $registered) . '.');
    }
}

            
render() public method

Defined in: yii\base\Controller::render()

Renders a view and applies layout if available.

The view to be rendered can be specified in one of the following formats:

  • path alias (e.g. "@app/views/site/index");
  • absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the view path of the application.
  • absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the view path of $module.
  • relative path (e.g. "index"): the actual view file will be looked for under $viewPath.

To determine which layout should be applied, the following two steps are conducted:

  1. In the first step, it determines the layout name and the context module:
  • If $layout is specified as a string, use it as the layout name and $module as the context module;
  • If $layout is null, search through all ancestor modules of this controller and find the first module whose layout is not null. The layout and the corresponding module are used as the layout name and the context module, respectively. If such a module is not found or the corresponding layout is not a string, it will return false, meaning no applicable layout.
  1. In the second step, it determines the actual layout file according to the previously found layout name and context module. The layout name can be:
  • a path alias (e.g. "@app/views/layouts/main");
  • an absolute path (e.g. "/main"): the layout name starts with a slash. The actual layout file will be looked for under the layout path of the application;
  • a relative path (e.g. "main"): the actual layout file will be looked for under the layout path of the context module.

If the layout name does not contain a file extension, it will use the default one .php.

public string render ( $view, $params = [] )
$view string

The view name.

$params array

The parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file or the layout file does not exist.

                public function render($view, $params = [])
{
    $content = $this->getView()->render($view, $params, $this);
    return $this->renderContent($content);
}

            
renderContent() public method (available since version 2.0.1)

Defined in: yii\base\Controller::renderContent()

Renders a static string by applying a layout.

public string renderContent ( $content )
$content string

The static string being rendered

return string

The rendering result of the layout with the given static string as the $content variable. If the layout is disabled, the string will be returned back.

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}

            
renderFile() public method

Defined in: yii\base\Controller::renderFile()

Renders a view file.

public string renderFile ( $file, $params = [] )
$file string

The view file to be rendered. This can be either a file path or a path alias.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
renderPartial() public method

Defined in: yii\base\Controller::renderPartial()

Renders a view without applying layout.

This method differs from render() in that it does not apply any layout.

public string renderPartial ( $view, $params = [] )
$view string

The view name. Please refer to render() on how to specify a view name.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderPartial($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
run() public method

Defined in: yii\base\Controller::run()

Runs a request specified in terms of a route.

The route can be either an ID of an action within this controller or a complete route consisting of module IDs, controller ID and action ID. If the route starts with a slash '/', the parsing of the route will start from the application; otherwise, it will start from the parent module of this controller.

See also runAction().

public mixed run ( $route, $params = [] )
$route string

The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.

$params array

The parameters to be passed to the action.

return mixed

The result of the action.

                public function run($route, $params = [])
{
    $pos = strpos($route, '/');
    if ($pos === false) {
        return $this->runAction($route, $params);
    } elseif ($pos > 0) {
        return $this->module->runAction($route, $params);
    }
    return Yii::$app->runAction(ltrim($route, '/'), $params);
}

            
runAction() public method

Defined in: yii\console\Controller::runAction()

Runs an action with the specified action ID and parameters.

If the action ID is empty, the method will use $defaultAction.

See also createAction().

public integer runAction ( $id, $params = [] )
$id string

The ID of the action to be executed.

$params array

The parameters (name-value pairs) to be passed to the action.

return integer

The status of the action execution. 0 means normal, other values mean abnormal.

throws yii\base\InvalidRouteException

if the requested action ID cannot be resolved into an action successfully.

throws yii\console\Exception

if there are unknown options or missing arguments

                public function runAction($id, $params = [])
{
    if (!empty($params)) {
        // populate options here so that they are available in beforeAction().
        $options = $this->options($id === '' ? $this->defaultAction : $id);
        if (isset($params['_aliases'])) {
            $optionAliases = $this->optionAliases();
            foreach ($params['_aliases'] as $name => $value) {
                if (array_key_exists($name, $optionAliases)) {
                    $params[$optionAliases[$name]] = $value;
                } else {
                    $message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
                    if (!empty($optionAliases)) {
                        $aliasesAvailable = [];
                        foreach ($optionAliases as $alias => $option) {
                            $aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
                        }
                        $message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
                            'aliases' => implode(', ', $aliasesAvailable)
                        ]);
                    }
                    throw new Exception($message);
                }
            }
            unset($params['_aliases']);
        }
        foreach ($params as $name => $value) {
            // Allow camelCase options to be entered in kebab-case
            if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
                $kebabName = $name;
                $altName = lcfirst(Inflector::id2camel($kebabName));
                if (in_array($altName, $options, true)) {
                    $name = $altName;
                }
            }
            if (in_array($name, $options, true)) {
                $default = $this->$name;
                if (is_array($default) && is_string($value)) {
                    $this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
                } elseif ($default !== null) {
                    settype($value, gettype($default));
                    $this->$name = $value;
                } else {
                    $this->$name = $value;
                }
                $this->_passedOptions[] = $name;
                unset($params[$name]);
                if (isset($kebabName)) {
                    unset($params[$kebabName]);
                }
            } elseif (!is_int($name)) {
                $message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
                if (!empty($options)) {
                    $message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
                }
                throw new Exception($message);
            }
        }
    }
    if ($this->help) {
        $route = $this->getUniqueId() . '/' . $id;
        return Yii::$app->runAction('help', [$route]);
    }
    return parent::runAction($id, $params);
}

            
saveTargets() protected method

Saves new asset bundles configuration.

protected void saveTargets ( $targets, $bundleFile )
$targets yii\web\AssetBundle[]

List of asset bundles to be saved.

$bundleFile string

Output file name.

throws yii\console\Exception

on failure.

                protected function saveTargets($targets, $bundleFile)
{
    $array = [];
    foreach ($targets as $name => $target) {
        if (isset($this->targets[$name])) {
            $array[$name] = array_merge($this->targets[$name], [
                'class' => get_class($target),
                'sourcePath' => null,
                'basePath' => $this->targets[$name]['basePath'],
                'baseUrl' => $this->targets[$name]['baseUrl'],
                'js' => $target->js,
                'css' => $target->css,
                'depends' => [],
            ]);
        } else {
            if ($this->isBundleExternal($target)) {
                $array[$name] = $this->composeBundleConfig($target);
            } else {
                $array[$name] = [
                    'sourcePath' => null,
                    'js' => [],
                    'css' => [],
                    'depends' => $target->depends,
                ];
            }
        }
    }
    $array = VarDumper::export($array);
    $version = date('Y-m-d H:i:s');
    $bundleFileContent = <<<EOD
p
his file is generated by the "yii {$this->id}" command.
O NOT MODIFY THIS FILE DIRECTLY.
version {$version}
rn {$array};

    if (!file_put_contents($bundleFile, $bundleFileContent, LOCK_EX)) {
        throw new Exception("Unable to write output bundle configuration at '{$bundleFile}'.");
    }
    $this->stdout("Output bundle configuration created at '{$bundleFile}'.\n", Console::FG_GREEN);
}

            
select() public method

Defined in: yii\console\Controller::select()

Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.

public string select ( $prompt, $options = [], $default null )
$prompt string

The prompt message

$options array

Key-value array of options to choose from

$default string|null

Value to use when the user doesn't provide an option. If the default is null, the user is required to select an option.

return string

An option character the user chose

Version Description
2.0.49 Added the $default argument

                public function select($prompt, $options = [], $default = null)
{
    if ($this->interactive) {
        return Console::select($prompt, $options, $default);
    }
    return $default;
}

            
setAssetManager() public method

Sets asset manager instance or configuration.

public void setAssetManager ( $assetManager )
$assetManager yii\web\AssetManager|array

Asset manager instance or its array configuration.

throws yii\console\Exception

on invalid argument type.

                public function setAssetManager($assetManager)
{
    if (is_scalar($assetManager)) {
        throw new Exception('"' . get_class($this) . '::assetManager" should be either object or array - "' . gettype($assetManager) . '" given.');
    }
    $this->_assetManager = $assetManager;
}

            
setView() public method

Defined in: yii\base\Controller::setView()

Sets the view object to be used by this controller.

public void setView ( $view )
$view yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function setView($view)
{
    $this->_view = $view;
}

            
setViewPath() public method (available since version 2.0.7)

Defined in: yii\base\Controller::setViewPath()

Sets the directory that contains the view files.

public void setViewPath ( $path )
$path string

The root directory of view files.

throws yii\base\InvalidArgumentException

if the directory is invalid

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
stderr() public method

Defined in: yii\console\Controller::stderr()

Prints a string to STDERR.

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console.

Example:

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string )
$string string

The string to print

return integer|boolean

Number of bytes printed or false on error

                public function stderr($string)
{
    if ($this->isColorEnabled(\STDERR)) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return fwrite(\STDERR, $string);
}

            
stdout() public method

Defined in: yii\console\Controller::stdout()

Prints a string to STDOUT.

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console.

Example:

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stdout ( $string )
$string string

The string to print

return integer|boolean

Number of bytes printed or false on error

                public function stdout($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return Console::stdout($string);
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event null )
$name string

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}