Класс ViewTask

_associationsисходный код защищенное

_associations( Model $model )

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

Параметры

Model $model

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

Возвращает

array
ассоциации

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

_interactive( )

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

_loadControllerисходный код защищенное

_loadController( )

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

Возвращает

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

_methodsToBakeисходный код защищенное

_methodsToBake( )

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

Возвращает

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

allисходный код публичное

all( )

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

bakeисходный код публичное

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

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

Параметры

строка $action

Действие для выпечки

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

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

Возвращает

boolean
Успешно

bakeActionsисходный код публичное

bakeActions( array $actions , array $vars )

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

Параметры

массив $actions

Массив действий для создания файлов.

массив $vars

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

customActionисходный код публичное

customAction( )

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

executeисходный код публичное

execute( )

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

Возвращает

mixed
смешанный

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

BakeTask::execute()

getContentисходный код публичное

getContent( string $action , array $vars null )

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

Параметры

строка $action

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

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

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

Возвращает

string
содержимое шаблона

getOptionParserисходный код публичное

getOptionParser( )

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

Возвращает

ConsoleOptionParser
ConsoleOptionParser

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

Shell::getOptionParser()

getTemplateисходный код публичное

getTemplate( string $action )

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

Параметры

строка $action

имя

Возвращает

string
имя шаблона

initializeисходный код публичное

initialize( )

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

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

Shell::initialize()

getPathисходный код публичное

getPath( )

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

Возвращает

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

startupисходный код публичное

startup( )

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

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

Shell::startup()

__constructисходный код публичное

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

Создаёт экземпляр этой оболочки.

Параметры

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исходный код публичное

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

__issetисходный код публичное

__isset( string $name )

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

Параметры

строка $name

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

_checkUnitTestисходный код защищенное

_checkUnitTest( )

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

Возвращает

boolean
Успешно

_controllerNameисходный код защищенное

_controllerName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_controllerPathsource protected

_controllerPath( string $name )

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

Параметры

string $name

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

Возвращает

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

_displayHelpsource protected

_displayHelp( string $command )

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

Параметры

string $command

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

_getInputsource protected

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

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

Параметры

string $prompt

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

string|array $options

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

string $default

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

Возвращает

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

_loadModelssource protected

_loadModels( )

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

Возвращает

boolean
bool

_modelKeysource protected

_modelKey( string $name )

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

Параметры

string $name

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

Возвращает

string
Единичный ключ модели

_modelNamesource protected

_modelName( string $name )

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

Параметры

string $name

Имя

Возвращает

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

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

string $pluginName

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

Возвращает

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Множественное имя

_pluralNamesource protected

_pluralName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularNamesource protected

_singularName( string $name )

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

Параметры

string $name

Значение множественного числа с нижним подчеркиванием.

Возвращает

string
Имя

_useLoggersource protected

_useLogger( boolean $enable true )

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

Параметры

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

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

Параметры

string $path

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

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

Параметры

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

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

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

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

Ссылка

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

errorsource 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

hasMethodsource public

hasMethod( string $name )

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

Параметры

string $name

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

Возвращает

boolean
bool

Ссылка

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

hasTasksource public

hasTask( string $task )

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

Параметры

string $task

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

Возвращает

boolean
Успех

Ссылка

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

hrsource 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

insource 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

loadModelsource public

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

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

Параметры

string $modelClass optional null

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

mixed $id optional null

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

Возвращает

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

Выбрасывает

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

loadTaskssource public

loadTasks( )

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

Возвращает

boolean
bool

nlsource public

nl( integer $multiplier 1 )

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

Параметры

integer $multiplier optional 1

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

Возвращает

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

Параметры

string|array $message optional null

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

integer $newlines optional 1

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

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

Перезаписывает уже выведенный текст.

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

Предупреждение Нельзя перезаписывать текст, содержащий новые строки.

Параметры

array|string $message

Сообщение для вывода.

integer $newlines optional 1

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

integer $size optional null

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

Возвращает

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

paramsource public

param( string $name )

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

Параметры

string $name

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

Возвращает

string|boolean|null
Значение. Вернет null, если параметр не существует.

runCommandsource public

runCommand( string $command , array $argv )

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

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

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

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

Параметры

string $command

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

array $argv

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

Ссылка

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

shortPathsource public

shortPath( string $file )

Делает абсолютный путь к файлу более читаемым

Параметры

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

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

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

Список параметров для использования при вызове $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 необязательно массив()

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

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

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

toStringsource public

toString( )

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

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

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

null

array('delete')

null

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

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

null

null

false

null

array()

array()

null

null

array()

array()

array()