class BlockView extends AbstractView (View source)

Work with the rendered view of a block.

$b = $this->getBlockObject();
$bv = new BlockView($b);

Traits

Properties

static protected $requestInstance from  AbstractView
static protected $requestInstances from  AbstractView
protected $scopeItems from  AbstractView
$controller from  AbstractView
protected $template from  AbstractView
protected $outputAssets from  AbstractView
protected Block|null $block
protected $area
protected $blockType
protected $blockTypePkgHandle
protected $blockViewHeaderFile
protected $blockViewFooterFile
protected $outputContent
protected $viewToRender
protected $viewPerformed
protected $showControls
protected $didPullFromOutputCache

Methods

getViewTemplate()

No description

addScopeItems($items)

No description

static 
getRequestInstance()

No description

__construct(mixed $mixed = false)

No description

static 
setRequestInstance(View $v)

No description

static 
revertRequestInstance()

No description

start($state)

No description

startRender()

No description

constructView($mixed)

Construct a block view object.

setupRender()

No description

finishRender($contents)

No description

action($task) deprecated

No description

addHeaderAsset($asset)

No description

addFooterAsset($asset)

No description

addOutputAsset($asset)

No description

requireAsset($assetType, $assetHandle = false)

No description

setController($controller)

No description

setViewTemplate($template)

No description

post($key, $defaultValue = null)

Returns the value of the item in the POST array.

onBeforeGetContents()

No description

postProcessViewContents($contents)

No description

onAfterGetContents()

No description

getScopeItems()

No description

render($state = false)

No description

renderViewContents($scopeItems)

Echo block contents.

static string
url(string $action, string $task = null)

URL is a utility function that is used inside a view to setup urls w/tasks and parameters.

renderError($title, $error, $errorObj = null)

No description

addHeaderItem($item)

No description

addFooterItem($item)

No description

static View
getInstance()

Get an instance of the View.

void
handleRequiredFeatures(mixed $controller, Theme $theme)

Given a block or page controller that we're rendering, we request all the features required by that block controller and then add them to the page's header/footer via requireAsset, if they're not already provided by the theme (which we check via getThemeSupportedFeatures)

void
requireFeaturesIfNotPresentInTheme(array $features, Theme $theme)

Requires one or more features if not present in theme.

showControls()

No description

disableControls()

No description

setAreaObject(Area $area)

No description

getAreaObject()

No description

setBlockViewHeaderFile($file)

No description

setBlockViewFooterFile($file)

No description

string
getBlockPath($filename = null) deprecated

Returns the path to the current block's directory.

string
getBlockURL($filename = null)

Returns a relative path to the current block's directory. If a filename is specified it will be appended and searched for as well.

inc($fileToInclude, $args = [])

No description

Block|null
getBlock()

No description

useBlockCache()

No description

field($field)

No description

usedBlockCacheDuringRender()

No description

runControllerTask()

No description

getThemePath()

Legacy.

fireOnBlockOutputEvent()

Fire an event just before the block is outputted on the page.

Details

getViewTemplate()

No description

addScopeItems($items)

No description

Parameters

$items

static getRequestInstance()

No description

__construct(mixed $mixed = false)

No description

Parameters

mixed $mixed

object to view

static protected setRequestInstance(View $v)

No description

Parameters

View $v

static protected revertRequestInstance()

No description

start($state)

No description

Parameters

$state

startRender()

No description

protected constructView($mixed)

Construct a block view object.

Parameters

$mixed

setupRender()

No description

finishRender($contents)

No description

Parameters

$contents

action($task) deprecated

deprecated in views, use $controller->getActionURL() using the same arguments

No description

Parameters

$task

addHeaderAsset($asset)

No description

Parameters

$asset

addFooterAsset($asset)

No description

Parameters

$asset

addOutputAsset($asset)

No description

Parameters

$asset

requireAsset($assetType, $assetHandle = false)

No description

Parameters

$assetType
$assetHandle

setController($controller)

No description

Parameters

$controller

setViewTemplate($template)

No description

Parameters

$template

post($key, $defaultValue = null)

Returns the value of the item in the POST array.

Parameters

$key
$defaultValue

protected onBeforeGetContents()

No description

postProcessViewContents($contents)

No description

Parameters

$contents

protected onAfterGetContents()

No description

getScopeItems()

No description

render($state = false)

No description

Parameters

$state

renderViewContents($scopeItems)

Echo block contents.

Parameters

$scopeItems

static string url(string $action, string $task = null)

URL is a utility function that is used inside a view to setup urls w/tasks and parameters.

Parameters

string $action
string $task

Return Value

string $url

renderError($title, $error, $errorObj = null)

No description

Parameters

$title
$error
$errorObj

addHeaderItem($item)

No description

Parameters

$item

addFooterItem($item)

No description

Parameters

$item

static View getInstance()

Get an instance of the View.

Note: In versions before 8.5.0a3, this method may return 'false' if it's called after the page is rendered (for example in middleware).

Return Value

View

protected void handleRequiredFeatures(mixed $controller, Theme $theme)

Given a block or page controller that we're rendering, we request all the features required by that block controller and then add them to the page's header/footer via requireAsset, if they're not already provided by the theme (which we check via getThemeSupportedFeatures)

Parameters

mixed $controller
Theme $theme

Return Value

void

protected void requireFeaturesIfNotPresentInTheme(array $features, Theme $theme)

Requires one or more features if not present in theme.

Parameters

array $features
Theme $theme

Return Value

void

showControls()

No description

disableControls()

No description

setAreaObject(Area $area)

No description

Parameters

Area $area

getAreaObject()

No description

setBlockViewHeaderFile($file)

No description

Parameters

$file

setBlockViewFooterFile($file)

No description

Parameters

$file

string getBlockPath($filename = null) deprecated

deprecated

Returns the path to the current block's directory.

Parameters

$filename

Return Value

string

string getBlockURL($filename = null)

Returns a relative path to the current block's directory. If a filename is specified it will be appended and searched for as well.

Parameters

$filename

Return Value

string

inc($fileToInclude, $args = [])

No description

Parameters

$fileToInclude
$args

Block|null getBlock()

Since: 9.0.3a1

No description

Return Value

Block|null

protected useBlockCache()

No description

field($field)

No description

Parameters

$field

usedBlockCacheDuringRender()

No description

runControllerTask()

No description

getThemePath()

Legacy.

private fireOnBlockOutputEvent()

Since: 8.4.1

Fire an event just before the block is outputted on the page.

Custom code can modify the block contents before the block contents are 'echoed' out on the page.