Класс FixtureTask

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

_generateRecordssource protected

_generateRecords( array $tableInfo , integer $recordCount 1 )

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

Параметры

массив $tableInfo

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

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

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

Возвращает

array
Массив записей для использования в фикстуре.

_generateSchemasource protected

_generateSchema( array $tableInfo )

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

Параметры

массив $tableInfo

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

Возвращает

string
Определения полей

_getRecordsFromTablesource protected

_getRecordsFromTable( string $modelName , string $useTable null )

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

Параметры

строка $modelName

Имя модели, из которой брать записи.

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

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

Возвращает

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

_interactivesource protected

_interactive( )

Интерактивная функция выпечки

_makeRecordStringsource protected

_makeRecordString( array $records )

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

Параметры

массив $records

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

Возвращает

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

allsource public

all( )

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

bakesource public

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

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

Параметры

строка $model

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

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

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

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

Параметры для public $import

Возвращает

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

executesource public

execute( )

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

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

BakeTask::execute()

generateFixtureFilesource public

generateFixtureFile( string $model , string $otherVars )

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

Параметры

строка $model

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

строка $otherVars

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

Возвращает

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

getOptionParsersource public

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

getPathsource public

getPath( )

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

Возвращает

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

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

BakeTask::getPath()

importOptionssource public

importOptions( string $modelName )

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

Параметры

строка $modelName

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

Возвращает

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

startupsource public

startup( )

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

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

Shell::startup()

__getsource public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

Shell
Объект Task

__issetsource public

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestsource protected

_checkUnitTest( )

Действие по созданию модульного теста

Возвращает

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

initializesource public

initialize( )

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

Ссылка

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

loadModelsource public

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

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

Параметры

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

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

смешанное $id необязательно 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 )

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

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

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

Выполняет Shell с предоставленными 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.

Параметры

string $text

Текст для форматирования.

string|integer|array $options optional 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. Если вы хотите это отключить, переопределите этот метод как пустую функцию.

Параметры

array $properties

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

string $class

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

boolean $normalize optional true

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

_setsource protected

_set( array $properties array() )

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

Параметры

array $properties optional array()

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status optional 0

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

dispatchMethodsource public

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

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

Параметры

string $method

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

array $params optional array()

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

Возвращает

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

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Подробнее о записи в журналы см. CakeLog::write().

Параметры

string $msg

Сообщение журнала

integer $type optional LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

null|string|array $scope optional 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.

Параметры

string|array $url

Строка или массив URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

array $extra optional array()

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

string
Имя данного класса

null

null

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

null

false

null

array()

array()

null

null

array()

array()

array()