Класс ThemeView

__construct()source public

__construct( Controller $controller null )

Конструктор

Параметры

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

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

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

CakeObject::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанный

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

boolean

__set()source public

__set( string $name , mixed $value )

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

Параметры

строка $name

Имя атрибута для задания.

смешанный $value

Значение атрибута для задания.

Возвращает

смешанный

_elementCache()source protected

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

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

Параметры

строка $name

Имя элемента

строка $data

Данные

массив $options

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

Возвращает

строка|null

_evaluate()source protected

_evaluate( string $viewFile , array $dataForView )

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

Параметры

строка $viewFile

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

массив $dataForView

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

Возвращает

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

_getElementFileName()source protected

_getElementFileName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_getExtensions()source protected

_getExtensions( )

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

Возвращает

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

_getLayoutFileName()source protected

_getLayoutFileName( string $name null )

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

Параметры

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

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

Возвращает

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

Выбрасывает

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

_getViewFileName()source protected

_getViewFileName( string $name null )

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

Параметры

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

Действие контроллера, для которого нужно найти имя файла шаблона

Возвращает

строка
Имя файла шаблона

Выбрасывает

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

_paths()source protected

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

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

Параметры

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

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

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

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

Возвращает

массив
пути

_render()source protected

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

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

Параметры

строка $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 для него и записывает в кэш, если используется кэш

Параметры

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

Параметры

строка $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() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет объектно-ориентированную обёртку для 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|string|array $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 необязательно array()

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

Возвращает

смешанное

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

toString()source public

toString( )

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

Возвращает

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