Класс Phalcon\Cli\Dispatcher

расширяет абстрактный класс Phalcon\Dispatcher

реализует Phalcon\Events\EventsAwareInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\DispatcherInterface, Phalcon\Cli\DispatcherInterface

Исходный код на GitHub

Диспетчирование — это процесс получения аргументов командной строки, извлечения из них имени модуля, имени задачи, имени действия и необязательных параметров, а затем создание экземпляра задачи и вызова действия на нём.

$di = new \Phalcon\Di();

$dispatcher = new \Phalcon\Cli\Dispatcher();

$dispatcher->setDi($di);

$dispatcher->setTaskName("posts");
$dispatcher->setActionName("index");
$dispatcher->setParams([]);

$handle = $dispatcher->dispatch();

Константы

целое число EXCEPTION_NO_DI

целое число EXCEPTION_CYCLIC_ROUTING

целое число EXCEPTION_HANDLER_NOT_FOUND

целое число EXCEPTION_INVALID_HANDLER

целое число EXCEPTION_INVALID_PARAMS

целое число EXCEPTION_ACTION_NOT_FOUND

Методы

public setTaskSuffix (смешанный тип $taskSuffix)

Устанавливает стандартный суффикс задачи

public setDefaultTask (смешанный тип $taskName)

Устанавливает имя стандартной задачи

public setTaskName (смешанный тип $taskName)

Устанавливает имя задачи для диспетчеризации

public getTaskName ()

Возвращает имя последней обработанной задачи

protected _throwDispatchException (смешанный тип $message, [смешанный тип $exceptionCode])

Выбрасывает внутреннюю ошибку

protected _handleException (Exception $exception)

Обрабатывает пользовательскую ошибку

public getLastTask ()

Возвращает последний обработанный контроллер

public getActiveTask ()

Возвращает активную задачу в диспетчере

public setOptions (массив $options)

Устанавливает параметры для диспетчеризации

public getOptions ()

Получает параметры диспетчеризации

public callActionMethod (смешанный тип $handler, смешанный тип $actionMethod, [массив $params])

...

public setDI (Phalcon\DiInterface $dependencyInjector) унаследованно от Phalcon\Dispatcher

Устанавливает инжектор зависимостей

public getDI () унаследованно от Phalcon\Dispatcher

Возвращает внутренний инжектор зависимостей

public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) унаследованно от Phalcon\Dispatcher

Устанавливает менеджер событий

public getEventsManager () унаследованно от Phalcon\Dispatcher

Возвращает внутренний менеджер событий

public setActionSuffix (смешанный тип $actionSuffix) унаследованно от Phalcon\Dispatcher

Устанавливает стандартный суффикс действия

public getActionSuffix () унаследованно от Phalcon\Dispatcher

Получает стандартный суффикс действия

public setModuleName (смешанный тип $moduleName) унаследованно от Phalcon\Dispatcher

Устанавливает модуль, в котором находится контроллер (только для информации)

public getModuleName () унаследованно от Phalcon\Dispatcher

Получает модуль, в котором находится класс контроллера

public setNamespaceName (смешанный тип $namespaceName) унаследованно от Phalcon\Dispatcher

Устанавливает пространство имён, в котором находится класс контроллера

public getNamespaceName () унаследованно от Phalcon\Dispatcher

Получает пространство имён, которое должно быть добавлено к текущему имени обработчика

public setDefaultNamespace (смешанный тип $namespaceName) унаследованно от Phalcon\Dispatcher

Устанавливает стандартное пространство имён

public getDefaultNamespace () унаследованно от Phalcon\Dispatcher

Возвращает стандартное пространство имён

public setDefaultAction (смешанный тип $actionName) унаследованно от Phalcon\Dispatcher

Устанавливает стандартное имя действия

public setActionName (смешанный тип $actionName) унаследованно от Phalcon\Dispatcher

Устанавливает имя действия для диспетчеризации

public getActionName () унаследованно от Phalcon\Dispatcher

Возвращает имя последнего обработанного действия

public setParams (массив $params) унаследованно от Phalcon\Dispatcher

Устанавливает параметры действия для диспетчеризации

public getParams () унаследованно от Phalcon\Dispatcher

Получает параметры действия

public setParam (смешанный тип $param, смешанный тип $value) унаследованно от Phalcon\Dispatcher

Устанавливает параметр по имени или числовому индексу

public смешанный тип getParam (смешанный тип $param, [строка | массив $filters], [смешанный тип $defaultValue]) унаследованно от Phalcon\Dispatcher

Получает параметр по имени или числовому индексу

public булево hasParam (смешанный тип $param) унаследованно от Phalcon\Dispatcher

Проверяет наличие параметра

public getActiveMethod () унаследованно от Phalcon\Dispatcher

Возвращает текущий метод, который должен/будет выполнен в диспетчере

public isFinished () унаследованно от Phalcon\Dispatcher

Проверяет, завершён ли цикл диспетчеризации или есть ли ещё подлежащие диспетчеризации контроллеры/задачи

public setReturnedValue (смешанный тип $value) унаследованно от Phalcon\Dispatcher

Устанавливает последнее возвращённое значение действием вручную

public смешанный тип getReturnedValue () унаследованно от Phalcon\Dispatcher

Возвращает значение, возвращённое последним обработанным действием

public setModelBinding (смешанный тип $value, [смешанный тип $cache]) унаследованно от Phalcon\Dispatcher

Включить/Выключить привязку модели во время диспетчеризации

$di->set('dispatcher', function() {
    $dispatcher = new Dispatcher();

    $dispatcher->setModelBinding(true, 'cache');
    return $dispatcher;
});

public setModelBinder (Phalcon\Mvc\Model\BinderInterface $modelBinder, [смешанный тип $cache]) унаследованно от Phalcon\Dispatcher

Включить привязку модели во время диспетчеризации

$di->set('dispatcher', function() {
    $dispatcher = new Dispatcher();

    $dispatcher->setModelBinder(new Binder(), 'cache');
    return $dispatcher;
});

public getModelBinder () унаследованно от Phalcon\Dispatcher

Получить привязку модели

public объект dispatch () унаследованно от Phalcon\Dispatcher

Диспетчирует действие обработки с учётом параметров маршрутизации

protected object _dispatch () inherited from Phalcon\Dispatcher

Передает обработку действия, учитывая параметры маршрутизации

public forward (array $forward) inherited from Phalcon\Dispatcher

Перенаправляет поток выполнения на другой контроллер/действие. Диспетчеры уникальны для каждого модуля. Перенаправление между модулями запрещено

$this->dispatcher->forward(
    [
        "controller" => "posts",
        "action"     => "index",
    ]
);

public wasForwarded () inherited from Phalcon\Dispatcher

Проверяет, было ли текущее выполняемое действие перенаправлено другим

public getHandlerClass () inherited from Phalcon\Dispatcher

Возможная имя класса, который будет использован для обработки запроса

public getBoundModels () inherited from Phalcon\Dispatcher

Возвращает связанные модели из экземпляра связующего объекта

class UserController extends Controller
{
    public function showAction(User $user)
    {
        $boundModels = $this->dispatcher->getBoundModels(); // return array with $user
    }
}

protected _resolveEmptyProperties () inherited from Phalcon\Dispatcher

Устанавливает пустые свойства в значения по умолчанию (если значения по умолчанию доступны)