Класс SerializedView

__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

Экземпляр EventManager.

массив $viewOptions опционально []

Массив опций представления

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

Cake\View\View::__construct()

_serialize()source abstract protected

_serialize( array|string $serialize )

Сериализация переменных представления.

Параметры

массив|строка $serialize

Имя(а) переменной(ых) представления, которые необходимо сериализовать

Возвращает

строка
Сериализованные данные

loadHelpers()source public

loadHelpers( )

Загрузка хелперов только если сериализация отключена.

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

Cake\View\View::loadHelpers()

render()source public

render( string|boolean|null $view = null , string|null $layout = null )

Вывод шаблона представления или возвращение сериализованных данных.

Специальные параметры

_serialize Для преобразования набора переменных представления в сериализованную форму. Его значение может быть строкой для имени одной переменной или массивом для нескольких имен. Если значение true, будут сериализованы все переменные представления. Если значение не установлено, будет выведен обычный шаблон представления.

Параметры

строка|логическое|null $view опционально null

Представление, которое отображается.

строка|null $layout опционально null

Макет, который отображается.

Возвращает

строка|null
Отображаемое представление.

Выбрасывает

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

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

Cake\View\View::render()

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

autoLayout( boolean|null $autoLayout = null )

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

Устарело

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

Параметры

логическое значение|null $autoLayout необязательно null

Логическое значение для включения/выключения. Если null, возвращает текущее значение.

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

логическое значение|null

blocks()source public

blocks( )

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

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

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

См. также

\Cake\View\ViewBlock::keys()

cache()source public

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

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

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

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

Параметры

вызываемый объект $block

Блок кода, вывод которого необходимо кэшировать.

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

Опции, определяющие ключ кэша и т.д.

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

строка
Отображаемый контент.

Исключения

RuntimeException
Когда в $options отсутствует опция 'key'.

disableAutoLayout()source public

disableAutoLayout( )

Отключает традиционный режим CakePHP по применению файлов макета.

Макеты не будут автоматически применяться к отрисованным представлениям.

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

$this

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

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

логическое значение
Успех

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 )

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

Параметры

string $name

Имя блока

Возвращает

boolean

extend()source public

extend( string $name )

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

Параметры

string $name

Шаблон или элемент, с которым нужно «расширить» текущий.

Возвращает

$this

Исключения

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

fetch()source public

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

Извлечь содержимое для блока. Если блок пуст или не определен, возвращается «».

Параметры

string $name

Имя блока

string $default необязательный ''

Текстовое значение по умолчанию

Возвращает

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

См. также

\Cake\View\ViewBlock::get()

get()source public

get( string $var , mixed $default = null )

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

Параметры

string $var

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

mixed $default необязательный null

Значение по умолчанию/значение fallback для $var.

Возвращает

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

getCurrentType()source public

getCurrentType( )

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

Возвращает

string

getLayout()source public

getLayout( )

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

Возвращает

string

getLayoutPath()source public

getLayoutPath( )

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

Возвращает

string

getName()source public

getName( )

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

Возвращает

string|null

С версии

3.7.7

getPlugin()source public

getPlugin( )

Возвращает имя плагина.

Возвращает

string|null

С версии

3.7.0

getRequest()source public

getRequest( )

Получение экземпляра запроса.

Возвращает

Cake\Http\ServerRequest

С версии

3.7.0

getResponse()source public

getResponse( )

Получение экземпляра ответа.

Возвращает

Cake\Http\Response

С версии

3.7.0

getSubDir()source public

getSubDir( )

Получение подкаталога для файлов шаблона.

Возвращает

string

См. также

\Cake\View\View::$subDir

С версии

3.7.0

getTemplate()source public

getTemplate( )

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

Возвращает

string

getTemplatePath()source public

getTemplatePath( )

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

Возвращает

string

getTheme()source public

getTheme( )

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

Возвращает

string|null

getVars()source public

getVars( )

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

Возвращает

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

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 optional []

Настройки для хелпера

Возвращает

Cake\View\Helper
объект сконструированного хелпера.

См. также

\Cake\View\HelperRegistry::load()

pluginSplit()source public

pluginSplit( string $name , boolean $fallback = true )

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

Параметры

string $name

Имя плагина, которое нужно разделить.

boolean $fallback optional true

Если true, использует плагин, установленный в текущем запросе, когда загруженный плагин не найден

Возвращает

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

prepend()source public

prepend( string $name , mixed $value )

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

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

Параметры

string $name

Имя блока

mixed $value

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::concat()

renderLayout()source public

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

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

Параметры

string $content

Содержимое для отображения в шаблоне, заключённое в окружающий макет.

string|null $layout optional 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()

setElementCache()source public

setElementCache( string $elementCache )

Устанавливает конфигурацию кэша, которую представление будет использовать для хранения кэшированных элементов

Параметры

string $elementCache

Имя конфигурации кэша.

Возвращает

$this

См. также

\Cake\View\View::$elementCache

С версии

3.7.0

setLayout()source public

setLayout( string $name )

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

Параметры

string $name

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

Возвращает

$this

setLayoutPath()source public

setLayoutPath( string $path )

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

Параметры

string $path

Путь для файлов макета.

Возвращает

$this

setPlugin()source public

setPlugin( string $name )

Устанавливает имя плагина.

Параметры

string $name

Имя плагина.

Возвращает

$this

С версии

3.7.0

setRequest()source public

setRequest( Cake\Http\ServerRequest $request )

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Свойства, которые устанавливаются:

• $this->request - В $request параметр
• $this->plugin - В значение, возвращённое $request->getParam('plugin')
• $this->passedArgs - То же, что и $request->params['pass]

Параметры

Cake\Http\ServerRequest $request

Экземпляр запроса.

Возвращает

$this

С версии

3.7.0

setResponse()source public

setResponse( Cake\Http\Response $response )

Устанавливает экземпляр ответа.

Параметры

Cake\Http\Response $response

Экземпляр ответа.

Возвращает

$this

С версии

3.7.0

setSubDir()source public

setSubDir( string $subDir )

Установить подкаталог для файлов шаблонов.

Параметры

string $subDir

Имя подкаталога.

Возвращает

$this

См. также

\Cake\View\View::$subDir

С версии

3.7.0

setTemplate()source public

setTemplate( string $name )

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

Параметры

string $name

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

Возвращает

$this

setTemplatePath()source public

setTemplatePath( string $path )

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

Параметры

string $path

Путь для файлов шаблонов.

Возвращает

$this

setTheme()source public

setTheme( string|null $theme )

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

Параметры

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

Параметры

string $name

Имя блока для захвата.

Возвращает

$this

См. также

\Cake\View\ViewBlock::start()

template()source public deprecated

template( string|null $name = null )

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

Устарело

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

Параметры

string|null $name optional null

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

Возвращает

string|null

templatePath()source public deprecated

templatePath( string|null $path = null )

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

Устарело

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

Параметры

string|null $path optional null

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

Возвращает

string|null

theme()source public deprecated

theme( string|null $theme = null )

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

Устарело

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

Параметры

string|null $theme необязательно null

Имя темы. Если null, возвращает текущую тему.

Возвращает

string|null

uuid()source public deprecated

uuid( string $object , string $url )

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

Устарело

3.7.0 Этот метод устарел и будет удалён в версии 4.0.0.

Параметры

string $object

Тип объекта, например, 'форма' или 'ссылка'

string $url

Целевой URL объекта

Возвращает

string

_createCell()source protected

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

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

Параметры

string $className

Имя класса ячейки.

string $action

Имя действия.

string $plugin

Имя плагина.

array $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');

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

Параметры

string $cell

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

array $data необязательно []

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

array $options необязательно []

Параметры для конструктора ячейки

Возвращает

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

Выбрасывает

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

dispatchEvent()source public

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

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

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

Параметры

string $name

Имя события.

array|null $data необязательно null

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

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

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

Возвращает

Cake\Event\Event

eventManager()source public deprecated

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

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
Успешность записи в журнал.

requestAction()source public deprecated

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

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

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

Примеры

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

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

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

$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 Вы должны переработать свой код, чтобы использовать ячейки представления вместо этого метода.

Параметры

string|array $url

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

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

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

Возвращает

mixed

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

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 )

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

Параметры

строка|массив $name

Строка или массив данных.

смешанное $value необязательно null

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

Возвращает

$this

viewBuilder()source public

viewBuilder( )

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

Возвращает

Cake\View\ViewBuilder

viewOptions()source public deprecated

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

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

Устарело

3.7.0 Используйте ViewBuilder::setOptions() или любой из его методов-сеттеров вместо этого.

Параметры

строка|массив|null $options необязательно null

строка или массив строк, которые нужно добавить в _validViewOptions.

boolean $merge необязательно true

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

Возвращает

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