eZPublishCommunityProject  2013.9
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement Class Reference
+ Inheritance diagram for eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement:
+ Collaboration diagram for eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement:

Public Member Functions

 __construct ($elementNumber)
 Constructor. More...
 
 analyseLink ($linkUri)
 Analyses $linkUri when generating a link to a route, in order to have the siteaccess part back in the URI. More...
 
 analyseURI ($uri)
 Analyses $uri and removes the siteaccess part, if needed. More...
 
 getName ()
 Returns the matcher's name. More...
 
 match ()
 Returns matching Siteaccess. More...
 
 setRequest (SimplifiedRequest $request)
 Injects the request object to match against. More...
 

Protected Member Functions

 getURIElements ()
 Returns URI elements as an array. More...
 

Private Attributes

 $elementNumber
 
 $request
 

Constructor & Destructor Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::__construct (   $elementNumber)

Constructor.

Parameters
int$elementNumberNumber of elements to take into account.

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::analyseLink (   $linkUri)

Analyses $linkUri when generating a link to a route, in order to have the siteaccess part back in the URI.

Parameters
string$linkUri
Returns
string The modified link URI

Implements eZ\Publish\Core\MVC\Symfony\SiteAccess\URILexer.

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::analyseURI (   $uri)

Analyses $uri and removes the siteaccess part, if needed.

Parameters
string$uriThe original URI
Returns
string The modified URI

Implements eZ\Publish\Core\MVC\Symfony\SiteAccess\URILexer.

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::getName ( )

Returns the matcher's name.

This information will be stored in the SiteAccess object itself to quickly be able to identify the matcher type.

Returns
string

Implements eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher.

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::getURIElements ( )
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::match ( )

Returns matching Siteaccess.

Returns
string|false Siteaccess matched or false.

Implements eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher.

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::setRequest ( SimplifiedRequest  $request)

Injects the request object to match against.

Parameters
\eZ\Publish\Core\MVC\Symfony\Routing\SimplifiedRequest$request
Returns
void

Implements eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher.

Member Data Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::$elementNumber
private
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\URIElement::$request
private

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