Router
in package
Record route generator
Tags
Table of Contents
- $config : Config
- VuFind configuration
- __construct() : mixed
- Constructor
- getActionRouteDetails() : array<string|int, mixed>
- Get routing details for a controller action.
- getRouteDetails() : array<string|int, mixed>
- Get routing details (route name and parameters array) to link to a record.
- getTabRouteDetails() : array<string|int, mixed>
- Get routing details to display a particular tab.
- extractSourceAndId() : array<string|int, mixed>
- Extract source and ID from a pipe-delimited string, adding a default source if appropriate.
Properties
$config
VuFind configuration
protected
Config
$config
Methods
__construct()
Constructor
public
__construct(Config $config) : mixed
Parameters
- $config : Config
-
VuFind configuration
Return values
mixed —getActionRouteDetails()
Get routing details for a controller action.
public
getActionRouteDetails(AbstractBase|string $driver, string $action) : array<string|int, mixed>
Parameters
- $driver : AbstractBase|string
-
Record driver representing record to link to, or source|id pipe-delimited string
- $action : string
-
Action to access
Return values
array<string|int, mixed> —getRouteDetails()
Get routing details (route name and parameters array) to link to a record.
public
getRouteDetails(AbstractBase|string $driver[, string $routeSuffix = '' ][, array<string|int, mixed> $extraParams = [] ]) : array<string|int, mixed>
Parameters
- $driver : AbstractBase|string
-
Record driver representing record to link to, or source|id pipe-delimited string
- $routeSuffix : string = ''
-
Suffix to add to route name
- $extraParams : array<string|int, mixed> = []
-
Extra parameters for route
Return values
array<string|int, mixed> —getTabRouteDetails()
Get routing details to display a particular tab.
public
getTabRouteDetails(AbstractBase|string $driver[, string $tab = null ][, array<string|int, mixed> $query = [] ]) : array<string|int, mixed>
Parameters
- $driver : AbstractBase|string
-
Record driver representing record to link to, or source|id pipe-delimited string
- $tab : string = null
-
Action to access
- $query : array<string|int, mixed> = []
-
Optional query params
Return values
array<string|int, mixed> —extractSourceAndId()
Extract source and ID from a pipe-delimited string, adding a default source if appropriate.
protected
extractSourceAndId(string $driver) : array<string|int, mixed>
Parameters
- $driver : string
-
source|ID string