Класс HelpShell

asText()source protected

asText( Cake\Console\CommandCollection $commands )

Вывод текста.

Параметры

Cake\Console\CommandCollection $commands

Коллекция команд для вывода.

asXml()source protected

asXml( Cake\Console\CommandCollection $commands )

Вывод в формате XML

Параметры

Cake\Console\CommandCollection $commands

Коллекция команд для вывода

getCommands()source protected

getCommands( )

Получение списка команд с помощью CommandTask

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

Возвращает

array

getOptionParser()source public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser

Переопределяет

Cake\Console\Shell::getOptionParser()

main()source public

main( )

Основная функция Вывод списка оболочек.

setCommandCollection()source public

setCommandCollection( Cake\Console\CommandCollection $commands )

Установка используемой коллекции команд.

Параметры

Cake\Console\CommandCollection $commands

Используемые команды.

Реализация

Cake\Console\CommandCollectionAwareInterface::setCommandCollection()

startup()source public

startup( )

Инициализация

Переопределяет

Cake\Console\Shell::startup()

__construct()source public

__construct( Cake\Console\ConsoleIo $io null )

Создание экземпляра этой оболочки.

Параметры

Cake\Console\ConsoleIo $io необязательно null

Экземпляр io.

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

string $name

Задача для получения.

Возвращает

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

_displayHelp()source protected

_displayHelp( string $command )

Вывод справки в правильном формате

Параметры

string $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

_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 )

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

Параметры

string $path

Куда поместить файл.

string $contents

Содержимое файла.

Возвращает

boolean
Успех

Ссылка

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

dispatchShell()source public

dispatchShell( )

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

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

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

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

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

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

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'] ]);

Возвращает

integer
Код завершения команды 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. Если параметры не переданы, выводит только перевод строки.

Параметры

string|array|null $message необязательно null

Строка или массив строк для вывода

integer $newlines необязательно 1

Количество переводов строк для добавления

Возвращает

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

error()source public

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

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

Устарело

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

Параметры

string $title

Заголовок ошибки

string|null $message необязательно null

Необязательное сообщение об ошибке

integer $exitCode необязательно self::CODE_ERROR

Код завершения для задачи shell.

Возвращает

integer
Код ошибки

Выбрасывает

Cake\Console\Exception\StopException

Ссылка

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

getIo()source public

getIo( )

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

Возвращает

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

Имя метода для проверки.

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

Имя задачи для проверки.

Возвращает

boolean
Успех

Ссылка

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

helper()source public

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

Вывод Console Helper

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

Параметры

string $name

Имя помощника для вывода

array $settings необязательно []

Конфигурационные данные для помощника.

Возвращает

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

hr()source public

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

Выводит серию символов тире в стандартный вывод, служит визуальным разделителем.

Параметры

integer $newlines необязательно 0

Количество переводов строк для пред- и пост-приложения

integer $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 )

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

Параметры

string $prompt

Текст запроса.

string|array|null $options необязательно null

Массив или строка параметров.

string|null $default необязательно null

Значение ввода по умолчанию.

Возвращает

mixed
Значение по умолчанию или введённое пользователем.

Ссылка

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

info()source public

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

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

Параметры

string|array|null $message необязательно null

Строка или массив строк для вывода

integer $newlines необязательно 1

Количество переводов строк для добавления

integer $level необязательно Cake\Shell\Shell::NORMAL

Уровень вывода сообщения, см. выше.

Возвращает

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

См.

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

initialize()source public

initialize( )

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

Ссылка

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 для этого shell.

Устарело

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 )

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

Параметры

целое число $multiplier необязательно 1

Количество повторений последовательности символов новой строки

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

строка

Ссылка

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 Cake\Shell\Shell::NORMAL )

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

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

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

Параметры

строка|массив|null $message необязательно null

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество символов новой строки для добавления

целое число $level необязательно Cake\Shell\Shell::NORMAL

Уровень вывода сообщения, см. выше.

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

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

Ссылка

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

param()source public

param( string $name )

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

Параметры

строка $name

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

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

строка|логическое значение|null
Значение. Вернет null, если параметр не существует.

parseDispatchArguments()source public

parseDispatchArguments( array $args )

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

Параметры

массив $args

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

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

массив

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

quiet()source public

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

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

Параметры

строка|массив $message

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество символов новой строки для добавления

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

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

runCommand()source public

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

Выполняет Shell с предоставленным argv.

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

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

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

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

Параметры

массив $argv

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

логическое значение $autoMethod необязательно false

Установите в значение true, чтобы разрешить вызов любого публичного метода, даже если он не был определен как подкоманда. Это используется ShellDispatcher для упрощения создания простых оболочек.

массив $extra необязательно []

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

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

целое число|логическое значение|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 )

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

Параметры

строка $name

Имя корневой команды.

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

$this

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

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

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

Ссылка

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

success()source public

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

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

Параметры

строка|массив|null $message необязательно null

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество символов новой строки для добавления

целое число $level необязательно Cake\Shell\Shell::NORMAL

Уровень вывода сообщения, см. выше.

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

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

См. также

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

verbose()source public

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

Вывод на уровне verbose.

Параметры

строка|массив $message

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество символов новой строки для добавления

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

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

warn()source public

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

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

Параметры

строка|массив|null $message необязательно null

Строка или массив строк для вывода

целое число $newlines необязательно 1

Количество символов новой строки для добавления

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

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

См. также

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

wrapMessageWithType()source protected

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

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

Параметры

строка $messageType

Тип сообщения, например "предупреждение".

строка|массив $message

Сообщение для обертывания.

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

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

wrapText()source public

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

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

Параметры

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

Параметры

string $text

Текст для форматирования.

integer|array $options необязательно []

Массив опций для использования или целое число для обрезки текста.

Возвращает

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

См. также

\Cake\Utility\Text::wrap()

Ссылка

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

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

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

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

Устарело

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

log()source public

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

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

Параметры

mixed $msg

Сообщение журнала.

integer|string $level необязательно LogLevel::ERROR

Уровень ошибки.

string|array $context необязательно []

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успех записи в журнал.

_mergeProperty()source protected

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

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

Параметры

string $property

Имя объединяемого свойства.

array $parentClasses

Массив классов, которые вы хотите объединить.

array $options

Параметры для объединения свойства, см. _mergeVars()

_mergePropertyData()source protected

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

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

Параметры

array $current

Текущее объединенное значение.

array $parent

Значение родительского класса.

boolean $isAssoc

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

Возвращает

mixed
Обновленное значение.

_mergeVars()source protected

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

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

Параметры:

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

Параметры

array $properties

Массив свойств и стратегии объединения для них.

array $options необязательно []

Параметры для использования при объединении свойств.

_setModelClass()source protected

_setModelClass( string $name )

Установка свойств modelClass и modelKey на основе соглашений.

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

Параметры

string $name

Имя класса.

getModelType()source public

getModelType( )

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

Возвращает

string

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

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