PHP Class Jarves\Router\FrontendRouter

Datei anzeigen Open project: jarves/jarves Class Usage Examples

Protected Properties

Property Type Description
$editorMode boolean
$foundPageUrl string
$jarves Jarves\Jarves
$request Symfony\Component\HttpFoundation\Request | null
$routes Symfony\Component\Routing\RouteCollection

Public Methods

Method Description
__construct ( Jarves $jarves, PageStack $pageStack, StopwatchHelper $stopwatch, Psr\Log\LoggerInterface $logger, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, Cacher $cacher ) FrontendRouter constructor.
checkPageAccess ( Node $page )
getPossibleLanguage ( ) : string Reads the requested URL and try to extract the requested language.
getRequest ( ) : Request
getRoutes ( ) : RouteCollection
isValidLanguage ( $lang ) : boolean Check whether specified pLang is a valid language
loadRoutes ( RouteCollection $routes, Node $page ) : null | RedirectResponse | Response Check for redirects/access requirements
registerMainPage ( Node $page )
registerPluginRoutes ( Node $page )
searchDomain ( ) : Domain | null Returns the domain if found
searchPage ( ) : Node | null Returns the id of given path-info. Null if not existent.
setRequest ( Request $request )
setRoutes ( RouteCollection $routes )

Method Details

__construct() public method

FrontendRouter constructor.
public __construct ( Jarves $jarves, PageStack $pageStack, StopwatchHelper $stopwatch, Psr\Log\LoggerInterface $logger, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, Cacher $cacher )
$jarves Jarves\Jarves
$pageStack Jarves\PageStack
$stopwatch Jarves\StopwatchHelper
$logger Psr\Log\LoggerInterface
$eventDispatcher Symfony\Component\EventDispatcher\EventDispatcherInterface
$cacher Jarves\Cache\Cacher

checkPageAccess() public method

public checkPageAccess ( Node $page )
$page Jarves\Model\Node

getPossibleLanguage() public method

Reads the requested URL and try to extract the requested language.
public getPossibleLanguage ( ) : string
return string Empty string if nothing found.

getRequest() public method

public getRequest ( ) : Request
return Symfony\Component\HttpFoundation\Request

getRoutes() public method

public getRoutes ( ) : RouteCollection
return Symfony\Component\Routing\RouteCollection

isValidLanguage() public method

Check whether specified pLang is a valid language
public isValidLanguage ( $lang ) : boolean
$lang
return boolean

loadRoutes() public method

Check for redirects/access requirements
public loadRoutes ( RouteCollection $routes, Node $page ) : null | RedirectResponse | Response
$routes Symfony\Component\Routing\RouteCollection
$page Jarves\Model\Node
return null | Symfony\Component\HttpFoundation\RedirectResponse | Symfony\Component\HttpFoundation\Response

registerMainPage() public method

public registerMainPage ( Node $page )
$page Jarves\Model\Node

registerPluginRoutes() public method

public registerPluginRoutes ( Node $page )
$page Jarves\Model\Node

searchDomain() public method

Returns the domain if found
public searchDomain ( ) : Domain | null
return Jarves\Model\Domain | null

searchPage() public method

Returns the id of given path-info. Null if not existent.
public searchPage ( ) : Node | null
return Jarves\Model\Node | null

setRequest() public method

public setRequest ( Request $request )
$request Symfony\Component\HttpFoundation\Request

setRoutes() public method

public setRoutes ( RouteCollection $routes )
$routes Symfony\Component\Routing\RouteCollection

Property Details

$editorMode protected_oe property

protected bool $editorMode
return boolean

$foundPageUrl protected_oe property

protected string $foundPageUrl
return string

$jarves protected_oe property

protected Jarves,Jarves $jarves
return Jarves\Jarves

$request protected_oe property

protected Request,Symfony\Component\HttpFoundation|null $request
return Symfony\Component\HttpFoundation\Request | null

$routes protected_oe property

protected RouteCollection,Symfony\Component\Routing $routes
return Symfony\Component\Routing\RouteCollection