Spec-Zone.ru › Yii 2.0

Класс yii\gii\console\GenerateController

Все классы | Свойства | Методы | События | Константы
Наследование yii\gii\console\GenerateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Доступна с версии 2.0
Исходный код https://github.com/yiisoft/yii2-gii/blob/master/console/GenerateController.php

Это командная версия Gii — генератора кода.

Вы можете использовать эту команду для генерации моделей, контроллеров и т. д. Например, для генерации модели ActiveRecord на основе таблицы базы данных, вы можете выполнить:

$ ./yii gii/model --tableName=city --modelClass=City

Публичные свойства

Свойство Тип Описание Определено в
$action yii\base\Action Действие, которое в настоящее время выполняется. yii\base\Controller
$behaviors yii\base\Behavior[] Список поведений, присоединенных к этому компоненту yii\base\Component
$color boolean Включить ANSI цвет в выводе. yii\console\Controller
$defaultAction string Идентификатор действия, используемый, когда идентификатор действия не указан в запросе. yii\base\Controller
$generators array Список доступных генераторов кода yii\gii\console\GenerateController
$help boolean Отображать ли справку по текущей команде. yii\console\Controller
$helpSummary string yii\console\Controller
$id string Идентификатор этого контроллера. yii\base\Controller
$interactive boolean Выполнять ли команду в интерактивном режиме. yii\console\Controller
$layout null|string|false Имя макета, который будет применяться к представлениям этого контроллера. yii\base\Controller
$module yii\gii\Module yii\gii\console\GenerateController
$modules yii\base\Module[] Все родительские модули, в которых расположен этот контроллер. yii\base\Controller
$overwrite boolean Перезаписывать ли все существующие файлы кода при работе в неинтерактивном режиме. yii\gii\console\GenerateController
$passedOptionValues array Свойства, соответствующие переданным параметрам. yii\console\Controller
$passedOptions array Имена параметров, переданных во время выполнения. yii\console\Controller
$route string Маршрут (идентификатор модуля, идентификатор контроллера и идентификатор действия) текущего запроса. yii\base\Controller
$uniqueID yii\gii\console\GenerateController
$uniqueId string Идентификатор контроллера, который предваряется идентификатором модуля (если есть). yii\base\Controller
$view yii\base\View|yii\web\View Объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Controller
$viewPath string Директория, содержащая файлы представлений для этого контроллера. yii\base\Controller

Публичные методы

Метод Описание Определено в
__call() Вызывает метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() yii\base\Controller
__get() Возвращает значение свойства компонента. yii\gii\console\GenerateController
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства компонента. yii\gii\console\GenerateController
__unset() Устанавливает свойство объекта в null. yii\base\Object
actionIndex() yii\gii\console\GenerateController
actions() Объявляет внешние действия для контроллера. yii\gii\console\GenerateController
afterAction() Этот метод вызывается сразу после выполнения действия. yii\base\Controller
ansiFormat() Форматирует строку с кодами ANSI. yii\console\Controller
attachBehavior() Присоединяет поведение к этому компоненту. yii\base\Component
attachBehaviors() Присоединяет список поведений к компоненту. yii\base\Component
beforeAction() Этот метод вызывается непосредственно перед выполнением действия. yii\base\Controller
behaviors() Возвращает список поведений, по которым должен действовать этот компонент. yii\base\Component
bindActionParams() Связывает параметры с действием. yii\console\Controller
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
confirm() Запрашивает у пользователя подтверждение, введя y или n. yii\console\Controller
createAction() Создаёт действие на основе заданного идентификатора действия. yii\gii\console\GenerateController
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. yii\base\Component
findLayoutFile() Находит соответствующий файл макета. yii\base\Controller
getActionArgsHelp() Возвращает справочную информацию по анонимным аргументам действия. yii\gii\console\GenerateController
getActionHelp() Возвращает подробную справочную информацию по указанному действию. yii\gii\console\GenerateController
getActionHelpSummary() Возвращает краткое описание действия в одной строке. yii\gii\console\GenerateController
getActionOptionsHelp() Возвращает справочную информацию по опциям действия. yii\gii\console\GenerateController
getBehavior() Возвращает объект поведения с указанным именем. yii\base\Component
getBehaviors() Возвращает все поведения, присоединённые к этому компоненту. yii\base\Component
getHelp() Возвращает справочную информацию для этого контроллера. yii\console\Controller
getHelpSummary() Возвращает краткое описание контроллера в одной строке. yii\console\Controller
getModules() Возвращает все родительские модули этого контроллера. yii\base\Controller
getOptionValues() Возвращает свойства, соответствующие опциям для идентификатора действия. Дочерние классы могут переопределить этот метод, чтобы указать возможные свойства. yii\console\Controller
getPassedOptionValues() Возвращает свойства, соответствующие переданным опциям. yii\console\Controller
getPassedOptions() Возвращает имена допустимых опций, переданных во время выполнения. yii\console\Controller
getRoute() Возвращает маршрут текущего запроса. yii\base\Controller
getUniqueID() yii\gii\console\GenerateController
getUniqueId() Возвращает уникальный идентификатор контроллера. yii\base\Controller
getView() Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Controller
getViewPath() Возвращает директорию, содержащую файлы представлений для этого контроллера. yii\base\Controller
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, присоединённый к событию с указанным именем. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует объект. yii\gii\console\GenerateController
isColorEnabled() Возвращает значение, указывающее, включен ли цвет ANSI. yii\console\Controller
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Присоединяет обработчик события к событию. yii\base\Component
optionAliases() Возвращает псевдонимы параметров. yii\console\Controller
options() Возвращает имена допустимых параметров для действия (id). Параметр требует существования публичного члена переменной с именем, совпадающим с именем параметра. yii\gii\console\GenerateController
prompt() Запрашивает у пользователя ввод и проверяет его. yii\console\Controller
render() Отображает представление и применяет макет, если он доступен. yii\base\Controller
renderContent() Отображает статическую строку, применяя макет. yii\base\Controller
renderFile() Отображает файл представления. yii\base\Controller
renderPartial() Отображает представление без применения макета. yii\base\Controller
run() Выполняет запрос, указанный в маршруте. yii\base\Controller
runAction() Выполняет действие с указанным идентификатором действия и параметрами. yii\console\Controller
select() Предлагает пользователю выбор из списка. Ввод '?' покажет список доступных вариантов и их описания. yii\console\Controller
setView() Устанавливает объект представления, который будет использоваться этим контроллером. yii\base\Controller
setViewPath() Устанавливает каталог, содержащий файлы представлений. yii\base\Controller
stderr() Выводит строку в STDERR. yii\console\Controller
stdout() Выводит строку в STDOUT. yii\console\Controller
trigger() Вызывает событие. yii\base\Component

Защищенные методы

Метод Описание Определено в
formatHint() yii\gii\console\GenerateController
getActionMethodReflection() yii\console\Controller
parseDocCommentDetail() Возвращает полное описание из блока документации. yii\console\Controller
parseDocCommentSummary() Возвращает первую строку блока документации. yii\console\Controller
parseDocCommentTags() Разбирает блок комментариев на теги. yii\console\Controller

События

Событие Тип Описание Определено в
EVENT_AFTER_ACTION yii\base\ActionEvent Событие, генерируемое сразу после выполнения действия контроллера. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent Событие, генерируемое непосредственно перед выполнением действия контроллера. yii\base\Controller

Константы

Константа Значение Описание Определено в
EXIT_CODE_ERROR 1 yii\console\Controller
EXIT_CODE_NORMAL 0 yii\console\Controller

Подробное описание свойств

$generators общедоступное свойство

Список доступных генераторов кода

public array $generators = []

$module общедоступное свойство

public yii\gii\Module $module = null

$overwrite общедоступное свойство

Указывает, нужно ли перезаписывать все существующие файлы кода в неинтерактивном режиме. По умолчанию false, т.е. существующие файлы кода не будут перезаписаны. Этот параметр используется только при --interactive=0.

public boolean $overwrite = false

$uniqueID общедоступное свойство (только для чтения)

public void getUniqueID ( )

Подробное описание методов

__get() public method

Возвращает значение свойства компонента.

Этот метод будет проверять в следующем порядке и действовать соответственно:

  • свойство, определенное getter'ом: возвращает результат getter'а
  • свойство поведения: возвращает значение свойства поведения

Не вызывайте этот метод напрямую, так как это магический метод PHP, который будет неявно вызван при выполнении $value = $component->property;.

public mixed __get ( $name )
$name string

Имя свойства

return mixed

Значение свойства или значение свойства поведения

throws yii\base\UnknownPropertyException

если свойство не определено

throws yii\base\InvalidCallException

если свойство только для записи.

__set() public method

Устанавливает значение свойства компонента.

Этот метод будет проверять в следующем порядке и действовать соответственно:

  • свойство, определенное setter'ом: устанавливает значение свойства
  • событие в формате "on xyz": присоединяет обработчик к событию "xyz"
  • поведение в формате "as xyz": присоединяет поведение с именем "xyz"
  • свойство поведения: устанавливает значение свойства поведения

Не вызывайте этот метод напрямую, так как это магический метод PHP, который будет неявно вызван при выполнении $component->property = $value;.

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

Имя свойства или имя события

$value mixed

Значение свойства

throws yii\base\UnknownPropertyException

если свойство не определено

throws yii\base\InvalidCallException

если свойство только для чтения.

actionIndex() public method

public void actionIndex ( )

actions() public method

Объявляет внешние действия для контроллера.

Этот метод предназначен для переопределения, чтобы объявить внешние действия для контроллера. Он должен возвращать массив, где ключи массива — это идентификаторы действий, а значения — соответствующие имена классов действий или конфигурационные массивы действий. Например,

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

Yii::createObject() будет использоваться позже для создания запрошенного действия с помощью предоставленной здесь конфигурации.

public void actions ( )

createAction() public method

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

Метод сначала проверяет, был ли идентификатор действия объявлен в actions(). Если да, он будет использовать объявленную там конфигурацию для создания объекта действия. Если нет, он будет искать метод контроллера, имя которого имеет формат actionXyz , где Xyz обозначает идентификатор действия. Если найдено, будет создан и возвращён yii\base\InlineAction, представляющий этот метод.

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

Идентификатор действия.

return yii\base\Action|null

Новый созданный экземпляр действия. Null, если ID не разрешается в какое-либо действие.

formatHint() protected method

protected void formatHint ( $hint )
$hint

getActionArgsHelp() public method

Возвращает справочную информацию по анонимным аргументам действия.

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

  • required: boolean, является ли этот аргумент обязательным.
  • type: string, тип PHP этого аргумента.
  • default: string, значение по умолчанию этого аргумента
  • comment: string, комментарий к этому аргументу

Реализация по умолчанию вернёт справочную информацию, извлеченную из комментария к документации параметров, соответствующих методу действия.

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

Справочная информация по аргументам действия

getActionHelp() public method

Возвращает подробную справочную информацию для указанного действия.

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

Действие, для которого требуется справка

return string

Подробная справочная информация для указанного действия.

getActionHelpSummary() public method

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

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

Действие, для которого требуется краткое описание

return string

Краткое описание указанного действия в одной строке.

getActionOptionsHelp() public method

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

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

  • type: string, тип PHP этого параметра.
  • default: string, значение по умолчанию этого параметра
  • comment: string, комментарий к этому параметру

Реализация по умолчанию возвратит справочную информацию, извлеченную из комментария к документации свойств, соответствующих параметрам действия.

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

Справочная информация по параметрам действия

getUniqueID() public method

public void getUniqueID ( )

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

options() public method

Возвращает имена допустимых параметров для действия (id). Параметр требует существования публичной переменной-члена, имя которой является именем параметра.

Подклассы могут переопределить этот метод, чтобы указать возможные параметры.

Обратите внимание, что значения, заданные через параметры, недоступны до вызова beforeAction().

public string[] options ( $id )
$id
return string[]

Имена параметров, допустимых для действия

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-gii-console-generatecontroller.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API