Класс ScaffoldView

_getViewFileName()source protected

_getViewFileName( string $name null )

Переопределяет _getViewFileName Добавляет специальные представления scaffolding в.

Параметры

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

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

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

строка
действие

Исключения

MissingViewException

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

View::_getViewFileName()

__construct()source public

__construct( Controller $controller null )

Конструктор

Параметры

Controller $controller необязательно null

Объект контроллера для получения View::_passedVars.

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

Object::__construct()

__get()source public

__get( string $name )

Магический аксессор для хелперов. Предоставляет доступ к атрибутам, которые были устаревшими.

Параметры

string $name

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

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

смешанное

__isset()source public

__isset( string $name )

Магическая проверка isset для устаревших атрибутов.

Параметры

string $name

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

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

логическое

__set()source public

__set( string $name , mixed $value )

Магический аксессор для устаревших атрибутов.

Параметры

string $name

Имя атрибута для установки.

смешанное $value

Значение атрибута для установки.

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

смешанное

_elementCache()source protected

_elementCache( string $name , string $data , array $options )

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

Параметры

string $name

Имя элемента

string $data

Данные

массив $options

Опции элемента

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

строка|null

_evaluate()source protected

_evaluate( string $viewFile , array $dataForView )

Метод-песочница для оценки шаблона/скрипта представления.

Параметры

string $viewFile

Имя файла представления

массив $dataForView

Данные для включения в отрисованное представление. Если пусто, используются текущие View::$viewVars.

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

строка
Выведенный вывод

_getElementFileName()source protected

_getElementFileName( string $name )

Ищет имя файла элемента, возвращает false при неудаче.

Параметры

string $name

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

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

смешанное
Имя файла элемента или false, если файл не найден.

_getExtensions()source protected

_getExtensions( )

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

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

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

_getLayoutFileName()source protected

_getLayoutFileName( string $name null )

Возвращает имя файла макета для этого шаблона в виде строки.

Параметры

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

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

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

строка
Имя файла файла макета (.ctp).

Исключения

MissingLayoutException
при невозможности найти макет

_paths()source protected

_paths( string $plugin null , boolean $cached true )

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

Параметры

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

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

boolean $cached необязательно true

Установите в false, чтобы принудительно обновить пути к представлениям. По умолчанию true.

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

массив
пути

_render()source protected

_render( string $viewFile , array $data array() )

Отображает и возвращает вывод для заданного имени файла представления с его массивом данных. Обрабатывает родительские/расширенные представления.

Параметры

string $viewFile

Имя файла представления

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

Данные для включения в отрисованное представление. Если пусто, используются текущие View::$viewVars.

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

строка
Выведенный вывод

Исключения

CakeException
при оставленном блоке открытым.

Вызывает

View.beforeRenderFile $this, array($viewFile)
View.afterRenderFile $this, array($viewFile, $content)

_renderElement()source protected

_renderElement( string $file , array $data , array $options )

Отрисовывает элемент и вызывает обратные вызовы before и afterRender для него, записывает в кэш, если используется кэш.

Параметры

string $file

Путь к файлу элемента

массив $data

Данные для отрисовки

массив $options

Опции элемента

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

строка

Вызывает

View.beforeRender $this, array($file)
View.afterRender $this, array($file, $element)

addScript()source public

addScript( string $name , string $content null )

Добавляет блок скрипта или другой элемент для вставки в $scripts_for_layout в <head /> макете документа.

Параметры

строка $name

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

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

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

См. также

View::start()

append()source public

append( string $name , mixed $value null )

Добавляет содержимое в существующий или новый блок. Добавление в новый блок создаст блок.

Параметры

строка $name

Имя блока

смешанное $value необязательно null

Содержимое блока.

См. также

ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

Устанавливает содержимое блока. Это перезапишет любое существующее содержимое.

Параметры

строка $name

Имя блока

смешанное $value

Содержимое блока.

См. также

ViewBlock::set()

blocks()source public

blocks( )

Получает имена всех существующих блоков.

Возвращает

массив
Массив, содержащий блоки.

См. также

ViewBlock::keys()

element()source public

element( string $name , array $data array() , array $options array() )

Отображает фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или любую другую строку.

Реализует концепцию элементов (или «частичных макетов»), а массив $params используется для передачи данных, которые будут использованы в элементе. Элементы могут быть кэшированы, улучшая производительность, используя параметр cache.

Параметры

строка $name

Имя файла шаблона в папке /app/View/Elements/, или MyPlugin.template для использования шаблона элемента из MyPlugin. Если элемент не найден в плагине, будет выполнено обычное поиск по цепочке путей.

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

Массив данных, которые должны быть доступны для рендеринга представления (т.е. элемента).

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

Массив опций. Возможные ключи: - cache - Может быть true, для включения кэширования с использованием конфигурации в View::$elementCache. Или массив. Если массив, следующие ключи могут быть использованы: - config - Используется для хранения кэшированного элемента в пользовательской конфигурации кэша. - key - Используется для определения ключа, используемого в Cache::write(). Будет префикс element_ - plugin - (устарело!) Загрузка элемента из определенного плагина. Этот параметр устарел и будет удален в CakePHP 3.0. Используйте Plugin.element_name вместо него. - callbacks - Установите в значение true для вызова обратного вызова помощника beforeRender и afterRender для этого элемента. По умолчанию false. - ignoreMissing - Используется для разрешения отсутствующих элементов. Установите в значение true, чтобы не выводить сообщения об ошибках.

Возвращает

строка
Отрендеренный элемент

elementExists()source public

elementExists( string $name )

Проверяет существование элемента.

Параметры

строка $name

Имя файла шаблона в папке /app/View/Elements/, или MyPlugin.template для проверки шаблона элемента из MyPlugin. Если элемент не найден в плагине, будет выполнено обычное поиск по цепочке путей.

Возвращает

логическое значение
Успех

end()source public

end( )

Завершение блока захвата. Комплементарное View::start()

См. также

ViewBlock::end()

exists()source public

exists( string $name )

Проверка существования блока.

Параметры

строка $name

Имя блока

Возвращает

логическое значение

extend()source public

extend( string $name )

Предоставляет расширение/наследование представления или элемента. Представления могут расширять родительское представление и заполнять блоки в родительском шаблоне.

Параметры

строка $name

Представление или элемент, которым нужно расширить текущий.

Исключения

LogicException
при расширении представления самим собой или при циклических расширениях.
LogicException
при расширении несуществующего элемента

fetch()source public

fetch( string $name , string $default '' )

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

Параметры

строка $name

Имя блока

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

Текст по умолчанию

Возвращает

строка
содержимое блока или $default, если блок не существует.

См. также

ViewBlock::get()

get()source public

get( string $var , mixed $default null )

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

Параметры

строка $var

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

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

Значение по умолчанию/резервное содержимое переменной $var.

Возвращает

смешанный тип
содержимое указанной переменной, если она задана, иначе $default.

getCurrentType()source public

getCurrentType( )

Получить текущий тип представления

Возвращает

строка

getEventManager()source public

getEventManager( )

Возвращает экземпляр менеджера CakeEventManager, обрабатывающий любые обратные вызовы. Вы можете использовать этот экземпляр для регистрации новых слушателей или обратных вызовов к событиям контроллера, или создавать собственные события и вызывать их по мере необходимости.

Возвращает

CakeEventManager

getVar()source public

getVar( string $var )

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

Параметры

строка $var

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

Возвращает

смешанный тип
Содержимое указанной переменной, если она задана, иначе null.

getVars()source public

getVars( )

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

Возвращает

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

loadHelper()source public

loadHelper( string $helperName , array $settings array() )

Загружает помощник. Делегирует загрузку помощника классу HelperCollection::load()

Параметры

строка $helperName

Имя помощника для загрузки.

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

Настройки для помощника.

Возвращает

Helper
объект помощника.

См. также

HelperCollection::load()

loadHelpers()source public

loadHelpers( )

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

pluginSplit()source public

pluginSplit( string $name , boolean $fallback true )

Разделяет имя плагина в формате «точка» на имя плагина и имя файла. Если в имени $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку

Параметры

string $name

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

boolean $fallback необязательно true

Если true, использует плагин, установленный в текущем CakeRequest, когда загруженный плагин не найден.

Возвращает

array
Массив с 2 индексами. 0 => имя плагина, 1 => имя файла

prepend()source public

prepend( string $name , mixed $value null )

Добавляет в начало существующего или нового блока. Добавление в новый блок создаст блок.

Параметры

string $name

Имя блока

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

Содержимое блока.

См. также

ViewBlock::concat()

render()source public

render( string $view null , string $layout null )

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

Render вызывает обратные вызовы помощников, которые срабатывают до и после отображения представления, а также до и после отображения макета. Обратные вызовы помощников вызываются:

• beforeRender
• afterRender
• beforeLayout
• afterLayout

Если View::$autoRender равен false и не предоставлено $layout, представление будет возвращено без обработки.

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

Параметры

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

Имя файла представления для использования

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

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

Возвращает

string|null
Отображенное содержимое или null, если содержимое уже было отображено и возвращено ранее.

Выбрасывает

CakeException
Если возникла ошибка в представлении.

Вызывает

View.beforeRender $this, array($viewFileName)
View.afterRender $this, array($viewFileName)

renderCache()source public

renderCache( string $filename , string $timeStart )

Отображение кэшированного представления. Работает в связке с CacheHelper и Dispatcher для отображения кэшированных файлов представления.

Параметры

string $filename

файл кэша для включения

string $timeStart

время начала рендеринга страницы

Возвращает

boolean
Успешность отображения кэшированного файла.

renderLayout()source public

renderLayout( string $content , string $layout null )

Отображает макет. Возвращает вывод из _render(). Возвращает false при ошибке. Создаются несколько переменных для использования в макете.

• title_for_layout - устаревшая заглушка, вы должны установить это значение, если хотите иметь больший контроль.
• content_for_layout - содержит отрендеренный файл представления
• scripts_for_layout - содержит содержимое, добавленное с помощью addScript(), а также содержимое в блоках «meta», «css» и «script». Они добавляются в указанном порядке.

Устаревшие возможности:

• $scripts_for_layout устарела и будет удалена в CakePHP 3.0. Используйте вместо этого возможности блоков. meta, css и script будут заполнены соответствующими методами HtmlHelper.
• $title_for_layout устарела и будет удалена в CakePHP 3.0. Используйте вместо этого блок title.
• $content_for_layout устарела и будет удалена в CakePHP 3.0. Используйте вместо этого блок content.

Параметры

string $content

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

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

Имя макета.

Возвращает

mixed
Отображенный вывод или false при ошибке

Выбрасывает

CakeException
Если возникла ошибка в представлении.

Вызывает

View.beforeLayout $this, array($layoutFileName)
View.afterLayout $this, array($layoutFileName)

set()source public

set( string|array $one , string|array $two null )

Позволяет шаблону или элементу задать переменную, которая будет доступна в макете или другом элементе. Аналогично Controller::set().

Параметры

string|array $one

Строка или массив данных.

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

Значение в случае, если $one является строкой (которая затем работает как ключ). Не используется, если $one является ассоциативным массивом, в противном случае служит значениями для ключей $one.

start()source public

start( string $name )

Начать захват вывода для «блока»

Параметры

string $name

Имя блока, для которого нужно захватить вывод.

См. также

ViewBlock::start()

startIfEmpty()source public

startIfEmpty( string $name )

Начать захват вывода для «блока», если он пуст

Параметры

string $name

Имя блока, для которого нужно захватить вывод.

См. также

ViewBlock::startIfEmpty()

uuid()source public

uuid( string $object , string $url )

Генерирует уникальный, не случайный идентификатор DOM для объекта, на основе типа объекта и целевого URL.

Параметры

string $object

Тип объекта, например, 'форма' или 'ссылка'

string $url

Целевой URL объекта

Возвращает

string

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства $property этого объекта со свойством в определении $class. Значение этого класса для свойства будет объединено поверх $class'

Это обеспечивает часть DRY-магии CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

array $properties

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

string $class

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

boolean $normalize необязательно true

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties необязательно array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

array $params необязательно array()

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

Возвращает

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

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

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

boolean
Результат записи в журнал

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

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

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

строка
Название этого класса