Класс I18nShell

getOptionParserисходный код public

getOptionParser( )

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

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

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

initdbисходный код public

initdb( )

Инициализирует базу данных I18N.

mainисходный код public

main( )

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

startupисходный код public

startup( )

Переопределяет запуск оболочки.

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

mixed
смешанный тип

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

Shell::startup()

__constructисходный код 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исходный код public

__get( string $name )

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

Параметры

строка $name

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

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

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

__issetисходный код public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestисходный код protected

_checkUnitTest( )

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

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

boolean
Успешно

_controllerNameисходный код protected

_controllerName( string $name )

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

Параметры

строка $name

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

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

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

_controllerPathисходный код protected

_controllerPath( string $name )

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

Параметры

строка $name

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

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

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

_displayHelpисходный код protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputисходный код protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

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

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

_loadModelsисходный код protected

_loadModels( )

Если $uses является массивом, загружаются все модели из массива.

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

boolean
bool

_modelKeyисходный код protected

_modelKey( string $name )

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

Параметры

строка $name

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

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

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

_modelNameисходный код protected

_modelName( string $name )

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

Параметры

строка $name

Имя

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

string
Имена модели с использованием camelize и в единственном числе

_modelNameFromKeyисходный код protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

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

string
Имя модели

_pluginPathисходный код protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

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

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

_pluralHumanNameисходный код protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

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

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

_pluralNameисходный код protected

_pluralName( string $name )

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

Параметры

строка $name

Имя для использования

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

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

_singularHumanNameисходный код 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

Параметры

логическое значение $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 )

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

Параметры

строка $path

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

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

Параметры

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

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

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

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

Ссылка

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

errorsource public

error( string $title , string $message null )

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

Параметры

строка $title

Название ошибки

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

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

Ссылка

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

hasMethodsource public

hasMethod( string $name )

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

Параметры

строка $name

Имя метода для проверки.

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource 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

insource 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

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 )

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

Параметры

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

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

смешанное $id необязательно 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 )

Выводит одно или несколько сообщений в stdout. Если параметры не переданы, выводится только перевод строки.

Уровни вывода

Существует 3 встроенных уровня вывода. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. Уровни вывода verbose и quiet соответствуют переключателям вывода verbose и quiet в большинстве оболочек. Использование Shell::QUIET для сообщения означает, что оно всегда будет отображаться. Использование Shell::VERBOSE означает, что оно будет отображаться только при включённом verbose выводе.

Параметры

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

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

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

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

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

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

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

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

Ссылка

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
Возвращает количество байтов, возвращённых при записи в stdout.

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

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

Это обеспечивает часть магии DRY, предоставляемой 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
Имя этого класса

'default'

array('DbConfig', 'Extract')

array()

array()

true

null

null

array()

null

array()

array()