eZPublishCommunityProject  2013.9
eZ\Publish\Core\REST\Common\RequestParser Interface Reference

Interface for Request parsers. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Common\RequestParser:

Public Member Functions

 generate ($type, array $values=array())
 Generate a URL of the given type from the specified values. More...
 
 parse ($url)
 Parse URL and return the IDs contained in the URL. More...
 
 parseHref ($href, $attribute)
 Tries to match $href as a route, and returns the value of $attribute from the result. More...
 

Detailed Description

Interface for Request parsers.

Member Function Documentation

eZ\Publish\Core\REST\Common\RequestParser::generate (   $type,
array  $values = array() 
)

Generate a URL of the given type from the specified values.

Parameters
string$type
array$values
Returns
string

Implemented in eZ\Publish\Core\REST\Common\RequestParser\Pattern, eZ\Bundle\EzPublishRestBundle\RequestParser\Router, and eZ\Publish\Core\REST\Common\RequestParser\Prefixed.

eZ\Publish\Core\REST\Common\RequestParser::parse (   $url)

Parse URL and return the IDs contained in the URL.

Parameters
string$url
Returns
array

Implemented in eZ\Publish\Core\REST\Common\RequestParser\Pattern, and eZ\Bundle\EzPublishRestBundle\RequestParser\Router.

eZ\Publish\Core\REST\Common\RequestParser::parseHref (   $href,
  $attribute 
)

Tries to match $href as a route, and returns the value of $attribute from the result.

Parameters
string$href
string$attribute
Returns
mixed|false

Implemented in eZ\Publish\Core\REST\Common\RequestParser\Pattern, and eZ\Bundle\EzPublishRestBundle\RequestParser\Router.


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