Класс DbConfigTask

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

_interactive( )

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

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

_verify( array $config )

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

Параметры

массив $config

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

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

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

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

bake( array $configs )

Собирает и записывает database.php

Параметры

массив $configs

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

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

boolean
Успех

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

execute( )

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

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

getConfig( )

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

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

getOptionParser( )

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

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

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

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

initialize( )

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

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

Shell::initialize()

__constructисходный код общедоступный

__construct( ConsoleOutput $stdout null , ConsoleOutput $stderr null , ConsoleInput $stdin null )

Создаёт экземпляр этого объекта Shell.

Параметры

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
Объект Task

__issetисходный код общедоступный

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestисходный код защищенное

_checkUnitTest( )

Действие для создания Unit Test

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

boolean
Успех

_controllerNameисходный код защищенное

_controllerName( string $name )

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

Параметры

строка $name

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

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

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

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

_controllerPath( string $name )

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

Параметры

строка $name

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

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

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

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

_displayHelp( string $command )

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

Параметры

строка $command

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

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

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

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

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

_loadModelsисходный код защищенное

_loadModels( )

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

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

boolean
Булево значение

_modelKeyисходный код защищенное

_modelKey( string $name )

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

Параметры

строка $name

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

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

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

_modelNameисходный код защищенное

_modelName( string $name )

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

Параметры

строка $name

Имя

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

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

_modelNameFromKeyисходный код защищенное

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

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

string
Имя модели

_pluginPathисходный код защищенное

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

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

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularNamesource protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

string
имя

_useLoggersource protected

_useLogger( boolean $enable true )

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

Параметры

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

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

integer $newlines optional 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 optional null

Дополнительное сообщение об ошибке

Ссылка

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

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 optional 0

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

integer $width optional 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 optional null

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

string $default optional null

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

Возвращает

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

Ссылка

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

loadModelsource public

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

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

Параметры

string $modelClass optional null

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

mixed $id optional null

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

Возвращает

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

Параметры

строка|массив $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

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.

Это обеспечивает некоторую 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 необязательный array()

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

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

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

toStringsource public

toString( )

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

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

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

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

array()

array()

true

null

null

array()

null

array()

array()

array()