Класс View

__construct()source public

__construct( Controller $controller null )

Конструктор

Параметры

Controller $controller optional null

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

mixed

__isset()source public

__isset( string $name )

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

Параметры

string $name

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

Возвращает

boolean

__set()source public

__set( string $name , mixed $value )

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

Параметры

string $name

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

mixed $value

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

Возвращает

mixed

_elementCache()source protected

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

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

Параметры

string $name

Имя элемента

string $data

Данные

array $options

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

Возвращает

string|null

_evaluate()source protected

_evaluate( string $viewFile , array $dataForView )

Метод для выполнения шаблона/скрипта представления в защищенной среде.

Параметры

string $viewFile

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

array $dataForView

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

Возвращает

string
Выходные данные

_getElementFileName()source protected

_getElementFileName( string $name )

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

Параметры

string $name

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

Возвращает

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

_getExtensions()source protected

_getExtensions( )

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

Возвращает

array
Массив расширений файлов представлений.

_getLayoutFileName()source protected

_getLayoutFileName( string $name null )

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

Параметры

string $name optional null

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

Возвращает

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

Выбрасывает

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

_getViewFileName()source protected

_getViewFileName( string $name null )

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

Параметры

string $name optional null

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

Возвращает

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

Выбрасывает

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

_paths()source protected

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

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

Параметры

string $plugin optional null

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

boolean $cached optional true

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

Возвращает

array
Пути

_render()source protected

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

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

Параметры

string $viewFile

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

array $data optional array()

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

Возвращает

string
Отображённые выходные данные

Выбрасывает

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

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

array $data

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

array $options

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

Возвращает

string

Вызывает

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

addScript()source public

addScript( string $name , string $content null )

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

Устарело

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

Параметры

string $name

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

string $content optional null

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

См. также

View::start()

append()source public

append( string $name , mixed $value null )

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

Параметры

string $name

Имя блока

mixed $value optional null

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

См. также

ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

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

Параметры

string $name

Имя блока

mixed $value

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

См. также

ViewBlock::set()

blocks()source public

blocks( )

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

Возвращает

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

См. также

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 )

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

Устарело

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

Параметры

строка $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. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имён файлов, содержащих точку

Параметры

строка $name

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

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

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

Возвращает

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

prepend()source public

prepend( string $name , mixed $value null )

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

Параметры

строка $name

Имя блока

смешанное $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, можно использовать представление/макет плагина вместо приложения. Если выбранный плагин не найден, представление будет найдено по стандартному каскаду путей представления.

Параметры

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

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

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

Используемый макет.

Возвращает

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

Исключения

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

Вызывает

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

renderCache()source public

renderCache( string $filename , string $timeStart )

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

Параметры

строка $filename

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

строка $timeStart

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

Возвращает

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

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.

Параметры

строка $content

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

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

Имя макета

Возвращает

смешанный тип
Отображаемый вывод или 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().

Параметры

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

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

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

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

start()source public

start( string $name )

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

Параметры

строка $name

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

См. также

ViewBlock::start()

startIfEmpty()source public

startIfEmpty( string $name )

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

Параметры

строка $name

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

См. также

ViewBlock::startIfEmpty()

uuid()source public

uuid( string $object , string $url )

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

Параметры

строка $object

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

строка $url

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

Возвращает

строка

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

целое число|строка $status необязательный 0

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

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

null

array()

array()

null

null

array()