Spec-Zone.ru › CakePHP 4.3

Класс ViewBlock

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

Пространство имен: Cake\View

Константы

  • string
    APPEND
    'append'

    Добавить контент

  • string
    OVERRIDE
    'override'

    Переопределить контент

  • string
    PREPEND
    'prepend'

    Вставить контент в начало

Резюме свойств

  • $_active protected
    array<string>

    Активные блоки, которые захватываются.

  • $_blocks protected
    array<string>

    Содержание блоков. Массив блоков, индексированных по имени.

  • $_discardActiveBufferOnEnd protected
    bool

    Необходимо ли отбрасывать захваченное содержимое при ViewBlock::end()

Резюме методов

  • active() public

    Получить имя текущего открытого блока.

  • concat() public

    Добавить контент к существующему или новому блоку. Добавление к новому блоку создаст блок.

  • end() public

    Закончить захват блока. Соответствует ViewBlock::start()

  • exists() public

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

  • get() public

    Получить содержимое блока.

  • keys() public

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

  • set() public

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

  • start() public

    Начать захват вывода для 'блока'

  • unclosed() public

    Получить незакрытые/активные блоки. Ключ - имя, значение - режим.

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

active() public

active(): string|null

Получить имя текущего открытого блока.

Возвращает

string|null

concat() public

concat(string $name, mixed $value = null, string $mode = ViewBlock::APPEND): void

Добавить контент к существующему или новому блоку. Добавление к новому блоку создаст блок.

Вызов concat() без значения создаст новый блок захвата, который необходимо завершить с помощью View::end(). Содержимое нового контекста захвата будет добавлено к существующему контексту блока.

Параметры

string $name

Имя блока

mixed $value optional

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

string $mode optional

Если ViewBlock::APPEND, контент будет добавлен к существующему контенту. Если ViewBlock::PREPEND, он будет вставлен в начало.

Возвращает

void

end() public

end(): void

Закончить захват блока. Соответствует ViewBlock::start()

Возвращает

void

См. также

\Cake\View\ViewBlock::start()

exists() public

exists(string $name): bool

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

Параметры

string $name

Имя блока

Возвращает

bool

get() public

get(string $name, string $default = ''): string

Получить содержимое блока.

Параметры

string $name

Имя блока

string $default optional

Значение по умолчанию

Возвращает

string

keys() public

keys(): array<string>

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

Возвращает

array<string>

set() public

set(string $name, mixed $value): void

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

Параметры

string $name

Имя блока

mixed $value

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

Возвращает

void

start() public

start(string $name, string $mode = ViewBlock::OVERRIDE): void

Начать захват вывода для 'блока'

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

Вы можете завершить захват блоков с помощью View::end(). Блоки можно выводить с помощью View::get();

Параметры

string $name

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

string $mode optional

Если ViewBlock::OVERRIDE, существующее содержимое будет перезаписано новым. Если ViewBlock::APPEND, контент будет добавлен к существующему. Если ViewBlock::PREPEND, он будет вставлен в начало.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
При повторном запуске блока

unclosed() public

unclosed(): array<string>

Получить незакрытые/активные блоки. Ключ - имя, значение - режим.

Возвращает

array<string>

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

$_active protected

Активные блоки, которые захватываются.

Тип

array<string>

$_blocks protected

Содержание блоков. Массив блоков, индексированных по имени.

Тип

array<string>

$_discardActiveBufferOnEnd protected

Необходимо ли отбрасывать захваченное содержимое при ViewBlock::end()

Тип

bool

© 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.3/class-Cake.View.ViewBlock.html

Spec-Zone.ru

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