class OpenlayersMap in Openlayers 8.4

Same name in this branch

8.4 src/Entity/OpenlayersMap.php \Drupal\openlayers\Entity\OpenlayersMap
8.4 src/Plugin/views/style/OpenlayersMap.php \Drupal\openlayers\Plugin\views\style\OpenlayersMap

Defines the Openlayers Map entity.

Plugin annotation


@ConfigEntityType(
  id = "openlayers_map",
  label = @Translation("Openlayers Map"),
  handlers = {
    "list_builder" = "Drupal\openlayers\Controller\OpenlayersMapListBuilder",
    "form" = {
      "add" = "Drupal\openlayers\Form\OpenlayersMapAddForm",
      "edit" = "Drupal\openlayers\Form\OpenlayersMapEditForm",
      "delete" = "Drupal\openlayers\Form\OpenlayersMapDeleteForm",
    }
  },
  config_prefix = "map",
  admin_permission = "administer openlayers",
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  config_export = {
    "id",
    "label",
    "layers",
    "styles",
    "controls",
    "interactions",
    "map_view"
  },
  links = {
    "edit-form" = "/admin/config/system/openlayers/map/{openlayers_map}/edit",
    "delete-form" = "/admin/config/system/openlayers/map/{openlayers_map}/delete",
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\openlayers\Entity\OpenlayersMap implements EntityWithPluginCollectionInterface, OpenlayersMapInterface

Expanded class hierarchy of OpenlayersMap

File

src/Entity/OpenlayersMap.php, line 48

Namespace

Drupal\openlayers\Entity

View source

class OpenlayersMap extends ConfigEntityBase implements OpenlayersMapInterface, EntityWithPluginCollectionInterface {

  /**
   * The Map ID.
   *
   * @var string
   */
  public $id;

  /**
   * The Map label.
   *
   * @var string
   */
  public $label;

  // Your specific configuration property get/set methods go here,
  // implementing the interface.

  /**
   * The ??? flag.?????
   *
   * @var array ???
   */
  public $layers;

  /**
   * The ??? flag.?????
   *
   * @var array ???
   */
  public $styles;

  /**
   * The ??? flag.?????
   *
   * @var array ???
   */
  public $controls;

  /**
   * The ??? flag.?????
   *
   * @var array ???
   */
  public $interactions;

  /**
   * The ??? flag.?????
   *
   * @var array ???
   */
  public $map_view;

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->id;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->label;
  }

  /**
   * Returns the image effect plugin manager.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   The image effect plugin manager.
   */
  protected function getStylePluginManager() {
    return \Drupal::service('plugin.manager.openlayers.style');
  }

  /**
   * Returns the image effect plugin manager.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   The image effect plugin manager.
   */
  protected function getControlPluginManager() {
    return \Drupal::service('plugin.manager.openlayers.control');
  }

  /**
   * Returns the image effect plugin manager.
   *
   * @return \Drupal\Component\Plugin\PluginManagerInterface
   *   The image effect plugin manager.
   */
  protected function getInteractionPluginManager() {
    return \Drupal::service('plugin.manager.openlayers.interaction');
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'styles' => $this
        ->getStyles(),
      'controls' => $this
        ->getControls(),
      'interactions' => $this
        ->getInteractions(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getLayer($layer) {

    //    return $this->getLayers()->get($layer);
    return $this
      ->getLayers()[$layer];
  }

  /**
   * {@inheritdoc}
   */
  public function getLayers() {
    if (!isset($this->layers)) {
      return [];
    }
    $layer_collection = [];
    foreach ($this->layers as $key => $layer) {
      $layer_id = $key;
    }
    return $this->layers;
  }

  /**
   * {@inheritdoc}
   */
  public function getAllLayers() {
    $layerNames = \Drupal::service('config.storage')
      ->listAll('openlayers.layer');
    $layers = [];
    foreach ($layerNames as $layerName) {
      $layerLabel = \Drupal::config($layerName)
        ->get('label');
      $layerName = str_replace('openlayers.layer.', '', $layerName);
      $layers[$layerName] = $layerLabel;
    }
    return $layers;
  }

  /**
   * {@inheritdoc}
   */
  public function getStyle($style) {
    return $this
      ->getStyles()
      ->get($style);
  }

  /**
   * {@inheritdoc}
   */
  public function getStyles() {
    if (!isset($this->stylesCollection)) {
      $this->stylesCollection = new OpenlayersPluginCollection($this
        ->getStylePluginManager(), isset($this->styles) ? $this->styles : []);
      $this->stylesCollection
        ->sort();
    }
    return $this->stylesCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getControl($control) {
    return $this
      ->getControls()
      ->get($control);
  }

  /**
   * {@inheritdoc}
   */
  public function getControls() {
    if (!isset($this->controlsCollection)) {
      $this->controlsCollection = new OpenlayersPluginCollection($this
        ->getControlPluginManager(), isset($this->controls) ? $this->controls : []);
      $this->controlsCollection
        ->sort();
    }
    return $this->controlsCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function getInteraction($interaction) {
    return $this
      ->getInteractions()
      ->get($interaction);
  }

  /**
   * {@inheritdoc}
   */
  public function getInteractions() {
    if (!isset($this->interactionsCollection)) {
      $this->interactionsCollection = new OpenlayersPluginCollection($this
        ->getInteractionPluginManager(), isset($this->interactions) ? $this->interactions : []);
      $this->interactionsCollection
        ->sort();
    }
    return $this->interactionsCollection;
  }

  /**
   * {@inheritdoc}
   */
  public function addMapLayer($configuration) {
    $uuid = \Drupal::service('uuid')
      ->generate();
    $this->layers[$configuration['uuid']] = $configuration;
    return $uuid;
  }

  /**
   * {@inheritdoc}
   */
  public function addMapStyle($configuration) {
    $configuration['uuid'] = $this
      ->uuidGenerator()
      ->generate();
    $this
      ->getStyles()
      ->addInstanceId($configuration['uuid'], $configuration);
    return $configuration['uuid'];
  }

  /**
   * {@inheritdoc}
   */
  public function addMapControl($configuration) {
    $configuration['uuid'] = $this
      ->uuidGenerator()
      ->generate();
    $this
      ->getControls()
      ->addInstanceId($configuration['uuid'], $configuration);
    return $configuration['uuid'];
  }

  /**
   * {@inheritdoc}
   */
  public function addMapInteraction($configuration) {
    $configuration['uuid'] = $this
      ->uuidGenerator()
      ->generate();
    $this
      ->getInteractions()
      ->addInstanceId($configuration['uuid'], $configuration);
    return $configuration['uuid'];
  }

  /**
   * {@inheritdoc}
   */
  public function updateMapLayer($configuration) {
    $this->layers[$configuration['uuid']] = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteMapLayer($configuration) {
    $uuid = $configuration->uuid;
    unset($this->layers[$uuid]);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteMapStyle($configuration) {
    $uuid = $configuration->uuid;
    unset($this->styles[$uuid]);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteMapControl($configuration) {
    $uuid = $configuration->uuid;
    unset($this->controls[$uuid]);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteMapInteraction($configuration) {
    $uuid = $configuration->uuid;
    unset($this->interactions[$uuid]);
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    if ($update) {
      if (!empty($this->original) && $this
        ->id() !== $this->original
        ->id()) {

        // The old image style name needs flushing after a rename.
        $this->original
          ->flush();
      }
      else {

        // Flush image style when updating without changing the name.
        $this
          ->flush();
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function flush() {

    // Clear caches so that formatters may be added for this style.
    Cache::invalidateTags($this
      ->getCacheTagsToInvalidate());
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
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	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
OpenlayersMap::$controls	public	property	The ??? flag.?????
OpenlayersMap::$id	public	property	The Map ID.
OpenlayersMap::$interactions	public	property	The ??? flag.?????
OpenlayersMap::$label	public	property	The Map label.
OpenlayersMap::$layers	public	property	The ??? flag.?????
OpenlayersMap::$map_view	public	property	The ??? flag.?????
OpenlayersMap::$styles	public	property	The ??? flag.?????
OpenlayersMap::addMapControl	public	function
OpenlayersMap::addMapInteraction	public	function
OpenlayersMap::addMapLayer	public	function
OpenlayersMap::addMapStyle	public	function
OpenlayersMap::deleteMapControl	public	function
OpenlayersMap::deleteMapInteraction	public	function
OpenlayersMap::deleteMapLayer	public	function
OpenlayersMap::deleteMapStyle	public	function
OpenlayersMap::flush	public	function
OpenlayersMap::getAllLayers	public	function
OpenlayersMap::getControl	public	function	Overrides OpenlayersMapInterface::getControl
OpenlayersMap::getControlPluginManager	protected	function	Returns the image effect plugin manager.
OpenlayersMap::getControls	public	function	Overrides OpenlayersMapInterface::getControls
OpenlayersMap::getInteraction	public	function	Overrides OpenlayersMapInterface::getInteraction
OpenlayersMap::getInteractionPluginManager	protected	function	Returns the image effect plugin manager.
OpenlayersMap::getInteractions	public	function	Overrides OpenlayersMapInterface::getInteractions
OpenlayersMap::getLayer	public	function	Returns a specific image effect. Overrides OpenlayersMapInterface::getLayer
OpenlayersMap::getLayers	public	function	Returns the image effects for this style. Overrides OpenlayersMapInterface::getLayers
OpenlayersMap::getPluginCollections	public	function	Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
OpenlayersMap::getStyle	public	function	Returns a specific image effect. Overrides OpenlayersMapInterface::getStyle
OpenlayersMap::getStylePluginManager	protected	function	Returns the image effect plugin manager.
OpenlayersMap::getStyles	public	function	Returns the image effects for this style. Overrides OpenlayersMapInterface::getStyles
OpenlayersMap::id	public	function	Gets the identifier. Overrides EntityBase::id
OpenlayersMap::label	public	function	Gets the label of the entity. Overrides EntityBase::label
OpenlayersMap::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
OpenlayersMap::updateMapLayer	public	function
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class OpenlayersMap in Openlayers 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation