Класс TemplateTask

_findTemplate()source protected

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

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

Параметры

строка $path

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

строка $directory

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

строка $filename

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

Возвращает

строка
Файл завершит программу, если шаблон не найден.

_findThemes()source protected

_findThemes( )

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

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

Возвращает

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

generate()source public

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

Выполняет шаблон

Параметры

строка $directory

каталог / тип того, что вы хотите

строка $filename

имя шаблона

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

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

Возвращает

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

getThemePath()source public

getThemePath( )

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

Возвращает

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

initialize()source public

initialize( )

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

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

Shell::initialize()

set()source public

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

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

Параметры

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

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

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

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

__construct()source 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/en/console-and-shells.html#Shell

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTest()source protected

_checkUnitTest( )

Действие для создания теста Unit

Возвращает

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPath()source protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

строка
Путь к контроллеру

_displayHelp()source protected

_displayHelp( string $command )

Отобразить справку в нужном формате

Параметры

string $command

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

_getInput()source protected

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

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

Параметры

string $prompt

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

string|array $options

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

string $default

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

Возвращает

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

_loadModels()source protected

_loadModels( )

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

Возвращает

boolean

_modelKey()source protected

_modelKey( string $name )

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

Параметры

string $name

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

Возвращает

string
Единичный ключ модели

_modelName()source protected

_modelName( string $name )

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

Параметры

string $name

Имя

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

string $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Множественное имя

_pluralName()source protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

Множественное значение с подчеркиваниями.

Возвращает

string
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

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

Параметры

boolean $enable optional true

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

_welcome()source protected

_welcome( )

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

clear()source public

clear( )

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

Ссылка

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

createFile()source public

createFile( string $path , string $contents )

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

Параметры

string $path

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

string $contents

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

Возвращает

boolean
Успешно

Ссылка

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

dispatchShell()source public

dispatchShell( )

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

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

С использованием строковой команды:

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

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

С использованием массива команд:

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

Возвращает

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

Ссылка

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

err()source 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/en/console-and-shells.html#Shell::err

error()source public

error( string $title , string $message null )

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

Параметры

string $title

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

string $message optional null

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

Ссылка

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

getOptionParser()source public

getOptionParser( )

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

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

Возвращает

ConsoleOptionParser

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

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

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

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

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

Загрузить указанный помощник командной оболочки

Параметры

строка $name

Имя класса помощника. Поддерживает синтаксис плагина.

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

BaseShellHelper
Экземпляр класса помощника

Исключения

RuntimeException
Если предоставлено неверное имя класса

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

in()source public

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

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

Параметры

строка $prompt

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

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

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

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

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

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

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

Ссылка

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

loadModel()source public

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

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

Параметры

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

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

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

Изначальный идентификатор, который должен иметь созданный экземпляр модели

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

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

Исключения

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

loadTasks()source public

loadTasks( )

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

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

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

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

Число повторений последовательности символов новой строки

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

строка

Ссылка

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

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

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

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

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

Ссылка

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

overwrite()source public

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

Перезаписывает уже выведенный текст.

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

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

Параметры

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

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

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

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

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

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

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

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

param()source public

param( string $name )

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

Параметры

строка $name

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

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

строка|boolean|null
Значение. Возвращает null, если параметр не существует.

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

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

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

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

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

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

wrapText()source public

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

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

Параметры

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

Параметры

строка $text

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

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

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

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

строка
Обёрнутый/отступленный текст

См. также

CakeText::wrap()

Ссылка

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

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

смешанное
Возвращает результат вызова метода

log()source 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().

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

логическое значение
Успешность записи лога

requestAction()source 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 и именованных/переданных аргументов.

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

смешанное

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

toString()source public

toString( )

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

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

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

array()

array()