Класс yii\console\Controller

ansiFormat() public method

Форматирует строку с кодами ANSI

Вы можете передать дополнительные параметры, используя константы, определённые в yii\helpers\Console.

Пример:

echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

bindActionParams() public method

Связывает параметры с действием.

Этот метод вызывается классом yii\base\Action при его запуске с заданными параметрами. Сначала метод связывает параметры с доступными опциями для действия. Затем он проверяет переданные аргументы.

confirm() public method

Запрашивает подтверждение у пользователя, введя y или n.

Типичное использование выглядит следующим образом:

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}

getActionArgsHelp() public method

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

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

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

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

getActionHelp() public method

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

getActionHelpSummary() public method

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

getActionMethodReflection() protected method

getActionOptionsHelp() public method

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

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

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

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

getHelp() public method

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

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

getHelpSummary() public method

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

Вы можете переопределить этот метод, чтобы вернуть настраиваемое краткое описание. Реализация по умолчанию возвращает первую строку из PHPDoc комментария.

getOptionValues() public method

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

getPassedOptionValues() public method

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

getPassedOptions() public method

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

isColorEnabled() public method

Возвращает значение, указывающее, включен ли цвет ANSI.

Цвет ANSI включён только если $color установлено в true или не установлено, и терминал поддерживает цвет ANSI.

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

Возвращает псевдонимы опций.

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

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

options() общедоступный метод

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

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

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

parseDocCommentDetail() защищённый метод

Возвращает полное описание из блока документации.

parseDocCommentSummary() защищённый метод

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

parseDocCommentTags() защищённый метод

Парсит блок комментариев на теги.

prompt() общедоступный метод

Запрашивает у пользователя ввод и проверяет его

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);

runAction() общедоступный метод

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

Если идентификатор действия пустой, метод будет использовать $defaultAction.

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

select() общедоступный метод

Даёт пользователю возможность выбора из предложенных вариантов. Ввод '?' отобразит список доступных опций и их описаний.

stderr() общедоступный метод

Выводит строку в STDERR

Вы можете дополнительно форматировать строку с помощью ANSI-кодов, передав дополнительные параметры, используя константы, определенные в yii\helpers\Console.

Пример:

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

stdout() общедоступный метод

Выводит строку в STDOUT

Вы можете дополнительно форматировать строку с помощью ANSI-кодов, передав дополнительные параметры, используя константы, определенные в yii\helpers\Console.

Пример:

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);