Класс ViewBlock

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

Пакет: Cake\Представление
Авторские права: Авторские права (с) Cake Software Foundation, Inc. (https://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() вместо этого.

Параметры

string $name: Имя блока
string $value необязательно 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()

См. также

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 )

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

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

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

Параметры

string $name: Имя блока для захвата.

Исключения

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

startIfEmpty()source public

startIfEmpty( string $name )

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

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

Параметры

string $name: Имя блока для захвата.

unclosed()source public

unclosed( )

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

Возвращает

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

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

$_activesource

protected массив

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

array()

$_blockssource

protected массив

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

array()

END_OF_DOCUMENT_MARKER

$_discardActiveBufferOnEndsource

protected boolean

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

См. также

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

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/2.10/class-ViewBlock.html