Класс ApiShell

_parseClass()source protected

_parseClass( string $path , string $class )

Разбор заданного класса (расположенного в заданном файле) и получение общедоступных методов и их сигнатур.

Параметры

string $path

Путь к файлу

string $class

Имя класса

Возвращает

массив
Методы и сигнатуры, индексированные по имени метода

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

help()source public

help( )

Отображает справку по этой оболочке.

initialize()source public

initialize( )

Переопределение инициализации оболочки

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

Shell::initialize()

main()source public

main( )

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

__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/ru/console-and-shells.html#Shell

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

string $name

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

_checkUnitTest()source protected

_checkUnitTest( )

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

Возвращает

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

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

Параметры

string $name

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

Возвращает

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

_controllerPath()source protected

_controllerPath( string $name )

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

Параметры

string $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

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

Возвращает

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

_modelName()source protected

_modelName( string $name )

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

Параметры

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

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

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

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

Ссылка

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

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

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

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

Параметры

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

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

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

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

целое число $level необязательный Shell::NORMAL

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

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

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

Ссылка

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

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

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

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

param()source public

param( string $name )

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

Параметры

строка $name

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

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

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

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

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

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

строка
короткое имя пути

Ссылка

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

startup()source public

startup( )

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

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

Ссылка

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

Массив опций для использования или целое число для обёртывания текста.

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

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

См. также

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 защищённый

_set( array $properties array() )

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

Параметры

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

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

_stop()source защищённый

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source публичный

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

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

Параметры

строка $method

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

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

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

Возвращает

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

log()source публичный

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 публичный

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'.

toString()source публичный

toString( )

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

Возвращает

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

array()