Класс I18nShell

getOptionParsersource public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser
\Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

initsource public

init( string|null $language null )

Инициализирует файл PO из файла POT.

Параметры

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

Код языка для использования.

Возвращает

integer|null
int|null

mainsource public

main( )

Переопределяет main() для обработки сообщений справки

__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 для ленивого построения задач

Параметры

string $name

Задача, которую нужно получить.

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

string $command

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

Возвращает

integer|boolean
int|bool

_setOutputLevelsource protected

_setOutputLevel( )

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

Параметры

string $path

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

string $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. Если параметров нет, выводит только новую строку.

Параметры

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

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

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

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

errorsource public

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

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

Параметры

string $title

Название ошибки

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

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

Возвращает

integer
Код ошибки

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

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

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

Ссылка

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.

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

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

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

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

Параметры

массив $argv

Массив аргументов для запуска шелла. В этом массиве должно отсутствовать имя шелла.

булево $autoMethod необязательно false

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

массив $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

startupsource public

startup( )

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

Переопределите этот метод, если хотите удалить приветственное сообщение или изменить поток перед командой другим способом.

Ссылка

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

verbosesource public

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

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

Параметры

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

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

целое число $newlines опционально 1

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

Возвращает

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

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::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 Table по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено исключение 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 )

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

Параметры

строка|null $modelType опционально null

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

Возвращает

string|$this
$this

['Extract']

[]

[]

true

null

[]

null

[]

[]

'Table'