Класс ModelTask

_generatePossibleKeys()source protected

_generatePossibleKeys( )

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

Возвращает

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

_getModelObject()source protected

_getModelObject( string $className , string $table null )

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

Параметры

строка $className

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

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

Имя таблицы

Возвращает

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

_interactive()source protected

_interactive( )

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

Возвращает

boolean

_printAssociation()source protected

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

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

Параметры

строка $modelName

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

строка $type

Имя ассоциации, которую вы хотите увидеть. Например, 'belongsTo'

строка $associations

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

all()source public

all( )

Создает все модели сразу.

bake()source public

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

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

Параметры

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

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

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

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

Возвращает

строка

bakeFixture()source public

bakeFixture( string $className , string $useTable null )

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

Параметры

строка $className

Имя класса, для которого необходимо создать фикстуру

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

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

См. также

FixtureTask::bake

bakeTest()source public

bakeTest( string $className )

Собирает и записывает файл теста модуля.

Параметры

строка $className

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

Возвращает

строка

confirmAssociations()source public

confirmAssociations( Model $model , array $associations )

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

Параметры

Model $model

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

массив $associations

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

Возвращает

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

doActsAs()source public

doActsAs( Model $model )

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

Параметры

Model $model

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

Возвращает

массив
Поведения

doAssociations()source public

doAssociations( Model $model )

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

Параметры

Model $model

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

Возвращает

массив
Ассоциации

doMoreAssociations()source public

doMoreAssociations( Model $model , array $associations )

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

Параметры

Model $model

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

массив $associations

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

Возвращает

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

doValidation()source public

doValidation( Model $model )

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

Параметры

Model $model

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

Возвращает

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

execute()source public

execute( )

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

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

BakeTask::execute()

fieldValidation()source public

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

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

Параметры

строка $fieldName

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

массив $metaData

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

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

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

Возвращает

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

findBelongsTo()source public

findBelongsTo( Model $model , array $associations )

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

Параметры

Model $model

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

массив $associations

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

Возвращает

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

findDisplayField()source public

findDisplayField( array $fields )

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

Параметры

массив $fields

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

Возвращает

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

findHasAndBelongsToMany()source public

findHasAndBelongsToMany( Model $model , array $associations )

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

Параметры

Model $model

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

массив $associations

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

Возвращает

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

findHasOneAndMany()source public

findHasOneAndMany( Model $model , array $associations )

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

Параметры

Model $model

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

массив $associations

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

Возвращает

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

findPrimaryKey()source public

findPrimaryKey( array $fields )

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

Параметры

массив $fields

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

Возвращает

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

getAllTables()source public

getAllTables( string $useDbConfig null )

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

Параметры

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

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

Возвращает

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

getName()source public

getName( string $useDbConfig null )

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

Параметры

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

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

Возвращает

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

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

getTable()source public

getTable( string $modelName , string $useDbConfig null )

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

Параметры

строка $modelName

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

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

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

Возвращает

строка
Имя таблицы

inOptions()source public

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

Генерирует список параметров с ключом и значением и запрос.

Параметры

массив $options

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

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

Запрос для использования со списком параметров.

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

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

Возвращает

целое число
Результат выбора пользователя.

initValidations()source public

initValidations( )

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

initialize()source public

initialize( )

Переопределить initialize

Overrides

Shell::initialize()

listAll()source public

listAll( string $useDbConfig null )

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

Parameters

string $useDbConfig optional null

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

Returns

array

getPath()source public

getPath( )

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

Returns

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

startup()source public

startup( )

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

Overrides

Shell::startup()

__construct()source public

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

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

Parameters

ConsoleOutput $stdout optional null

Объект ConsoleOutput для стандартного вывода.

ConsoleOutput $stderr optional null

Объект ConsoleOutput для стандартного потока ошибок.

ConsoleInput $stdin optional null

Объект ConsoleInput для стандартного ввода.

Link

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

Overrides

Object::__construct()

__get()source public

__get( string $name )

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

Parameters

string $name

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

Returns

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

__isset()source public

__isset( string $name )

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

Parameters

string $name

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

_checkUnitTest()source protected

_checkUnitTest( )

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

Returns

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

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

Parameters

string $name

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

Returns

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

_controllerPath()source protected

_controllerPath( string $name )

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

Parameters

string $name

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

Returns

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

_displayHelp()source protected

_displayHelp( string $command )

Выводит справку в правильном формате

Parameters

string $command

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

_getInput()source protected

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

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

Parameters

string $prompt

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

string|array $options

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

string $default

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

Returns

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

_loadModels()source protected

_loadModels( )

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

Returns

boolean

_modelKey()source protected

_modelKey( string $name )

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

Parameters

string $name

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

Returns

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

_modelName()source protected

_modelName( string $name )

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

Parameters

string $name

Имя

Returns

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Parameters

string $key

Внешний ключ

Returns

string
Имя модели

_pluginPath()source protected

_pluginPath( string $pluginName )

Находит правильный путь к плагину. Ищет в $pluginPaths плагин, который требуется.

Parameters

string $pluginName

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

Returns

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Parameters

string $name

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

Returns

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

_pluralName()source protected

_pluralName( string $name )

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

Parameters

string $name

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

Returns

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Parameters

string $name

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

Returns

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

_singularName()source protected

_singularName( string $name )

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

Parameters

string $name

Множественное подчеркнутое значение.

Returns

string
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

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

Параметры

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

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

Параметры

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

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

integer $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

Параметры

string $title

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

string $message необязательно 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 необязательно 0

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

integer $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 )

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

Параметры

string $prompt

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

string|array $options необязательно null

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

string $default необязательно null

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

Возвращает

mixed
Либо значение по умолчанию, либо введенные пользователем данные.

Ссылка

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

loadModel()source public

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

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

Параметры

string $modelClass необязательно null

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

mixed $id необязательно null

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

Возвращает

mixed
true, если найдена единственная модель и создан экземпляр; возвращает ошибку, если модель не найдена.

Выбрасывает

MissingModelException
если класс модели не может быть найден.

loadTasks()source public

loadTasks( )

Загружает задачи, определенные в public $tasks

Возвращает

boolean

nl()source public

nl( integer $multiplier 1 )

Возвращает последовательность одной или нескольких новой строки.

Параметры

integer $multiplier необязательно 1

Количество повторений последовательности новой строки

Возвращает

string

Ссылка

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 )

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

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

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

Возвращает

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

param()source public

param( string $name )

Безопасный доступ к значениям в $this->params.

Параметры

строка $name

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

Возвращает

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

Массив параметров или целое число для обрезки текста.

Возвращает

строка
Обрезанный/отступленный текст

См. также

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

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

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

Список параметров для использования при вызове $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() для получения дополнительной информации об областях ведения журналов.

Возвращает

логическое значение
Успех записи в журнал

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 и именованных/переданных аргументов.

Возвращает

смешанное

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

toString()source public

toString( )

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

Возвращает

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

array()

array()

array()

null

array('i18n')

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