Класс yii\gii\Module
| Наследование | yii\gii\Module » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\BootstrapInterface, yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-gii/blob/master/Module.php |
Это основной класс модуля Gii.
Чтобы использовать Gii, включите его как модуль в конфигурацию приложения, как показано ниже:
return [
'bootstrap' => ['gii'],
'modules' => [
'gii' => ['class' => 'yii\gii\Module'],
],
]
Поскольку Gii генерирует новые файлы кода на сервере, вы должны использовать его только на собственном компьютере для разработки. Чтобы предотвратить доступ к этому модулю другим пользователям, по умолчанию Gii доступен только по адресу localhost. Вы можете настроить свойство $allowedIPs, если хотите сделать его доступным на других машинах.
С помощью вышеуказанной конфигурации вы сможете получить доступ к GiiModule в браузере, используя URL http://localhost/path/to/index.php?r=gii
Если в вашем приложении включены красивые URL-адреса, вы можете получить доступ к Gii через URL: http://localhost/path/to/index.php/gii
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $aliases | массив | Список псевдонимов путей для определения. | yii\base\Module |
| $allowedIPs | массив | Список IP-адресов, разрешённых для доступа к этому модулю. | yii\gii\Module |
| $basePath | строка | Корневая директория модуля. | yii\base\Module |
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к этому компоненту. | yii\base\Component |
| $components | массив | Список определений компонентов или загруженных экземпляров компонентов (ID => определение или экземпляр). | yii\di\ServiceLocator |
| $controllerMap | массив | Сопоставление идентификатора контроллера с конфигурациями контроллера. | yii\base\Module |
| $controllerNamespace | строка | Пространство имён, в котором находятся классы контроллеров. | yii\gii\Module |
| $controllerPath | строка | Директория, содержащая классы контроллеров. | yii\base\Module |
| $defaultRoute | строка | По умолчанию маршрут этого модуля. | yii\base\Module |
| $generators | массив|yii\gii\Generator[] | Список конфигураций генераторов или экземпляров. | yii\gii\Module |
| $id | строка | Идентификатор, уникально определяющий этот модуль среди других модулей, имеющих того же родителя. | yii\base\Module |
| $layout | строка|логическое значение | Макет, который должен быть применён для представлений в рамках этого модуля. | yii\base\Module |
| $layoutPath | строка | Корневая директория файлов макета. | yii\base\Module |
| $module | yii\base\Module | Родительский модуль этого модуля. | yii\base\Module |
| $modules | массив | Модули (индексированные по их идентификаторам). | yii\base\Module |
| $newDirMode | целое число | Права доступа для вновь созданных директорий. | yii\gii\Module |
| $newFileMode | целое число | Права доступа для вновь созданных файлов кода. | yii\gii\Module |
| $params | массив | Пользовательские параметры модуля (имя => значение). | yii\base\Module |
| $uniqueId | строка | Уникальный идентификатор модуля. | yii\base\Module |
| $version | строка | Версия этого модуля. | yii\base\Module |
| $viewPath | строка | Корневая директория файлов представлений. | yii\base\Module |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Component |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Module |
| __get() | Возвращает значение свойства компонента. | yii\base\Component |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Component |
| __set() | Устанавливает значение свойства компонента. | yii\base\Component |
| __unset() | Устанавливает свойство компонента в значение null. | yii\base\Component |
| afterAction() | Этот метод вызывается сразу после выполнения действия в рамках данного модуля. | yii\base\Module |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeAction() | Этот метод вызывается сразу перед выполнением действия в рамках данного модуля. | yii\gii\Module |
| behaviors() | Возвращает список поведений, по которым должен действовать этот компонент. | yii\base\Component |
| bootstrap() | Метод инициализации, вызываемый во время загрузки приложения. | yii\gii\Module |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Component |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Component |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| clear() | Удаляет компонент из локатора. | yii\di\ServiceLocator |
| createController() | Создаёт экземпляр контроллера на основе заданного маршрута. | yii\base\Module |
| createControllerByID() | Создаёт контроллер на основе заданного идентификатора контроллера. | yii\base\Module |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| get() | Возвращает экземпляр компонента с указанным идентификатором. | yii\di\ServiceLocator |
| getBasePath() | Возвращает корневую директорию модуля. | yii\base\Module |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединённые к этому компоненту поведения. | yii\base\Component |
| getComponents() | Возвращает список определений компонентов или загруженных экземпляров компонентов. | yii\di\ServiceLocator |
| getControllerPath() | Возвращает директорию, содержащую классы контроллеров в соответствии с $controllerNamespace. | yii\base\Module |
| getInstance() | Возвращает текущий запрашиваемый экземпляр этого класса модуля. | yii\base\Module |
| getLayoutPath() | Возвращает директорию, содержащую файлы шаблонов макета для этого модуля. | yii\base\Module |
| getModule() | Извлекает дочерний модуль с указанным идентификатором. | yii\base\Module |
| getModules() | Возвращает дочерние модули в этом модуле. | yii\base\Module |
| getUniqueId() | Возвращает идентификатор, уникально определяющий данный модуль среди всех модулей в текущем приложении. | yii\base\Module |
| getVersion() | Возвращает текущую версию модуля. | yii\base\Module |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого модуля. | yii\base\Module |
| has() | Возвращает значение, указывающее, имеет ли локатор указанное определение компонента или инициализировал компонент. | yii\di\ServiceLocator |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики, присоединенные к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Component |
| hasModule() | Проверяет, существует ли дочерний модуль с указанным идентификатором. | yii\base\Module |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство для этого компонента. | yii\base\Component |
| init() | Инициализирует модуль. | yii\base\Module |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| runAction() | Выполняет действие контроллера, заданное маршрутом. | yii\base\Module |
| set() | Регистрирует определение компонента в этом локаторе. | yii\di\ServiceLocator |
| setAliases() | Определяет псевдонимы путей. | yii\base\Module |
| setBasePath() | Устанавливает корневую директорию модуля. | yii\base\Module |
| setComponents() | Регистрирует набор определений компонентов в этом локаторе. | yii\di\ServiceLocator |
| setInstance() | Устанавливает текущий запрашиваемый экземпляр этого класса модуля. | yii\base\Module |
| setLayoutPath() | Устанавливает директорию, содержащую файлы макетов. | yii\base\Module |
| setModule() | Добавляет дочерний модуль к этому модулю. | yii\base\Module |
| setModules() | Регистрирует подмодули в текущем модуле. | yii\base\Module |
| setVersion() | Устанавливает текущую версию модуля. | yii\base\Module |
| setViewPath() | Устанавливает директорию, содержащую файлы представлений. | yii\base\Module |
| trigger() | Вызывает событие. | yii\base\Component |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| checkAccess() | yii\gii\Module | |
| coreGenerators() | Возвращает список конфигураций генераторов ядра. | yii\gii\Module |
| defaultVersion() | Возвращает версию модуля по умолчанию. | yii\gii\Module |
| resetGlobalSettings() | Сбрасывает потенциально несовместимые глобальные настройки, выполненные в конфигурации приложения. | yii\gii\Module |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | Событие, срабатывающее после выполнения действия контроллера. | yii\base\Module |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | Событие, срабатывающее перед выполнением действия контроллера. | yii\base\Module |
Подробное описание свойств
$allowedIPs общедоступное свойство
Список IP-адресов, разрешенных для доступа к этому модулю. Каждый элемент массива представляет отдельный фильтр IP-адресов, который может быть либо IP-адресом, либо адресом с подстановкой (например, 192.168.0.*) для представления сетевого сегмента. Значение по умолчанию — ['127.0.0.1', '::1'], что означает, что доступ к модулю разрешен только с localhost.
public array $allowedIPs = ['127.0.0.1', '::1']
$controllerNamespace общедоступное свойство
Пространство имен, в котором находятся классы контроллеров. Это пространство имен будет использоваться для загрузки классов контроллеров путём добавления его в качестве префикса к имени класса контроллера.
Если не задано, оно будет использовать controllers подпространство в пространстве имен этого модуля. Например, если пространство имен этого модуля — foo\bar, то пространство имен контроллеров по умолчанию будет foo\bar\controllers.
См. также раздел руководства по автоматической загрузке, чтобы узнать больше о определении пространств имен и о том, как загружаются классы.
public string $controllerNamespace = 'yii\gii\controllers'
$generators общедоступное свойство
Список конфигураций или экземпляров генераторов. Ключи массива — идентификаторы генераторов (например, "crud"), а элементы массива — соответствующие конфигурации генераторов или экземпляры.
После инициализации модуля это свойство станет массивом экземпляров генераторов, созданных на основе ранее заданных конфигураций.
Новое назначение генераторов будет объединено с базовыми, и новые генераторы будут иметь приоритет при совпадении идентификатора генератора.
public array|yii\gii\Generator[] $generators = []
$newDirMode общедоступное свойство
Разрешения, которые будут установлены для вновь созданных каталогов. Это значение будет использоваться функцией PHP chmod. По умолчанию 0777, что означает, что каталог может быть прочитан, изменён и выполнен всеми пользователями.
public integer $newDirMode = 0777
$newFileMode общедоступное свойство
Разрешения, которые будут установлены для вновь созданных файлов кода. Это значение будет использоваться функцией PHP chmod. По умолчанию 0666, что означает, что файл может быть прочитан и изменён всеми пользователями.
public integer $newFileMode = 0666
Подробное описание методов
beforeAction() общедоступный метод
Этот метод вызывается непосредственно перед выполнением действия в рамках данного модуля.
Метод вызовет событие 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
}
| public boolean beforeAction ( $action ) | ||
|---|---|---|
| $action | yii\base\Action |
Действие, подлежащее выполнению. |
| return | boolean |
Должно ли действие продолжить выполнение. |
bootstrap() общедоступный метод
Метод начальной загрузки, который вызывается во время начального этапа приложения.
| public void bootstrap ( $app ) | ||
|---|---|---|
| $app | yii\base\Application |
Текущее приложение |
checkAccess() защищенный метод
| protected integer checkAccess ( ) | ||
|---|---|---|
| return | integer |
Разрешено ли доступ к модулю текущему пользователю |
coreGenerators() защищенный метод
Возвращает список конфигураций генераторов ядра.
| protected array coreGenerators ( ) | ||
|---|---|---|
| return | array |
Список конфигураций генераторов ядра. |
defaultVersion() защищенный метод (доступен начиная с версии 2.0.6)
Возвращает версию модуля по умолчанию.
Дочерний класс может переопределить этот метод, чтобы обеспечить более точное определение версии.
| protected string defaultVersion ( ) | ||
|---|---|---|
| return | string |
Версия данного модуля. |
resetGlobalSettings() защищенный метод
Сбрасывает потенциально несовместимые глобальные настройки, выполненные в конфигурации приложения.
| protected void resetGlobalSettings ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-gii-module.html