class GeolocationShapes in Geolocation Field 8.3

Redraw locations as shapes.

Plugin annotation


@MapFeature(
  id = "geolocation_shapes",
  name = @Translation("Draw Shapes"),
  description = @Translation("Draw shapes based on locations."),
  type = "all",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
    class \Drupal\geolocation\Plugin\geolocation\MapFeature\GeolocationShapes

Expanded class hierarchy of GeolocationShapes

File

src/Plugin/geolocation/MapFeature/GeolocationShapes.php, line 17

Namespace

Drupal\geolocation\Plugin\geolocation\MapFeature

View source

class GeolocationShapes extends MapFeatureBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'remove_markers' => FALSE,
      'polyline' => TRUE,
      'polyline_title' => '',
      'strokeColor' => '#FF0000',
      'strokeOpacity' => 0.8,
      'strokeWidth' => 2,
      'polygon' => FALSE,
      'polygon_title' => '',
      'fillColor' => '#FF0000',
      'fillOpacity' => 0.35,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsSummary(array $settings) {
    $summary = parent::getSettingsSummary($settings);
    $summary[] = $this
      ->t('Draw polyline: @polyline', [
      '@polyline' => $settings['polyline'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = $this
      ->t('Draw polygon: @polygon', [
      '@polygon' => $settings['polygon'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $states_prefix = array_shift($parents) . '[' . implode('][', $parents) . ']';
    $form['remove_markers'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove markers'),
      '#description' => $this
        ->t('Remove location elements and markers from output.'),
      '#default_value' => $settings['remove_markers'],
    ];
    $form['polyline'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Draw polyline'),
      '#description' => $this
        ->t('A polyline is a linear overlay of connected line segments on the map.'),
      '#default_value' => $settings['polyline'],
    ];
    $form['polyline_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Polyline title (Tokens supported)'),
      '#default_value' => $settings['polyline_title'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['strokeColor'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke color'),
      '#description' => $this
        ->t('The stroke color. All CSS3 colors are supported except for extended named colors.'),
      '#size' => 4,
      '#default_value' => $settings['strokeColor'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['strokeOpacity'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke opacity'),
      '#description' => $this
        ->t('The stroke opacity between 0.0 and 1.0.'),
      '#size' => 2,
      '#default_value' => $settings['strokeOpacity'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['strokeWidth'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke width'),
      '#description' => $this
        ->t('The stroke width in pixels.'),
      '#size' => 2,
      '#default_value' => $settings['strokeWidth'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['polygon'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Draw polygon'),
      '#description' => $this
        ->t('Polygons form a closed loop and define a filled region.'),
      '#default_value' => $settings['polygon'],
    ];
    $form['polygon_title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Polygon title (Tokens supported)'),
      '#default_value' => $settings['polygon_title'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['fillColor'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill color'),
      '#description' => $this
        ->t('The fill color. All CSS3 colors are supported except for extended named colors.'),
      '#size' => 4,
      '#default_value' => $settings['fillColor'],
      '#states' => [
        'visible' => [
          'input[name="' . $states_prefix . '[polygon]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['fillOpacity'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill opacity'),
      '#description' => $this
        ->t('The fill opacity between 0.0 and 1.0.'),
      '#size' => 4,
      '#default_value' => $settings['fillOpacity'],
      '#states' => [
        'visible' => [
          'input[name="' . $states_prefix . '[polygon]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    if (empty($render_array['#children']['locations'])) {
      return $render_array;
    }
    $coordinates = [];
    foreach ($render_array['#children']['locations'] as $location) {
      if (empty($location['#coordinates'])) {
        continue;
      }
      $coordinates[] = $location['#coordinates'];
    }
    if ($feature_settings['remove_markers']) {
      unset($render_array['#children']['locations']);
    }
    if ($feature_settings['polyline']) {
      $render_array['#children']['polyline'] = [
        '#type' => 'geolocation_map_polyline',
        '#coordinates' => $coordinates,
        '#title' => \Drupal::token()
          ->replace($feature_settings['polyline_title'], $context),
        '#stroke_color' => $feature_settings['strokeColor'],
        '#stroke_width' => $feature_settings['strokeWidth'],
        '#stroke_opacity' => $feature_settings['strokeOpacity'],
      ];
    }
    if ($feature_settings['polygon']) {
      $render_array['#children']['polygon'] = [
        '#type' => 'geolocation_map_polygon',
        '#coordinates' => $coordinates,
        '#title' => \Drupal::token()
          ->replace($feature_settings['polygon_title'], $context),
        '#stroke_color' => $feature_settings['strokeColor'],
        '#stroke_width' => $feature_settings['strokeWidth'],
        '#stroke_opacity' => $feature_settings['strokeOpacity'],
        '#fill_color' => $feature_settings['fillColor'],
        '#fill_opacity' => $feature_settings['fillOpacity'],
      ];
    }
    return $render_array;
  }

}

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
GeolocationShapes::alterMap	public	function	Alter render array. Overrides MapFeatureBase::alterMap
GeolocationShapes::getDefaultSettings	public static	function	Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
GeolocationShapes::getSettingsForm	public	function	Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
GeolocationShapes::getSettingsSummary	public	function	Provide a summary array to use in field formatters. Overrides MapFeatureBase::getSettingsSummary
MapFeatureBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
MapFeatureBase::getSettings	public	function	Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface::getSettings
MapFeatureBase::validateSettingsForm	public	function	Validate Feature Form. Overrides MapFeatureInterface::validateSettingsForm	5
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.

You are here

class GeolocationShapes in Geolocation Field 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation