Класс ScaffoldView

_getViewFileNameисходный код защищенный

_getViewFileName( string $name null )

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

Параметры

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

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

Возвращает

string
действие

Выбрасывает

MissingViewException
MissingViewException

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

View::_getViewFileName()

__constructисходный код публичный

__construct( Controller $controller null )

Конструктор

Параметры

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

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

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

Object::__construct()

__getисходный код публичный

__get( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
смешанный

__issetисходный код публичный

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

boolean
логическое

__setисходный код публичный

__set( string $name , mixed $value )

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

Параметры

строка $name

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

смешанный $value

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

Возвращает

mixed
смешанный

_elementCacheисходный код защищенный

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

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

Параметры

строка $name

Имя элемента

строка $data

Данные

массив $options

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

Возвращает

string|null
строка|null

_evaluateисходный код защищенный

_evaluate( string $viewFile , array $dataForView )

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

Параметры

строка $viewFile

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

массив $dataForView

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

Возвращает

string
Вывод отрисовки

_getElementFileNameисходный код защищенный

_getElementFileName( string $name )

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

Параметры

строка $name

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

Возвращает

mixed
Строка имени файла элемента или false, если файл не найден.

_getExtensionsисходный код защищенный

_getExtensions( )

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

Возвращает

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

_getLayoutFileNameисходный код защищенный

_getLayoutFileName( string $name null )

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

Параметры

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

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

Возвращает

string
Имя файла макета (.ctp).

Выбрасывает

MissingLayoutException
при невозможности найти макет

_pathsисходный код защищенный

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

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

Параметры

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

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

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

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

Возвращает

array
пути

_renderисходный код защищенный

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

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

Параметры

строка $viewFile

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

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

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

Возвращает

string
Вывод отрисовки

Выбрасывает

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

Вызывает

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

_renderElementисходный код защищенный

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

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

Параметры

строка $file

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

массив $data

Данные для отрисовки

массив $options

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

Возвращает

string
строка

Вызывает

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

addScriptисходный код публичный

addScript( string $name , string $content null )

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

Параметры

строка $name

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

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

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

См.

View::start()

appendисходный код публичный

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, чтобы запустить обработчики 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 )

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

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

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

Если массив включает ключ "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()