Класс View

__construct()source public

__construct( Controller $controller null )

Конструктор

Параметры

Controller $controller optional null

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

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

Object::__construct()

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанный тип

__isset()source public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

булево значение

__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

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

логическое $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 /> макета документа.

Устарело

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

Параметры

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

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

Устарело

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 )

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

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

• 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

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

Возвращает

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

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

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

Возвращает

смешанное

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

toString()source public

toString( )

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

Возвращает

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

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