eZPublishCommunityProject  2013.9
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound Class Reference

Base for Compound siteaccess matchers. More...

+ Inheritance diagram for eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound:
+ Collaboration diagram for eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound:

Public Member Functions

 __construct (array $config)
 
 __sleep ()
 Serialization occurs when serializing the siteaccess for subrequests. 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...
 
 getSubMatchers ()
 Returns all used sub-matchers. More...
 
 setMatcherBuilder (MatcherBuilderInterface $matcherBuidler)
 Injects the matcher builder, to allow the Compound matcher to properly build the underlying matchers. More...
 
 setRequest (SimplifiedRequest $request)
 Injects the request object to match against. More...
 
- Public Member Functions inherited from eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher
 match ()
 Returns matched Siteaccess or false if no siteaccess could be matched. More...
 

Protected Attributes

 $config
 
 $matcherBuilder
 
 $matchersMap = array()
 
 $request
 
 $subMatchers = array()
 

Detailed Description

Base for Compound siteaccess matchers.

All classes extending this one must implement a NAME class constant.

Constructor & Destructor Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::__construct ( array  $config)

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::__sleep ( )

Serialization occurs when serializing the siteaccess for subrequests.

See Also
::generateFragmentUri()
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::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\Compound::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\Compound::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\Compound::setMatcherBuilder ( MatcherBuilderInterface  $matcherBuilder)

Injects the matcher builder, to allow the Compound matcher to properly build the underlying matchers.

Parameters
\eZ\Publish\Core\MVC\Symfony\SiteAccess\MatcherBuilderInterface$matcherBuilder

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

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::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\Compound::$config
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::$matcherBuilder
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::$matchersMap = array()
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::$request
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\Compound::$subMatchers = array()
protected

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