Класс AppShell

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

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__issetsource public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestsource protected

_checkUnitTest( )

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

Возвращает

boolean
Успешно

_controllerNamesource protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathsource protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputsource protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModelssource protected

_loadModels( )

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

Возвращает

boolean
логическое значение

_modelKeysource protected

_modelKey( string $name )

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

Параметры

строка $name

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

Возвращает

string
Единичное имя модели

_modelNamesource protected

_modelName( string $name )

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

Параметры

строка $name

Имя

Возвращает

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

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

строка $name

Используемое имя

Возвращает

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

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularNamesource protected

_singularName( string $name )

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

Параметры

строка $name

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

Возвращает

string
имя

_useLoggersource protected

_useLogger( boolean $enable true )

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

getOptionParsersource public

getOptionParser( )

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

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

Ссылка

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

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

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

Возвращает

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

Выбрасывает

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

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

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

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

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

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'

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

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

Список параметров для использования при вызове $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()

true

null

null

array()

null

array()

array()

array()