class TileWMS in Openlayers 7.3
Class TileWMS.
Plugin annotation
@OpenlayersPlugin(
id = "TileWMS",
description = "Layer source for tile data from WMS servers."
)
Hierarchy
- class \Drupal\openlayers\Types\Base extends \Drupal\Component\Plugin\PluginBase implements ObjectInterface
- class \Drupal\openlayers\Types\Source implements SourceInterface
- class \Drupal\openlayers\Plugin\Source\TileWMS\TileWMS
- class \Drupal\openlayers\Types\Source implements SourceInterface
Expanded class hierarchy of TileWMS
File
- src/
Plugin/ Source/ TileWMS/ TileWMS.php, line 19 - Source: TileWMS.
Namespace
Drupal\openlayers\Plugin\Source\TileWMSView source
class TileWMS extends Source {
/**
* {@inheritdoc}
*/
public function optionsForm(array &$form, array &$form_state) {
$form['options']['url'] = array(
'#type' => 'textarea',
'#title' => t('Base URL (template)'),
'#default_value' => $this
->getOption('url') ? implode("\n", (array) $this
->getOption('url')) : '',
);
$form['options']['wms_layers'] = array(
'#type' => 'textarea',
'#title' => t('WMS Layers (comma-separated list)'),
'#default_value' => $this
->getOption('wms_layers') ? $this
->getOption('wms_layers') : '',
);
$form['options']['version'] = array(
'#type' => 'textfield',
'#title' => t('Version'),
'#description' => t('Leave blank to use the Openlayers default.'),
'#default_value' => $this
->getOption('version') ? $this
->getOption('version') : '',
);
}
/**
* {@inheritdoc}
*/
public function optionsFormSubmit(array $form, array &$form_state) {
// If an options array is not set, create it.
if (!isset($form_state['item']->options)) {
$form_state['item']->options = array();
}
// If the URL is blank, unset it in the options.
if ($form_state['values']['options']['url'] == '') {
unset($form_state['item']->options['url']);
}
// Create a parameters array if it doesn't already exist.
if (!isset($form_state['item']->options['params'])) {
$form_state['item']->options['params'] = array();
}
// Copy parameters into the params array.
$param_keys = array(
'wms_layers' => 'LAYERS',
'version' => 'VERSION',
);
foreach ($param_keys as $key => $param) {
if (!empty($form_state['values']['options'][$key])) {
$form_state['item']->options['params'][$param] = check_plain($form_state['values']['options'][$key]);
}
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Base:: |
protected | property | Holds all the attachment used by this object. | 6 |
Base:: |
protected | property | Holds the Collection object. | |
Base:: |
protected | property | A unique ID for the object. | |
Base:: |
public | function |
Add an object into the collection of the parent object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns a list of attachments for building the render array. Overrides ObjectInterface:: |
6 |
Base:: |
public | function |
Remove an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Defines dependencies. Overrides ObjectInterface:: |
3 |
Base:: |
public | function |
Returns the path to the plugin directory. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns the path to the class file. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the Collection object linked to the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the object configuration. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return all the dependencies objects of the parent object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the description of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return an object, CTools Exportable. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the Factory Service of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the object unique ID. Overrides ObjectInterface:: |
|
Base:: |
public | function |
!Attention! This function will remove any option that is named after a
plugin type e.g.: layers, controls, styles, interactions, components . Overrides ObjectInterface:: |
6 |
Base:: |
public | function |
Return the unique machine name of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the human name of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return an array of OL objects indexed by their type. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the options array. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns an array with the maps this object is attached on. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the description of the object's plugin. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the module that provides this plugin. Overrides ObjectInterface:: |
|
Base:: |
public | function |
The type of this object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Get the weight of an object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Refresh string translations. Overrides ObjectInterface:: |
1 |
Base:: |
public | function |
Initializes the object. Overrides ObjectInterface:: |
2 |
Base:: |
public | function |
Initializes the Collection,
Import objects from options,
Import the current object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Whether or not this object has to be processed asynchronously. Overrides ObjectInterface:: |
3 |
Base:: |
public | function |
Validation callback for the options form. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return a flat array containing Openlayers Objects from the options array. Overrides ObjectInterface:: |
9 |
Base:: |
public | function |
Invoked after an objects render array is built. Overrides ObjectInterface:: |
13 |
Base:: |
public | function |
Invoked before an objects render array is built. Overrides ObjectInterface:: |
4 |
Base:: |
public | function |
Remove an object from the collection. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Reset the object's Collection. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the Factory Service of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the object ID. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the options array. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the weight of an object. Overrides ObjectInterface:: |
|
Source:: |
protected | property |
The array containing the options. Overrides Base:: |
|
TileWMS:: |
public | function |
@TODO What is this return? If it is the form, why is form by reference? Overrides Base:: |
|
TileWMS:: |
public | function |
Submit callback for the options form. Overrides Base:: |