class YamapsDefaultFormatter in Yandex.Maps 8

Plugin implementation of the 'yamaps' formatter.

Plugin annotation


@FieldFormatter(
  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\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\yamaps\Plugin\Field\FieldFormatter\YamapsDefaultFormatter

Expanded class hierarchy of YamapsDefaultFormatter

File

src/Plugin/Field/FieldFormatter/YamapsDefaultFormatter.php, line 21

Namespace

Drupal\yamaps\Plugin\Field\FieldFormatter

View source

class YamapsDefaultFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $map_behaviors = [];
    if ($this
      ->getSetting('enable_zoom')) {
      $map_behaviors[] = 'scrollZoom';
      $map_behaviors[] = 'dblClickZoom';
    }
    if ($this
      ->getSetting('enable_drag')) {
      $map_behaviors[] = 'drag';
    }
    foreach ($items as $delta => $item) {
      $map_id = Html::getUniqueId($items
        ->getName() . '-' . $delta);

      // Map information.
      $default_js = yamaps_format_values_to_js($item);

      // Map initialization parameters.
      $map = [
        'init' => [
          'center' => $default_js['coords']['center'] ?? NULL,
          'zoom' => $default_js['coords']['zoom'] ?? NULL,
          'type' => 'yandex#map',
          'behaviors' => $map_behaviors,
        ],
        'display_options' => [
          'display_type' => 'map',
          'width' => $this
            ->getSetting('width'),
          'height' => $this
            ->getSetting('height'),
        ],
        'controls' => 1,
        'placemarks' => $this
          ->getFieldSetting('enable_placemarks') ? $default_js['placemarks'] : [],
        'lines' => $this
          ->getFieldSetting('enable_lines') ? $default_js['lines'] : [],
        'polygons' => $this
          ->getFieldSetting('enable_polygons') ? $default_js['polygons'] : [],
        'edit' => FALSE,
      ];
      $element = [
        '#theme' => 'yamaps_field_formatter',
        '#width' => $this
          ->getSetting('width'),
        '#height' => $this
          ->getSetting('height'),
        '#map_id' => $map_id,
      ];
      $elements['#attached']['drupalSettings']['yamaps'][$map_id] = $map;
      $elements[$delta] = $element;
    }
    $elements['#attached']['library'][] = 'yamaps/yandex-map-api';
    if ($this
      ->getFieldSetting('enable_placemarks')) {
      $elements['#attached']['library'][] = 'yamaps/yamaps-placemark';
    }
    if ($this
      ->getFieldSetting('enable_lines')) {
      $elements['#attached']['library'][] = 'yamaps/yamaps-line';
    }
    if ($this
      ->getFieldSetting('enable_polygons')) {
      $elements['#attached']['library'][] = 'yamaps/yamaps-polygon';
    }
    $elements['#attached']['library'][] = 'yamaps/yamaps-map';
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['width'] = [
      '#title' => $this
        ->t('Map width'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('width'),
    ];
    $element['height'] = [
      '#title' => $this
        ->t('Map height'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('height'),
    ];
    $element['enable_drag'] = [
      '#title' => $this
        ->t('Allow the user to drag a map.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('enable_drag'),
    ];
    $element['enable_zoom'] = [
      '#title' => $this
        ->t('Allow the user to zoom a map.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('enable_zoom'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'width' => '100%',
      'height' => '400px',
      'enable_drag' => true,
      'enable_zoom' => true,
    ] + parent::defaultSettings();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary	22
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
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::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.
YamapsDefaultFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
YamapsDefaultFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
YamapsDefaultFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements

You are here

class YamapsDefaultFormatter in Yandex.Maps 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation