eZPublishCommunityProject  2012.12
eZ\Publish\Core\MVC\Legacy\Templating\Converter\MultipleObjectConverter Interface Reference

Interface for multiple object converters. More...

+ Inheritance diagram for eZ\Publish\Core\MVC\Legacy\Templating\Converter\MultipleObjectConverter:
+ Collaboration diagram for eZ\Publish\Core\MVC\Legacy\Templating\Converter\MultipleObjectConverter:

Public Member Functions

 convertAll ()
 Converts all registered objects and returns them in a hash where the object's alias is the key. More...
 
 register ($object, $alias)
 Registers an object to the converter. More...
 
- Public Member Functions inherited from eZ\Publish\Core\MVC\Legacy\Templating\Converter\ObjectConverter
 convert ($object)
 Converts $object to make it compatible with eZTemplate API. More...
 

Detailed Description

Interface for multiple object converters.

This is useful if one needs to convert several objects at once.

Member Function Documentation

eZ\Publish\Core\MVC\Legacy\Templating\Converter\MultipleObjectConverter::convertAll ( )

Converts all registered objects and returns them in a hash where the object's alias is the key.

Returns
array|[]

Implemented in eZ\Publish\Core\MVC\Legacy\Templating\Converter\ApiContentConverter, and eZ\Publish\Core\MVC\Legacy\Templating\Converter\DelegatingConverter.

eZ\Publish\Core\MVC\Legacy\Templating\Converter\MultipleObjectConverter::register (   $object,
  $alias 
)

Registers an object to the converter.

$alias is the variable name that will be exposed in the legacy template.

Parameters
mixed$object
string$alias
Exceptions
\InvalidArgumentExceptionIf $object is not an object
Returns
void

Implemented in eZ\Publish\Core\MVC\Legacy\Templating\Converter\ApiContentConverter, and eZ\Publish\Core\MVC\Legacy\Templating\Converter\DelegatingConverter.


The documentation for this interface was generated from the following file: