Класс ViewBlock

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

Пакет: Cake\Представление
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/View/ViewBlock.php

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

string

APPEND

'append'
string

PREPEND

'prepend'

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

$_active protected

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

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

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

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

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

Добавить в существующий или новый блок. Добавление в новый блок создаст блок.
concat() public

Добавить содержимое к существующему или новому блоку. Добавление к новому блоку создаст блок.
end() public
Закончить захватывающий блок. Соответствие ViewBlock::start()
exists() public
Проверить существование блока
get() public
Получить содержимое блока.
keys() public
Получить имена всех существующих блоков.
set() public

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

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

active()source public

active( )

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

Возвращает

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

append()source public

append( string $name , string $value null )

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

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

Устарело

3.0.0 Начиная с 2.3, используйте ViewBlock::concat() вместо этого.

Параметры

строка $name: Имя блока
строка $value необязательно null: Содержимое блока.

concat()source public

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

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

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

Параметры

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

end()source public

end( )

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

См. также

ViewBlock::start()

exists()source public

exists( string $name )

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

Параметры

строка $name: Имя блока

Возвращает

boolean

get()source public

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

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

Параметры

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

Возвращает

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

keys()source public

keys( )

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

Возвращает

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

set()source public

set( string $name , mixed $value )

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

Параметры

строка $name: Имя блока
смешанное $value: Содержимое блока.

start()source public

start( string $name )

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

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

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

Параметры

строка $name: Имя блока, для которого нужно захватить.

Исключения

CakeException
При повторном начале блока

startIfEmpty()source public

startIfEmpty( string $name )

Начать захват вывода для 'блока', если он пуст

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

Параметры

строка $name: Имя блока, для которого нужно захватить.

unclosed()source public

unclosed( )

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

Возвращает

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

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

$_activesource

protected массив

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

array()

$_blockssource

protected массив

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

array()

END_OF_DOCUMENT_MARKER

$_discardActiveBufferOnEndsource

protected boolean

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

См. также

ViewBlock::end()
ViewBlock::startIfEmpty()

false

© 2005–2016 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/2.9/class-ViewBlock.html