Класс CompletionShell

_output()source protected

_output( array $options = [] )

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

Параметры

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

Параметры для вывода

Возвращает

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

commands()source public

commands( )

Список команд

Возвращает

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

fuzzy()source public

fuzzy( )

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

Возвращает

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

getOptionParser()source public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

main()source public

main( )

Не вызывается оболочкой автозаполнения — для любопытных пользователей

Возвращает

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

options()source public

options( )

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

Возвращает

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

startup()source public

startup( )

Не выводит заголовок, переопределяя метод startup

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

Cake\Console\Shell::startup()

subcommands()source public

subcommands( )

Список подкоманд для указанной команды

Возвращает

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

Выбрасывает

ReflectionException

__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
Объект Task

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

строка $command

Команда, для которой нужна справка.

Возвращает

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

_setOutputLevel()source protected

_setOutputLevel( )

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

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

_stop()source protected

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

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

Параметры

integer|string $status необязательный self::CODE_SUCCESS

см. https://secure.php.net/exit для значений

Выбрасывает

Cake\Console\Exception\StopException

_validateTasks()source protected

_validateTasks( )

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

Выбрасывает

RuntimeException

_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

Число добавляемых новых строк

Возвращает

целое число|логическое значение
Количество байтов, возвращенных из записи в 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.

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

логическое значение

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

логическое значение
Успех

Ссылка

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

info()source public

info( 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

initialize()source public

initialize( )

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

Ссылка

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

io()source public deprecated

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 )

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

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

Существует 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

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

Возвращает

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

Ссылка

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

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

Возвращает

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

runCommand()source public

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

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

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

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

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

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

Параметры

массив $argv

Массив аргументов для запуска shell. Этот массив должен быть без имени 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 для данного shell.

Параметры

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

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

Возвращает

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

См. также

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

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

Возвращает

целое число|логическое значение
Количество байтов, возвращенных при записи в 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

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

log()source public

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

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

Параметры

смешанный $msg

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

целое число|строка $level необязательно LogLevel::ERROR

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

строка|массив $context необязательно []

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

Возвращает

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

_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 необязательно []

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

_setModelClass()source protected

_setModelClass( string $name )

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

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

Параметры

строка $name

Имя класса.

getModelType()source public

getModelType( )

Получение типа модели, используемого этим классом

Возвращает

строка

loadModel()source public

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

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

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

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

Параметры

строка|null $modelClass необязательно null

Имя класса модели для загрузки. По умолчанию $this->modelClass

строка|null $modelType необязательно null

Тип репозитория для загрузки. По умолчанию значение modelType().

Возвращает

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

Выбрасывает

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

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

строка $type

Имя типа репозитория, для которого предназначена фабричная функция.

вызываемая функция $factory

Фабричная функция, используемая для создания экземпляров.

modelType()source public deprecated

modelType( string|null $modelType = null )

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

Устаревшее

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

Параметры

string|null $modelType optional null

Тип модели или null для получения текущего

Возвращает

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

string $modelType

Тип модели

Возвращает

$this

['Command']