eZPublishCommunityProject  2013.5
eZ\Publish\Core\REST\Common\Input\ParserTools Class Reference

Tools object to be used in Input Parsers. More...

Public Member Functions

 isEmbeddedObject (array $objectElement)
 Returns if the given $objectElement has embedded object data or is only a reference. More...
 
 parseBooleanValue ($stringValue)
 Parses a boolean from $stringValue. More...
 
 parseDefaultSortField ($defaultSortFieldString)
 Parses the default sort field from the given $defaultSortFieldString. More...
 
 parseDefaultSortOrder ($defaultSortOrderString)
 Parses the default sort order from the given $defaultSortOrderString. More...
 
 parseLimitation (array $limitation)
 Parses the input structure to Limitation object. More...
 
 parseObjectElement (array $objectElement, ParsingDispatcher $parsingDispatcher)
 Parses the given $objectElement, if it contains embedded data. More...
 
 parseStatus ($contentTypeStatus)
 Parses the content types status from $contentTypeStatus. More...
 
 parseTranslatableList (array $listElement)
 Parses a translatable list, like names or descriptions. More...
 

Protected Member Functions

 getLimitationByIdentifier ($identifier)
 Instantiates Limitation object based on identifier. More...
 

Detailed Description

Tools object to be used in Input Parsers.

Member Function Documentation

eZ\Publish\Core\REST\Common\Input\ParserTools::getLimitationByIdentifier (   $identifier)
protected

Instantiates Limitation object based on identifier.

Parameters
string$identifier
Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundException
Returns
Todo:
Use dependency injection system

Referenced by eZ\Publish\Core\REST\Common\Input\ParserTools\parseLimitation().

eZ\Publish\Core\REST\Common\Input\ParserTools::isEmbeddedObject ( array  $objectElement)

Returns if the given $objectElement has embedded object data or is only a reference.

Parameters
array$objectElement
Returns
boolean

Referenced by eZ\Publish\Core\REST\Common\Input\ParserTools\parseObjectElement().

eZ\Publish\Core\REST\Common\Input\ParserTools::parseBooleanValue (   $stringValue)

Parses a boolean from $stringValue.

Parameters
string$stringValue
Returns
boolean
eZ\Publish\Core\REST\Common\Input\ParserTools::parseDefaultSortField (   $defaultSortFieldString)

Parses the default sort field from the given $defaultSortFieldString.

Parameters
string$defaultSortFieldString
Returns
int
eZ\Publish\Core\REST\Common\Input\ParserTools::parseDefaultSortOrder (   $defaultSortOrderString)

Parses the default sort order from the given $defaultSortOrderString.

Parameters
string$defaultSortOrderString
Returns
int
eZ\Publish\Core\REST\Common\Input\ParserTools::parseLimitation ( array  $limitation)

Parses the input structure to Limitation object.

Parameters
array$limitation
Returns
eZ\Publish\Core\REST\Common\Input\ParserTools::parseObjectElement ( array  $objectElement,
ParsingDispatcher  $parsingDispatcher 
)

Parses the given $objectElement, if it contains embedded data.

Parameters
array$objectElement
\eZ\Publish\Core\REST\Common\Input\ParsingDispatcher$parsingDispatcher
Returns
mixed
eZ\Publish\Core\REST\Common\Input\ParserTools::parseStatus (   $contentTypeStatus)

Parses the content types status from $contentTypeStatus.

Parameters
string$contentTypeStatus
Returns
int
eZ\Publish\Core\REST\Common\Input\ParserTools::parseTranslatableList ( array  $listElement)

Parses a translatable list, like names or descriptions.

Parameters
array$listElement
Returns
array

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