Класс TemplateTask

_findTemplateисходный код защищённый

_findTemplate( string $path , string $directory , string $filename )

Находит шаблон внутри каталога внутри пути. Будет сканировать все остальные каталоги тем, если шаблон не найден в первом каталоге.

Параметры

строка $path

Начальный путь для поиска файла. Если он не найден, будут использоваться резервные варианты.

строка $directory

Подкаталог для поиска, например, 'views', 'objects'

строка $filename

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

Возвращает

string
Имя файла, программа завершится, если шаблон не найден.

_findThemesисходный код защищённый

_findThemes( )

Находит пути ко всем установленным темам оболочек в приложении.

Темы Bake — это каталоги, не имеющие имени skel внутри пути Console/Templates. Они перечислены в таком порядке: приложение -> плагин -> по умолчанию

Возвращает

array
Массив установленных тем Bake.

generateисходный код публичный

generate( string $directory , string $filename , array $vars null )

Запускает шаблон

Параметры

строка $directory

каталог / тип того, что нужно

строка $filename

имя шаблона

массив $vars необязательно null

Дополнительные переменные для установки в область видимости шаблона.

Возвращает

string
содержимое сгенерированного шаблона кода

getThemePathисходный код публичный

getThemePath( )

Находит имя темы для текущей операции. Если в $templatePaths есть только одна тема, она будет использоваться. Если в аргументах командной строки есть параметр -theme, он будет использоваться. Если установлено более одной темы, будет происходить взаимодействие с пользователем

Возвращает

string
Возвращает путь к выбранной теме.

initializeисходный код публичный

initialize( )

Обратный вызов инициализации. Установка путей для задачи шаблона.

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

Shell::initialize()

setисходный код публичный

set( string|array $one , string|array $two null )

Устанавливает значения переменных в область видимости шаблона

Параметры

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

Строка или массив данных.

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

Значение в случае, если $one является строкой (в этом случае она работает как ключ). Не используется, если $one является ассоциативным массивом, в противном случае служит значениями для ключей $one.

__constructисходный код публичный

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

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

Параметры

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

Объект ConsoleOutput для stdout.

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

Объект ConsoleOutput для stderr.

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

Объект ConsoleInput для stdin.

Ссылка

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

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

Object::__construct()

__getисходный код публичный

__get( string $name )

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

Параметры

строка $name

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

Возвращает

Shell
Объект задачи

__issetисходный код публичный

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestисходный код защищённый

_checkUnitTest( )

Действие для создания модульного теста

Возвращает

boolean
Успех

_controllerNameисходный код защищённый

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathисходный код защищённый

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpисходный код защищённый

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputисходный код защищённый

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

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

Параметры

строка $prompt

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

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

Массив или строка вариантов.

строка $default

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

Возвращает

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

_loadModelsисходный код защищённый

_loadModels( )

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

Возвращает

boolean
bool

_modelKeyисходный код защищённый

_modelKey( string $name )

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

Параметры

строка $name

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

Возвращает

string
Ключ модели в единственном числе

_modelNameисходный код защищённый

_modelName( string $name )

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

Параметры

строка $name

Имя

Возвращает

string
Именованое имя модели в единственном числе

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

string $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. Если вы не хотите видеть в stdout или stderr всё, что регистрируется через CakeLog, вызовите эту функцию с первым параметром 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

getOptionParsersource public

getOptionParser( )

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

Переопределив этот метод, вы можете настроить ConsoleOptionParser перед возвратом.

Возвращает

ConsoleOptionParser
ConsoleOptionParser

Ссылка

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

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 )

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

Параметры

строка $prompt

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

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

Массив или строка параметров.

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

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

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

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

Ссылка

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

loadModelsource public

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

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

Параметры

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

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

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

Параметры

строка|массив $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 )

Выполняет оболочку с предоставленным 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( )

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

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

Ссылка

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. Для данных GET используйте $extra['url']. Параметр $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
Имя этого класса

array()

array()

array()

array()

true

null

null

array()

null

array()

array()

array()