Класс yii\base\Module

__construct() public method

Конструктор.

afterAction() public method

Этот метод вызывается сразу после выполнения действия в рамках этого модуля.

Метод вызовет событие EVENT_AFTER_ACTION. Значение возвращаемого методом результата будет использовано в качестве результата действия.

Если вы переопределяете этот метод, ваш код должен выглядеть следующим образом:

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

beforeAction() public method

Этот метод вызывается непосредственно перед выполнением действия в рамках этого модуля.

Метод вызовет событие EVENT_BEFORE_ACTION. Значение возвращаемого методом результата определит, должно ли действие продолжать выполняться.

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

Если вы переопределяете этот метод, ваш код должен выглядеть следующим образом:

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

    // your custom code here

    return true; // or false to not run the action
}

createController() public method

Создаёт экземпляр контроллера на основе заданного маршрута.

Маршрут должен быть относительным к этому модулю. Метод реализует следующий алгоритм для разрешения заданного маршрута:

1. Если маршрут пуст, используйте $defaultRoute;
2. Если первый сегмент маршрута является допустимым идентификатором модуля, как указано в $modules, вызовите метод createController() с оставшейся частью маршрута;
3. Если первый сегмент маршрута найден в $controllerMap, создайте контроллер на основе соответствующей конфигурации, найденной в $controllerMap;
4. Заданный маршрут имеет формат abc/def/xyz. Попробуйте класс abc\DefController или abc\def\XyzController в пространстве имён контроллера $controllerNamespace.

Если любой из вышеперечисленных шагов приводит к созданию контроллера, он возвращается вместе с оставшейся частью маршрута, которая будет обрабатываться как идентификатор действия. В противном случае возвращается false.

createControllerByID() public method

Создаёт контроллер на основе заданного идентификатора контроллера.

Идентификатор контроллера относительный к этому модулю. Класс контроллера должен быть в пространстве имён $controllerNamespace.

Обратите внимание, что этот метод не проверяет $modules или $controllerMap.

defaultVersion() protected method (available since version 2.0.11)

Возвращает версию по умолчанию для модуля.

Дочерний класс может переопределить этот метод, чтобы предоставить более точное определение версии.

getBasePath() public method

Возвращает корневой каталог модуля.

По умолчанию это каталог, содержащий файл класса модуля.

getControllerPath() public method

Возвращает каталог, содержащий классы контроллеров согласно $controllerNamespace.

Обратите внимание, что для того, чтобы этот метод возвращал значение, вы должны определить псевдоним для корневого пространства имён $controllerNamespace.

getInstance() public static method

Возвращает текущий запрошенный экземпляр этого класса модуля.

Если класс модуля не запрошен, возвращается null. Этот метод предоставляется для доступа к экземпляру модуля из любой точки внутри модуля.

getLayoutPath() public method

Возвращает каталог, содержащий файлы представления макета для этого модуля.

getModule() public method

Извлекает дочерний модуль с указанным идентификатором.

Этот метод поддерживает извлечение как дочерних, так и внучатых модулей.

См. также hasModule().

getModules() public method

Возвращает дочерние модули в этом модуле.

getUniqueId() public method

Возвращает идентификатор, который однозначно идентифицирует этот модуль среди всех модулей в текущем приложении.

Обратите внимание, что если модуль является приложением, будет возвращена пустая строка.

getVersion() public method (доступно начиная с версии 2.0.11)

Возвращает текущую версию модуля.

Если версия не установлена явно, будет использоваться метод defaultVersion() для определения ее значения.

getViewPath() public method

Возвращает директорию, содержащую файлы представления для этого модуля.

hasModule() public method

Проверяет, существует ли дочерний модуль с указанным ID.

Этот метод поддерживает проверку существования дочерних и внуков модулей.

init() public method

Инициализирует модуль.

Этот метод вызывается после создания и инициализации модуля со значениями свойств, указанных в конфигурации. Стандартная реализация инициализирует $controllerNamespace, если он не задан.

Если вы переопределяете этот метод, убедитесь, что вызываете родительскую реализацию.

runAction() public method

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

Этот метод анализирует указанный путь и создает соответствующие дочерние модули, контроллер и экземпляры действий. Затем он вызывает yii\base\Controller::runAction() для выполнения действия с заданными параметрами. Если путь пустой, метод будет использовать $defaultRoute.

setAliases() public method

Определяет псевдонимы путей.

Этот метод вызывает Yii::setAlias() для регистрации псевдонимов путей. Этот метод предоставлен для того, чтобы вы могли определить псевдонимы путей при настройке модуля.

[
    '@models' => '@app/models', // an existing alias
    '@backend' => __DIR__ . '/../backend',  // a directory
]

setBasePath() public method

Устанавливает корневой каталог модуля.

Этот метод может быть вызван только в начале конструктора.

setInstance() public static method

Устанавливает текущий запрашиваемый экземпляр этого класса модуля.

setLayoutPath() public method

Устанавливает каталог, содержащий файлы макета.

setModule() public method

Добавляет дочерний модуль в этот модуль.

setModules() public method

Регистрирует дочерние модули в текущем модуле.

Каждый дочерний модуль должен быть указан как имя-значение, где имя относится к идентификатору модуля, а значение — к модулю или конфигурационному массиву, который можно использовать для создания модуля. В последнем случае будет использоваться Yii::createObject() для создания модуля.

Если новый дочерний модуль имеет тот же ID, что и существующий, существующий будет перезаписан без каких-либо сообщений.

Следующий пример регистрирует два дочерних модуля:

[
    'comment' => [
        'class' => 'app\modules\comment\CommentModule',
        'db' => 'db',
    ],
    'booking' => ['class' => 'app\modules\booking\BookingModule'],
]

setVersion() public method (доступно начиная с версии 2.0.11)

Устанавливает текущую версию модуля.

function (Module $module) {
    //return string
}

setViewPath() public method

Устанавливает директорию, содержащую файлы представлений.