Interface

eZ\Bundle\EzPublishCoreBundle\SiteAccess\Matcher

interface Matcher implements Matcher

Interface for service based siteaccess matchers.

Methods

setRequest(SimplifiedRequest $request)

Injects the request object to match against.

from Matcher
string|false match()

Returns matched Siteaccess or false if no siteaccess could be matched.

from Matcher
string getName()

Returns the matcher's name.

from Matcher
setMatchingConfiguration(mixed $matchingConfiguration)

Registers the matching configuration associated with the matcher.

Details

in Matcher at line 23
public setRequest(SimplifiedRequest $request)

Injects the request object to match against.

Parameters

SimplifiedRequest $request

in Matcher at line 30
public string|false match()

Returns matched Siteaccess or false if no siteaccess could be matched.

Return Value

string|false

in Matcher at line 38
public string 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.

Return Value

string

at line 23
public setMatchingConfiguration(mixed $matchingConfiguration)

Registers the matching configuration associated with the matcher.

Parameters

mixed $matchingConfiguration