You are here

Home » API reference » Openlayers 7.3 » Circle.php

class Circle in Openlayers 7.3

Class Circle.

Plugin annotation


@OpenlayersPlugin(
 id = "Circle"
)

Hierarchy

  • class \Drupal\openlayers\Types\Base extends \Drupal\Component\Plugin\PluginBase implements ObjectInterface

Expanded class hierarchy of Circle

3 string references to 'Circle'
Geofield::optionsForm in modules/openlayers_geofield/src/Plugin/Control/Geofield/Geofield.php
@inheritDoc
Openlayers::getGeometryTypes in src/Openlayers.php
The list of geometries available.
openlayers_geofield_default_openlayers_controls in modules/openlayers_geofield/includes/openlayers_geofield.default_openlayers_controls.inc
Implements hook_default_openlayers_controls().

File

src/Plugin/Style/Circle/Circle.php, line 19
Style: Circle.

Namespace

Drupal\openlayers\Plugin\Style\Circle
View source 
class Circle extends Style {

  /**
   * {@inheritdoc}
   */
  public function optionsForm(array &$form, array &$form_state) {
    $form['options']['default'] = array(
      '#type' => 'fieldset',
      '#title' => t('Default'),
      '#collapsible' => TRUE,
    );
    $form['options']['default']['image'] = array(
      '#type' => 'fieldset',
      '#title' => t('Image options'),
      '#collapsible' => FALSE,
    );
    $form['options']['default']['image']['radius'] = array(
      '#type' => 'textfield',
      '#title' => 'Radius',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'radius',
      ), '5'),
      '#required' => TRUE,
    );
    $form['options']['default']['image']['fill'] = array(
      '#type' => 'fieldset',
      '#title' => t('Fill options'),
      '#collapsible' => FALSE,
    );
    $form['options']['default']['image']['fill']['color'] = array(
      '#type' => 'textfield',
      '#title' => 'Fill color',
      '#field_prefix' => 'rgba(',
      '#field_suffix' => ')',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'fill',
        'color',
      ), '255,255,255,0.4'),
      '#required' => TRUE,
    );
    $form['options']['default']['image']['stroke'] = array(
      '#type' => 'fieldset',
      '#title' => t('Stroke options'),
      '#collapsible' => FALSE,
    );
    $form['options']['default']['image']['stroke']['color'] = array(
      '#type' => 'textfield',
      '#title' => 'Stroke color',
      '#field_prefix' => 'rgba(',
      '#field_suffix' => ')',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'stroke',
        'color',
      ), '51,153,204,1'),
      '#required' => TRUE,
    );
    $form['options']['default']['image']['stroke']['width'] = array(
      '#type' => 'textfield',
      '#title' => 'Stroke width',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'stroke',
        'width',
      ), '1.25'),
      '#required' => TRUE,
    );
    $form['options']['default']['image']['stroke']['lineDash'] = array(
      '#type' => 'textfield',
      '#title' => 'Line dash',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'stroke',
        'lineDash',
      ), '0,0'),
      '#required' => TRUE,
    );
    $form['options']['default']['stroke']['lineDash'] = array(
      '#type' => 'textfield',
      '#title' => 'Line dash',
      '#description' => 'Two integers separated by a comma. The comma is mandatory. Default to disable is <em>0,0</em>.',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'image',
        'stroke',
        'lineDash',
      ), '0,0'),
      '#required' => TRUE,
    );
    $form['options']['default']['stroke'] = array(
      '#type' => 'fieldset',
      '#title' => 'Stroke',
    );
    $form['options']['default']['stroke']['color'] = array(
      '#type' => 'textfield',
      '#title' => 'Color',
      '#field_prefix' => 'rgba(',
      '#field_suffix' => ')',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'stroke',
        'color',
      ), '51,153,204,1'),
      '#required' => TRUE,
    );
    $form['options']['default']['stroke']['width'] = array(
      '#type' => 'textfield',
      '#title' => 'Width',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'stroke',
        'width',
      ), 1.25),
      '#required' => TRUE,
    );
    $form['options']['default']['stroke']['lineDash'] = array(
      '#type' => 'textfield',
      '#title' => 'Line dash',
      '#description' => 'Two integers separated by a comma. The comma is mandatory. Default to disable is <em>0,0</em>.',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'stroke',
        'lineDash',
      ), '0,0'),
      '#required' => TRUE,
    );
    $form['options']['default']['fill'] = array(
      '#type' => 'fieldset',
      '#title' => 'Fill',
    );
    $form['options']['default']['fill']['color'] = array(
      '#type' => 'textfield',
      '#title' => 'Color',
      '#field_prefix' => 'rgba(',
      '#field_suffix' => ')',
      '#default_value' => $this
        ->getOption(array(
        'default',
        'fill',
        'color',
      ), '51,153,204,1'),
      '#required' => TRUE,
    );
    foreach (Openlayers::getGeometryTypes() as $geometry_type => $geometry) {
      $enabled = (bool) $this
        ->getOption(array(
        $geometry_type,
        'enabled',
      ), FALSE);
      $form['options'][$geometry_type] = array(
        '#type' => 'fieldset',
        '#title' => t('Geometry @geometry', array(
          '@geometry' => $geometry,
        )),
        '#collapsible' => TRUE,
        '#collapsed' => !$enabled,
      );
      $form['options'][$geometry_type]['enabled'] = array(
        '#type' => 'checkbox',
        '#title' => t('Enable this geometry type ?'),
        '#default_value' => $enabled,
      );
      $form['options'][$geometry_type]['image']['radius'] = array(
        '#type' => 'textfield',
        '#title' => 'Radius',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'image',
          'radius',
        ), '5'),
      );
      $form['options'][$geometry_type]['image']['fill']['color'] = array(
        '#type' => 'textfield',
        '#title' => 'Fill color',
        '#field_prefix' => 'rgba(',
        '#field_suffix' => ')',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'image',
          'fill',
          'color',
        ), '255,255,255,0.4'),
      );
      $form['options'][$geometry_type]['image']['stroke']['color'] = array(
        '#type' => 'textfield',
        '#title' => 'Color',
        '#field_prefix' => 'rgba(',
        '#field_suffix' => ')',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'image',
          'stroke',
          'color',
        ), '51,153,204,1'),
      );
      $form['options'][$geometry_type]['image']['stroke']['width'] = array(
        '#type' => 'textfield',
        '#title' => 'Width',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'image',
          'stroke',
          'width',
        ), 1.25),
        '#required' => TRUE,
      );
      $form['options'][$geometry_type]['image']['stroke']['lineDash'] = array(
        '#type' => 'textfield',
        '#title' => 'Line dash',
        '#description' => 'Two integers separated by a comma. The comma is mandatory. Default to disable is <em>0,0</em>.',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'image',
          'stroke',
          'lineDash',
        ), '0,0'),
        '#required' => TRUE,
      );
      $form['options'][$geometry_type]['stroke'] = array(
        '#type' => 'fieldset',
        '#title' => 'Stroke',
      );
      $form['options'][$geometry_type]['stroke']['color'] = array(
        '#type' => 'textfield',
        '#title' => 'Color',
        '#field_prefix' => 'rgba(',
        '#field_suffix' => ')',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'stroke',
          'color',
        ), '51,153,204,1'),
      );
      $form['options'][$geometry_type]['stroke']['width'] = array(
        '#type' => 'textfield',
        '#title' => 'Width',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'stroke',
          'width',
        ), 1.25),
      );
      $form['options'][$geometry_type]['stroke']['lineDash'] = array(
        '#type' => 'textfield',
        '#title' => 'Line dash',
        '#description' => 'Two integers separated by a comma. The comma is mandatory. Default to disable is <em>0,0</em>.',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'stroke',
          'lineDash',
        ), '0,0'),
      );
      $form['options'][$geometry_type]['fill'] = array(
        '#type' => 'fieldset',
        '#title' => 'Fill',
      );
      $form['options'][$geometry_type]['fill']['color'] = array(
        '#type' => 'textfield',
        '#title' => 'Color',
        '#field_prefix' => 'rgba(',
        '#field_suffix' => ')',
        '#default_value' => $this
          ->getOption(array(
          $geometry_type,
          'fill',
          'color',
        ), '51,153,204,1'),
      );
    }
  }

  /**
   * {@inheritdoc}
   */
  public function optionsFormSubmit(array $form, array &$form_state) {
    parent::optionsFormSubmit($form, $form_state);
    $options = $this
      ->getOptions();
    foreach (Openlayers::getGeometryTypes() as $geometry_type => $geometry) {
      if ((bool) $options[$geometry_type]['enabled'] === FALSE) {
        unset($options[$geometry_type]);
      }
    }
    $this
      ->setOptions($options);
    $form_state['values']['options'] = $options;
    parent::optionsFormSubmit($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Base::$attached protected property Holds all the attachment used by this object. 6
Base::$collection protected property Holds the Collection object.
Base::$id protected property A unique ID for the object.
Base::addObject public function Add an object into the collection of the parent object. Overrides ObjectInterface::addObject
Base::attached public function Returns a list of attachments for building the render array. Overrides ObjectInterface::attached 6
Base::clearOption public function Remove an option. Overrides ObjectInterface::clearOption
Base::dependencies public function Defines dependencies. Overrides ObjectInterface::dependencies 3
Base::getClassDirectory public function Returns the path to the plugin directory. Overrides ObjectInterface::getClassDirectory
Base::getClassPath public function Returns the path to the class file. Overrides ObjectInterface::getClassPath
Base::getCollection public function Return the Collection object linked to the object. Overrides ObjectInterface::getCollection
Base::getConfiguration public function Return the object configuration. Overrides ObjectInterface::getConfiguration
Base::getDependencies public function Return all the dependencies objects of the parent object. Overrides ObjectInterface::getDependencies
Base::getDescription public function Return the description of the object. Overrides ObjectInterface::getDescription
Base::getExport public function Return an object, CTools Exportable. Overrides ObjectInterface::getExport
Base::getFactoryService public function Return the Factory Service of the object. Overrides ObjectInterface::getFactoryService
Base::getId public function Return the object unique ID. Overrides ObjectInterface::getId
Base::getMachineName public function Return the unique machine name of the object. Overrides ObjectInterface::getMachineName
Base::getName public function Return the human name of the object. Overrides ObjectInterface::getName
Base::getObjects public function Return an array of OL objects indexed by their type. Overrides ObjectInterface::getObjects
Base::getOption public function Returns an option. Overrides ObjectInterface::getOption
Base::getOptions public function Return the options array. Overrides ObjectInterface::getOptions
Base::getParents public function Returns an array with the maps this object is attached on. Overrides ObjectInterface::getParents
Base::getPluginDescription public function Return the description of the object's plugin. Overrides ObjectInterface::getPluginDescription
Base::getProvider public function Return the module that provides this plugin. Overrides ObjectInterface::getProvider
Base::getType public function The type of this object. Overrides ObjectInterface::getType
Base::getWeight public function Get the weight of an object. Overrides ObjectInterface::getWeight
Base::i18nStringsRefresh public function Refresh string translations. Overrides ObjectInterface::i18nStringsRefresh 1
Base::init public function Initializes the object. Overrides ObjectInterface::init 2
Base::initCollection public function Initializes the Collection, Import objects from options, Import the current object. Overrides ObjectInterface::initCollection
Base::isAsynchronous public function Whether or not this object has to be processed asynchronously. Overrides ObjectInterface::isAsynchronous 3
Base::optionsFormValidate public function Validation callback for the options form. Overrides ObjectInterface::optionsFormValidate
Base::optionsToObjects public function Return a flat array containing Openlayers Objects from the options array. Overrides ObjectInterface::optionsToObjects 9
Base::postBuild public function Invoked after an objects render array is built. Overrides ObjectInterface::postBuild 13
Base::preBuild public function Invoked before an objects render array is built. Overrides ObjectInterface::preBuild 4
Base::removeObject public function Remove an object from the collection. Overrides ObjectInterface::removeObject
Base::resetCollection public function Reset the object's Collection. Overrides ObjectInterface::resetCollection
Base::setFactoryService public function Set the Factory Service of the object. Overrides ObjectInterface::setFactoryService
Base::setId public function Set the object ID. Overrides ObjectInterface::setId
Base::setOption public function Set an option. Overrides ObjectInterface::setOption
Base::setOptions public function Set the options array. Overrides ObjectInterface::setOptions
Base::setWeight public function Set the weight of an object. Overrides ObjectInterface::setWeight
Circle::optionsForm public function @TODO What is this return? If it is the form, why is form by reference? Overrides Base::optionsForm
Circle::optionsFormSubmit public function Submit callback for the options form. Overrides Base::optionsFormSubmit
Style::$options protected property The array containing the options. Overrides Base::$options
Style::getJS public function !Attention! This function will remove any option that is named after a plugin type e.g.: layers, controls, styles, interactions, components . Overrides Base::getJS