Класс ExtractTask

_addTranslation()source protected

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

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

Учитывает дублирующиеся переводы

Параметры

строка $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, т.е. эта задача извлекает строки из того же приложения.

Возвращает

boolean

_isPathUsable()source protected

_isPathUsable( string $path )

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

Параметры

string $path

Путь к папке

Возвращает

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

_markerError()source protected

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

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

Параметры

string $file

Файл, содержащий недопустимый маркер

integer $line

Номер строки

string $marker

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

integer $count

Счёт

_parse()source protected

_parse( string $functionName , array $map )

Разбор маркеров

Параметры

string $functionName

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

array $map

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

_searchFiles()source protected

_searchFiles( )

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

_store()source protected

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

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

Параметры

string $domain

Домен

string $header

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

string $sentence

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

_welcome()source protected

_welcome( )

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

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

Cake\Console\Shell::_welcome()

_writeFiles()source protected

_writeFiles( )

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

_writeHeader()source protected

_writeHeader( )

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

Возвращает

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

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

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

Возвращает

array

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

Cake\Console\Shell
Объект Task

_displayHelp()source protected

_displayHelp( string $command )

Вывести справку в правильном формате

Параметры

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

abort()source public

abort( string $message , integer $exitCode = self::CODE_ERROR )

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

Параметры

string $message

Сообщение об ошибке

integer $exitCode необязательно self::CODE_ERROR

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

Вызывает

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 )

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

Параметры

string $path

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

string $contents

Содержимое для помещения в файл.

Возвращает

boolean
Успех

Ссылка

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

dispatchShell()source public

dispatchShell( )

Отправляет команду в другой Shell. Аналогично 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'] ]);

Возвращает

integer
Код завершения команды командной строки. 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. Если параметры не переданы, выводится только перевод строки.

Параметры

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

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

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

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

Возвращает

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

error()source public устарело

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

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

Устарело

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

Параметры

string $title

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

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

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

integer $exitCode необязательно 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 Helper

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

Параметры

string $name

Имя рендеринга помощника

array $settings необязательно []

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

Возвращает

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

hr()source public

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

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

Параметры

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

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

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

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

Параметры

string $prompt

Текст приглашения.

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

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

string|null $default необязательно 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\Task\Shell::NORMAL )

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

Параметры

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

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

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

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

integer $level необязательно Cake\Shell\Task\Shell::NORMAL

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

Возвращает

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

См.

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

initialize()source public

initialize( )

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

Ссылка

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

io()source public устарело

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

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

Устарело

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 )

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

Параметры

integer $multiplier необязательно 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\Task\Shell::NORMAL )

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

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

Возвращает

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

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

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

Возвращает

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

См.

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.

Параметры

string $text

Текст, который нужно отформатировать.

integer|array $options необязательно []

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

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

string
Оборачиваемый/отступленный текст

См. также

\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 устаревший

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() для получения дополнительной информации о записи в журналы.

Параметры

mixed $msg

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

integer|string $level необязательно LogLevel::ERROR

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

string|array $context необязательно []

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

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

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

_mergeProperty()source protected

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

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

Параметры

string $property

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

array $parentClasses

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

array $options

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

_mergePropertyData()source protected

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

Объединяет каждый ключ в свойстве.

Параметры

array $current

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

array $parent

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

boolean $isAssoc

Флаг, указывающий на то, следует ли выполнять слияние в ассоциативном режиме.

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

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

_mergeVars()source protected

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

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

Параметры:

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

Параметры

array $properties

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

array $options необязательно []

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

_setModelClass()source protected

_setModelClass( string $name )

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

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

Параметры

string $name

Имя класса.

getModelType()source public

getModelType( )

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

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

string

loadModel()source public

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

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

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

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

Параметры

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

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

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

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

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

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

Исключения

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

modelFactory()source public

modelFactory( string $type , callable $factory )

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

Параметры

string $type

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

callable $factory

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

modelType()source public устаревший

modelType( string|null $modelType = null )

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

Устаревший

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

Параметры

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

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

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

string|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

string $modelType

Тип модели

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

$this

[]

false

[]

false

[]

[]

[]

[]

'default'