SSViewer_DataPresenter
class SSViewer_DataPresenter extends SSViewer_Scope (View source)
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 |
|
Properties
| protected | object | $item | The current "global" item (the one any lookup starts from) |
from SSViewer_Scope |
| protected | Iterator | $itemIterator | If we're looping over the current "global" item, here's the iterator that tracks with item we're up to |
from SSViewer_Scope |
| protected | int | $itemIteratorTotal | Total number of items in the iterator |
from SSViewer_Scope |
| protected | array|null | $overlay | Overlay variables. Take precedence over anything from the current scope |
|
| protected | array | $underlay | Underlay variables. Concede precedence to overlay variables or anything from the current scope |
Methods
No description
Called at the start of every lookup chain by SSTemplateParser to indicate a new lookup from local scope
Reset the local scope - restores saved state to the "global" item stack. Typically called after a lookup chain has been completed
No description
$Up and $Top need to restore the overlay from the parent and top-level scope respectively.
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
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
No description
Look up injected value - it may be part of an "overlay" (arguments passed to <% include %>), set on the current item, part of an "underlay" ($Layout or $Content), or an iterator/global property
Evaluate a template override
Details
__construct($item, array $overlay = null, array $underlay = null, SSViewer_Scope $inheritedScope = null)
No description
object
getItem()
Returns the current "active" item
SSViewer_Scope
locally()
Called at the start of every lookup chain by SSTemplateParser to indicate a new lookup from local scope
resetLocalScope()
Reset the local scope - restores saved state to the "global" item stack. Typically called after a lookup chain has been completed
mixed
getObj(string $name, array $arguments = [], bool $cache = false, string $cacheName = null)
No description
$this
obj(string $name, array $arguments = [], bool $cache = false, string $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.
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
SSViewer_Scope
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
mixed
next()
Fast-forwards the current iterator to the next item
mixed
__call(string $name, array $arguments)
No description
protected array
getItemStack()
No description
protected
setItemStack(array $stack)
No description
protected int|null
getUpIndex()
No description
protected
cacheGlobalProperties()
Build cache of global properties
protected
cacheIteratorProperties()
Build cache of global iterator properties
protected array
getPropertiesFromProvider($interfaceToQuery, $variableMethod, $createObject = false)
No description
array|null
getInjectedValue(string $property, array $params, bool $cast = true)
Look up injected value - it may be part of an "overlay" (arguments passed to <% include %>), set on the current item, part of an "underlay" ($Layout or $Content), or an iterator/global property
protected null|array
processTemplateOverride(string $property, array $overrides)
Evaluate a template override
protected array|null
getValueSource(string $property)
Determine source to use for getInjectedValue
protected DBField
castValue(mixed $value, array $source)
Ensure the value is cast safely