Класс DbConfigTask

_interactive()исходный код защищенное

_interactive( )

Интерактивный интерфейс

_verify()исходный код защищенное

_verify( array $config )

Вывод сообщения о проверке и выпечка, если все хорошо

Параметры

массив $config

Данные конфигурации.

Возвращает

boolean
True, если пользователь подтверждает, что все хорошо, иначе false

bake()исходный код общедоступное

bake( array $configs )

Сборка и запись database.php

Параметры

массив $configs

Настройки конфигурации для использования

Возвращает

boolean
Успех

execute()исходный код общедоступное

execute( )

Метод выполнения, всегда используемый для задач

getConfig()исходный код общедоступное

getConfig( )

Получение указанного пользователем имени соединения

getOptionParser()исходный код общедоступное

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

initialize()исходный код общедоступное

initialize( )

Обратный вызов инициализации

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

Shell::initialize()

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

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

Возвращает

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

_controllerPath()исходный код защищенное

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

строка
Путь к контроллеру

_displayHelp()исходный код защищенное

_displayHelp( string $command )

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

Параметры

строка $command

Команда, для которой нужно получить справку.

_getInput()исходный код защищенное

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

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

Параметры

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

Параметры

логический $enable необязательно 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 )

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

Параметры

строка $path

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

строка $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');

Возвращает

смешанное
Результат работы другой оболочки.

Ссылка

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

Параметры

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

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

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

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

Ссылка

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

error()source public

error( string $title , string $message null )

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

Параметры

строка $title

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

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

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

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

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

Параметры

строка $name

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

Возвращает

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

Исключения

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

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

in()source public

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

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

Параметры

строка $prompt

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

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

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

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

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

Возвращает

смешанный тип
Значение по умолчанию или введённое пользователем.

Ссылка

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

Количество байтов для перезаписи. По умолчанию равно длине последнего выведенного сообщения.

Возвращает

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

param()source public

param( string $name )

Безопасно получает значения из $this->params.

Параметры

строка $name

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

Возвращает

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

runCommand()source public

runCommand( string $command , array $argv )

Выполняет Shell с предоставленным argv.

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

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

Если shell реализует метод 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

startup()source public

startup( )

Запускает Shell и отображает приветственное сообщение. Позволяет проверять и настраивать перед выполнением команды или основного действия

Переопределите этот метод, если вы хотите удалить приветственную информацию или каким-либо образом изменить предварительный поток команды.

Ссылка

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

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 защищенное

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства этого объекта $property со свойством в определении $class. Значение свойства этого класса будет объединено поверх значения $class.

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source защищенное

_set( array $properties array() )

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

Параметры

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

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

_stop()source защищенное

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source публичный

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

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

Параметры

строка $method

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

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

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

Возвращает

mixed
Возвращает результат вызова метода

log()source публичный

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 публичный

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

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

Возвращает

mixed

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

toString()source публичный

toString( )

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

Возвращает

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

array(
    'name' => 'default',
    'datasource' => 'Database/Mysql',
    'persistent' => 'false',
    'host' => 'localhost',
    'login' => 'root',
    'password' => 'password',
    'database' => 'project_name',
    'schema' => null,
    'prefix' => null,
    'encoding' => null,
    'port' => null
)

'DATABASE_CONFIG'

null