eZPublishCommunityProject  2013.6
eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor Class Reference

Basic ValueObjectVisitor. More...

Inherited by eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ContentObjectStates, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ContentTypeCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ContentTypeGroupCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ContentTypeGroupUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\FieldDefinitionCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\Limitation, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\LocationCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\LocationUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ObjectStateCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ObjectStateGroupCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ObjectStateGroupUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\ObjectStateUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\PolicyCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\PolicyUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\RoleAssignment, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\RoleCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\RoleUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\SectionCreateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\SectionIncludingContentMetadataUpdateStruct, eZ\Publish\Core\REST\Client\Output\ValueObjectVisitor\SectionUpdateStruct, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Conflict, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentObjectStates, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentTypeGroup, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentTypeGroupList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentTypeGroupRefList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentTypeInfoList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentTypeList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Exception, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ImageVariation, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\LocationList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\NoContent, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ObjectStateGroup, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ObjectStateGroupList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ObjectStateList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\PermanentRedirect, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Policy, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\PolicyList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RelationList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ResourceCreated, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestContent, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestContentTypeBase, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestExecutedView, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestLocation, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestObjectState, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestRelation, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestTrashItem, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUser, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUserGroup, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUserGroupRoleAssignment, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUserRoleAssignment, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Role, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RoleAssignmentList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RoleList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Root, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Section, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\SectionList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\SeeOther, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\TemporaryRedirect, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Trash, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLAlias, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLAliasList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLAliasRefList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLWildcard, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLWildcardList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\UserGroupList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\UserGroupRefList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\UserList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\UserRefList, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\UserSession, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Version, eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\VersionInfo, and eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\VersionList.

Public Member Functions

 __construct (UrlHandler $urlHandler)
 Construct from used URL handler. More...
 
 visit (Visitor $visitor, Generator $generator, $data)
 Visit struct returned by controllers. More...
 

Protected Member Functions

 serializeBool ($boolValue)
 Returns a string representation for the given $boolValue. More...
 
 serializeSortField ($sortField)
 Serializes the given $sortField to a string representation. More...
 
 serializeSortOrder ($sortOrder)
 Serializes the given $sortOrder to a string representation. More...
 
 visitDescriptionsList (Generator $generator, array $descriptions)
 Visits the given list of $descriptions. More...
 
 visitLimitation (Generator $generator, Limitation $limitation)
 Visits a limitation. More...
 
 visitNamesList (Generator $generator, array $names)
 Visits the given list of $names. More...
 
 visitTranslatedList (Generator $generator, array $translatedElements, $listName)
 Visits a list of translated elements. More...
 

Protected Attributes

 $urlHandler
 

Detailed Description

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::__construct ( UrlHandler  $urlHandler)

Construct from used URL handler.

Parameters
\eZ\Publish\Core\REST\Common\UrlHandler$urlHandler

Member Function Documentation

eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::serializeBool (   $boolValue)
protected

Returns a string representation for the given $boolValue.

Parameters
boolean$boolValue
Returns
string

Referenced by eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\URLAlias\visit(), and eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestFieldDefinition\visit().

eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::serializeSortField (   $sortField)
protected
eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::serializeSortOrder (   $sortOrder)
protected
eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::visit ( Visitor  $visitor,
Generator  $generator,
  $data 
)
abstract

Visit struct returned by controllers.

Parameters
\eZ\Publish\Core\REST\Common\Output\Visitor$visitor
\eZ\Publish\Core\REST\Common\Output\Generator$generator
mixed$data
eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::visitDescriptionsList ( Generator  $generator,
array  $descriptions 
)
protected
eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::visitLimitation ( Generator  $generator,
Limitation  $limitation 
)
protected

Visits a limitation.

Parameters
\eZ\Publish\Core\REST\Common\Output\Generator$generator
\eZ\Publish\API\Repository\Values\User\Limitation$limitation

Referenced by eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Policy\visit(), eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUserRoleAssignment\visit(), and eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\RestUserGroupRoleAssignment\visit().

eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::visitTranslatedList ( Generator  $generator,
array  $translatedElements,
  $listName 
)
protected

Visits a list of translated elements.

Parameters
\eZ\Publish\Core\REST\Common\Output\Generator$generator
array$translatedElements
mixed$listName

Referenced by eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor\visitDescriptionsList(), and eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor\visitNamesList().

Member Data Documentation

eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::$urlHandler
protected

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