You are here

Home » API reference » Openlayers 7.3 » Views.php

class Views in Openlayers 7.3

Class Views.

Plugin annotation


@OpenlayersPlugin(
 id = "Views"
)

Hierarchy

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

Expanded class hierarchy of Views

File

modules/openlayers_views/src/Plugin/Source/Views/Views.php, line 18
Source: Views.

Namespace

Drupal\openlayers_views\Plugin\Source\Views
View source 
class Views extends Source {

  /**
   * @inheritDoc
   */
  public function optionsForm(array &$form, array &$form_state) {
    $options = array();
    foreach (views_get_all_views() as $view) {
      foreach ($view->display as $display) {
        if ($display->id != 'default') {
          $view
            ->set_display($display->id);
          $viewname = sprintf('%s (%s)', $view->human_name, $view->name);
          if ($view->display_handler
            ->get_option('style_plugin') == 'openlayers_source_vector') {
            $options[$viewname][$view->name . ':' . $display->id] = sprintf('%s:%s', $view->human_name, $display->id);
          }
          if ($view->display_handler
            ->get_option('style_plugin') == 'openlayers_map_views') {
            $options[$viewname][$view->name . ':' . $display->id] = sprintf('%s:%s', $view->human_name, $display->id);
          }
        }
      }
    }
    $form['options']['view'] = array(
      '#type' => 'select',
      '#title' => 'View and display',
      '#options' => $options,
      '#default_value' => $this
        ->getOption('view'),
      '#required' => TRUE,
    );
    return parent::optionsForm($form, $form_state);
  }

  /**
   * @inheritDoc
   */
  public function init() {
    $features = array();
    $source = Openlayers::loadExportable('source', $this
      ->getMachineName());
    if (is_object($source)) {
      $this
        ->setOptions($source->options);
    }
    if ($view = $this
      ->getOption('view', FALSE)) {
      list($views_id, $display_id) = explode(':', $view, 2);
      $view = views_get_view($views_id);
      if ($view && $view
        ->access($display_id)) {
        $view
          ->set_display($display_id);
        if (empty($view->current_display) || !empty($display_id) && $view->current_display != $display_id) {
          if (!$view
            ->set_display($display_id)) {
            return FALSE;
          }
        }
        $view
          ->pre_execute();
        $view
          ->init_style();
        $view
          ->execute();

        // Do not render the map, just return the features.
        $view->style_plugin->options['skipMapRender'] = TRUE;
        $features = array_merge($features, $view->style_plugin
          ->render());
        $view
          ->post_execute();
      }
    }
    $this
      ->setOption('features', $features);
    return parent::init();
  }

}

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::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 ObjectInterface::getJS 6
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::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::optionsFormSubmit public function Submit callback for the options form. Overrides ObjectInterface::optionsFormSubmit 11
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
Source::$options protected property The array containing the options. Overrides Base::$options
Views::init public function @inheritDoc Overrides Base::init
Views::optionsForm public function @inheritDoc Overrides Base::optionsForm