Класс ExtractTask

_addTranslationисходный код защищенное

_addTranslation( string $category , string $domain , string $msgid , array $details array() )

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

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

Параметры

строка $category

Категория

строка $domain

Домен

строка $msgid

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

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

Ссылки на файл и строку

_buildFilesисходный код защищенное

_buildFiles( )

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

_extractисходный код защищенное

_extract( )

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

_extractPluginValidationMessagesисходный код защищенное

_extractPluginValidationMessages( string $plugin null )

Извлечение сообщений валидации из моделей приложения или плагинов

Параметры

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

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

_extractTokensисходный код защищенное

_extractTokens( )

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

_extractValidationMessagesисходный код защищенное

_extractValidationMessages( )

Поиск моделей в приложении и извлечение сообщений валидации для добавления в карту перевода

_formatStringисходный код защищенное

_formatString( string $string )

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

Параметры

строка $string

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

Возвращает

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

_getPathsисходный код защищенное

_getPaths( )

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

_getStringsисходный код защищенное

_getStrings( integer $position , integer $target )

Получение строк с указанной позиции вперед.

Параметры

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

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

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

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

Возвращает

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

_isExtractingAppисходный код защищенное

_isExtractingApp( )

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

Возвращает

boolean
bool

_isPathUsableисходный код защищенное

_isPathUsable( string $path )

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

Параметры

строка $path

Путь к папке

Возвращает

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

_markerErrorисходный код защищенное

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

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

Параметры

строка $file

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

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

Номер строки

строка $marker

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

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

Счетчик

_parseисходный код защищенное

_parse( string $functionName , array $map )

Разбор токенов

Параметры

строка $functionName

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

массив $map

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

_processValidationRulesисходный код защищенное

_processValidationRules( string $field , array $rules , string $file , string $domain , string $category 'LC_MESSAGES' )

Обработка правила валидации для поля и поиск сообщения, которое нужно добавить в карту перевода

Параметры

строка $field

имя обрабатываемого поля

массив $rules

набор правил валидации для поля

строка $file

имя файла, где было найдено это правило валидации

строка $domain

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

строка $category необязательно 'LC_MESSAGES'

категория перевода

_searchFilesисходный код защищенное

_searchFiles( )

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

_storeисходный код защищенное

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

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

Параметры

строка $category

Категория

строка $domain

Домен

строка $header

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

строка $sentence

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

_writeFilesисходный код защищенное

_writeFiles( )

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

_writeHeaderисходный код защищенное

_writeHeader( )

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

Возвращает

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

executeисходный код общедоступный

execute( )

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

getOptionParserисходный код общедоступный

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

__constructsource public

__construct( ConsoleOutput $stdout null , ConsoleOutput $stderr null , ConsoleInput $stdin null )

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

Параметры

ConsoleOutput $stdout необязательно null

Объект ConsoleOutput для стандартного вывода.

ConsoleOutput $stderr необязательно null

Объект ConsoleOutput для стандартного потока ошибок.

ConsoleInput $stdin необязательно null

Объект ConsoleInput для стандартного ввода.

Ссылка

http://book.cakephp.org/2.0/en/console-and-shells.html#Shell

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

Object::__construct()

__getsource public

__get( string $name )

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

Параметры

строка $name

Имя свойства для доступа.

Возвращает

Shell
Объект Task

__issetsource public

__isset( string $name )

Ленично загружает модели с помощью метода loadModel(), если они объявлены в $uses

Параметры

строка $name

Имя модели для поиска.

_checkUnitTestsource protected

_checkUnitTest( )

Действие по созданию unit-теста

Возвращает

boolean
Успешно

_controllerNamesource protected

_controllerName( string $name )

Создаёт правильное множественное имя контроллера для указанного имени класса контроллера

Параметры

строка $name

Имя класса контроллера

Возвращает

string
Множественное имя контроллера

_controllerPathsource protected

_controllerPath( string $name )

Создаёт правильный путь к контроллеру для указанного имени класса контроллера

Параметры

строка $name

Имя класса контроллера

Возвращает

string
Путь к контроллеру

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputsource protected

_getInput( string $prompt , string|array $options , string $default )

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModelssource protected

_loadModels( )

Если $uses является массивом, загрузить каждую модель из массива

Возвращает

boolean
bool

_modelKeysource protected

_modelKey( string $name )

Создаёт правильный подчеркнутый ключ модели для ассоциаций

Параметры

строка $name

Имя класса модели

Возвращает

string
Единственное имя ключа модели

_modelNamesource protected

_modelName( string $name )

Создаёт правильное имя модели с использованием camelization (единственное число) для указанного имени

Параметры

строка $name

Имя

Возвращает

string
Имя модели с использованием camelization (единственное число)

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

Создаёт правильное имя модели из внешнего ключа

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

Находит правильный путь к плагину. Сканирует $pluginPaths для нужного плагина.

Параметры

строка $pluginName

Имя плагина, например DebugKit

Возвращает

string
Путь к плагину.

_pluralHumanNamesource protected

_pluralHumanName( string $name )

Создаёт множественное имя в формате, используемом в представлениях

Параметры

строка $name

Имя контроллера

Возвращает

string
Множественное имя в формате, используемом в представлениях

_pluralNamesource protected

_pluralName( string $name )

Создаёт множественное имя для представлений

Параметры

строка $name

Имя для использования

Возвращает

string
Множественное имя для представлений

_singularHumanNamesource protected

_singularHumanName( string $name )

Создаёт имя единственного числа в формате, используемом в представлениях

Параметры

строка $name

Имя контроллера

Возвращает

string
Имя единственного числа в формате, используемом в представлениях

_singularNamesource protected

_singularName( string $name )

Создаёт единственное имя для использования в представлениях.

Параметры

строка $name

Значение множественного числа с нижним подчёркиванием.

Возвращает

string
Имя

_useLoggersource protected

_useLogger( boolean $enable true )

Используется для включения или выключения вывода логирования в стандартный вывод и стандартный поток ошибок. Если вы не хотите видеть всё, что регистрируется через CakeLog, в вашем стандартном выводе или стандартном потоке ошибок, вызовите эту функцию с первым параметром false.

Параметры

boolean $enable необязательно true

включать или нет вывод CakeLog

_welcomesource protected

_welcome( )

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

clearsource public

clear( )

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

Ссылка

http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::clear

createFilesource public

createFile( string $path , string $contents )

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

Параметры

строка $path

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

строка $contents

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

Возвращает

boolean
Успешно

Ссылка

http://book.cakephp.org/2.0/en/console-and-shells.html#Shell::createFile

dispatchShellsource public

dispatchShell( )

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

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

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

return $this->dispatchShell('schema create DbAcl');

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

С массивом команд:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

Возвращает

mixed
Результат работы другого shell.

Ссылка

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

errsource public

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

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

Параметры

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

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

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

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

Ссылка

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

errorsource public

error( string $title , string $message null )

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

Параметры

строка $title

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

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

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

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource public

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

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

Параметры

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

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

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

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

Ссылка

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

insource public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

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

Ссылка

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

initializesource public

initialize( )

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

Ссылка

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

loadModelsource public

loadModel( string $modelClass null , mixed $id null )

Загружает и инициализирует модели, необходимые для этого shell.

Параметры

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

Имя класса модели для загрузки

смешанное $id необязательно null

Начальный ID, который должна иметь экземпляризованная модель

Возвращает

mixed
true, если модель найдена и экземпляр создан, возвращается ошибка, если модель не найдена.

Исключения

MissingModelException
если класс модели не может быть найден.

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

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

Количество раз, которое последовательность символов новой строки должна быть повторена

Возвращает

string
строка

Ссылка

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

outsource public

out( string|array $message null , integer $newlines 1 , integer $level Shell::NORMAL )

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

overwritesource public

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

Перезаписывает часть уже выведенного текста.

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

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

Параметры

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

Сообщение для вывода.

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

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

целое число $size необязательно null

Количество байтов для перезаписи. По умолчанию равно длине последнего выведенного сообщения.

Возвращает

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

paramsource public

param( string $name )

Безопасно получить значения из $this->params.

Параметры

строка $name

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

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

string|boolean|null
Значение. Вернёт null, если параметр не найден.

runCommandsource public

runCommand( string $command , array $argv )

Выполняет Shell с заданными аргументами argv.

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

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

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

Параметры

строка $command

Имя команды для выполнения в этом Shell. Если этот аргумент пустой, и в Shell есть метод main(), он будет вызван вместо этого.

массив $argv

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

Ссылка

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

shortPathsource public

shortPath( string $file )

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

Параметры

строка $file

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

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

string
Короткое имя пути

Ссылка

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

startupsource public

startup( )

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

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

Ссылка

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

wrapTextsource public

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

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

Параметры

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

Параметры

строка $text

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

строка/целое число/массив $options необязательно массив()

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

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

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

См.

CakeText::wrap()

Ссылка

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

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства объекта $property со свойствами в определении $class. Значение свойства данного класса будет объединено сверху значения $class.

Это предоставляет некоторую DRY-магию, предоставляемую CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

массив $properties

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

строка $class

Класс для объединения свойства с.

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

Установите в true, чтобы запустить свойства через Hash::normalize() перед объединением.

_setsource protected

_set( array $properties array() )

Позволяет устанавливать несколько свойств объекта в одной строке кода. Будут установлены только свойства, являющиеся частью объявления класса.

Параметры

массив $properties необязательно массив()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethodsource public

dispatchMethod( string $method , array $params array() )

Вызывает метод в этом объекте с заданными параметрами. Обеспечивает ОО-обёртку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно массив()

Список параметров для использования при вызове $method

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

mixed
Возвращает результат вызова метода

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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

Параметры

строка $msg

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

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и) создания сообщения журнала. См. CakeLog::config() для получения дополнительной информации о областям ведения журнала.

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

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

requestActionsource public

requestAction( string|array $url , array $extra array() )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров друг к другу или связи плагинов с основным приложением. requestAction может использоваться для возврата отображённых представлений или получения возвращаемого значения действий контроллеров.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse()

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

строка/массив $url

Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

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

Если массив содержит ключ "return", устанавливает AutoRender в true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

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

mixed
Булево true или false об успехе/неудачи, или содержимое отображённого действия, если в $extra установлен 'return'.

toStringsource public

toString( )

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

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

string
Имя этого класса

array()

false

true

null

array()

false

null

array()

array()

array()

array()

'default'

array()

array()

true

null

null

array()

null

array()

array()

array()