RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-console-request below:

Request, yii\console\Request | API Documentation for Yii 2.0

The console Request represents the environment information for a console application.

It is a wrapper for the PHP $_SERVER variable which holds information about the currently running PHP script and the command line arguments given to it.

Hide inherited methods

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.

Source code

                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()");
}

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.

Source code

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

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

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

public void __construct ( $config = [] ) $config array

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

Source code

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

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 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.

Source code

                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]);
    }
}

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

public array resolve ( ) return array

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

throws yii\console\Exception

when parameter is wrong and can not be resolved

Source code

                public function resolve()
{
    $rawParams = $this->getParams();
    $endOfOptionsFound = false;
    if (isset($rawParams[0])) {
        $route = array_shift($rawParams);
        if ($route === '--') {
            $endOfOptionsFound = true;
            $route = array_shift($rawParams);
        }
    } else {
        $route = '';
    }
    $params = [];
    $prevOption = null;
    foreach ($rawParams as $param) {
        if ($endOfOptionsFound) {
            $params[] = $param;
        } elseif ($param === '--') {
            $endOfOptionsFound = true;
        } elseif (preg_match('/^--([\w-]+)(?:=(.*))?$/', $param, $matches)) {
            $name = $matches[1];
            if (is_numeric(substr($name, 0, 1))) {
                throw new Exception('Parameter "' . $name . '" is not valid');
            }
            if ($name !== Application::OPTION_APPCONFIG) {
                $params[$name] = isset($matches[2]) ? $matches[2] : true;
                $prevOption = &$params[$name];
            }
        } elseif (preg_match('/^-([\w-]+)(?:=(.*))?$/', $param, $matches)) {
            $name = $matches[1];
            if (is_numeric($name)) {
                $params[] = $param;
            } else {
                $params['_aliases'][$name] = isset($matches[2]) ? $matches[2] : true;
                $prevOption = &$params['_aliases'][$name];
            }
        } elseif ($prevOption === true) {
            
            $prevOption = $param;
        } else {
            $params[] = $param;
        }
    }
    return [$route, $params];
}

public void setIsConsoleRequest ( $value ) $value boolean

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

Source code

                public function setIsConsoleRequest($value)
{
    $this->_isConsoleRequest = $value;
}

Sets the command line arguments.

public void setParams ( $params ) $params array

The command line arguments

Source code

                public function setParams($params)
{
    $this->_params = $params;
}

Defined in: yii\base\Request::setScriptFile()

Sets the entry script file path.

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

Source code

                public function setScriptFile($value)
{
    $scriptFile = realpath(Yii::getAlias($value));
    if ($scriptFile !== false && is_file($scriptFile)) {
        $this->_scriptFile = $scriptFile;
    } else {
        throw new InvalidConfigException('Unable to determine the entry script file path.');
    }
}

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.

Source code

                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);
            
            if ($event->handled) {
                return;
            }
        }
    }
    
    Event::trigger($this, $name, $event);
}

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4