Класс Shell

Базовый класс для утилит командной строки для автоматизации задач программиста.

Эквивалент Cake\Controller\Controller в командной строке.

Cake\Console\Shell использует Cake\ORM\Locator\LocatorAwareTrait , Cake\Log\LogTrait , Cake\Utility\MergeVariablesTrait , Cake\Datasource\ModelAwareTrait

Непосредственные подклассы

Косвенные подклассы

Cake\Shell\OrmCacheShell

Пространство имён: Cake\Console
Расположение: Console/Shell.php

Резюме констант

integer

CODE_ERROR

1
integer

CODE_SUCCESS

0
integer

NORMAL

ConsoleIo::NORMAL
integer

QUIET

ConsoleIo::QUIET
integer

VERBOSE

ConsoleIo::VERBOSE

Резюме свойств

$OptionParser public

Cake\Console\ConsoleOptionParser
Экземпляр ConsoleOptionParser, настроенный для этого класса.
$Tasks public

Cake\Console\TaskRegistry
Коллекция задач для команды, используется для создания задач.
$_io protected

Cake\Console\ConsoleIo
Экземпляр ConsoleIo.
$_taskMap protected

array
Нормализованный массив задач.
$args public

array
Содержит аргументы, прочитанные из командной строки.
$command public

string
Команда (метод/задача), которая выполняется.
$interactive public

boolean
Если true, сценарий запросит разрешение на выполнение действий.
$name public

string
Имя оболочки в формате camelized.
$params public

array
Содержит переключатели команд, прочитанные из командной строки.
$plugin public

string

Имя плагина, к которому принадлежит оболочка. Автоматически устанавливается ShellDispatcher при создании оболочки.
$rootName protected

string
Корневое имя команды, используемое при генерации вывода справки.
$taskNames public

array
Содержит загруженные задачи.
$tasks public

array|boolean
Содержит задачи для загрузки и создания экземпляров.

Унаследованные свойства

_tableLocator _modelFactories, _modelType, modelClass

Резюме методов

__construct() public
Создаёт экземпляр этого объекта Shell.
__debugInfo() public

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
__get() public
Перегрузка get для ленивого создания задач
_displayHelp() protected
Отображает справку в правильном формате
_setOutputLevel() protected
Устанавливает уровень вывода на основе параметров.
_stop() protected

Останавливает выполнение текущего скрипта. Вызывает исключение StopException для попытки остановки выполнения.
_validateTasks() protected
Проверяет, что задачи в карте задач действительно доступны
_welcome() protected
Отображает заголовок для оболочки
abort() public

Отображает отформатированное сообщение об ошибке и завершает приложение с кодом состояния 1
clear() public
Очистить консоль
createFile() public
Создаёт файл по заданному пути
dispatchShell() public

Передача команды другому Shell. Аналогично Object::requestAction(), но предназначено для запуска оболочек из других оболочек.
err() public

Выводит одно или несколько сообщений об ошибках в stderr. Если параметров нет, выводит только новую строку.
error() public deprecated

Отображает отформатированное сообщение об ошибке и завершает приложение с кодом состояния 1
getIo() public
Получить объект io для этой оболочки.
getOptionParser() public
Получает экземпляр анализатора параметров и настраивает его.
hasMethod() public
Проверка наличия вызываемого метода по заданному имени в этой оболочке.
hasTask() public
Проверка наличия задачи с указанным именем в этой оболочке.
helper() public
Отобразить помощник консоли
hr() public
Выводит серию символов минус в стандартный вывод, используется в качестве визуального разделителя.
in() public
Запрашивает у пользователя ввод и возвращает его.
info() public
Удобный метод для out(), который оборачивает сообщение между тегами
initialize() public

Инициализирует оболочку, выступает как конструктор для подклассов, позволяет настроить задачи до выполнения оболочки.
io() public deprecated
Получить/установить объект io для этой оболочки.
loadTasks() public
Загружает задачи, определённые в public $tasks
nl() public
Возвращает последовательности из одной или нескольких символов новой строки.
out() public

Выводит одно или несколько сообщений в стандартный вывод. Если параметров нет, выводит только новую строку.
param() public
Безопасный доступ к значениям в $this->params.
parseDispatchArguments() public
Разбирает аргументы для метода dispatchShell().
quiet() public
Вывод на всех уровнях.
runCommand() public
Запускает оболочку с предоставленным argv.
setIo() public
Установить объект io для этой оболочки.
setRootName() public
Устанавливает имя корневой команды для вывода справки.
shortPath() public
Делает абсолютный путь к файлу более читаемым
startup() public

Запускает оболочку и отображает приветственное сообщение. Позволяет проверять и настраивать перед выполнением команды или основного выполнения.
success() public
Удобный метод для out(), который оборачивает сообщение между тегами
verbose() public
Вывод на уровне verbose.
warn() public
Удобный метод для err(), который оборачивает сообщение между тегами
wrapMessageWithType() protected deprecated
Оборачивает сообщение с указанным типом сообщения, например:
wrapText() public

Оборачивает блок текста. Позволяет задать ширину и отступы в блоке текста.

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

__construct()source public

__construct( Cake\Console\ConsoleIo $io = null , Cake\ORM\Locator\LocatorInterface $locator = null )

Создаёт экземпляр этого объекта Shell.

Параметры

Cake\Console\ConsoleIo $io необязательно null: Экземпляр io.
Cake\ORM\Locator\LocatorInterface $locator необязательно null: Экземпляр распознавателя таблиц.

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

Перегрузка get для ленивого создания задач

Параметры

строка $name: Задача для получения.

Возвращает

Cake\Console\Shell
Объект задачи

_displayHelp()source protected

_displayHelp( string $command )

Отображает справку в правильном формате

Параметры

строка $command: Команда, для которой нужно получить справку.

Возвращает

целое число/логическое значение
Количество байтов, возвращённых из записи в стандартный вывод.

_setOutputLevel()source protected

_setOutputLevel( )

Устанавливает уровень вывода на основе параметров.

Это перенастраивает как уровень вывода для out(), так и настроенный вывод журнала stdout/stderr

_stop()source protected

_stop( integer|string $status = self::CODE_SUCCESS )

Останавливает выполнение текущего скрипта. Вызывает исключение StopException для попытки остановки выполнения.

Параметры

целое число/строка $status необязательно self::CODE_SUCCESS: см. https://secure.php.net/exit для значений

Исключения

Cake\Console\Exception\StopException

_validateTasks()source protected

_validateTasks( )

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

Исключения

RuntimeException

END_OF_DOCUMENT_MARKER

_welcome()source protected

_welcome( )

Отображает заголовок оболочки.

abort()source public

abort( string $message , integer $exitCode = self::CODE_ERROR )

Отображает отформатированное сообщение об ошибке и завершает приложение со статусом 1.

Параметры

строка $message: Сообщение об ошибке
целое число $exitCode необязательно self::CODE_ERROR: Код завершения задачи оболочки.

Исключения

Cake\Console\Exception\StopException

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#styling-output

clear()source public

clear( )

Очистить консоль

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#console-output

createFile()source public

createFile( string $path , string $contents )

Создаёт файл по заданному пути.

Параметры

строка $path: Местоположение файла.
строка $contents: Содержание файла.

Возвращает

boolean
Успех

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#creating-files

dispatchShell()source public

dispatchShell( )

Отправляет команду в другую оболочку. Похоже на Object::requestAction(), но предназначено для запуска оболочек из других оболочек.

Использование:

С командной строкой:

return $this->dispatchShell('schema create DbAcl');

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

С массивом команд:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

С массивом, содержащим две пары ключ/значение: - command может принимать строку или массив. Представляет команду для запуска - extra может принимать массив дополнительных параметров, передаваемых в диспетчер. Эти параметры будут доступны в свойстве param вызываемой Shell

return $this->dispatchShell([ 'command' => 'schema create DbAcl', 'extra' => ['param' => 'value'] ]);

или

return $this->dispatchShell([ 'command' => ['schema', 'create', 'DbAcl'], 'extra' => ['param' => 'value'] ]);

Возвращает

целое число
Код завершения команды cli. 0 — успех.

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#invoking-other-shells-from-your-shell

err()source public

err( string|array|null $message = null , integer $newlines = 1 )

Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не переданы, выводит только новую строку.

Параметры

строка|массив|null $message необязательно null: Строка или массив строк для вывода
целое число $newlines необязательно 1: Количество новых строк для добавления

Возвращает

целое число|boolean
Количество байтов, возвращённых из записи в stderr.

error()source public deprecated

error( string $title , string|null $message = null , integer $exitCode = self::CODE_ERROR )

Отображает отформатированное сообщение об ошибке и завершает приложение со статусом 1

Устаревшее

3.2.0 Используйте Shell::abort() вместо этого.

Параметры

строка $title: Заголовок ошибки
строка|null $message необязательно null: Необязательное сообщение об ошибке
целое число $exitCode необязательно self::CODE_ERROR: Код завершения задачи оболочки.

Возвращает

целое число
Код ошибки

Исключения

Cake\Console\Exception\StopException

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#styling-output

getIo()source public

getIo( )

Получить объект io для этой оболочки.

Возвращает

Cake\Console\ConsoleIo
Текущий объект ConsoleIo.

getOptionParser()source public

getOptionParser( )

Получает экземпляр анализатора параметров и настраивает его.

Переопределяя этот метод, вы можете настроить ConsoleOptionParser перед его возвращением.

Возвращает

Cake\Console\ConsoleOptionParser

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#configuring-options-and-generating-help

hasMethod()source public

hasMethod( string $name )

Проверка наличия вызываемого метода с заданным именем в этой оболочке.

Параметры

строка $name: Имя метода для проверки.

Возвращает

boolean

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#shell-tasks

hasTask()source public

hasTask( string $task )

Проверка наличия задачи с заданным именем в этой оболочке.

Параметры

строка $task: Имя задачи для проверки.

Возвращает

boolean
Успех

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#shell-tasks

helper()source public

helper( string $name , array $settings = [] )

Отобразить помощник Console

Создать и отобразить вывод для объекта помощника. Если объект помощника ещё не загружен, он будет загружен и создан.

Параметры

строка $name: Имя помощника для отображения
массив $settings необязательно []: Данные конфигурации для помощника.

Возвращает

Cake\Console\Helper
Созданный экземпляр помощника.

hr()source public

hr( integer $newlines = 0 , integer $width = 63 )

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

Параметры

целое число $newlines необязательно 0: Количество новых строк для добавления перед и после
целое число $width необязательно 63: Ширина строки, по умолчанию 63

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::hr

in()source public

in( string $prompt , string|array|null $options = null , string|null $default = null )

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

Параметры

строка $prompt: Текст запроса.
строка|массив|null $options необязательно null: Массив или строка вариантов.
строка|null $default необязательно null: Значение ввода по умолчанию.

Возвращает

смешанный тип
Значение по умолчанию или введенное пользователем значение.

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::in

END_OF_DOCUMENT_MARKER

info()source public

info( string|array|null $message = null , integer $newlines = 1 , integer $level = Shell::NORMAL )

Удобный метод для out(), который оборачивает сообщение тегом

Параметры

string|array|null $message необязательный null: Строка или массив строк для вывода
integer $newlines необязательный 1: Количество символов новой строки для добавления
integer $level необязательный Shell::NORMAL: Уровень вывода сообщения, см. выше.

Возвращает

integer|boolean
Количество байтов, возвращенных при записи в стандартный вывод.

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::out

initialize()source public

initialize( )

Инициализирует оболочку, действует как конструктор для подклассов, позволяет настроить задачи до выполнения оболочки

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Cake\Console\ConsoleOptionParser::initialize

io()source public устаревший

io( Cake\Console\ConsoleIo $io = null )

Получение/установка объекта io для этой оболочки.

Устаревший

3.5.0 Используйте getIo()/setIo() вместо этого.

Параметры

Cake\Console\ConsoleIo $io необязательный null: Объект ConsoleIo для использования.

Возвращает

Cake\Console\ConsoleIo
Текущий объект ConsoleIo.

loadTasks()source public

loadTasks( )

Загружает задачи, определенные в public $tasks

Возвращает

boolean

nl()source public

nl( integer $multiplier = 1 )

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

Параметры

integer $multiplier необязательный 1: Количество повторений последовательности новой строки

Возвращает

string

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::nl

out()source public

out( string|array|null $message = null , integer $newlines = 1 , integer $level = Shell::NORMAL )

Выводит одно или несколько сообщений в стандартный вывод. Если параметры не переданы, выводит только новую строку.

Уровни вывода

Существует 3 встроенных уровня вывода. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. Уровни вывода verbose и quiet соответствуют параметрам вывода verbose и quiet в большинстве оболочек. Использование Shell::QUIET для сообщения означает, что оно всегда будет отображаться. В то время как использование Shell::VERBOSE означает, что оно будет отображаться только при включенном подробном выводе.

Параметры

string|array|null $message необязательный null: Строка или массив строк для вывода
integer $newlines необязательный 1: Количество символов новой строки для добавления
integer $level необязательный Shell::NORMAL: Уровень вывода сообщения, см. выше.

Возвращает

integer|boolean
Количество байтов, возвращенных при записи в стандартный вывод.

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::out

param()source public

param( string $name )

Безопасный доступ к значениям в $this->params.

Параметры

string $name: Имя параметра для получения.

Возвращает

string|boolean|null
Значение. Вернет null, если он не существует.

parseDispatchArguments()source public

parseDispatchArguments( array $args )

Разбирает аргументы для метода dispatchShell().

Параметры

array $args: Аргументы, полученные от метода dispatchShell() с помощью func_get_args()

Возвращает

array

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

quiet()source public

quiet( string|array $message , integer $newlines = 1 )

Вывод на всех уровнях.

Параметры

string|array $message: Строка или массив строк для вывода
integer $newlines необязательный 1: Количество символов новой строки для добавления

Возвращает

integer|boolean
Количество байтов, возвращенных при записи в стандартный вывод.

runCommand()source public

runCommand( array $argv , boolean $autoMethod = false , array $extra = [] )

Выполняет оболочку с предоставленным argv.

Делегирует вызовы задачам и разрешает методы внутри класса. Команды ищутся в следующем порядке:

Метод в оболочке.
Соответствующее имя задачи.
main() метод.

Если оболочка реализует метод main(), все отсутствующие вызовы методов будут отправлены в main() с оригинальным именем метода в argv.

Для вызова задач они должны быть представлены в виде подкоманд. Если вы определяете подкоманды, вы должны определить все подкоманды, необходимые вашей оболочке, независимо от того, являются ли они методами этого класса или методами задач.

Параметры

array $argv: Массив аргументов для запуска оболочки. В этом массиве должно отсутствовать имя оболочки.
boolean $autoMethod необязательный false: Установите в значение true, чтобы позволить вызывать любой публичный метод, даже если он не был определен как подкоманда. Это используется ShellDispatcher для упрощения создания простых оболочек.
array $extra необязательный []: Дополнительные параметры, которые вы можете вручную передать в оболочку для обработки. Встроенный дополнительный параметр - : - requested : если используется, предотвратит отображение приветственного сообщения оболочки

Возвращает

integer|boolean|null

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#the-cakephp-console

setIo()source public

setIo( Cake\Console\ConsoleIo $io )

Установить объект io для этой оболочки.

Параметры

Cake\Console\ConsoleIo $io: Объект ConsoleIo для использования.

setRootName()source public

setRootName( string $name )

Установить имя корневой команды для вывода справки.

Параметры

string $name: Имя корневой команды.

Возвращает

$this

shortPath()source public

shortPath( string $file )

Делает абсолютный путь к файлу более читабельным

Параметры

string $file: Абсолютный путь к файлу

Возвращает

string
сокращенный путь

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::shortPath

startup()source public

startup( )

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

Переопределите этот метод, если хотите удалить приветственную информацию или изменить поток до команды.

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Cake\Console\ConsoleOptionParser::startup

END_OF_DOCUMENT_MARKER

success()source public

success( string|array|null $message = null , integer $newlines = 1 , integer $level = Shell::NORMAL )

Удобный метод для out(), который оборачивает сообщение тегом

Параметры

строка|массив|null $message необязательно null: Строка или массив строк для вывода
целое число $newlines необязательно 1: Количество добавляемых символов новой строки
целое число $level необязательно Shell::NORMAL: Уровень вывода сообщения, см. выше.

Возвращаемое значение

целое число|логическое значение
Количество байтов, возвращённых из stdout.

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::out

verbose()source public

verbose( string|array $message , integer $newlines = 1 )

Вывод на уровне подробностей.

Параметры

строка|массив $message: Строка или массив строк для вывода
целое число $newlines необязательно 1: Количество добавляемых символов новой строки

Возвращаемое значение

целое число|логическое значение
Количество байтов, возвращённых из stdout.

warn()source public

warn( string|array|null $message = null , integer $newlines = 1 )

Удобный метод для err(), который оборачивает сообщение тегом

Параметры

строка|массив|null $message необязательно null: Строка или массив строк для вывода
целое число $newlines необязательно 1: Количество добавляемых символов новой строки

Возвращаемое значение

целое число|логическое значение
Количество байтов, возвращённых из stderr.

См. также

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::err

wrapMessageWithType()source protected deprecated

wrapMessageWithType( string $messageType , string|array $message )

Оборачивает сообщение с указанным типом сообщения, например,

Устарело

3.6.0 Будет удалено в версии 4.0.0, так как больше не используется.

Параметры

строка $messageType: Тип сообщения, например, "предупреждение".
строка|массив $message: Сообщение для обертывания.

Возвращаемое значение

массив|строка
Сообщение, обернутое указанным типом сообщения.

wrapText()source public

wrapText( string $text , integer|array $options = [] )

Оборачивает блок текста. Позволяет задать ширину и отступы для блока текста.

Параметры

width Ширина обрезания. По умолчанию 72
wordWrap Оборачивать только на границах слов (пробелы). По умолчанию true.
indent Отступ текста с помощью указанной строки. По умолчанию null.

Параметры

строка $text: Текст для форматирования.
целое число|массив $options необязательно []: Массив параметров или целое число для обрезания текста.

Возвращаемое значение

строка
Оборачиваемый/отступленный текст

См. также

\Cake\Utility\Text::wrap()

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::wrapText

Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait

getTableLocator()source public

getTableLocator( )

Получение локатора таблиц.

Возвращаемое значение

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Установка локатора таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращаемое значение

$this

tableLocator()source public deprecated

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Установка локатора таблиц. Если параметры не переданы, возвращает текущий используемый локатор.

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null: Экземпляр LocatorInterface.

Возвращаемое значение

Cake\ORM\Locator\LocatorInterface

Методы, используемые из Cake\Log\LogTrait

log()source public

log( mixed $msg , integer|string $level = LogLevel::ERROR , string|array $context = [] )

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

смешанный $msg: Сообщение журнала.
целое число|строка $level необязательно LogLevel::ERROR: Уровень ошибки.
строка|массив $context необязательно []: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращаемое значение

логическое значение
Успешность записи в журнал.

Методы, используемые из Cake\Utility\MergeVariablesTrait

_mergeProperty()source protected

_mergeProperty( string $property , array $parentClasses , array $options )

Объединение одного свойства со значениями, объявленными во всех родительских классах.

Параметры

строка $property: Имя объединяемого свойства.
массив $parentClasses: Массив классов, которые нужно объединить.
массив $options: Параметры для объединения свойства, см. _mergeVars()

_mergePropertyData()source protected

_mergePropertyData( array $current , array $parent , boolean $isAssoc )

Объединение каждого из ключей в свойстве вместе.

Параметры

массив $current: Текущее объединённое значение.
массив $parent: Значение родительского класса.
логическое значение $isAssoc: Флаг, указывающий, должно ли объединение выполняться в ассоциативном режиме.

Возвращаемое значение

смешанный
Обновлённое значение.

_mergeVars()source protected

_mergeVars( array $properties , array $options = [] )

Объединение списка $properties со всеми родительскими классами текущего класса.

Параметры:

associative - Список свойств, которые должны обрабатываться как ассоциативные массивы. Свойства в этом списке будут переданы через Hash::normalize() перед объединением.

Параметры

массив $properties: Массив свойств и стратегии их объединения.
массив $options необязательно []: Параметры, используемые при объединении свойств.

Методы, используемые из Cake\Datasource\ModelAwareTrait

_setModelClass()source protected

_setModelClass( string $name )

Установка свойств modelClass и modelKey на основе конвенций.

Если свойства уже установлены, они не будут перезаписаны

Параметры

строка $name: Имя класса.

getModelType()source public

getModelType( )

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

Возвращаемое значение

строка

END_OF_DOCUMENT_MARKER

loadModel()source public

loadModel( string|null $modelClass = null , string|null $modelType = null )

Загружает и создаёт объекты репозитория, необходимые для этого объекта

Обычно используется для загрузки объектов таблицы ORM по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

string|null $modelClass необязательно null: Имя класса модели для загрузки. По умолчанию равно $this->modelClass
string|null $modelType необязательно null: Тип репозитория для загрузки. По умолчанию равно значению modelType().

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не был зарегистрирован.
UnexpectedValueException
Если тип модели не был определён

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

string $type: Имя типа репозитория, для которого предназначена функция фабрики.
callable $factory: Функция фабрики, используемая для создания экземпляров.

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Устаревшее

3.5.0 Используйте getModelType()/setModelType() вместо этого.

Параметры

string|null $modelType необязательно null: Тип модели или null для получения текущего

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

string $modelType: Тип модели

Возвращает

$this

Краткое описание магических методов

main()source public

main( )

Возвращает

integer|boolean|null

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

$OptionParsersource

public Cake\Console\ConsoleOptionParser

Экземпляр ConsoleOptionParser, настроенный для этого класса.

$Taskssource

public Cake\Console\TaskRegistry

Коллекция задач для команды, используемая для создания задач.

$_iosource

protected Cake\Console\ConsoleIo

Экземпляр ConsoleIo.

$_taskMapsource

protected array

Нормализованная карта задач.

[]

$argssource

public array

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

[]

$commandsource

public string

Команда (метод/задача), которая выполняется.

$interactivesource

public boolean

Если true, скрипт запросит разрешение на выполнение действий.

true

$namesource

public string

Имя оболочки в camelized форме.

$paramssource

public array

Содержит переключатели команд, проанализированные из командной строки.

[]

$pluginsource

public string

Имя плагина, к которому принадлежит оболочка. Автоматически устанавливается ShellDispatcher при создании оболочки.

$rootNamesource

protected string

Основное имя команды, используемое при генерации вывода справки.

'cake'

$taskNamessource

public array

Содержит загруженные задачи

[]

$taskssource

public array|boolean

Содержит задачи для загрузки и инициализации

Ссылка

https://book.cakephp.org/3.0/ru/console-and-shells.html#Shell::$tasks

[]

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Console.Shell.html