Map
extends AbstractBase
in package
Map tab
Tags
Table of Contents
- $accessPermission : string
- Permission that must be granted to access this module (null for no restriction)
- $basemapOptions : array<string|int, mixed>
- Basemap settings
- $displayCoords : bool
- Should we display coordinates as part of labels?
- $driver : AbstractBase|null
- Record driver associated with the tab
- $graticule : bool
- Display graticule / map lat long grid?
- $mapLabels : string
- Map labels setting from config.ini.
- $mapTabDisplay : bool
- Should Map Tab be displayed?
- $pathResolver : PathResolver
- Configuration file path resolver
- $request : Request|bool
- User request associated with the tab (false for none)
- __construct() : mixed
- Constructor
- getBasemap() : array<string|int, mixed>
- Get the basemap configuration settings.
- getDescription() : string
- Get the on-screen description for this tab.
- getDisplayCoords() : array<string|int, mixed>
- Get the map display coordinates.
- getGeoLocationCoords() : array<string|int, mixed>
- Get the bbox-geo coordinates.
- getMapGraticule() : string
- Get the map graticule setting.
- getMapLabels() : array<string|int, mixed>
- Get the map labels.
- getMapTabData() : array<string|int, mixed>
- Construct the map coordinates and labels array.
- isActive() : bool
- Is this tab active?
- isVisible() : bool
- Is this tab initially visible?
- setRecordDriver() : AbstractBase
- Set the record driver
- setRequest() : AbstractBase
- Set the user request
- supportsAjax() : bool
- Can this tab be loaded via AJAX?
- getRecordDriver() : AbstractBase
- Get the record driver
- getRequest() : Request|bool
- Get the user request (or false if unavailable)
Properties
$accessPermission
Permission that must be granted to access this module (null for no restriction)
protected
string
$accessPermission
= null
$basemapOptions
Basemap settings
protected
array<string|int, mixed>
$basemapOptions
= []
$displayCoords
Should we display coordinates as part of labels?
protected
bool
$displayCoords
= false
$driver
Record driver associated with the tab
protected
AbstractBase|null
$driver
= null
$graticule
Display graticule / map lat long grid?
protected
bool
$graticule
= false
$mapLabels
Map labels setting from config.ini.
protected
string
$mapLabels
= null
$mapTabDisplay
Should Map Tab be displayed?
protected
bool
$mapTabDisplay
= false
$pathResolver
Configuration file path resolver
protected
PathResolver
$pathResolver
$request
User request associated with the tab (false for none)
protected
Request|bool
$request
= false
Methods
__construct()
Constructor
public
__construct([bool $mapTabDisplay = false ][, array<string|int, mixed> $basemapOptions = [] ][, array<string|int, mixed> $mapTabOptions = [] ][, PathResolver $pathResolver = null ]) : mixed
Parameters
- $mapTabDisplay : bool = false
-
Display Map
- $basemapOptions : array<string|int, mixed> = []
-
basemap settings
- $mapTabOptions : array<string|int, mixed> = []
-
MapTab settings
- $pathResolver : PathResolver = null
-
Config file path resolver
Return values
mixed —getBasemap()
Get the basemap configuration settings.
public
getBasemap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDescription()
Get the on-screen description for this tab.
public
getDescription() : string
Return values
string —getDisplayCoords()
Get the map display coordinates.
public
getDisplayCoords() : array<string|int, mixed>
Return values
array<string|int, mixed> —getGeoLocationCoords()
Get the bbox-geo coordinates.
public
getGeoLocationCoords() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMapGraticule()
Get the map graticule setting.
public
getMapGraticule() : string
Return values
string —getMapLabels()
Get the map labels.
public
getMapLabels() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMapTabData()
Construct the map coordinates and labels array.
public
getMapTabData() : array<string|int, mixed>
Return values
array<string|int, mixed> —isActive()
Is this tab active?
public
isActive() : bool
Return values
bool —isVisible()
Is this tab initially visible?
public
isVisible() : bool
Return values
bool —setRecordDriver()
Set the record driver
public
setRecordDriver(AbstractBase $driver) : AbstractBase
Parameters
- $driver : AbstractBase
-
Record driver
Return values
AbstractBase —setRequest()
Set the user request
public
setRequest(Request $request) : AbstractBase
Parameters
- $request : Request
-
Request
Return values
AbstractBase —supportsAjax()
Can this tab be loaded via AJAX?
public
supportsAjax() : bool
Return values
bool —getRecordDriver()
Get the record driver
protected
getRecordDriver() : AbstractBase
Tags
Return values
AbstractBase —getRequest()
Get the user request (or false if unavailable)
protected
getRequest() : Request|bool