Класс BakeShell

all()source public

all( )

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

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

main()source public

main( )

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

Возвращает

mixed

startup()source public

startup( )

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

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

Shell::startup()

__construct()source 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/ru/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( )

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

Возвращает

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPath()source protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInput()source protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModels()source protected

_loadModels( )

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

Возвращает

boolean

_modelKey()source protected

_modelKey( string $name )

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

Параметры

строка $name

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

Возвращает

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

_modelName()source protected

_modelName( string $name )

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

Параметры

строка $name

Имя

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

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

строка
Путь к нужному плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

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

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

_pluralName()source protected

_pluralName( string $name )

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

Параметры

строка $name

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

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

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

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

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

_singularName()source protected

_singularName( string $name )

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

Параметры

строка $name

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

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

строка
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

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

Параметры

булево $enable необязательный true

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

_welcome()source protected

_welcome( )

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

clear()source public

clear( )

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

Ссылка

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

createFile()source public

createFile( string $path , string $contents )

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

Параметры

строка $path

Место сохранения файла.

строка $contents

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

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

булево
Успех

Ссылка

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

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

смешанное
Результат работы другой оболочки.

Ссылка

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

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

error()source public

error( string $title , string $message null )

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

Параметры

строка $title

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

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

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

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

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

булево

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

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

булево
Успех

Ссылка

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

initialize()source public

initialize( )

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

Ссылка

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

loadModel()source public

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

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

Параметры

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

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

mixed $id необязательный null

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

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

mixed
true, если найдена и создана одна модель, ошибка, если модель не найдена.

Исключения

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

loadTasks()source public

loadTasks( )

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

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

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier необязательный 1

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

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

string

Ссылка

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

Параметры

string|array $message необязательный null

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

integer $newlines необязательный 1

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

integer $level необязательный Shell::NORMAL

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

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

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

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

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

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

Параметры

array|string $message

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

integer $newlines необязательный 1

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

integer $size необязательный null

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

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

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

param()source public

param( string $name )

Безопасный доступ к значениям в $this->params.

Параметры

string $name

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

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

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

runCommand()source public

runCommand( string $command , array $argv )

Запускает оболочку (Shell) с предоставленным argv.

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

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

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

Параметры

string $command

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

array $argv

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

Ссылка

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

shortPath()source public

shortPath( string $file )

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

Параметры

string $file

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

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

string
короткий путь

Ссылка

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

wrapText()source public

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

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

Параметры

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

Параметры

string $text

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

string|integer|array $options необязательный array()

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

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

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

См. также

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

Параметры

array $properties

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

string $class

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

boolean $normalize необязательный true

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties необязательный array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательный 0

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

mixed
Результат вызова метода

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

Возвращает

boolean
Успех записи в журнал

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

'default'

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