Класс ExtractTask

_addTranslation()source protected

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

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

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

Параметры

строка $domain

Домен

строка $msgid

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

массив $details optional []

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

_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

Путь к папке

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

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

Создает экземпляр этого объекта Shell.

Параметры

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

Экземпляр io.

Ссылка

http://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

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

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

целое число|boolean

_setOutputLevel()source protected

_setOutputLevel( )

Установка уровня вывода на основе параметров.

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

_stop()source protected

_stop( integer|string $status 0 )

Остановка выполнения текущего скрипта. Выбрасывает StopException, чтобы попытаться остановить выполнение.

Параметры

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

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

Исключения

Cake\Console\Exception\StopException

abort()source public

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

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

Параметры

строка $message

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

целое число $exitCode необязательно self::CODE_ERROR

Код завершения для задачи оболочки.

Исключения

Cake\Console\Exception\StopException

Ссылка

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

clear()source public

clear( )

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

Ссылка

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

createFile()source public

createFile( string $path , string $contents )

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

Параметры

строка $path

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

строка $contents

Содержание, которое нужно поместить в файл.

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

boolean
Успех

Ссылка

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

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

смешанное
Результат работы другой оболочки.

Ссылка

http://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

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

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

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Результат

Ссылка

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

helper()source public

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

Отображение помощника командной строки

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

Параметры

string $name

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

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

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

Возвращает

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

hr()source public

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

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

Параметры

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

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

integer $width необязательно 63

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

Ссылка

http://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
Значение по умолчанию или введенное пользователем значение.

Ссылка

http://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
Возвращает количество байтов, возвращенных при записи в стандартный вывод.

См. также

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

initialize()source public

initialize( )

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

Ссылка

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

io()source public

io( Cake\Console\ConsoleIo $io null )

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

Параметры

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

Ссылка

http://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 выводе.

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

param()source public

param( string $name )

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

Параметры

string $name

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

Возвращает

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

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

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

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

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

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

Возвращает

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

Ссылка

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

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

Возвращает

строка
сокращённый путь

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

http://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

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

Возвращает

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

См. также

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

verbose()source public

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

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

Параметры

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

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

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

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

Возвращает

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

warn()source public

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

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

Параметры

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

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

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

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

Возвращает

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

См. также

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

wrapText()source public

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

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

Параметры

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

Параметры

строка $text

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

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

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

Возвращает

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

См. также

\Cake\Utility\Text::wrap()

Ссылка

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

tableLocator()source public

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

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

Параметры

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

Выполнять ли слияние в ассоциативном режиме.

Возвращает

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

_mergeVars()source protected

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

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

Параметры:

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

Параметры

массив $properties

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

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

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

_setModelClass()source protected

_setModelClass( string $name )

Установить свойства modelClass и modelKey на основе конвенций.

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

Параметры

строка $name

Имя класса.

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

modelType( string|null $modelType null )

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

Параметры

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

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

Возвращает

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

[]

false

null

[]

false

null

[]

[]

[]

[]

'default'