Класс ViewTask

_associations()source protected

_associations( Model $model )

Возвращает ассоциации для моделей контроллеров.

Параметры

Model $model

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

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

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

_interactive()source protected

_interactive( )

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

_loadController()source protected

_loadController( )

Загружает контроллер и устанавливает переменные для шаблона Доступные переменные шаблона 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'

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

массив
Возвращает переменные, доступные в шаблоне представления

_methodsToBake()source protected

_methodsToBake( )

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

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

массив
Массив имён действий, которые следует создать

all()source public

all( )

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

bake()source public

bake( string $action , string $content '' )

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

Параметры

строка $action

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

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

Содержимое для записи

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

булево
Успех

bakeActions()source public

bakeActions( array $actions , array $vars )

Создаёт файл представления для каждого из переданных действий

Параметры

массив $actions

Массив действий, для которых необходимо создать файлы.

массив $vars

Переменные шаблона.

customAction()source public

customAction( )

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

execute()source public

execute( )

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

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

смешанный

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

BakeTask::execute()

getContent()source public

getContent( string $action , array $vars null )

Создаёт содержимое из шаблона и переменных

Параметры

строка $action

имя для генерации содержимого

массив $vars необязательно null

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

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

строка
содержимое из шаблона

getOptionParser()source public

getOptionParser( )

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

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

ConsoleOptionParser

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

Shell::getOptionParser()

getTemplate()source public

getTemplate( string $action )

Получает имя шаблона на основе имени действия

Параметры

строка $action

имя

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

строка
имя шаблона

initialize()source public

initialize( )

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

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

Shell::initialize()

getPath()source public

getPath( )

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

Возвращает

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

startup()source public

startup( )

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

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

Shell::startup()

__construct()source public

__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/ru/console-and-shells.html#Shell

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

Object::__construct()

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

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

Параметры

string $name

Имя

Возвращает

string
Имя модели, преобразованное в camelCase и приведённое к единственному числу

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

Используется для включения или отключения вывода логов в стандартный вывод и стандартный поток ошибок. Если вы не хотите видеть все, что записывается через 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 )

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

Параметры

строка $path

Куда поместить файл.

строка $contents

Содержимое файла.

Возвращает

boolean
Успех

Ссылка

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

dispatchShell()source public

dispatchShell( )

Передать команду другому Shell. Похоже на Object::requestAction(), но предназначено для запуска команд shell из других shell.

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

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

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

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

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

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

Параметры

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

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

целое число $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.

Параметры

строка $title

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

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

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

Ссылка

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

hasMethod()source public

hasMethod( string $name )

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

Параметры

строка $name

Имя проверяемого метода.

Возвращает

boolean

Ссылка

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

hasTask()source public

hasTask( string $task )

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

Параметры

строка $task

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

Возвращает

boolean
Успех

Ссылка

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

helper()source public

helper( string $name )

Загрузка заданного класса помощника shell

Параметры

строка $name

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

Возвращает

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

Исключения

RuntimeException
Если имя класса недействительно

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

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

loadModel()source public

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

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

Параметры

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

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

смешанный $id необязательно null

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

Возвращает

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

Исключения

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

loadTasks()source public

loadTasks( )

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

Возвращает

boolean

nl()source public

nl( integer $multiplier 1 )

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

Параметры

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

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

Возвращает

строка

Ссылка

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

Параметры

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

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

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

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

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

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

Возвращает

целое число|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

array('delete')

null

array('index', 'view', 'add', 'edit')

array('Project', 'Controller', 'DbConfig', 'Template')

null