SSViewer_DataPresenter

class SSViewer_DataPresenter extends SSViewer_Scope

This extends SSViewer_Scope to mix in data on top of what the item provides. This can be "global" data that is scope-independant (like BaseURL), or type-specific data that is layered on top cross-cut like (like $FirstLast etc).

It's separate from SSViewer_Scope to keep that fairly complex code as clean as possible.

Constants

ITEM

ITEM_ITERATOR

ITEM_ITERATOR_TOTAL

POP_INDEX

UP_INDEX

CURRENT_INDEX

ITEM_OVERLAY

Methods

__construct($item, $overlay = null, $underlay = null, $inheritedScope = null)

No description

getItem()

No description

from SSViewer_Scope
locally()

Called at the start of every lookup chain by SSTemplateParser to indicate a new lookup from local scope

from SSViewer_Scope
resetLocalScope()

No description

from SSViewer_Scope
getObj($name, $arguments = null, $forceReturnedObject = true, $cache = false, $cacheName = null)

No description

obj($name, $arguments = null, $forceReturnedObject = true, $cache = false, $cacheName = null)

$Up and $Top need to restore the overlay from the parent and top-level scope respectively.

object
self()

Gets the current object and resets the scope.

from SSViewer_Scope
pushScope()

Store the current overlay (as it doesn't directly apply to the new scope that's being pushed). We want to store the overlay against the next item "up" in the stack (hence upIndex), rather than the current item, because SSViewer_Scope::obj() has already been called and pushed the new item to the stack by this point

popScope()

Now that we're going to jump up an item in the item stack, we need to restore the overlay that was previously stored against the next item "up" in the stack from the current one

next()

No description

from SSViewer_Scope
__call($name, $arguments)

No description

array
getInjectedValue(string $property, array $params, bool $cast = true)

Get the injected value

Details

at line 418
__construct($item, $overlay = null, $underlay = null, $inheritedScope = null)

Parameters

$item
$overlay
$underlay
$inheritedScope

in SSViewer_Scope at line 72
getItem()

in SSViewer_Scope at line 77
locally()

Called at the start of every lookup chain by SSTemplateParser to indicate a new lookup from local scope

in SSViewer_Scope at line 88
resetLocalScope()

at line 622
getObj($name, $arguments = null, $forceReturnedObject = true, $cache = false, $cacheName = null)

Parameters

$name
$arguments
$forceReturnedObject
$cache
$cacheName

at line 595
obj($name, $arguments = null, $forceReturnedObject = true, $cache = false, $cacheName = null)

$Up and $Top need to restore the overlay from the parent and top-level scope respectively.

Parameters

$name
$arguments
$forceReturnedObject
$cache
$cacheName

in SSViewer_Scope at line 136
object self()

Gets the current object and resets the scope.

Return Value

object

at line 559
pushScope()

Store the current overlay (as it doesn't directly apply to the new scope that's being pushed). We want to store the overlay against the next item "up" in the stack (hence upIndex), rather than the current item, because SSViewer_Scope::obj() has already been called and pushed the new item to the stack by this point

at line 580
popScope()

Now that we're going to jump up an item in the item stack, we need to restore the overlay that was previously stored against the next item "up" in the stack from the current one

in SSViewer_Scope at line 163
next()

at line 628
__call($name, $arguments)

Parameters

$name
$arguments

at line 482
array getInjectedValue(string $property, array $params, bool $cast = true)

Get the injected value

Parameters

string $property Name of property
array $params
bool $cast If true, an object is always returned even if not an object.

Return Value

array Result array with the keys 'value' for raw value, or 'obj' if contained in an object

Exceptions

InvalidArgumentException