class YamapsDefaultWidget in Yandex.Maps 8

Plugin implementation of the 'yamaps_default' widget.

Plugin annotation


@FieldWidget(
  id = "yamaps_default",
  label = @Translation("Yandex Map Field default"),
  field_types = {
    "yamaps"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\yamaps\Plugin\Field\FieldWidget\YamapsDefaultWidget

Expanded class hierarchy of YamapsDefaultWidget

File

src/Plugin/Field/FieldWidget/YamapsDefaultWidget.php, line 22

Namespace

Drupal\yamaps\Plugin\Field\FieldWidget

View source

class YamapsDefaultWidget extends WidgetBase {
  protected $map;

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $this->map = [];
    $map_id = Html::getUniqueId($items
      ->getName() . '-' . $delta);
    $element += [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Map'),
    ];
    $element['#attached']['library'][] = 'yamaps/yandex-map-api';
    $this
      ->initMap($element, $map_id, $items[$delta]->coords);
    $this
      ->addPlacemarksToMap($element, $map_id, $items[$delta]->placemarks);
    $this
      ->addLinesToMap($element, $map_id, $items[$delta]->lines);
    $this
      ->addPolygonsToMap($element, $map_id, $items[$delta]->polygons);
    $element['#attached']['library'][] = 'yamaps/yamaps-map';
    $element['#attached']['drupalSettings']['yamaps'] = [
      $map_id => $this->map,
    ];
    return $element;
  }

  /**
   * Add placemarks to map and enable tool.
   *
   * @param array $elements
   * @param $map_id
   * @param $placemarks
   */
  protected function addPlacemarksToMap(array &$element, $map_id, $placemarks) {
    $element['placemarks'] = [
      '#type' => 'hidden',
      '#default_value' => $placemarks,
      '#attributes' => [
        'class' => [
          'field-yamaps-placemarks-' . $map_id,
        ],
      ],
    ];
    if ($this
      ->getFieldSetting('enable_lines')) {
      $element['#attached']['library'][] = 'yamaps/yamaps-placemark';
      $this->map['placemarks'] = Json::decode($placemarks);
    }
  }

  /**
   * Add lines to map and enable tool.
   *
   * @param array $elements
   * @param $map_id
   * @param $placemarks
   */
  protected function addLinesToMap(array &$element, $map_id, $lines) {
    $element['lines'] = [
      '#type' => 'hidden',
      '#default_value' => $lines,
      '#attributes' => [
        'class' => [
          'field-yamaps-lines-' . $map_id,
        ],
      ],
    ];
    if ($this
      ->getFieldSetting('enable_lines')) {
      $element['#attached']['library'][] = 'yamaps/yamaps-line';
      $this->map['lines'] = Json::decode($lines);
    }
  }

  /**
   * Add polygons to map and enable tool.
   *
   * @param array $elements
   * @param $map_id
   * @param $placemarks
   */
  protected function addPolygonsToMap(array &$element, $map_id, $polygons) {
    $element['polygons'] = [
      '#type' => 'hidden',
      '#default_value' => $polygons,
      '#attributes' => [
        'class' => [
          'field-yamaps-polygons-' . $map_id,
        ],
      ],
    ];
    if ($this
      ->getFieldSetting('enable_polygons')) {
      $element['#attached']['library'][] = 'yamaps/yamaps-polygon';
      $this->map['polygons'] = Json::decode($polygons);
    }
  }

  /**
   * Create map container and .
   *
   * @param array $elements
   * @param $map_id
   * @param $placemarks
   */
  protected function initMap(&$element, $map_id, $coords) {
    $element['map_container'] = [
      '#title' => $this
        ->t('Preview'),
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#attributes' => [
        'id' => $map_id,
        'class' => 'yamaps-field-map',
        'style' => 'width: 100%; height: 400px;',
      ],
    ];
    $element['coords'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Coordinates'),
      '#default_value' => $coords,
      '#attributes' => [
        'class' => [
          'field-yamaps-coords-' . $map_id,
        ],
      ],
    ];
    $element['type'] = [
      '#type' => 'hidden',
      '#default_value' => 'yandex#map',
    ];
    $coords = Json::decode($coords);
    $this->map['init'] = [
      'center' => $coords['center'] ?? NULL,
      'zoom' => $coords['zoom'] ?? NULL,
      'type' => 'yandex#map',
      'behaviors' => [
        'scrollZoom',
        'dblClickZoom',
        'drag',
      ],
    ];
    $this->map['display_options'] = [
      'display_type' => 'map',
      'open_button_text' => 'Open map',
      'close_button_text' => 'Close map',
      'width' => '100%',
      'height' => '400px',
    ];
    $this->map['controls'] = 1;
    $this->map['edit'] = TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings	42
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	5
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm	16
WidgetBase::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary	15
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct	public	function	Constructs a WidgetBase object. Overrides PluginBase::__construct	5
YamapsDefaultWidget::$map	protected	property
YamapsDefaultWidget::addLinesToMap	protected	function	Add lines to map and enable tool.
YamapsDefaultWidget::addPlacemarksToMap	protected	function	Add placemarks to map and enable tool.
YamapsDefaultWidget::addPolygonsToMap	protected	function	Add polygons to map and enable tool.
YamapsDefaultWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
YamapsDefaultWidget::initMap	protected	function	Create map container and .

You are here

class YamapsDefaultWidget in Yandex.Maps 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation