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

Public Member Functions

 __construct ($elementNumber)
 Constructor. More...
 
 getName ()
 Returns the matcher's name. More...
 
 match ()
 Returns matching Siteaccess. More...
 
 setRequest (SimplifiedRequest $request)
 Injects the request object to match against. More...
 

Private Attributes

 $elementNumber
 
 $request
 

Constructor & Destructor Documentation

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

Constructor.

Parameters
int$elementNumberNumber of elements to take into account.

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\HostElement::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\HostElement::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\HostElement::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\HostElement::$elementNumber
private
eZ\Publish\Core\MVC\Symfony\SiteAccess\Matcher\HostElement::$request
private

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