Класс XmlView

$this->set(compact('posts', 'users', 'stuff'));
$this->set('_serialize', array('posts', 'users'));

__constructисходный код public

__construct( Controller $controller null )

Конструктор

Параметры

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

Экземпляр контроллера.

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

View::__construct()

_serializeисходный код protected

_serialize( array $serialize )

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

Специальные параметры

_xmlOptions Вы можете задать массив пользовательских опций для Xml::fromArray() таким образом, например, 'format' как 'attributes' вместо 'tags'.

Параметры

массив $serialize

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

Возвращает

string
Сериализированные данные

loadHelpersисходный код public

loadHelpers( )

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

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

View::loadHelpers()

renderисходный код public

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

Отображение XML-представления.

Использует специальный параметр «_serialize» для преобразования набора переменных представления в XML-ответ. Это значительно упрощает создание простых XML-ответов. Вы можете опустить параметр «_serialize» и использовать обычное представление + макет.

Параметры

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

Представление, которое отображается.

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

Макет, который отображается.

Возвращает

string
Отображаемое представление.

Выбрасывает

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

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

View::render()

__getисходный код public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
смешанное

__issetисходный код public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
булево

__setисходный код public

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанное $value

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

Возвращает

mixed
смешанное

_elementCacheисходный код protected

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

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

Параметры

строка $name

Имя элемента

строка $data

Данные

массив $options

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

Возвращает

string|null
строка|null

_evaluateисходный код protected

_evaluate( string $viewFile , array $dataForView )

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

Параметры

строка $viewFile

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

массив $dataForView

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

Возвращает

string
Результат рендеринга

_getElementFileNameисходный код protected

_getElementFileName( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
Строка имени файла элемента или false, если файл не найден.

_getExtensionsисходный код protected

_getExtensions( )

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

Возвращает

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

_getLayoutFileNameисходный код protected

_getLayoutFileName( string $name null )

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

Параметры

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

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

Возвращает

string
Имя файла макета (.ctp).

Выбрасывает

MissingLayoutException
Если макет не найден

_getViewFileNameисходный код protected

_getViewFileName( string $name null )

Возвращает имя файла шаблона для данного действия (.ctp) в виде строки. Имена действий с заглавными буквами преобразуются в нижний регистр! Это означает, что вы можете иметь имена действий с заглавными буквами, которые относятся к представлениям long_action_names.ctp.

Параметры

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

Действие контроллера для поиска имени файла шаблона

Возвращает

string
Имя файла шаблона

Выбрасывает

MissingViewException
Если файл представления не найден.

_pathsисходный код protected

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

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

Параметры

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

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

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

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

Возвращает

array
пути

_rendersource protected

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

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

Параметры

строка $viewFile

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

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

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

Возвращает

string
Выводимый результат

Выбрасывает

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

Вызывает

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

_renderElementsource protected

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

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

Параметры

строка $file

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

массив $data

Данные для отображения

массив $options

Параметры элемента

Возвращает

string
строка

Вызывает

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

addScriptsource public

addScript( string $name , string $content null )

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

Устарело

3.0.0 Будет удалено в 3.0. Заменено функциональностью блоков.

Параметры

строка $name

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

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

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

См.

View::start()

appendsource public

append( string $name , mixed $value null )

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

Параметры

строка $name

Имя блока

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

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

См.

ViewBlock::concat()

assignsource public

assign( string $name , mixed $value )

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

Параметры

строка $name

Имя блока

смешанный $value

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

См.

ViewBlock::set()

blockssource public

blocks( )

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

Возвращает

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

См.

ViewBlock::keys()

elementsource public

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

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

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

Параметры

строка $name

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

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

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

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

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

Возвращает

string
Отображаемый элемент

elementExistssource public

elementExists( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
Успех

endsource public

end( )

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

См.

ViewBlock::end()

existssource public

exists( string $name )

Проверить, существует ли блок

Параметры

строка $name

Имя блока

Возвращает

boolean
bool

extendsource public

extend( string $name )

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

Параметры

строка $name

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

Выбрасывает

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

fetchsource public

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

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

Параметры

строка $name

Имя блока

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

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

Возвращает

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

См.

ViewBlock::get()

getsource public

get( string $var , mixed $default null )

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

Параметры

строка $var

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

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

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

Возвращает

mixed
Содержимое названной переменной, если она задана, иначе $default.

getCurrentTypesource public

getCurrentType( )

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

Возвращает

string
строка

getEventManagersource public

getEventManager( )

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

Возвращает

CakeEventManager
CakeEventManager

getVarsource public

getVar( string $var )

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

Устаревшее

3.0.0 Будет удалено в 3.0. Используйте View::get() вместо этого.

Параметры

строка $var

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

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

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

getVarssource public

getVars( )

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

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

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

loadHelpersource public

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

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

Параметры

строка $helperName

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

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

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

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

Helper
Объект построенного помощника.

См. также

HelperCollection::load()

pluginSplitsource public

pluginSplit( string $name , boolean $fallback true )

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

Параметры

строка $name

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

логическое значение $fallback необязательно true

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

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

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

prependsource public

prepend( string $name , mixed $value null )

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

Параметры

строка $name

Имя блока

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

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

См. также

ViewBlock::concat()

renderCachesource public

renderCache( string $filename , string $timeStart )

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

Параметры

строка $filename

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

строка $timeStart

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

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

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

renderLayoutsource 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.

Параметры

строка $content

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

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

Имя макета

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

mixed
Отображенный результат или false при ошибке

Исключения

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

Вызывает

View.beforeLayout $this, массив($layoutFileName)
View.afterLayout $this, массив($layoutFileName)

setsource public

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

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

Параметры

строка|массив $one

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

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

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

startsource public

start( string $name )

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

Параметры

строка $name

Имя блока для захвата.

См. также

ViewBlock::start()

startIfEmptysource public

startIfEmpty( string $name )

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

Параметры

строка $name

Имя блока для захвата.

См. также

ViewBlock::startIfEmpty()

uuidsource public

uuid( string $object , string $url )

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

Параметры

строка $object

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

строка $url

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

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

string
строка

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

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

'xml'

null

''

null

false

array()

array(
    'viewVars', 'autoLayout', 'ext', 'helpers', 'view', 'layout', 'name', 'theme',
    'layoutPath', 'viewPath', 'request', 'plugin', 'passedArgs', 'cacheAction'
)

array()

array()

array()

array()

true

false

'default'

array()

'.ctp'

false

array()

'default'

null

null

array()

null

null

array()

array()

null

null

array()