Класс ModelTask

_generatePossibleKeysисходный код защищённый

_generatePossibleKeys( )

Находит все возможные ключи для использования в пользовательских ассоциациях.

Возвращает

array
Массив таблиц и возможных ключей

_getModelObjectисходный код защищённый

_getModelObject( string $className , string $table null )

Получение объекта модели для имени класса.

Параметры

строка $className

Имя класса, для которого требуется модель.

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

Имя таблицы

Возвращает

Model
Экземпляр модели

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

_interactive( )

Обработка интерактивного создания

Возвращает

boolean
логическое значение

_printAssociationисходный код защищённый

_printAssociation( string $modelName , string $type , string $associations )

Вывод всех ассоциаций определенного типа.

Параметры

строка $modelName

Имя модели, к которой относятся отношения.

строка $type

Имя ассоциации, которое нужно отобразить. Например, 'belongsTo'

строка $associations

Коллекция ассоциаций.

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

all( )

Одновременное создание всех моделей.

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

bake( string|object $name , array|boolean $data array() )

Сборка и запись файла модели.

Параметры

строка|объект $name

Имя модели или объект

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

если массив и $name не является объектом, предполагается данные для выпечки, в противном случае логическое значение.

Возвращает

string
строка

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

bakeFixture( string $className , string $useTable null )

Взаимодействие с FixtureTask для автоматического создания фикстур при создании моделей.

Параметры

строка $className

Имя класса для создания фикстуры

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

Необязательное имя таблицы для использования фикстурой.

См.

FixtureTask::bake()

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

bakeTest( string $className )

Сборка и запись файла теста единиц.

Параметры

строка $className

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

Возвращает

string
строка

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

confirmAssociations( Model $model , array $associations )

Взаимодействие с пользователем и подтверждение ассоциаций.

Параметры

Model $model

Временный экземпляр модели.

массив $associations

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

Возвращает

array
Массив подтвержденных ассоциаций

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

doActsAs( Model $model )

Обработка поведения.

Параметры

Model $model

Объект модели.

Возвращает

array
Поведения

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

doAssociations( Model $model )

Обработка ассоциаций.

Параметры

Model $model

Объект модели

Возвращает

array
Ассоциации

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

doMoreAssociations( Model $model , array $associations )

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

Параметры

Model $model

Временный экземпляр модели

массив $associations

Массив ассоциаций.

Возвращает

array
Массив ассоциаций.

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

doValidation( Model $model )

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

Параметры

Model $model

Модель, для которой нужно сгенерировать валидацию.

Возвращает

array
массив валидации Массив выбранных пользователем валидаций.

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

execute( )

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

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

BakeTask::execute()

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

fieldValidation( string $fieldName , array $metaData , string $primaryKey 'id' )

Обработка валидации отдельных полей.

Параметры

строка $fieldName

Имя поля, которое нужно валидировать.

массив $metaData

метаданные поля

строка $primaryKey необязательно 'id'

Поле первичного ключа.

Возвращает

array
Массив валидации для поля.

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

findBelongsTo( Model $model , array $associations )

Поиск отношений belongsTo и добавление их в список ассоциаций.

Параметры

Model $model

Экземпляр модели, для которой генерируется модель.

массив $associations

Массив текущих ассоциаций

Возвращает

array
Ассоциации с добавленными belongsTo.

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

findDisplayField( array $fields )

Взаимодействие с пользователем для определения значения displayField для модели.

Параметры

массив $fields

Массив полей для поиска и выбора как displayField

Возвращает

mixed
Имя поля для использования в displayField или false, если пользователь отказался от выбора

findHasAndBelongsToManysource public

findHasAndBelongsToMany( Model $model , array $associations )

Находит отношения hasAndBelongsToMany и добавляет их в список ассоциаций

Параметры

Model $model

Экземпляр модели, который генерируется

массив $associations

Массив текущих ассоциаций

Возвращает

array
Ассоциации с добавленными hasAndBelongsToMany.

findHasOneAndManysource public

findHasOneAndMany( Model $model , array $associations )

Находит отношения hasOne и hasMany и добавляет их в список ассоциаций

Параметры

Model $model

Экземпляр модели, который генерируется

массив $associations

Массив текущих ассоциаций

Возвращает

array
Ассоциации с добавленными hasOne и hasMany.

findPrimaryKeysource public

findPrimaryKey( array $fields )

Находит первичный ключ в списке полей.

Параметры

массив $fields

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

Возвращает

string
Имя поля, являющегося первичным ключом.

getAllTablessource public

getAllTables( string $useDbConfig null )

Возвращает массив всех таблиц в указанном соединении. Прекращает выполнение скрипта, если таблицы не найдены.

Параметры

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

Имя подключения для сканирования.

Возвращает

array
Массив таблиц в базе данных.

getNamesource public

getName( string $useDbConfig null )

Принуждает пользователя указать модель, которую он хочет создать, и возвращает выбранное имя модели.

Параметры

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

Имя конфигурации базы данных

Возвращает

string
Имя модели

getOptionParsersource public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

getTablesource public

getTable( string $modelName , string $useDbConfig null )

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

Параметры

строка $modelName

Имя модели, для которой нужна таблица.

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

Имя конфигурации базы данных для получения таблиц.

Возвращает

string
Имя таблицы

inOptionssource public

inOptions( array $options , string $prompt null , integer $default null )

Генерирует список опций и запрос.

Параметры

массив $options

Массив опций для выбора. Индексы должны начинаться с 0.

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

Запрос для списка опций.

целое число $default необязательно null

Значение по умолчанию для данного запроса.

Возвращает

integer
Результат выбора пользователя.

initValidationssource public

initValidations( )

Заполняет массив _validations

initializesource public

initialize( )

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

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

Shell::initialize()

listAllsource public

listAll( string $useDbConfig null )

Выводит список возможных моделей или контроллеров из базы данных

Параметры

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

Имя конфигурации базы данных

Возвращает

array
массив

getPathsource public

getPath( )

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

Возвращает

string
Путь вывода.

startupsource public

startup( )

Отключает кэширование и включает отладку для создания. Это заставляет использовать самую последнюю схему базы данных.

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

Shell::startup()

__constructsource public

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

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

Параметры

ConsoleOutput $stdout необязательно null

Объект ConsoleOutput для вывода stdout.

ConsoleOutput $stderr необязательно null

Объект ConsoleOutput для вывода stderr.

ConsoleInput $stdin необязательно null

Объект ConsoleInput для ввода stdin.

Ссылка

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

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

Object::__construct()

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__issetsource public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestsource protected

_checkUnitTest( )

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

Возвращает

boolean
Успех

_controllerNamesource protected

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathsource protected

_controllerPath( string $name )

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

Параметры

строка $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

строка $command

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

_getInputsource protected

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

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

Параметры

строка $prompt

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

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

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

строка $default

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

Возвращает

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

_loadModelssource protected

_loadModels( )

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

Возвращает

boolean
bool

_modelKeysource protected

_modelKey( string $name )

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

Параметры

строка $name

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

Возвращает

string
Единственное имя ключа модели

_modelNamesource protected

_modelName( string $name )

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

Параметры

строка $name

Имя

Возвращает

string
Имя модели с верблюжьей нотацией и единственным числом

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularHumanNamesource 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

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 )

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

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

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

Ссылка

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

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

Массив опций для использования или целое число, до которого нужно обрезать текст.

Возвращает

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

array()

array()

null

array('i18n')

array('DbConfig', 'Fixture', 'Test', 'Template')

null

false

null

array()

array()

null

null

array()

array()

array()