Spec-Zone.ru › CakePHP 3.5

Класс View

Представление, V в триаде MVC. Представление взаимодействует с помощниками и переменными представления, переданными из контроллера, чтобы отобразить результаты действия контроллера. Часто это HTML, но также может быть в формате JSON, XML, PDF или потоковых файлов.

CakePHP использует двухэталонную модель представления. Это означает, что сначала содержимое шаблона отображается, а затем вставляется в выбранное макет. Это также означает, что вы можете передавать данные из шаблона в макет с помощью $this->set()

Класс представления поддерживает использование плагинов в качестве тем. Вы можете установить

public function beforeRender(\Cake\Event\Event $event)
{
     $this->viewBuilder()->setTheme('SuperHot');
}

в вашем контроллере, чтобы использовать плагин SuperHot в качестве темы. Например, если текущим действием является PostsController::index(), то класс представления будет искать файл шаблона plugins/SuperHot/Template/Posts/index.ctp. Если шаблон темы для текущего действия не найден, используется стандартный файл шаблона приложения.

Cake\View\View реализует Cake\Event\EventDispatcherInterface использует Cake\View\CellTrait , Cake\Event\EventDispatcherTrait , Cake\Log\LogTrait , Cake\Routing\RequestActionTrait , Cake\View\ViewVarsTrait

Непосредственные подклассы

  • Cake\View\AjaxView
  • Cake\View\SerializedView

Косвенные подклассы

  • Cake\View\JsonView
  • Cake\View\XmlView
Пространство имён: Cake\View
Расположение: View/View.php

Краткое описание констант

  • string

    NAME_ELEMENT
    'Element'
  • string

    NAME_TEMPLATE
    'Template'
  • string

    TYPE_ELEMENT
    'element'
  • string

    TYPE_LAYOUT
    'layout'
  • string

    TYPE_TEMPLATE
    'view'
  • string

    TYPE_VIEW
    'view'

Краткое описание свойств

  • $Blocks public
    Cake\View\ViewBlock
    Экземпляр ViewBlock.
  • $_current protected
    string
    Файл представления, который в данный момент отображается. Используется для поиска родительских файлов.
  • $_currentType protected
    string

    В данный момент отображается элемент. Используется для поиска родительских фрагментов для элементов.

  • $_ext protected
    string
    Расширение файла. По умолчанию используется шаблон CakePHP ".ctp".
  • $_helpers protected
    Cake\View\HelperRegistry
    Коллекция помощников
  • $_parents protected
    array
    Имена представлений и их родителей, используемые с View::extend();
  • $_passedVars protected
    array
    Список переменных для сбора из связанного контроллера.
  • $_paths protected
    array
    Содержит массив путей.
  • $_pathsForPlugin protected
    array
    Содержит массив путей плагинов.
  • $_stack protected
    array
    Стек содержимого, используемый для вложенных шаблонов, которые все используют View::extend();
  • $_viewBlockClass protected
    string
    Класс ViewBlock.
  • $autoLayout public
    boolean

    Включает или выключает стандартный режим CakePHP по применению файлов макета. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к отображаемым шаблонам.

  • $elementCache public
    string

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

  • $hasRendered public
    boolean
    Истина, когда представление было отображено.
  • $helpers public
    array
    Массив имён встроенных помощников для включения.
  • $layout public
    string

    Имя файла макета, внутри которого будет отображаться шаблон. Указанное имя — имя файла макета в /src/Template/Layout без расширения .ctp.

  • $layoutPath public
    string
    Имя подкаталога макетов, содержащих макеты для данного представления.
  • $name public
    string
    Имя контроллера, который создал представление, если таковой имеется.
  • $passedArgs public
    array
    Текущие переданные параметры. Передаются в представление из создающего контроллера для удобства.
  • $plugin public
    string
    Имя плагина.
  • $request public
    Cake\Http\ServerRequest

    Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию об текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.

  • $response public
    Cake\Http\Response
    Ссылка на объект Response
  • $subDir public
    string|null

    Подкаталог для этого файла шаблона. Часто используется для маршрутизации на основе расширений. Например, с расширением xml, $subDir будет xml/

  • $template public
    string

    Имя файла шаблона для отображения. Указанное имя — имя файла в /src/Template/ без расширения .ctp.

  • $templatePath public
    string
    Имя подкаталога, содержащего шаблоны для данного представления.
  • $theme public
    string|null
    Тема представления, которую нужно использовать.
  • $uuids public
    array
    Список сгенерированных UUID DOM.

Краткое описание магических свойств

  • $Blocks public
    Cake\View\ViewBlock
  • $Flash public
    Cake\View\Helper\FlashHelper
  • $Form public
    Cake\View\Helper\FormHelper
  • $Html public
    Cake\View\Helper\HtmlHelper
  • $Number public
    Cake\View\Helper\NumberHelper
  • $Paginator public
    Cake\View\Helper\PaginatorHelper
  • $Rss public
    Cake\View\Helper\RssHelper
  • $Session public
    Cake\View\Helper\SessionHelper
  • $Text public
    Cake\View\Helper\TextHelper
  • $Time public
    Cake\View\Helper\TimeHelper
  • $Url public
    Cake\View\Helper\UrlHelper
  • $view public
    string
  • $viewPath public
    string

Наследуемые магические свойства

  • _validViewOptions

Наследуемые свойства

  • _eventClass, _eventManager _viewBuilder, viewClass, viewVars

Краткое описание методов

  • __construct() public
    Конструктор
  • __get() public
    Магический аксессор для помощников.
  • __set() public
    Магический установщик для устаревших свойств.
  • _checkFilePath() protected
    Проверка, что путь к файлу представления не выходит за пределы определённых путей шаблонов.
  • _elementCache() protected
    Генерация конфигурации кеширования для элемента.
  • _evaluate() protected
    Метод-песочница для оценки шаблона/скрипта представления.
  • _getElementFileName() protected
    Находит имя файла элемента, возвращает false при ошибке.
  • _getLayoutFileName() protected
    Возвращает имя файла макета для данного шаблона в виде строки.
  • _getSubPaths() protected

    Находит все пути к подшаблонам, основанные на $basePath. Если в текущем запросе определён префикс, этот метод добавит префиксный путь шаблона к $basePath, переходя вверх по иерархии в случае вложенного префикса. В основном используется для поиска префиксных путей шаблонов для элементов и макетов.

  • _getViewFileName() protected

    Возвращает имя файла шаблона заданного действия (.ctp) в виде строки. Имена действий с заглавными буквами (CamelCased) по умолчанию преобразуются в нижний регистр с символами подчеркивания (under_scored). Это означает, что вы можете иметь имена действий с длинными заглавными буквами (LongActionNames), которые ссылаются на представления long_action_names.ctp. Вы можете изменить правило инфлекции, переопределив _inflectViewFileName.

  • _inflectViewFileName() protected
    Изменение имени файла шаблона представления в формате с подчеркиваниями.
  • _paths() protected
    Возвращает все возможные пути для поиска файлов представления в нужном порядке.
  • _render() protected

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

  • _renderElement() protected

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

  • append() public
    Добавить в существующий или новый блок.
  • assign() public

    Установить содержимое блока. Это перепишет любое существующее содержимое.

  • autoLayout() public

    Включает или выключает стандартный режим CakePHP по применению файлов макетов. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендеряемым шаблонам.

  • blocks() public
    Получить имена всех существующих блоков.
  • cache() public
    Создать кэшированный блок логики представления.
  • element() public
    Отображает фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или любую другую строку.
  • elementExists() public
    Проверяет, существует ли элемент.
  • enableAutoLayout() public

    Включает или выключает стандартный режим CakePHP по применению файлов макетов. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендеряемым представлениям.

  • end() public
    Завершить блок захвата. Комплементарно методу View::start()
  • exists() public
    Проверить, существует ли блок.
  • extend() public

    Обеспечивает расширение/наследование шаблонов или элементов. Представления могут расширять родительское представление и заполнять блоки в родительском шаблоне.

  • fetch() public

    Получить содержимое блока. Если блок пуст или неопределён, будет возвращено ''.

  • get() public
    Возвращает содержимое заданной переменной представления.
  • getCurrentType() public
    Получить текущий тип представления.
  • getLayout() public

    Получить имя файла макета для отображения шаблона внутри него. Указанное имя является именем файла макета в /src/Template/Layout без расширения .ctp.

  • getLayoutPath() public
    Получить путь к файлам макетов.
  • getTemplate() public

    Получить имя файла шаблона для отображения. Указанное имя является именем файла в /src/Template/ без расширения .ctp.

  • getTemplatePath() public
    Получить путь к файлам шаблонов.
  • getTheme() public
    Получить текущую тему представления.
  • getVars() public
    Возвращает список переменных, доступных в текущем контексте представления.
  • helpers() public
    Получить реестр помощников, используемый этим классом представления.
  • initialize() public
    Метод инициализации.
  • isAutoLayoutEnabled() public

    Возвращает, включён ли стандартный режим CakePHP по применению файлов макетов. Выключено означает, что макеты не будут автоматически применяться к рендеряемым представлениям.

  • layout() public

    Получить/установить имя файла макета для отображения шаблона внутри него. Указанное имя является именем файла макета в /src/Template/Layout без расширения .ctp.

  • layoutPath() public
    Получить/установить путь к файлам макетов.
  • loadHelper() public
    Загрузка помощника. Делегирует загрузку помощника в HelperRegistry::load().
  • loadHelpers() public
    Взаимодействие с HelperRegistry для загрузки всех помощников.
  • pluginSplit() public

    Разделяет имя плагина с точкой на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, в противном случае имя файла останется неизменным для имён файлов, содержащих точку.

  • prepend() public
    Добавить в начало существующего или нового блока.
  • render() public
    Отображает представление для данного файла шаблона и макета.
  • renderLayout() public

    Отображает макет. Возвращает вывод из _render(). Возвращает false при ошибке. Несколько переменных создаются для использования в макете.

  • reset() public

    Сбросить содержимое блока. Это перепишет любое существующее содержимое.

  • setLayout() public

    Установить имя файла макета для отображения шаблона внутри него. Указанное имя является именем файла макета в /src/Template/Layout без расширения .ctp.

  • setLayoutPath() public
    Установить путь к файлам макетов.
  • setTemplate() public

    Установить имя файла шаблона для отображения. Указанное имя является именем файла в /src/Template/ без расширения .ctp.

  • setTemplatePath() public
    Установить путь к файлам шаблонов.
  • setTheme() public
    Установить тему представления для использования.
  • start() public
    Начать захват вывода для 'блока'.
  • template() public

    Получить/установить имя файла шаблона для отображения. Указанное имя является именем файла в /src/Template/ без расширения .ctp.

  • templatePath() public
    Получить/установить путь к файлам шаблонов.
  • theme() public
    Тема представления для использования.
  • uuid() public
    Генерирует уникальный, не случайный идентификатор DOM для объекта, основанный на типе объекта и целевом URL.

Подробное описание методов

__construct()source public

__construct( Cake\Http\ServerRequest $request null , Cake\Http\Response $response null , Cake\Event\EventManager $eventManager null , array $viewOptions [] )

Конструктор

Параметры

Cake\Http\ServerRequest $request необязательно null
Экземпляр запроса.
Cake\Http\Response $response необязательно null
Экземпляр ответа.
Cake\Event\EventManager $eventManager необязательно null
Экземпляр менеджера событий.
массив $viewOptions необязательно []

Параметры представления. Список параметров, которые устанавливаются как свойства класса, см. в View::$_passedVars.

__get()source public

__get( string $name )

Магический аксессор для помощников.

Параметры

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

Возвращает

смешанное

__set()source public

__set( string $name , mixed $value )

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

Параметры

строка $name
Имя свойства.
смешанное $value
Значение свойства.

_checkFilePath()source protected

_checkFilePath( string $file , string $path )

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

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

Параметры

строка $file
Путь к файлу шаблона.
строка $path
Базовый путь, в котором $file должен находиться.

Возвращает

строка
Путь к файлу

Выбрасывает

InvalidArgumentException

_elementCache()source protected

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

Генерация конфигурации кеширования для элемента.

Параметры

строка $name
Имя элемента
массив $data
Данные
массив $options
Параметры элемента

Возвращает

массив
Конфигурация кэша элемента.

_evaluate()source protected

_evaluate( string $viewFile , array $dataForView )

Метод для выполнения шаблона/скрипта представления в защищенной среде.

Параметры

строка $viewFile
Имя файла представления
массив $dataForView
Данные для включения в отрендеренное представление.

Возвращает

строка
Отрендеренный вывод

_getElementFileName()source protected

_getElementFileName( string $name , boolean $pluginCheck true )

Поиск имени файла элемента, возвращает false при ошибке.

Параметры

строка $name
Имя элемента для поиска.
логический $pluginCheck необязательно true
  • если false, плагин из запроса будет проигнорирован, если загружен плагин с таким же именем

Возвращает

строка|false
Имя файла элемента или false, если файл не найден.

_getLayoutFileName()source protected

_getLayoutFileName( string|null $name null )

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

Параметры

строка|null $name необязательно null
Имя макета для поиска.

Возвращает

строка
Имя файла макета (.ctp).

Выбрасывает

Cake\View\Exception\MissingLayoutException
если макет не найден

_getSubPaths()source protected

_getSubPaths( string $basePath )

Находит все пути к подшаблонам, основанные на $basePath. Если в текущем запросе определен префикс, этот метод добавит префиксный путь к шаблону в $basePath, переходя вверх по иерархии префиксов. Это используется для поиска префиксных путей к шаблонам элементов и макетов.

Параметры

строка $basePath
Базовый путь, для которого нужно получить префиксный путь.

Возвращает

массив
Массив со всеми путями шаблонов.

_getViewFileName()source protected

_getViewFileName( string|null $name null )

Возвращает имя файла шаблона для заданного действия (.ctp) в виде строки. Имена действий с верблюжьей нотацией по умолчанию преобразуются в нижний регистр. Это означает, что вы можете использовать имена действий с верблюжьей нотацией, которые будут ссылаться на представления с нижним регистром. Вы можете изменить правило инфлекции, переопределяя _inflectViewFileName.

Параметры

строка|null $name необязательно null
Действие контроллера для поиска имени файла шаблона.

Возвращает

строка
Имя файла шаблона

Выбрасывает

Cake\View\Exception\MissingTemplateException
если файл представления не найден.

_inflectViewFileName()source protected

_inflectViewFileName( string $name )

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

Параметры

строка $name
Имя файла, которое должно быть преобразовано.

Возвращает

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

_paths()source protected

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

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

Параметры

строка|null $plugin необязательно null
Необязательное имя плагина для поиска файлов представлений.
логический $cached необязательно true
Установите в значение false, чтобы принудительно обновить пути представлений. По умолчанию true.

Возвращает

массив
пути

_render()source protected

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

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

Параметры

строка $viewFile
Имя файла представления
массив $data необязательно []

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

Возвращает

строка
Отрендеренный вывод

Выбрасывает

LogicException
Если блок оставлен открытым.

Вызывает

View.beforeRenderFile $this, [$viewFile]
View.afterRenderFile $this, [$viewFile, $content]

_renderElement()source protected

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

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

Параметры

строка $file
Путь к файлу элемента
массив $data
Данные для рендеринга
массив $options
Параметры элемента

Возвращает

строка

Вызывает

View.beforeRender $this, [$file]
View.afterRender $this, [$file, $element]

append()source public

append( string $name , mixed $value null )

Добавить в существующий или новый блок.

Добавление в новый блок создаст этот блок.

Параметры

строка $name
Имя блока
смешанный $value необязательно null

Содержимое блока. Значение будет приведено к строковому типу.

Возвращает


$this

См. также

\Cake\View\ViewBlock::concat()

assign()source public

assign( string $name , mixed $value )

Установить содержимое блока. Это перезапишет любое существующее содержимое.

Параметры

строка $name
Имя блока
смешанный $value

Содержимое блока. Значение будет приведено к строковому типу.

Возвращает


$this

См. также

\Cake\View\ViewBlock::set()

autoLayout()source public

autoLayout( boolean|null $autoLayout null )

Включает или отключает стандартный режим применения файлов макета CakePHP. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендеру шаблонов.

Устарело

3.5.0 Используйте isAutoLayoutEnabled()/enableAutoLayout() вместо этого.

Параметры

boolean|null $autoLayout необязательно null
Булевое значение для включения/выключения. Если null, возвращает текущее значение.

Возвращает

boolean|null

blocks()source public

blocks( )

Получить имена всех существующих блоков.

Возвращает

array
Массив, содержащий блоки.

См. также

\Cake\View\ViewBlock::keys()

cache()source public

cache( callable $block , array $options [] )

Создать кэшированный блок логики представления.

Это позволяет кэшировать блок вывода представления в кэш, определённый в elementCache.

Этот метод сначала попытается прочитать кэш. Если кэш пуст, $block будет выполнен, и вывод будет сохранён.

Параметры

вызываемый $block
Блок кода, вывод которого нужно кэшировать.
массив $options необязательно []
Опции, определяющие ключ кэша и т. д.

Возвращает

строка
Отрендеренное содержимое.

Выбрасывает

RuntimeException
Если в $options отсутствует опция 'key'.

element()source public

element( string $name , array $data [] , array $options [] )

Рендерит фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или другую строку.

Реализует концепцию элементов (или «частичных макетов»), и массив $params используется для передачи данных, которые будут использованы в элементе. Элементы можно кэшировать, улучшая производительность с помощью опции cache.

Параметры

строка $name

Имя файла шаблона в папке /src/Template/Element/, или MyPlugin.template для использования шаблона элемента из MyPlugin. Если элемент не найден в плагине, будет произведён поиск по стандартному пути.

массив $data необязательно []
Массив данных, которые будут доступны в рендеренном представлении (т. е. элементе)
массив $options необязательно []

Массив опций. Возможные ключи: - cache - Может быть true, для включения кэширования с использованием конфигурации в View::$elementCache. Или массив. Если массив, могут быть использованы следующие ключи: - config - Используется для хранения кэшированного элемента в пользовательской конфигурации кэша. - key - Используется для определения ключа, используемого в Cache::write(). Будет префиксен с element_ - callbacks - Устанавливается в true для вызова колбэков beforeRender и afterRender для этого элемента. По умолчанию false. - ignoreMissing - Используется для разрешения отсутствия элементов. Установите в true, чтобы не выбрасывать исключения. - plugin - Установка в false принудительно использует элемент приложения из шаблонов плагина, когда плагин имеет элемент с таким же именем. По умолчанию true

Возвращает

строка
Отрендеренный элемент

Выбрасывает

Cake\View\Exception\MissingElementException

Если элемент отсутствует, и ignoreMissing равно false.


elementExists()source public

elementExists( string $name )

Проверяет существование элемента

Параметры

строка $name

Имя файла шаблона в папке /src/Template/Element/, или MyPlugin.template для проверки элемента шаблона из MyPlugin. Если элемент не найден в плагине, будет произведён поиск по стандартному пути.

Возвращает

boolean
Успех

enableAutoLayout()source public

enableAutoLayout( boolean $enable true )

Включает или отключает стандартный режим применения файлов макета CakePHP. Включено по умолчанию. Выключение означает, что макеты не будут автоматически применяться к рендерингу представлений.

Параметры

boolean $enable необязательно true
Булевое значение для включения/выключения.

Возвращает


$this

end()source public

end( )

Завершить блок захвата. Комплементарное действие к View::start()

Возвращает


$this

См. также

\Cake\View\ViewBlock::end()

exists()source public

exists( string $name )

Проверить, существует ли блок

Параметры

строка $name
Имя блока

Возвращает

boolean

extend()source public

extend( string $name )

Обеспечивает расширение/наследование шаблонов или элементов. Представления могут расширять родительское представление и заполнять блоки в родительском шаблоне.

Параметры

строка $name
Шаблон или элемент для 'расширения' текущего.

Возвращает


$this

Выбрасывает

LogicException
если вы расширяете шаблон с самим собой или создаёте цикл расширений.
LogicException
если вы расширяете элемент, который не существует

fetch()source public

fetch( string $name , string $default '' )

Получить содержимое блока. Если блок пуст или не определён, будет возвращено ''.

Параметры

строка $name
Имя блока
строка $default необязательно ''
Текс по умолчанию

Возвращает

строка
Содержимое блока или $default, если блок не существует.

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default null )

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

Параметры

строка $var
Переменная представления, содержимое которой нужно получить.
смешанный $default необязательно null
Значение по умолчанию/резервное значение для $var.

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

строка

getLayout()source public

getLayout( )

Получить имя файла макета для рендеринга шаблона внутри него. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

Возвращает

строка

getLayoutPath()source public

getLayoutPath( )

Получить путь к файлам макета.

Возвращает

строка

getTemplate()source public

getTemplate( )

Получить имя файла шаблона для отрисовки. Указанное имя — это имя файла в /src/Template/ без расширения .ctp.

Возвращает

string

getTemplatePath()source public

getTemplatePath( )

Получить путь к файлам шаблонов.

Возвращает

string

getTheme()source public

getTheme( )

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

Возвращает

string|null

getVars()source public

getVars( )

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

Возвращает

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

helpers()source public

helpers( )

Получить используемую реестр помощников данного класса представления.

Возвращает

Cake\View\HelperRegistry

initialize()source public

initialize( )

Метод обработки инициализации.

Свойства, такие как $helpers и т. д., не могут быть статически инициализированы в вашем пользовательском классе представления, так как они перезаписываются значениями из контроллера в конструкторе. Таким образом, этот метод позволяет манипулировать ими по мере необходимости после создания экземпляра представления.

isAutoLayoutEnabled()source public

isAutoLayoutEnabled( )

Возвращает значение, указывающее, включён ли стандартный режим CakePHP для применения файлов макета. Выключенное состояние означает, что макеты не будут автоматически применяться к рендеру представлений.

Возвращает

boolean

layout()source public

layout( string|null $name null )

Получить/установить имя файла макета для отрисовки шаблона внутри него. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

Устарело

3.5.0 Используйте getLayout()/setLayout() вместо этого.

Параметры

string|null $name необязательно null
Имя файла макета для установки. Если null, возвращает текущее имя.

Возвращает

string|null

layoutPath()source public

layoutPath( string|null $path null )

Получить/установить путь к файлам макета.

Устарело

3.5.0 Используйте getLayoutPath()/setLayoutPath() вместо этого.

Параметры

string|null $path необязательно null
Путь к файлам макета. Если null, возвращает текущий путь.

Возвращает

string|null

loadHelper()source public

loadHelper( string $name , array $config [] )

Загружает хелпер. Делегирует загрузку хелпера классу HelperRegistry::load()

Параметры

string $name
Имя загружаемого хелпера.
array $config необязательно []
Настройки для хелпера

Возвращает

Cake\View\Helper
объект созданного хелпера.

См. также

\Cake\View\HelperRegistry::load()

loadHelpers()source public

loadHelpers( )

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

Возвращает


$this

pluginSplit()source public

pluginSplit( string $name , boolean $fallback true )

Разделяет имя плагина в формате точка на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется без изменений для имён файлов, содержащих точку

Параметры

string $name
Имя плагина, который требуется разделить.
boolean $fallback необязательно true
Если true, использует плагин, установленный в текущем запросе, когда загруженный плагин не найден

Возвращает

array
Массив с 2 индексами. 0 => имя плагина, 1 => имя файла

prepend()source public

prepend( string $name , mixed $value )

Добавляет в начало существующего или нового блока.

Добавление в новый блок создаст блок.

Параметры

string $name
Имя блока
mixed $value

Содержимое блока. Значение будет преобразовано в строку.

Возвращает


$this

См. также

\Cake\View\ViewBlock::concat()

render()source public

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

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

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

  • beforeRender
  • afterRender
  • beforeLayout
  • afterLayout

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

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

Параметры

string|false|null $view необязательно null
Имя файла представления для использования
string|null $layout необязательно null
Макет для использования.

Возвращает

string|null
Отрендеренный контент или null, если контент уже был рендерен и возвращен ранее.

Выбрасывает

Cake\Core\Exception\Exception
В случае ошибки в представлении.

Вызывает

View.beforeRender $this, [$viewFileName]
View.afterRender $this, [$viewFileName]

renderLayout()source public

renderLayout( string $content , string|null $layout null )

Отображает макет. Возвращает вывод от _render(). Возвращает false при ошибке. Несколько переменных создаются для использования в макете.

Параметры

string $content
Контент для рендеринга в шаблоне, обернутый окружающим макетом.
string|null $layout необязательно null
Имя макета

Возвращает

mixed
Отрендеренный вывод, или false при ошибке

Выбрасывает

Cake\Core\Exception\Exception
в случае ошибки в представлении.

Вызывает

View.beforeLayout $this, [$layoutFileName]
View.afterLayout $this, [$layoutFileName]

reset()source public

reset( string $name )

Сбросить содержимое блока. Это перезапишет любое существующее содержимое.

Параметры

string $name
Имя блока

Возвращает


$this

См. также

\Cake\View\ViewBlock::set()

setLayout()source public

setLayout( string $name )

Установить имя файла макета для рендеринга шаблона внутри него. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

Параметры

string $name
Имя файла макета для установки.

Возвращает


$this

setLayoutPath()source public

setLayoutPath( string $path )

Установить путь к файлам макета.

Параметры

строка $path
Путь к файлам макета.

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


$this

setTemplate()source public

setTemplate( string $name )

Установить имя файла шаблона для рендеринга. Указанное имя — это имя файла в /src/Template/ без расширения .ctp.

Параметры

строка $name
Имя файла шаблона для установки.

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


$this

setTemplatePath()source public

setTemplatePath( string $path )

Установить путь к файлам шаблонов.

Параметры

строка $path
Путь к файлам шаблонов.

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


$this

setTheme()source public

setTheme( string|null $theme )

Установить тему представления.

Параметры

строка|null $theme
Имя темы.

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


$this

start()source public

start( string $name )

Начать захват вывода для «блока».

Вы можете использовать start несколько раз для добавления или предварения содержимого в режиме захвата.

// Append content to an existing block.
$this->start('content');
echo $this->fetch('content');
echo 'Some new content';
$this->end();

// Prepend content to an existing block
$this->start('content');
echo 'Some new content';
echo $this->fetch('content');
$this->end();

Параметры

строка $name
Имя блока, для которого необходимо захватить вывод.

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


$this

См. также

\Cake\View\ViewBlock::start()

template()source public

template( string|null $name null )

Получить/установить имя файла шаблона для рендеринга. Указанное имя — это имя файла в /src/Template/ без расширения .ctp.

Устарело

3.5.0 Используйте getTemplate()/setTemplate() вместо этого.

Параметры

строка|null $name необязательно null
Имя файла шаблона для установки. Если null, возвращает текущее имя.

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

строка|null

templatePath()source public

templatePath( string|null $path null )

Получить/установить путь к файлам шаблонов.

Устарело

3.5.0 Используйте getTemplatePath()/setTemplatePath() вместо этого.

Параметры

строка|null $path необязательно null
Путь к файлам шаблонов. Если null, возвращает текущий путь.

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

строка|null

theme()source public

theme( string|null $theme null )

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

Устарело

3.5.0 Используйте getTheme()/setTheme() вместо этого.

Параметры

строка|null $theme необязательно null
Имя темы. Если null, возвращает текущую тему.

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

строка|null

uuid()source public

uuid( string $object , string $url )

Генерирует уникальный, не случайный идентификатор DOM для объекта, основанный на типе объекта и целевом URL.

Параметры

строка $object
Тип объекта, например, «форма» или «ссылка»
строка $url
Целевой URL объекта

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

строка

Методы, используемые из Cake\View\CellTrait

_createCell()source protected

_createCell( string $className , string $action , string $plugin , array $options )

Создать и настроить экземпляр ячейки.

Параметры

строка $className
Класс ячейки.
строка $action
Имя действия.
строка $plugin
Имя плагина.
массив $options
Параметры конструктора для ячейки.

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

Cake\View\Cell

cell()source protected

cell( string $cell , array $data [] , array $options [] )

Отображает заданную ячейку.

Пример:

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

Действие display будет использоваться по умолчанию, если действие не указано:

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

Ячейки отображаются только после того, как они будут выведены.

Параметры

строка $cell

Вы должны указать имя ячейки и, необязательно, действие ячейки. Например: TagCloud::smallList вызовет View\Cell\TagCloudCell::smallList(), действие display будет вызвано по умолчанию, если оно не указано.

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

Дополнительные аргументы для метода ячейки. Например: cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2']) соответствует View\Cell\TagCloud::smallList(v1, v2)

массив $options необязательно []
Параметры для конструктора ячейки

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

Cake\View\Cell
Экземпляр ячейки

Исключения

Cake\View\Exception\MissingCellException
Если класс ячейки не найден.
BadMethodCallException
Если класс ячейки не указал действие ячейки.

Методы, используемые из Cake\Event\EventDispatcherTrait

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

Обёртка для создания и отправки событий.

Возвращает обработанное событие.

Параметры

строка $name
Имя события.
массив|null $data необязательно null

Любое значение, которое вы хотите передать с этим событием, оно может быть прочитано слушателями.

объект|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

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

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Устарело

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательно null
установщик eventManager

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

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

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

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Параметры

Cake\Event\EventManager $eventManager
установщик eventManager

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


$this

Методы, используемые из Cake\Log\LogTrait

log()source public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Метод для удобной записи сообщения в журнал. Подробнее о записи в журналы см. Log::write().

Параметры

mixed $msg
Сообщение журнала.
integer|string $level необязательный LogLevel::ERROR
Уровень ошибки.
string|array $context необязательный []
Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

boolean
Успешность записи в журнал.

Методы, используемые из Cake\Routing\RequestActionTrait

requestAction()source public

requestAction( string|array $url , array $extra [] )

Вызывает метод контроллера из любого места. Может использоваться для подключения контроллеров друг к другу или для связывания плагинов с основным приложением. requestAction может использоваться для возвращения рендеренных представлений или получения значения возврата действий контроллера.

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Примеры

Базовый пример получения значения возврата действия контроллера:

$variables = $this->requestAction('/articles/popular');

Базовый пример requestAction для получения рендеренной страницы без макета.

$viewHtml = $this->requestAction('/articles/popular', ['return']);

Вы также можете передать URL в виде массива:

$vars = $this->requestAction(['controller' => 'articles', 'action' => 'popular']);

Передача других данных запроса

Вы можете передать данные POST, GET, COOKIE и другие данные в запрос, используя соответствующие ключи. Куки можно передать, используя ключ cookies. Параметры GET можно задать с помощью query, а данные POST можно отправить с помощью ключа post.

$vars = $this->requestAction('/articles/popular', [
  'query' => ['page' => 1],
  'cookies' => ['remember_me' => 1],
]);

Отправка значений среды или заголовков

По умолчанию действия, отправленные с помощью этого метода, будут использовать значения глобальных переменных $_SERVER и $_ENV. Если вы хотите переопределить эти значения для действия запроса, вы можете указать значения:

$vars = $this->requestAction('/articles/popular', [
  'environment' => ['CONTENT_TYPE' => 'application/json']
]);

Передача сессии

По умолчанию действия, отправленные с помощью этого метода, будут использовать стандартный объект сессии. Если вы хотите использовать определенный экземпляр сессии, вам нужно его указать.

$vars = $this->requestAction('/articles/popular', [
  'session' => new Session($someSessionConfig)
]);

Устаревшее

3.3.0 Вам следует переработать свой код, чтобы использовать View Cells вместо этого метода.

Параметры

string|array $url

Строковый или массивный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные аргументы в параметре $url.

array $extra необязательный []

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

Возвращает

mixed

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


Методы, используемые из Cake\View\ViewVarsTrait

createView()source public

createView( string|null $viewClass null )

Создает экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass необязательный null
Необязательное полное имя класса представления для создания экземпляра.

Возвращает

Cake\View\View

Инициирует

Cake\View\Exception\MissingViewException
Если класс представления не найден.

set()source public

set( string|array $name , mixed $value null )

Сохраняет переменную или ассоциативный массив переменных для использования в шаблоне.

Параметры

string|array $name
Строка или массив данных.
mixed $value необязательный null

Значение, если $name является строкой (которая затем используется в качестве ключа). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Возвращает


$this

viewBuilder()source public

viewBuilder( )

Получение используемого билдера представлений.

Возвращает

Cake\View\ViewBuilder

viewOptions()source public

viewOptions( string|array|null $options null , boolean $merge true )

Получение/Установка допустимых параметров представления в свойстве _validViewOptions объекта. Свойство создается как пустой массив, если оно не задано. Если вызывается без параметров, оно возвращает текущий список допустимых параметров представления. См. createView().

Параметры

string|array|null $options необязательный null
Строка или массив строк, которые нужно добавить к _validViewOptions.
boolean $merge необязательный true

Объединение или переопределение существующих допустимых параметров представления. По умолчанию true.

Возвращает

array
Обновленные параметры представления в виде массива.

Магические методы, унаследованные от Cake\Event\EventDispatcherInterface

getEventManager()

Подробное описание свойств

$Blockssource

public Cake\View\ViewBlock

Экземпляр ViewBlock.

$_currentsource

protected string

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

$_currentTypesource

protected string

В данный момент рендерится элемент. Используется для поиска родительских фрагментов для элементов.

''

$_extsource

protected string

Расширение файла. По умолчанию шаблон CakePHP имеет расширение ".ctp".

'.ctp'

$_helperssource

protected Cake\View\HelperRegistry

Коллекция хелперов.

$_parentssource

protected array

Имена представлений и их родителей, используемых с View::extend();

[]

$_passedVarssource

protected array

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

[
    'viewVars', 'autoLayout', 'helpers', 'template', 'layout', 'name', 'theme',
    'layoutPath', 'templatePath', 'plugin', 'passedArgs'
]

$_pathssource

protected array

Содержит массив путей.

[]

$_pathsForPluginsource

protected array

Содержит массив путей плагинов.

[]

$_stacksource

protected array

Стек содержимого, используется для вложенных шаблонов, которые все используют View::extend();

[]

$_viewBlockClasssource

protected string

Класс ViewBlock.

ViewBlock::class
END_OF_DOCUMENT_MARKER

$autoLayoutsource

public boolean

Включает или отключает стандартный режим CakePHP для применения файлов макета. По умолчанию включено. Отключение означает, что макеты не будут автоматически применяться к рендеряемым шаблонам.

true

$elementCachesource

public string

Конфигурация кэша, которую View будет использовать для хранения кэшированных элементов. Изменение этой конфигурации повлияет на стандартную конфигурацию, под которой хранятся элементы. Также можно выбрать конфигурацию кэша для каждого элемента.

См. также

\Cake\View\View::element()
'default'

$hasRenderedsource

public boolean

Истинно, когда представление было рендерировано.

false

$helperssource

public array

Массив имён встроенных помощников (helpers), которые нужно включить.

[]

$layoutsource

public string

Имя файла макета, внутри которого будет рендериться шаблон. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

'default'

$layoutPathsource

public string

Имя подкаталога макетов, содержащего макеты для данного представления.

$namesource

public string

Имя контроллера, который создал представление, если таковой имеется.

$passedArgssource

public array

Текущие переданные параметры. Передаются в представление из создающего контроллера для удобства.

Устарело

3.1.0 Используйте $this->request->getParam('pass') вместо этого.
[]

$pluginsource

public string

Имя плагина.

$requestsource

public Cake\Http\ServerRequest

Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для считывания дополнительной информации о запросе.

$responsesource

public Cake\Http\Response

Ссылка на объект Response

$subDirsource

public string|null

Подкаталог для этого файла шаблона. Часто используется для маршрутизации на основе расширений. Например, с расширением xml, $subDir будет xml/

$templatesource

public string

Имя файла шаблона для рендеринга. Указанное имя — это имя файла в /src/Template/ без расширения .ctp.

$templatePathsource

public string

Имя подкаталога, содержащего шаблоны для этого представления.

$themesource

public string|null

Тема представления для использования.

$uuidssource

public array

Список сгенерированных UUID DOM.

[]

Подробное описание магических свойств

$Blockssource

public Cake\View\ViewBlock

$Flashsource

public Cake\View\Helper\FlashHelper

$Formsource

public Cake\View\Helper\FormHelper

$Htmlsource

public Cake\View\Helper\HtmlHelper

$Numbersource

public Cake\View\Helper\NumberHelper

$Paginatorsource

public Cake\View\Helper\PaginatorHelper

$Rsssource

public Cake\View\Helper\RssHelper

$Sessionsource

public Cake\View\Helper\SessionHelper

$Textsource

public Cake\View\Helper\TextHelper

$Timesource

public Cake\View\Helper\TimeHelper

$Urlsource

public Cake\View\Helper\UrlHelper

$viewsource

public string

$viewPathsource

public string

© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.5/class-Cake.View.View.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API