eZPublishCommunityProject  2013.4
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router Class Reference

Public Member Functions

 __construct (MatcherBuilderInterface $matcherBuilder, LoggerInterface $logger, $defaultSiteAccess, array $siteAccessesConfiguration, array $siteAccessList, $siteAccessClass=null)
 Constructor. More...
 
 getSiteAccess ()
 
 match (SimplifiedRequest $request)
 Performs SiteAccess matching given the $request. More...
 
 setSiteAccess (SiteAccess $siteAccess=null)
 

Protected Attributes

 $defaultSiteAccess
 
 $logger
 
 $matcherBuilder
 
 $siteAccess
 
 $siteAccessClass
 
 $siteAccessesConfiguration
 
 $siteAccessList
 

Private Member Functions

 doMatch (SimplifiedRequest $request)
 Returns the SiteAccess object matched against $request and the siteaccess configuration. More...
 

Constructor & Destructor Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::__construct ( MatcherBuilderInterface  $matcherBuilder,
LoggerInterface  $logger,
  $defaultSiteAccess,
array  $siteAccessesConfiguration,
array  $siteAccessList,
  $siteAccessClass = null 
)

Constructor.

Parameters
\eZ\Publish\Core\MVC\Symfony\SiteAccess\MatcherBuilderInterface$matcherBuilder
\Psr\Log\LoggerInterface$logger
string$defaultSiteAccess
array$siteAccessesConfiguration
array$siteAccessList
string | null$siteAccessClass

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::doMatch ( SimplifiedRequest  $request)
private

Returns the SiteAccess object matched against $request and the siteaccess configuration.

If nothing could be matched, the default siteaccess is returned, with "default" as matching type.

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

Referenced by eZ\Publish\Core\MVC\Symfony\SiteAccess\Router\match().

eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::getSiteAccess ( )
Returns
|null
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::match ( SimplifiedRequest  $request)

Performs SiteAccess matching given the $request.

Parameters
\eZ\Publish\Core\MVC\Symfony\Routing\SimplifiedRequest$request
Exceptions
\eZ\Publish\Core\MVC\Exception\InvalidSiteAccessException
Returns
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::setSiteAccess ( SiteAccess  $siteAccess = null)
Parameters
\eZ\Publish\Core\MVC\Symfony\SiteAccess$siteAccessprivate Only for unit tests use

Member Data Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$defaultSiteAccess
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$logger
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$matcherBuilder
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$siteAccessClass
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$siteAccessesConfiguration
protected
eZ\Publish\Core\MVC\Symfony\SiteAccess\Router::$siteAccessList
protected

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