Класс ApiShell

_parseClassисходный код защищенное

_parseClass( string $path , string $class )

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

Параметры

строка $path

Путь к файлу

строка $class

Имя класса

Возвращает

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

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

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

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

help( )

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

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

initialize( )

Переопределяет инициализацию оболочки.

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

Shell::initialize()

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

main( )

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

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

__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исходный код публичное

__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
Камелизаванное и единственное имя модели

_modelNameFromKeyисходный код защищенное

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathисходный код защищенное

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

string
путь к нужному плагину.

_pluralHumanNameисходный код защищенное

_pluralHumanName( string $name )

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

Параметры

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

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 )

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

Параметры

string $prompt

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

string|array $options optional null

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

string $default optional null

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

Возвращает

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

Ссылка

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

loadModelsource public

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

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

Параметры

string $modelClass optional null

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

mixed $id optional 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 необязательно массив()

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

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

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
Название этого класса

array()

array()

array()

true

null

null

array()

null

array()

array()

array()