Spec-Zone.ru › CakePHP 4.2

Класс Renderer

Класс для рендеринга сообщения электронной почты.

Пространство имён: Cake\Mailer

Константы

  • string
    TEMPLATE_FOLDER
    'email'

    Константа для имени папки, содержащей шаблоны электронных писем.

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

  • $_viewBuilder protected
    Cake\View\ViewBuilder|null

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

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

  • __clone() public

    Клонирование экземпляра ViewBuilder при клонировании рендерера.

  • __construct() public

    Конструктор

  • createView() public

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

  • render() public

    Рендеринг текстового/HTML содержимого.

  • reset() public

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

  • set() public

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

  • viewBuilder() public

    Возвращает используемый билдер представлений.

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

__clone() public

__clone(): void

Клонирование экземпляра ViewBuilder при клонировании рендерера.

Возвращает

void

__construct() public

__construct()

Конструктор

createView() public

createView(string|null $viewClass = null): Cake\View\View

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

Параметры

string|null $viewClass optional

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

Возвращает

Cake\View\View

Исключения

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

render() public

render(string $content, string[] $types = []): array

Рендеринг текстового/HTML содержимого.

Если шаблон не задан, $content будет возвращён в виде хеша указанных типов содержимого для письма.

Параметры

string $content

Содержимое.

string[] $types optional

Типы содержимого для рендеринга. Допустимые значения массива: Message::MESSAGE_HTML, Message::MESSAGE_TEXT.

Возвращает

array

reset() public

reset(): $this

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

Возвращает

$this

set() public

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

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

Параметры

string|array $name

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

mixed $value optional

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

Возвращает

$this

viewBuilder() public

viewBuilder(): Cake\View\ViewBuilder

Возвращает используемый билдер представлений.

Возвращает

Cake\View\ViewBuilder

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

$_viewBuilder protected

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

Тип

Cake\View\ViewBuilder|null

© 2005–present 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/4.2/class-Cake.Mailer.Renderer.html

Spec-Zone.ru

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