Класс I18nShell

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

initdb()source public

initdb( )

Инициализация базы данных I18N.

main()source public

main( )

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

startup()source public

startup( )

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

Возвращает

mixed

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

Shell::startup()

__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/en/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( )

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

Возвращает

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 )

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

Параметры

строка $name

Имя

Возвращает

строка
Имя модели с применением camelize и singularize

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Множественное число для человекопонятного имени

_pluralName()source protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

string
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

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

Параметры

boolean $enable optional 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 )

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

Параметры

string $path

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

string $contents

Содержание, которое нужно поместить в файл.

Возвращает

boolean
Успех

Ссылка

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');

Возвращает

mixed
Результат работы другой оболочки.

Ссылка

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. Если параметры не переданы, выводится только новая строка.

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

Ссылка

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

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

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

Параметры

string $name

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

Возвращает

BaseShellHelper
Экземпляр класса помощника

Исключения

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

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

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

initialize()source public

initialize( )

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

Ссылка

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

loadModel()source public

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

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

Параметры

строка $modelClass необязательно null

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

смешанный тип $id необязательно null

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

Возвращает

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

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

Возвращает

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

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

shortPath()source public

shortPath( string $file )

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

Параметры

строка $file

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

Возвращает

строка
короткий путь

Ссылка

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.

Параметры

строка $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 protected

_set( array $properties array() )

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

Параметры

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

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

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

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

Возвращает

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

'default'

array('DbConfig', 'Extract')