Класс PluginShell

Оболочка для задач, связанных с плагинами.

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

Cake\Shell\PluginShell

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

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

CODE_ERROR, CODE_SUCCESS, NORMAL, QUIET, VERBOSE

Краткое описание свойств

$tasks public

array
Плагины для загрузки

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

$Assets public

Cake\Shell\Task\AssetsTask
$Load public

Cake\Shell\Task\LoadTask
$Unload public

Cake\Shell\Task\UnloadTask

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

OptionParser, Tasks, _io, _taskMap, args, command, interactive, name, params, plugin, rootName, taskNames _tableLocator _modelFactories, _modelType, modelClass

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

getOptionParser() public
Получает экземпляр парсера параметров и настраивает его.
loaded() public
Отображает все загруженные плагины.

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

getOptionParser()source public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

loaded()source public

loaded( )

Отображает все загруженные плагины.

Методы, унаследованные от Cake\Console\Shell

__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: Команда, для которой требуется получить справку.

Возвращает

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

_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

_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: Содержимое файла.

Возвращает

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

Ссылка

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

END_OF_DOCUMENT_MARKER

err()source public

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

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

Параметры

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

Возвращает

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

error()source public deprecated

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

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

Устарело

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

Параметры

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

Возвращает

integer
Код ошибки

Исключение

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 )

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

Параметры

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

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

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

Параметры

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

Возвращает

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

hr()source public

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

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

Параметры

integer $newlines optional 0: Количество новых строк для добавления сверху и снизу
integer $width optional 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 optional null: Массив или строка опций.
string|null $default optional 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 optional null: Строка или массив строк для вывода
integer $newlines optional 1: Количество добавляемых новых строк
integer $level optional Cake\Shell\Shell::NORMAL: Уровень вывода сообщения, см. выше.

Возвращает

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

См.

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 deprecated

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

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

Устарело

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

Параметры

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

Возвращает

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

loadTasks()source public

loadTasks( )

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

Возвращает

boolean

nl()source public

nl( integer $multiplier = 1 )

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

Параметры

integer $multiplier optional 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 = Cake\Shell\Shell::NORMAL )

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

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

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

Параметры

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

Возвращает

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

Ссылка

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

END_OF_DOCUMENT_MARKER

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.

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

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

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

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

Параметры

массив $argv: Массив аргументов для выполнения shell. В этом массиве должно отсутствовать имя shell.
логическое значение $autoMethod необязательно false: Установите в true, чтобы разрешить вызов любого публичного метода, даже если он не был определён как подкоманда. Это используется ShellDispatcher для упрощения создания простых shell.
массив $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

startup()source public

startup( )

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

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

Ссылка

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

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: Количество новых строк для добавления

Возвращает

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

END_OF_DOCUMENT_MARKER

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

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

log()source public

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

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

Параметры

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

Возвращает

boolean
Результат записи в журнал.

Методы, используемые из 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( )

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

Возвращает

строка

loadModel()source public

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

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

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

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

Параметры

строка|null $modelClass необязательно null: Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, например 'Post' или FQCN, например App\Model\Table\PostsTable::class.
строка|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 устаревшее

modelType( string|null $modelType = null )

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

Устаревшее

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

Параметры

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

Возвращает

строка|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

строка $modelType: Тип модели

Возвращает

$this

Магические методы, унаследованные от Cake\Console\Shell

main()

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

$taskssource

public массив

Загружаемые задачи

[
    'Assets',
    'Load',
    'Unload',
]

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

© 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.8/class-Cake.Shell.PluginShell.html