Класс ExtractTask

_addTranslation()source protected

_addTranslation( string $domain , string $msgid , array $details = [] )

Добавление перевода в внутреннее свойство translations

Обрабатывает дублированные переводы

Параметры

строка $domain

Домен

строка $msgid

Строка сообщения

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

Контекст и форма множественного числа, если таковые имеются, ссылки на файл и строку

_buildFiles()source protected

_buildFiles( )

Создание содержимого шаблона перевода из полученных строк

_extract()source protected

_extract( )

Извлечение текста

_extractTokens()source protected

_extractTokens( )

Извлечение токенов из всех файлов для обработки

_formatString()source protected

_formatString( string $string )

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

Параметры

строка $string

Строка для форматирования

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

строка
Отформатированная строка

_getPaths()source protected

_getPaths( )

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

_getStrings()source protected

_getStrings( integer $position , integer $target )

Получить строки с указанной позиции

Параметры

целое число $position

Текущая позиция в массиве токенов

целое число $target

Количество строк для извлечения

Возвращает

массив
Извлеченные строки

_isExtractingApp()source protected

_isExtractingApp( )

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

Возвращает

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

_isPathUsable()source protected

_isPathUsable( string $path )

Проверяет, доступна ли заданная папка для записи.

Параметры

строка $path

Путь к папке

Возвращает

логическое значение
true, если папка существует и доступна для записи, иначе false

_markerError()source protected

_markerError( string $file , integer $line , string $marker , integer $count )

Указывает на неверный маркер в обработанном файле

Параметры

строка $file

Файл, в котором находится неверный маркер

целое число $line

Номер строки

строка $marker

Найденный маркер

целое число $count

Счётчик

_parse()source protected

_parse( string $functionName , array $map )

Обработать токены

Параметры

строка $functionName

Имя функции, указывающее на переводческую строку (например: '__')

массив $map

Массив, содержащий переменные (например: домен, единственное число, множественное число)

_searchFiles()source protected

_searchFiles( )

Поиск файлов, которые могут содержать переводческие строки

_store()source protected

_store( string $domain , string $header , string $sentence )

Подготовить файл для хранения

Параметры

строка $domain

Домен

строка $header

Содержание заголовка.

строка $sentence

Предложение для хранения.

_welcome()source protected

_welcome( )

Сообщение приветствия отсутствует.

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

Cake\Console\Shell::_welcome()

_writeFiles()source protected

_writeFiles( )

Записать файлы, которые необходимо сохранить

_writeHeader()source protected

_writeHeader( )

Сформировать заголовок шаблона перевода

Возвращает

строка
Заголовок шаблона перевода

getOptionParser()source public

getOptionParser( )

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

Возвращает

Cake\Console\ConsoleOptionParser

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

Cake\Console\Shell::getOptionParser()

main()source public

main( )

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

__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

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

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

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

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

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

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

целое число
Код выхода команды 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

Код выхода для задачи shell.

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

целое число
Код ошибки

Вызывает

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.

Параметры

строка $name

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

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

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

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

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

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

Ссылка

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

helper()source public

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

Отображение Console Helper

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

Параметры

строка $name

Имя helper для отображения

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

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

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

Cake\Console\Helper
Созданный экземпляр 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\Task\Shell::NORMAL )

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

Параметры

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

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

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

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

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

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

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

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

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

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

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\Task\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\Task\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 = [] )

Выполняет оболочку с предоставленными argv.

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

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

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

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

Параметры

массив $argv

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

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

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

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

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

Возвращает

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

startup()source public

startup( )

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

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

Ссылка

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

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

Параметры

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

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

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

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

целое число $level необязательно Cake\Shell\Task\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() вместо этого.

Параметры

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

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

Возвращает

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

setModelType()source public

setModelType( string $modelType )

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

Параметры

строка $modelType

Тип модели

Возвращает

$this

[]

false

[]

false

[]

false

[]

[]

[]

'default'