BasemapConfig
extends AbstractConfig
in package
Basemap Configuration Class
Tags
Table of Contents
- $configLoader : PluginManager
- Configuration loader
- $options : array<string|int, string>
- Valid options to retrieve from configuration
- $requestOrigin : string
- Request origin
- __construct() : mixed
- Constructor
- getBasemap() : array<string|int, mixed>
- Get the basemap configuration settings.
- getDefaultOptions() : array<string|int, mixed>
- Set default options
- getMapSelectionBasemap() : array<string|int, mixed>
- Get the basemap configuration settings for MapSelection.
- getMapTabBasemap() : array<string|int, mixed>
- Get the basemap configuration settings for MapTab.
- getOptions() : array<string|int, mixed>
- Convert a config object to an options array; return empty array if configuration is missing or incomplete.
Properties
$configLoader
Configuration loader
protected
PluginManager
$configLoader
$options
Valid options to retrieve from configuration
protected
array<string|int, string>
$options
= ['basemap_url', 'basemap_attribution']
$requestOrigin
Request origin
protected
string
$requestOrigin
Methods
__construct()
Constructor
public
__construct(PluginManager $configLoader) : mixed
Parameters
- $configLoader : PluginManager
-
Configuration loader
Return values
mixed —getBasemap()
Get the basemap configuration settings.
public
getBasemap(string $origin) : array<string|int, mixed>
Parameters
- $origin : string
-
Origin of request MapTab or MapSelection
Return values
array<string|int, mixed> —getDefaultOptions()
Set default options
protected
getDefaultOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMapSelectionBasemap()
Get the basemap configuration settings for MapSelection.
protected
getMapSelectionBasemap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMapTabBasemap()
Get the basemap configuration settings for MapTab.
protected
getMapTabBasemap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOptions()
Convert a config object to an options array; return empty array if configuration is missing or incomplete.
protected
getOptions(string $configName, string $section, array<string|int, mixed> $validOptions) : array<string|int, mixed>
Parameters
- $configName : string
-
Name of config file to read
- $section : string
-
Name of section to read
- $validOptions : array<string|int, mixed>
-
List of valid fields to read