Класс ViewBlock

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

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

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

string

APPEND

'append'
string

OVERRIDE

'override'
string

PREPEND

'prepend'

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

$_active protected

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

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

boolean
Должно ли текущее захваченное содержимое быть отброшено при ViewBlock::end()?

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

active() public
Получение имени текущего открытого блока.
concat() public

Добавление содержимого к существующему или новому блоку. Добавление к новому блоку создаст его.
end() public
Завершение захвата блока. Комплементарная функция ViewBlock::start()
exists() public
Проверка существования блока
get() public
Получение содержимого блока.
keys() public
Получение имён всех существующих блоков.
set() public

Установка содержимого блока. Это перезапишет любое существующее содержимое.
start() public
Начало захвата вывода для 'блока'
unclosed() public
Получение имён незакрытых/активных блоков.

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

active()source public

active( )

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

Возвращает

string|null
Либо null, либо имя последнего открытого блока.

concat()source public

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

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

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

Параметры

string $name: Имя блока
mixed $value необязательно null: Содержимое блока. Значение будет приведено к строковому типу.
string $mode необязательно ViewBlock::APPEND: Если ViewBlock::APPEND содержимое будет добавлен к существующему содержимому. Если ViewBlock::PREPEND — в начало.

end()source public

end( )

Завершение захвата блока. Комплементарная функция ViewBlock::start()

См. также

\Cake\View\ViewBlock::start()

exists()source public

exists( string $name )

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

Параметры

string $name: Имя блока

Возвращает

boolean

get()source public

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

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

Параметры

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

Возвращает

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

keys()source public

keys( )

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

Возвращает

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

set()source public

set( string $name , mixed $value )

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

Параметры

string $name: Имя блока
mixed $value: Содержимое блока. Значение будет приведено к строковому типу.

start()source public

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

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

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

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

Параметры

string $name: Имя блока для захвата.
string $mode необязательно ViewBlock::OVERRIDE: Если ViewBlock::OVERRIDE существующее содержимое будет перезаписано новым. Если ViewBlock::APPEND содержимое будет добавлен к существующему. Если ViewBlock::PREPEND — в начало.

Исключения

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

unclosed()source public

unclosed( )

Получение имён незакрытых/активных блоков.

Возвращает

array
Массив незакрытых блоков.

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

$_activesource

protected array

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

[]

$_blockssource

protected array

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

[]

$_discardActiveBufferOnEndsource

protected boolean

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

См. также

\Cake\View\ViewBlock::end()

false

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