abstract class Layer in Openlayers 7.3

Class Layer.

Hierarchy

class \Drupal\openlayers\Types\Base extends \Drupal\Component\Plugin\PluginBase implements ObjectInterface
- class \Drupal\openlayers\Types\Layer implements LayerInterface

Expanded class hierarchy of Layer

6 files declare their use of Layer

Group.php in src/Plugin/Layer/Group/Group.php: Layer: Heatmap.
Heatmap.php in src/Plugin/Layer/Heatmap/Heatmap.php: Layer: Heatmap.
Image.php in src/Plugin/Layer/Image/Image.php: Layer: Image.
InlineJS.php in src/Plugin/Layer/InlineJS/InlineJS.php: Layer: JS.
Tile.php in src/Plugin/Layer/Tile/Tile.php: Layer: Tile.

... See full list

11 string references to 'Layer'

Group::optionsForm in src/Plugin/Layer/Group/Group.php: @TODO What is this return? If it is the form, why is form by reference?
LayerSwitcher::optionsForm in src/Plugin/Control/LayerSwitcher/LayerSwitcher.php: @TODO What is this return? If it is the form, why is form by reference?
openlayers.services.yml in ./openlayers.services.yml: openlayers.services.yml
openlayers_layer_form_options in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersLayers.inc: Layer options config form handler.
openlayers_layer_form_options_submit in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersLayers.inc: Layer options config form submit handler.

... See full list

File

src/Types/Layer.php, line 14: Class Layer.

Namespace

Drupal\openlayers\Types

View source

abstract class Layer extends Base implements LayerInterface {

  /**
   * The array containing the options.
   *
   * @var array
   */
  protected $options = array();

  /**
   * {@inheritdoc}
   */
  public function getSource() {
    $source = $this
      ->getObjects('source');
    if ($source = array_shift($source)) {
      return $source instanceof SourceInterface ? $source : FALSE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getStyle() {
    $style = $this
      ->getObjects('style');
    if ($style = array_shift($style)) {
      return $style instanceof StyleInterface ? $style : FALSE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setSource(SourceInterface $source) {
    $this
      ->setOption('source', $source
      ->getMachineName());
    return $this
      ->addObject($source);
  }

  /**
   * {@inheritdoc}
   */
  public function setStyle(StyleInterface $style) {

    /** @var Style $style */
    $this
      ->setOption('style', $style
      ->getMachineName());
    return $this
      ->addObject($style);
  }

  /**
   * {@inheritdoc}
   */
  public function optionsToObjects() {
    $import = parent::optionsToObjects();
    foreach (array(
      'style',
      'source',
    ) as $option) {
      if ($option_value = $this
        ->getOption($option, FALSE)) {
        if ($object = $this
          ->getCollection()
          ->getObjectById($option, $option_value)) {
          $import = array_merge($import, $object
            ->getCollection()
            ->getFlatList());
        }
        else {
          $import = array_merge($import, Openlayers::load($option, $option_value)
            ->getCollection()
            ->getFlatList());
        }
      }
    }
    return $import;
  }

  /**
   * {@inheritdoc}
   */
  public function setOpacity($opacity) {
    return $this
      ->setOption('opacity', floatval($opacity));
  }

  /**
   * {@inheritdoc}
   */
  public function getOpacity() {
    return $this
      ->getOption('opacity');
  }

  /**
   * {@inheritdoc}
   */
  public function setZIndex($zindex) {
    return $this
      ->setOption('zIndex', intval($zindex));
  }

  /**
   * {@inheritdoc}
   */
  public function getZIndex() {
    return $this
      ->getOption('zIndex');
  }

  /**
   * {@inheritdoc}
   */
  public function setVisible($visibility) {
    return $this
      ->setOption('visible', (bool) $visibility);
  }

  /**
   * {@inheritdoc}
   */
  public function getVisible() {
    return (bool) $this
      ->getOption('visible');
  }

}

Members

Name	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::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::optionsForm	public	function	@TODO What is this return? If it is the form, why is form by reference? Overrides ObjectInterface::optionsForm	54
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::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
Layer::$options	protected	property	The array containing the options. Overrides Base::$options
Layer::getOpacity	public	function	Return the opacity of the layer (between 0 and 1). Overrides LayerInterface::getOpacity
Layer::getSource	public	function	Returns the source of this layer. Overrides LayerInterface::getSource
Layer::getStyle	public	function	Returns the style of this layer. Overrides LayerInterface::getStyle
Layer::getVisible	public	function	Return the visibility of the layer. Overrides LayerInterface::getVisible
Layer::getZIndex	public	function	Return the Z-index of the layer. Overrides LayerInterface::getZIndex
Layer::optionsToObjects	public	function	Return a flat array containing Openlayers Objects from the options array. Overrides Base::optionsToObjects	1
Layer::setOpacity	public	function	Set the opacity of the layer. Overrides LayerInterface::setOpacity
Layer::setSource	public	function	Set the source of this layer. Overrides LayerInterface::setSource
Layer::setStyle	public	function	Set the style of this layer. Overrides LayerInterface::setStyle
Layer::setVisible	public	function	Set the visibility of the layer. Overrides LayerInterface::setVisible
Layer::setZIndex	public	function	Set Z-index of the layer, which is used to order layers before rendering. Overrides LayerInterface::setZIndex

You are here

abstract class Layer in Openlayers 7.3

Hierarchy

File

Namespace

Members

API Navigation