AdminUrlGenerator
in package
FinalYes
Tags
Table of Contents
Properties
- $adminContextProvider : AdminContextProvider
- $currentPageReferrer : string|null
- $customPageReferrer : string|null
- $dashboardControllerRegistry : DashboardControllerRegistry
- $dashboardRoute : string|null
- $includeReferrer : bool|null
- $isInitialized : bool
- $routeParameters : array<string|int, mixed>
- $urlGenerator : UrlGeneratorInterface
Methods
- __construct() : mixed
- __toString() : string
- addSignature() : self
- generateUrl() : string
- get() : mixed
- getSignature() : string
- includeReferrer() : self
- removeReferrer() : self
- set() : self
- setAction() : self
- setAll() : self
- setController() : self
- setDashboard() : self
- setEntityId() : self
- setReferrer() : self
- setRoute() : self
- unset() : self
- unsetAll() : self
- unsetAllExcept() : self
- initialize() : void
- setRouteParameter() : void
Properties
$adminContextProvider
private
AdminContextProvider
$adminContextProvider
$currentPageReferrer
private
string|null
$currentPageReferrer
= null
$customPageReferrer
private
string|null
$customPageReferrer
= null
$dashboardControllerRegistry
private
DashboardControllerRegistry
$dashboardControllerRegistry
$dashboardRoute
private
string|null
$dashboardRoute
= null
$includeReferrer
private
bool|null
$includeReferrer
= null
$isInitialized
private
bool
$isInitialized
= false
$routeParameters
private
array<string|int, mixed>
$routeParameters
= []
$urlGenerator
private
UrlGeneratorInterface
$urlGenerator
Methods
__construct()
public
__construct(AdminContextProvider $adminContextProvider, UrlGeneratorInterface $urlGenerator, DashboardControllerRegistry $dashboardControllerRegistry) : mixed
Parameters
- $adminContextProvider : AdminContextProvider
- $urlGenerator : UrlGeneratorInterface
- $dashboardControllerRegistry : DashboardControllerRegistry
__toString()
public
__toString() : string
Return values
stringaddSignature()
public
addSignature([bool $addSignature = true ]) : self
Parameters
- $addSignature : bool = true
Return values
selfgenerateUrl()
public
generateUrl() : string
Return values
stringget()
public
get(string $paramName) : mixed
Parameters
- $paramName : string
getSignature()
public
getSignature() : string
Return values
stringincludeReferrer()
public
includeReferrer() : self
Return values
selfremoveReferrer()
public
removeReferrer() : self
Return values
selfset()
public
set(string $paramName, mixed $paramValue) : self
Parameters
- $paramName : string
- $paramValue : mixed
Return values
selfsetAction()
public
setAction(string $action) : self
Parameters
- $action : string
Return values
selfsetAll()
public
setAll(array<string|int, mixed> $routeParameters) : self
Parameters
- $routeParameters : array<string|int, mixed>
Return values
selfsetController()
public
setController(string $crudControllerFqcn) : self
Parameters
- $crudControllerFqcn : string
Return values
selfsetDashboard()
public
setDashboard(string $dashboardControllerFqcn) : self
Parameters
- $dashboardControllerFqcn : string
Return values
selfsetEntityId()
public
setEntityId(mixed $entityId) : self
Parameters
- $entityId : mixed
Return values
selfsetReferrer()
public
setReferrer(string $referrer) : self
Parameters
- $referrer : string
Return values
selfsetRoute()
public
setRoute(string $routeName[, array<string|int, mixed> $routeParameters = [] ]) : self
Parameters
- $routeName : string
- $routeParameters : array<string|int, mixed> = []
Return values
selfunset()
public
unset(string $paramName) : self
Parameters
- $paramName : string
Return values
selfunsetAll()
public
unsetAll() : self
Return values
selfunsetAllExcept()
public
unsetAllExcept(string ...$namesOfParamsToKeep) : self
Parameters
- $namesOfParamsToKeep : string
Return values
selfinitialize()
private
initialize() : void
setRouteParameter()
private
setRouteParameter(string $paramName, mixed $paramValue) : void
Parameters
- $paramName : string
- $paramValue : mixed