PHP Interface Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface

Afficher le fichier Open project: sulu/sulu Interface Usage Examples

Méthodes publiques

Méthode Description
analyze ( Request $request ) Analyzes the current request, and saves the values for portal, language, country and segment for further usage.
getAnalyticsKey ( ) : string Returns the analytics key.
getAttribute ( string $name, mixed | null $default = null ) : mixed Returns request attribute with given name.
getCurrentLocalization ( ) : Localization Returns the current localization for this Request.
getGetParameters ( ) : array Returns the get parameters.
getMatchType ( ) : integer Returns the current match type for this request.
getPortal ( ) : Portal Returns the current portal for this request.
getPortalInformation ( ) : PortalInformation Returns portal-information of request.
getPortalUrl ( ) : string Returns the url of the current portal.
getPostParameters ( ) : array Returns the post parameters.
getRedirect ( ) : string Returns the redirect url.
getResourceLocator ( ) : string Returns the path of the current request, which is the url without host, language and so on.
getResourceLocatorPrefix ( ) : string Returns the prefix required before the resource locator.
getSegment ( ) : Segment Returns the current segment for this request.
getWebspace ( ) : Webspace Returns the current webspace for this request.
validate ( Request $request ) Validates the data written on the given request and throws exceptions in case something is wrong or missing.

Method Details

analyze() public méthode

Analyzes the current request, and saves the values for portal, language, country and segment for further usage.
public analyze ( Request $request )
$request Symfony\Component\HttpFoundation\Request The request to analyze

getAnalyticsKey() public méthode

Returns the analytics key.
public getAnalyticsKey ( ) : string
Résultat string

getAttribute() public méthode

Returns request attribute with given name.
public getAttribute ( string $name, mixed | null $default = null ) : mixed
$name string
$default mixed | null
Résultat mixed

getCurrentLocalization() public méthode

Returns the current localization for this Request.
public getCurrentLocalization ( ) : Localization
Résultat Sulu\Component\Localization\Localization

getGetParameters() public méthode

Returns the get parameters.
public getGetParameters ( ) : array
Résultat array

getMatchType() public méthode

Returns the current match type for this request.
public getMatchType ( ) : integer
Résultat integer

getPortal() public méthode

Returns the current portal for this request.
public getPortal ( ) : Portal
Résultat Sulu\Component\Webspace\Portal

getPortalInformation() public méthode

Returns portal-information of request.
public getPortalInformation ( ) : PortalInformation
Résultat Sulu\Component\Webspace\PortalInformation

getPortalUrl() public méthode

Returns the url of the current portal.
public getPortalUrl ( ) : string
Résultat string

getPostParameters() public méthode

Returns the post parameters.
public getPostParameters ( ) : array
Résultat array

getRedirect() public méthode

Returns the redirect url.
public getRedirect ( ) : string
Résultat string

getResourceLocator() public méthode

Returns the path of the current request, which is the url without host, language and so on.
public getResourceLocator ( ) : string
Résultat string

getResourceLocatorPrefix() public méthode

Returns the prefix required before the resource locator.
public getResourceLocatorPrefix ( ) : string
Résultat string

getSegment() public méthode

Returns the current segment for this request.
public getSegment ( ) : Segment
Résultat Sulu\Component\Webspace\Segment

getWebspace() public méthode

Returns the current webspace for this request.
public getWebspace ( ) : Webspace
Résultat Sulu\Component\Webspace\Webspace

validate() public méthode

Validates the data written on the given request and throws exceptions in case something is wrong or missing.
public validate ( Request $request )
$request Symfony\Component\HttpFoundation\Request