Класс ConsoleShell

_bind()source protected

_bind( mixed $command )

Привязать ассоциацию

Параметры

mixed $command

Команда для выполнения.

_columns()source protected

_columns( mixed $command )

Показать столбцы для модели

Параметры

mixed $command

Команда для выполнения.

_exit()source protected

_exit( )

Установить свойство finiished, чтобы цикл в методе main завершился

_find()source protected

_find( mixed $command )

Выполнить поиск

Параметры

mixed $command

Команда для выполнения.

_isValidModel()source protected

_isValidModel( string $modelToCheck )

Указывает, входит ли указанная модель в список доступных моделей

Параметры

string $modelToCheck

Модель для проверки.

Возвращает

_loadRoutes()source protected

_loadRoutes( )

Перезагружает конфигурацию маршрутов из app/Config/routes.php и компилирует все найденные маршруты

Возвращает

_method()source protected

_method( string $command )

Определить метод для обработки текущей команды

Параметры

string $command

Команда для выполнения.

Возвращает

_models()source protected

_models( )

Список всех моделей

_routeToArray()source protected

_routeToArray( mixed $command )

Разбор строкового URL и отображение в виде массива

Параметры

mixed $command

Команда для выполнения.

_routeToString()source protected

_routeToString( mixed $command )

Разбор массива URL и отображение эквивалентного URL в виде строки

Параметры

mixed $command

Команда для выполнения.

_routesReload()source protected

_routesReload( )

Перезагрузить определения маршрутов

_routesShow()source protected

_routesShow( )

Показать все маршруты

_save()source protected

_save( mixed $command )

Сохранить запись

Параметры

mixed $command

Команда для выполнения.

_unbind()source protected

_unbind( mixed $command )

Отвязать ассоциацию

Параметры

смешанный $command

Команда для выполнения.

getOptionParser()source public

getOptionParser( )

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

Возвращает

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

help()source public

help( )

Выводит сообщение справки

main()source public

main( string $command null )

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

Параметры

строка $command дополнительно null

Команда для выполнения.

startup()source public

startup( )

Переопределяет запуск Shell

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

__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 для стандартного ввода.

Ссылка

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

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTest()source protected

_checkUnitTest( )

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

Возвращает

_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 - массив, загружает каждую модель из массива

Возвращает

_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

Параметры

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

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

_welcome()source protected

_welcome( )

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

clear()source public

clear( )

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

Ссылка

createFile()source public

createFile( string $path , string $contents )

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

Параметры

string $path

Куда поместить файл.

string $contents

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

Возвращает

Ссылка

dispatchShell()source public

dispatchShell( )

Перенаправляет команду в другую оболочку. Аналогично Object::requestAction(), но предназначено для запуска оболочек из других оболочек.

Использование:

С строковой командой:

return $this->dispatchShell('schema create DbAcl');

Избегайте использования этой формы, если у вас есть строковые аргументы с пробелами в них. Запущенная оболочка будет вызвана неправильно. Используйте эту форму только для простого перенаправления команд.

С массивом команд:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

Возвращает

Ссылка

err()source public

err( string|array $message null , integer $newlines 1 )

Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не переданы, выводит только новую строку.

Параметры

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

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

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

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

Ссылка

error()source public

error( string $title , string $message null )

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

Параметры

string $title

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

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

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

Ссылка

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

Имя проверяемого метода.

Возвращает

Ссылка

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

Ссылка

helper()source public

helper( string $name )

Загрузить заданный класс помощника оболочки

Параметры

string $name

Имя класса помощника. Поддерживает синтаксис плагинов.

Возвращает

Исключения

hr()source public

hr( integer $newlines 0 , integer $width 63 )

Выводит серию символов минус в стандартный вывод, используется в качестве визуального разделителя.

Параметры

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

Количество новых строк для предварительного и последующего добавления

integer $width необязательный 63

Ширина строки, по умолчанию 63

Ссылка

in()source public

in( string $prompt , string|array $options null , string $default null )

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

Параметры

string $prompt

Текст приглашения.

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

Массив или строка вариантов.

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

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

Возвращает

Ссылка

initialize()source public

initialize( )

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

Ссылка

loadModel()source public

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

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

Параметры

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

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

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

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

Возвращает

Исключения

loadTasks()source public

loadTasks( )

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

Возвращает

nl()source public

nl( integer $multiplier 1 )

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

Параметры

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

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

Возвращает

Ссылка

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

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

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

Ссылка

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

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

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

runCommand()source public

runCommand( string $command , array $argv )

Выполняет оболочку с предоставленным argv.

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

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

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

Параметры

строка $command

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

массив $argv

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

Ссылка

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

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

Ссылка

wrapText()source public

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

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

Параметры

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

Параметры

строка $text

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

строка|целое число|массив $options необязательно массив()

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

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

См.

Ссылка

_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 protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

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

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

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

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.

Параметры

string|array $url

Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

array $extra optional array()

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

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

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

toString()source public

toString( )

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

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