Класс 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( )

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

Возвращает

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

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 массив

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

[]

$_blockssource

protected массив

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

[]

$_discardActiveBufferOnEndsource

protected boolean

Следует ли игнорировать захваченное содержимое при ViewBlock::end()

См. также

\Cake\View\ViewBlock::end()

false

© 2005–2017 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.4/class-Cake.View.ViewBlock.html