abstract class OpenlayersPluginFormBase in Openlayers 8.4
Provides a base form for the settings for Openlayers plugins.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\openlayers\Form\OpenlayersPluginFormBase
Expanded class hierarchy of OpenlayersPluginFormBase
4 files declare their use of OpenlayersPluginFormBase
- OpenlayersControlPluginAddForm.php in src/
Form/ OpenlayersControlPluginAddForm.php - OpenlayersInteractionPluginAddForm.php in src/
Form/ OpenlayersInteractionPluginAddForm.php - OpenlayersPluginEditForm.php in src/
Form/ OpenlayersPluginEditForm.php - OpenlayersStylePluginAddForm.php in src/
Form/ OpenlayersStylePluginAddForm.php
File
- src/
Form/ OpenlayersPluginFormBase.php, line 18
Namespace
Drupal\openlayers\FormView source
abstract class OpenlayersPluginFormBase extends FormBase {
/**
* The Openlayers map.
*
* @var \Drupal\image\OpenlayersMapInterface
*/
protected $olMap;
/**
* The openlayers plugin.
*
* @var \Drupal\openlayers\OpenlayersPluginInterface.
*/
protected $olPlugin;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'openlayers_plugin_form';
}
/**
* {@inheritdoc}
*
* @param \Drupal\image\ImageStyleInterface $image_style
* The openlayers map.
* @param string $image_effect
* The openlayers plugin ID.
*
* @return array
* The form structure.
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
*/
public function buildForm(array $form, FormStateInterface $form_state, OpenlayersMapInterface $map = NULL, $plugin_type = NULL, $plugin = NULL) {
$this->olMap = $map;
try {
$this->olPlugin = $this
->preparePlugin($plugin_type, $plugin);
} catch (PluginNotFoundException $e) {
throw new NotFoundHttpException("Invalid plugin id: '{$plugin}'.");
}
$definition = $this->olPlugin
->getPluginDefinition();
$request = $this
->getRequest();
if (!$this->olPlugin instanceof OpenlayersConfigurablePluginInterface) {
throw new NotFoundHttpException();
}
$form['#attached']['library'][] = 'image/admin';
// TODO
$form['uuid'] = [
'#type' => 'value',
'#value' => $this->olPlugin
->getUuid(),
];
$form['id'] = [
'#type' => 'value',
'#value' => $this->olPlugin
->getPluginId(),
];
$form['data'] = [];
$subform_state = SubformState::createForSubform($form['data'], $form, $form_state);
$form['data'] = $this->olPlugin
->buildConfigurationForm($form['data'], $subform_state);
$form['data']['#tree'] = TRUE;
// Check the URL for a weight, then the image effect, otherwise use default.
$form['weight'] = [
'#type' => 'hidden',
'#value' => isset($this->olPlugin->ol_id) ? $this->olPlugin->ol_id : $this->olPlugin
->getWeight(),
];
// Check the URL for a weight, then the image effect, otherwise use default.
$form['ol_id'] = [
'#type' => 'hidden',
'#value' => isset($definition['ol_id']) ? $definition['ol_id'] : '???',
];
$form['actions'] = [
'#type' => 'actions',
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#button_type' => 'primary',
];
$form['actions']['cancel'] = [
'#type' => 'link',
'#title' => $this
->t('Cancel'),
'#url' => $this->olMap
->toUrl('edit-form'),
'#attributes' => [
'class' => [
'button',
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// The image effect configuration is stored in the 'data' key in the form,
// pass that through for validation.
$this->olPlugin
->validateConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$form_state
->cleanValues();
// The plugin configuration is stored in the 'data' key in the form, which is then passed through for submission.
$this->olPlugin
->submitConfigurationForm($form['data'], SubformState::createForSubform($form['data'], $form, $form_state));
$this->olPlugin
->setWeight($form_state
->getValue('weight'));
if (!$this->olPlugin
->getUuid()) {
$definition = $this->olPlugin
->getPluginDefinition();
$configuration = $this->olPlugin
->getConfiguration();
$configuration['ol_id'] = $form_state
->getValue('ol_id');
$plugin_type = $definition['type'];
$this->olMap
->{'addMap' . ucwords($plugin_type)}($configuration);
}
$this->olMap
->save();
// $node->getCacheTags()
Cache::invalidateTags([
'config:openlayers.map.ol_map2',
]);
$this
->messenger()
->addStatus($this
->t('The Settings for the plugin were successfully saved.'));
$form_state
->setRedirectUrl($this->olMap
->toUrl('edit-form'));
}
/**
* Converts an image effect ID into an object.
*
* @param string $image_effect
* The image effect ID.
*
* @return \Drupal\image\ImageEffectInterface
* The image effect object.
*/
protected abstract function preparePlugin($plugin_type, $plugin);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
OpenlayersPluginFormBase:: |
protected | property | The Openlayers map. | |
OpenlayersPluginFormBase:: |
protected | property | The openlayers plugin. | |
OpenlayersPluginFormBase:: |
public | function |
Overrides FormInterface:: |
4 |
OpenlayersPluginFormBase:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
OpenlayersPluginFormBase:: |
abstract protected | function | Converts an image effect ID into an object. | 4 |
OpenlayersPluginFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
OpenlayersPluginFormBase:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |