Zend Framework
Back to top  

Marker view model for indicating feed data.

 Methods

Constructor

__construct(null | array | \Traversable $variables, array | \Traversable $options) 
Inherited

inherited_from \Zend\View\Model\ViewModel::__construct()

Parameters

$variables

nullarray\Traversable

$options

array\Traversable

Property overloading: get variable value

__get(string $name) : mixed
Inherited

inherited_from \Zend\View\Model\ViewModel::__get()

Parameters

$name

string

Returns

mixed

Property overloading: do we have the requested variable value?

__isset(string $name) : bool
Inherited

inherited_from \Zend\View\Model\ViewModel::__isset()

Parameters

$name

string

Returns

bool

Property overloading: set variable value

__set(string $name, mixed $value) : void
Inherited

inherited_from \Zend\View\Model\ViewModel::__set()

Parameters

$name

string

$value

mixed

Property overloading: unset the requested variable

__unset(string $name) : void
Inherited

inherited_from \Zend\View\Model\ViewModel::__unset()

Parameters

$name

string

Add a child model

addChild(\Zend\View\Model\ModelInterface $child, null | string $captureTo, null | bool $append) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::addChild()

Parameters

$child

\Zend\View\Model\ModelInterface

$captureTo

nullstring

Optional; if specified, the "capture to" value to set on the child

$append

nullbool

Optional; if specified, append to child with the same capture

Returns

\Zend\View\Model\ViewModel

Get the name of the variable to which to capture this model

captureTo() : string
Inherited

inherited_from \Zend\View\Model\ViewModel::captureTo()

Returns

string

Clears out all child models

clearChildren() : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::clearChildren()

Returns

\Zend\View\Model\ViewModel

Clear any existing renderer options/hints

clearOptions() : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::clearOptions()

Returns

\Zend\View\Model\ViewModel

Clear all variables

clearVariables() : \Zend\View\Model\ViewModel
Inherited

Resets the internal variable container to an empty container.

inherited_from \Zend\View\Model\ViewModel::clearVariables()

Returns

\Zend\View\Model\ViewModel

Return count of children

count() : int
Inherited

inherited_from \Zend\View\Model\ViewModel::count()

Returns

int

Return all children.

getChildren() : array
Inherited

Return specifies an array, but may be any iterable object.

inherited_from \Zend\View\Model\ViewModel::getChildren()

Returns

array

Returns an array of Viewmodels with captureTo value $capture

getChildrenByCaptureTo(string $capture, bool $recursive) : array
Inherited

inherited_from \Zend\View\Model\ViewModel::getChildrenByCaptureTo()

Parameters

$capture

string

$recursive

bool

search recursive through children, default true

Returns

array

getFeed() 

getFeed() : \Zend\Feed\Writer\Feed

Returns

\Zend\Feed\Writer\Feed

Get the feed type

getFeedType() : false | string

Returns

falsestring

Get iterator of children

getIterator() : \ArrayIterator
Inherited

inherited_from \Zend\View\Model\ViewModel::getIterator()

Returns

\ArrayIterator

Get a single option

getOption(string $name, mixed | null $default) : mixed
Inherited

inherited_from \Zend\View\Model\ViewModel::getOption()

Parameters

$name

string

The option to get.

$default

mixednull

(optional) A default value if the option is not yet set.

Returns

mixed

Get renderer options/hints

getOptions() : array
Inherited

inherited_from \Zend\View\Model\ViewModel::getOptions()

Returns

array

Get the template to be used by this model

getTemplate() : string
Inherited

inherited_from \Zend\View\Model\ViewModel::getTemplate()

Returns

string

Get a single view variable

getVariable(string $name, mixed | null $default) : mixed
Inherited

inherited_from \Zend\View\Model\ViewModel::getVariable()

Parameters

$name

string

$default

mixednull

(optional) default value if the variable is not present.

Returns

mixed

Get view variables

getVariables() : array | \ArrayAccess | \Traversable
Inherited

inherited_from \Zend\View\Model\ViewModel::getVariables()

Returns

array\ArrayAccess\Traversable

Does the model have any children?

hasChildren() : bool
Inherited

inherited_from \Zend\View\Model\ViewModel::hasChildren()

Returns

bool

Is this append to child with the same capture?

isAppend() : bool
Inherited

inherited_from \Zend\View\Model\ViewModel::isAppend()

Returns

bool

Set flag indicating whether or not append to child with the same capture

setAppend(bool $append) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setAppend()

Parameters

$append

bool

Returns

\Zend\View\Model\ViewModel

Set the name of the variable to capture this model to, if it is a child model

setCaptureTo(string $capture) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setCaptureTo()

Parameters

$capture

string

Returns

\Zend\View\Model\ViewModel

Set the feed object

setFeed(\Zend\Feed\Writer\Feed $feed) : \Zend\View\Model\FeedModel

Parameters

$feed

\Zend\Feed\Writer\Feed

Returns

\Zend\View\Model\FeedModel

Set a single option

setOption(string $name, mixed $value) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setOption()

Parameters

$name

string

$value

mixed

Returns

\Zend\View\Model\ViewModel

Set renderer options/hints en masse

setOptions(array | \Traversable $options) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\View\Exception\InvalidArgumentException

Returns

\Zend\View\Model\ViewModel

Set the template to be used by this model

setTemplate(string $template) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setTemplate()

Parameters

$template

string

Returns

\Zend\View\Model\ViewModel

Set flag indicating whether or not this is considered a terminal or standalone model

setTerminal(bool $terminate) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setTerminal()

Parameters

$terminate

bool

Returns

\Zend\View\Model\ViewModel

Set view variable

setVariable(string $name, mixed $value) : \Zend\View\Model\ViewModel
Inherited

inherited_from \Zend\View\Model\ViewModel::setVariable()

Parameters

$name

string

$value

mixed

Returns

\Zend\View\Model\ViewModel

Set view variables en masse

setVariables(array | \ArrayAccess | \Traversable $variables, bool $overwrite) : \Zend\View\Model\ViewModel
Inherited

Can be an array or a Traversable + ArrayAccess object.

inherited_from \Zend\View\Model\ViewModel::setVariables()

Parameters

$variables

array\ArrayAccess\Traversable

$overwrite

bool

Whether or not to overwrite the internal container with $variables

Exceptions

\Zend\View\Exception\InvalidArgumentException

Returns

\Zend\View\Model\ViewModel

Is this considered a terminal or standalone model?

terminate() : bool
Inherited

inherited_from \Zend\View\Model\ViewModel::terminate()

Returns

bool

 Properties

 

Is this append to child with the same capture?

$append : bool
Inherited

inherited_from \Zend\View\Model\ViewModel::$$append
 

What variable a parent model should capture this model to

$captureTo : string
Inherited

inherited_from \Zend\View\Model\ViewModel::$$captureTo
 

Child models

$children : array
Inherited

inherited_from \Zend\View\Model\ViewModel::$$children
 

$feed

$feed : \Zend\Feed\Writer\Feed

 

Renderer options

$options : array
Inherited

inherited_from \Zend\View\Model\ViewModel::$$options
 

Template to use when rendering this model

$template : string
Inherited

inherited_from \Zend\View\Model\ViewModel::$$template
 

A feed is always terminal

$terminate : bool

 

$type

$type : false | string

 

View variables

$variables : array | \Zend\View\Model\ArrayAccessTraversable
Inherited

inherited_from \Zend\View\Model\ViewModel::$$variables