Класс FixtureTask

__construct()source public

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

Переопределить инициализацию

Параметры

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

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

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

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

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

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

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

Shell::__construct()

_generateRecords()source protected

_generateRecords( array $tableInfo , integer $recordCount 1 )

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

Параметры

массив $tableInfo

Массив схемы таблицы

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

Количество записей для генерации.

Возвращает

массив
Массив записей, используемых в фикстуре.

_generateSchema()source protected

_generateSchema( array $tableInfo )

Генерирует строковое представление схемы.

Параметры

массив $tableInfo

Массив схемы таблицы

Возвращает

строка
Определения полей

_getRecordsFromTable()source protected

_getRecordsFromTable( string $modelName , string $useTable null )

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

Параметры

строка $modelName

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

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

Имя таблицы для использования.

Возвращает

массив
Массив записей.

_interactive()source protected

_interactive( )

Функция интерактивного выпекания

_makeRecordString()source protected

_makeRecordString( array $records )

Преобразовать массив $records в строку.

Параметры

массив $records

Массив записей, которые должны быть преобразованы в строку

Возвращает

строка
Строковое значение массива $records.

all()source public

all( )

Выпекать все фикстуры сразу. Будет выпекать фикстуры только для существующих моделей.

bake()source public

bake( string $model , string $useTable false , array $importOptions array() )

Собирает и записывает файл фикстуры

Параметры

строка $model

Имя модели для выпекания.

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

Имя таблицы для использования.

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

Опции для public $import

Возвращает

строка|null
Содержимое фикстуры, в противном случае null.

execute()source public

execute( )

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

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

BakeTask::execute()

generateFixtureFile()source public

generateFixtureFile( string $model , string $otherVars )

Генерирует файл фикстуры и записывает его на диск

Параметры

строка $model

Имя модели, которая генерируется

строка $otherVars

Содержимое файла фикстуры.

Возвращает

строка
Содержимое, сохранённое в файле фикстуры.

getOptionParser()source public

getOptionParser( )

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

Возвращает

ConsoleOptionParser

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

Shell::getOptionParser()

getPath()source public

getPath( )

Получить путь к фикстурам.

Возвращает

string
Путь к фикстурам

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

BakeTask::getPath()

importOptions()source public

importOptions( string $modelName )

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

Параметры

string $modelName

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

Возвращает

array
Массив параметров импорта.

startup()source public

startup( )

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

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

Shell::startup()

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

__isset()source public

__isset( string $name )

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

Параметры

string $name

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

_checkUnitTest()source protected

_checkUnitTest( )

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

Возвращает

boolean
Успех

_controllerName()source protected

_controllerName( string $name )

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

Параметры

string $name

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

Возвращает

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

_controllerPath()source protected

_controllerPath( string $name )

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

Параметры

string $name

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

Возвращает

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

_displayHelp()source protected

_displayHelp( string $command )

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

Параметры

string $command

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

_getInput()source protected

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

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

Параметры

string $prompt

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

string|array $options

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

string $default

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

Возвращает

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

_loadModels()source protected

_loadModels( )

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

Возвращает

boolean

_modelKey()source protected

_modelKey( string $name )

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

Параметры

string $name

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

Возвращает

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

_modelName()source protected

_modelName( string $name )

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

Параметры

string $name

Имя

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

string $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_pluralName()source protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

string
Имя

_useLogger()source protected

_useLogger( boolean $enable true )

Используется для включения или отключения вывода потока регистрации в stdout и stderr. Если вы не хотите видеть всё, что регистрируется через CakeLog, в stdout или stderr, вызовите эту функцию с первым параметром 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( )

Отправляет команду в другой Shell. Аналогично Object::requestAction(), но предназначено для запуска команд из других команд.

Использование:

С командной строкой:

return $this->dispatchShell('schema create DbAcl');

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

С массивом команд:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

Возвращает

mixed
Результат работы другого Shell.

Ссылка

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

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

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

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

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

Загружает указанный класс помощника Shell

Параметры

string $name

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

Возвращает

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

Выбрасывает

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

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

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

initialize()source public

initialize( )

Инициализирует Shell, служит конструктором для подклассов, позволяет настроить задачи до выполнения Shell

Ссылка

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

loadModel()source public

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

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

Параметры

string $modelClass optional null

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

mixed $id optional null

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

Возвращает

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

Выбрасывает

MissingModelException
если модель класса не найдена.

loadTasks()source public

loadTasks( )

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

Возвращает

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

integer $level optional Shell::NORMAL

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

Возвращает

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

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

Возвращает

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

param()source public

param( string $name )

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

Параметры

строка $name

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

Возвращает

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

runCommand()source public

runCommand( string $command , array $argv )

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

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

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

Если shell реализует метод main(), все недостающие вызовы методов будут отправлены в main() с исходным именем метода в argv.

Параметры

строка $command

Имя команды для выполнения в этом shell. Если этот аргумент пустой, и shell имеет метод main(), этот метод будет вызван вместо него.

массив $argv

Массив аргументов для выполнения shell. В этом массиве не должно быть имени shell.

Ссылка

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

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

Возвращает

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

null

null

array('DbConfig', 'Model', 'Template')