Класс 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) в виде строки. Имена действий с регистром CamelCase будут преобразовываться в нижний регистр с подчеркиванием! Это значит, что у вас могут быть LongActionNames, которые ссылаются на 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 )

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

Параметры

строка $var

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

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

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

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

строка

getEventManager()source public

getEventManager( )

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

Возвращает

CakeEventManager

getVar()source public

getVar( string $var )

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

Параметры

строка $var

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

Возвращает

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

getVars()source public

getVars( )

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

Возвращает

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

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 )

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

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

• beforeRender
• afterRender
• beforeLayout
• afterLayout

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

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

Параметры

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

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

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

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

Возвращает

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

Вызывает исключение

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

Вызывает

View.beforeRender $this, массив($viewFileName)
View.afterRender $this, массив($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, массив($layoutFileName)
View.afterLayout $this, массив($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 необязательно массив()

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

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

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

Возвращает

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 в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

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