Класс ThemeView

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

__construct( Controller $controller null )

Конструктор

Параметры

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

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

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

Object::__construct()

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

Параметры

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

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

Возвращает

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

Вызывает

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

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

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

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

Параметры

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

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

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

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

Возвращает

array
пути

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

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

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

Параметры

строка $viewFile

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

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

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

Возвращает

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

Вызывает

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

Вызывает события

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

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

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

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

Параметры

строка $file

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

массив $data

Данные для рендеринга

массив $options

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

Возвращает

string
строка

Вызывает события

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

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

addScript( string $name , string $content null )

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

Параметры

строка $name

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

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

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

См. также

View::start()

appendисходный код 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, чтобы вызвать обратные вызовы helper 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 )

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

Параметры

строка $var

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

Возвращает

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

getVarssource public

getVars( )

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

Возвращает

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

loadHelpersource public

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

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

Параметры

строка $helperName

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

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

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

Возвращает

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

См. также

HelperCollection::load()

loadHelperssource public

loadHelpers( )

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

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

rendersource public

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

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

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

• beforeRender
• afterRender
• beforeLayout
• afterLayout

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

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

Параметры

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

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

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

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

Возвращает

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

Выбрасывает

CakeException
В случае ошибки в представлении.

Вызывает

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

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, array($layoutFileName)
View.afterLayout $this, array($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 необязательно array()

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

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

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

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

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

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

toStringsource public

toString( )

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

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

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

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