Класс PluginTask

_interactivesource protected

_interactive( string $plugin null )

Интерактивный интерфейс

Параметры

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

Имя плагина.

_modifyBootstrapsource protected

_modifyBootstrap( string $plugin )

Обновление файла bootstrap.php приложения.

Параметры

строка $plugin

Название плагина

bakesource public

bake( string $plugin )

Сгенерировать плагин, создать директории и файлы

Параметры

строка $plugin

Имя плагина в формате CamelCased

Возвращает

boolean
bool

executesource public

execute( )

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

findPathsource public

findPath( array $pathOptions )

поиск и изменение $this->path на пользовательский выбор

Параметры

массив $pathOptions

Список путей для поиска.

getOptionParsersource public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

initializesource public

initialize( )

инициализация

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

Shell::initialize()

__constructsource public

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

Создаёт экземпляр данной оболочки.

Параметры

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

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

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

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

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

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

Ссылка

http://book.cakephp.org/2.0/ru/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( )

Действие по созданию тестового блока

Возвращает

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 и singularization

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Множественное число человекопонятного имени

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Единственное число человекопонятного имени

_singularNamesource protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

string
Имя

_useLoggersource protected

_useLogger( boolean $enable true )

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

Параметры

boolean $enable optional true

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

_welcomesource protected

_welcome( )

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

clearsource public

clear( )

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

Ссылка

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

createFilesource public

createFile( string $path , string $contents )

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

Параметры

string $path

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

string $contents

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

Возвращает

boolean
Успех

Ссылка

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

dispatchShellsource public

dispatchShell( )

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

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

С командной строкой:

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

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

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

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

Возвращает

mixed
Результат работы другой оболочки.

Ссылка

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

errsource public

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

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

Ссылка

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

errorsource public

error( string $title , string $message null )

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

Параметры

string $title

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

string $message optional null

Дополнительное сообщение об ошибке

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource public

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

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

Параметры

integer $newlines optional 0

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

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

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

Параметры

string $prompt

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

string|array $options optional null

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

string $default optional null

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

Возвращает

mixed
Либо значение по умолчанию, либо введённые пользователем данные.

Ссылка

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

loadModelsource public

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

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

Параметры

string $modelClass optional null

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

mixed $id optional null

Инициализирующий идентификатор класса модели

Возвращает

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 означает, что оно будет отображаться только при включенном 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.

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

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

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

Параметры

строка $command

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

массив $argv

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

Ссылка

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 необязательно array()

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

Возвращает

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 необязательно array()

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

_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 необязательно array()

Список параметров для использования при вызове $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 необязательно array()

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

null

null

array()

array()

true

null

null

array()

null

array()

array()

array()