Класс CommandListShell

_asTextsource protected

_asText( array $shellList )

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

Параметры

массив $shellList

Список команд оболочки.

_asXmlsource protected

_asXml( array $shellList )

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

Параметры

массив $shellList

Список команд оболочки.

getOptionParsersource public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser
\Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

mainsource public

main( )

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

startupsource public

startup( )

startup

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

Cake\Console\Shell::startup()

__constructsource public

__construct( Cake\Console\ConsoleIo $io null )

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

Параметры

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

Экземпляр io.

Ссылка

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

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

строка $command

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

Возвращает

integer|boolean
int|bool

_setOutputLevelsource protected

_setOutputLevel( )

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

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

_stopsource protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число или строка $status необязательно 0

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

_welcomesource protected

_welcome( )

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

clearsource public

clear( )

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

Ссылка

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

createFilesource public

createFile( string $path , string $contents )

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

Параметры

строка $path

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

строка $contents

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

Возвращает

boolean
Успешно

Ссылка

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

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

Возвращает

mixed
Возвращаемое значение другой оболочки.

Ссылка

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

errsource public

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

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

Параметры

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

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

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

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

errorsource public

error( string $title , string|null $message null )

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

Параметры

строка $title

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

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

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

Возвращает

integer
Код ошибки

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

строка $name

Имя проверяемого метода.

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

helpersource public

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

Отобразить помощник командной строки

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

Параметры

строка $name

Имя помощника для отображения

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

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

Возвращает

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

hrsource public

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

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

Параметры

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

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

целое число $width необязательно 63

Ширина строки, по умолчанию 63

Ссылка

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

insource public

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

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

Параметры

строка $prompt

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

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

Массив или строка опций.

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

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

Возвращает

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

Ссылка

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

initializesource public

initialize( )

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

Ссылка

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

iosource public

io( Cake\Console\ConsoleIo $io null )

Получение/установка объекта io для данного командного интерпретатора.

Параметры

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

Объект ConsoleIo для использования.

Возвращает

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

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

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

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

Возвращает

string
строка

Ссылка

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

outsource 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

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

Возвращает

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

Ссылка

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

paramsource public

param( string $name )

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

Параметры

строка $name

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

Возвращает

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

parseDispatchArgumentssource public

parseDispatchArguments( array $args )

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

Параметры

массив $args

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

Возвращает

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

quietsource public

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

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

Параметры

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

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

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

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

Возвращает

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

runCommandsource 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 для упрощения создания простых shell.

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

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

Возвращает

mixed
смешанный тип

Ссылка

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

shortPathsource public

shortPath( string $file )

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

Параметры

строка $file

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

Возвращает

string
короткий путь

Ссылка

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

verbosesource public

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

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

Параметры

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

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

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

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

Возвращает

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

wrapTextsource public

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

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

Варианты

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

Параметры

строка $text

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

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

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

Возвращает

string
Оформленный/отступленный текст

См. также

Cake\Utility\Text::wrap()

Ссылка

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

tableLocatorsource public

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

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface
\Cake\ORM\Locator\LocatorInterface

logsource public

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

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

Параметры

смешанный тип $msg

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

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

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

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

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

Возвращает

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

_mergePropertysource protected

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

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

Параметры

строка $property

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

массив $parentClasses

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

массив $options

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

_mergePropertyDatasource protected

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

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

Параметры

массив $current

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

массив $parent

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

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

Указывает, должно ли объединение выполняться в ассоциативном режиме.

Возвращает

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

_mergeVarssource protected

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

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

Параметры:

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

Параметры

массив $properties

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

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

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

_setModelClasssource protected

_setModelClass( string $name )

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

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

Параметры

строка $name

Имя класса.

loadModelsource public

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

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

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

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

Параметры

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

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

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

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

Возвращает

object
Созданный экземпляр модели.

Выбрасывает

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

modelFactorysource public

modelFactory( string $type , callable $factory )

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

Параметры

строка $type

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

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

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

modelTypesource public

modelType( string|null $modelType null )

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

Параметры

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

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

Возвращает

string|$this
$this

['Command']

[]

[]

true

null

[]

null

[]

[]

'Table'