Класс BakeShell

allисходный код public

all( )

Быстрая генерация MVC

getOptionParserисходный код public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

mainисходный код public

main( )

Переопределить main() для обработки действия

Возвращает

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

startupисходный код public

startup( )

Назначить $this->connection активной задаче, если параметр подключения задан.

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

Shell::startup()

__constructисходный код 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()

__getисходный код public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__issetисходный код public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestисходный код protected

_checkUnitTest( )

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

Возвращает

boolean
Успех

_controllerNameисходный код protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathисходный код protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpисходный код protected

_displayHelp( string $command )

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

Параметры

строка $command

Команда для получения справки.

_getInputисходный код protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModelsисходный код protected

_loadModels( )

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

Возвращает

boolean
bool

_modelKeyисходный код protected

_modelKey( string $name )

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

Параметры

строка $name

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

Возвращает

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

_modelNameисходный код protected

_modelName( string $name )

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

Параметры

строка $name

Имя

Возвращает

string
Имя модели с верблюжьей нотацией и единственное

_modelNameFromKeyисходный код protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathисходный код protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanNameисходный код protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_pluralNameисходный код protected

_pluralName( string $name )

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

Параметры

строка $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 необязательно 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 необязательно null

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

integer $newlines необязательно 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 необязательно 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 необязательно 0

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

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

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

Параметры

string $prompt

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

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

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

string $default необязательно null

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

Возвращает

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

Ссылка

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

initializesource public

initialize( )

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

Ссылка

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

loadModelsource public

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

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

Параметры

string $modelClass необязательно null

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

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

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
Имя этого класса

'default'

array('Project', 'DbConfig', 'Model', 'Controller', 'View', 'Plugin', 'Fixture', 'Test')

array()

array()

true

null

null

array()

null

array()

array()