Класс ScaffoldView

_getViewFileName()source protected

_getViewFileName( string $name null )

Переопределяет _getViewFileName Добавляет специальные представления scaffolding.

Параметры

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

имя файла представления для получения.

Возвращает

строка
действие

Исключения

MissingViewException

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

View::_getViewFileName()

__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

Название атрибута для проверки.

Возвращает

булево

__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
при невозможности найти макет

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

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

Параметры

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

Возвращает

boolean
Результат

end()source public

end( )

Закрывает блок захвата. Противоположность View::start()

См. также

ViewBlock::end()

exists()source public

exists( string $name )

Проверяет существование блока

Параметры

строка $name

Имя блока

Возвращает

boolean

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, массив($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'.

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

Возвращает

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