You are here

Home » API reference » Simple XML sitemap 4.x » SimpleSitemap.php

class SimpleSitemap in Simple XML sitemap 4.x

Defines the simple_sitemap entity.

@ConfigEntityType( id = "simple_sitemap", label = @Translation("Sitemap"), label_collection = @Translation("Sitemaps"), label_singular = @Translation("sitemap"), label_plural = @Translation("sitemaps"), label_count = @PluralTranslation( singular = "@count sitemap", plural = "@count sitemaps", ), handlers = { "storage" = "Drupal\simple_sitemap\Entity\SimpleSitemapStorage", "list_builder" = "\Drupal\simple_sitemap\SimpleSitemapListBuilder", "form" = { "default" = "\Drupal\simple_sitemap\Form\SimpleSitemapEntityForm", "add" = "\Drupal\simple_sitemap\Form\SimpleSitemapEntityForm", "edit" = "\Drupal\simple_sitemap\Form\SimpleSitemapEntityForm", "delete" = "\Drupal\Core\Entity\EntityDeleteForm" }, }, config_prefix = "sitemap", admin_permission = "administer sitemap settings", entity_keys = { "id" = "id", "uuid" = "uuid", "label" = "label", "weight" = "weight", }, config_export = { "id", "label", "description", "type", "weight", }, links = { "add-form" = "/admin/config/search/simplesitemap/variants/add", "edit-form" = "/admin/config/search/simplesitemap/variants/{simple_sitemap}", "delete-form" = "/admin/config/search/simplesitemap/variants/{simple_sitemap}/delete", "collection" = "/admin/config/search/simplesitemap", }, )

@todo Implement dependency injection after https://www.drupal.org/project/drupal/issues/2142515 is fixed.

Hierarchy

Expanded class hierarchy of SimpleSitemap

14 files declare their use of SimpleSitemap
CustomLinksForm.php in src/Form/CustomLinksForm.php
FormHelper.php in src/Form/FormHelper.php
Generator.php in src/Manager/Generator.php
QueueWorker.php in src/Queue/QueueWorker.php
SettingsForm.php in src/Form/SettingsForm.php

... See full list

File

src/Entity/SimpleSitemap.php, line 58

Namespace

Drupal\simple_sitemap\Entity
View source 
class SimpleSitemap extends ConfigEntityBase implements SimpleSitemapInterface {
  public const SITEMAP_UNPUBLISHED = 0;
  public const SITEMAP_PUBLISHED = 1;
  public const SITEMAP_PUBLISHED_GENERATING = 2;
  public const FETCH_BY_STATUS_ALL = NULL;
  public const FETCH_BY_STATUS_UNPUBLISHED = 0;
  public const FETCH_BY_STATUS_PUBLISHED = 1;

  /**
   * @var int
   */
  protected $fetchByStatus;

  /**
   * @var \Drupal\simple_sitemap\Entity\SimpleSitemapTypeInterface
   */
  protected $sitemapType;
  public function __toString() : string {
    return $this
      ->toString();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
    $this
      ->addDependency('config', $this
      ->getType()
      ->getConfigDependencyName());
    return $this;
  }
  public function fromPublished() : SimpleSitemapInterface {
    $this->fetchByStatus = self::FETCH_BY_STATUS_PUBLISHED;
    return $this;
  }
  public function fromUnpublished() : SimpleSitemapInterface {
    $this->fetchByStatus = self::FETCH_BY_STATUS_UNPUBLISHED;
    return $this;
  }
  public function fromPublishedAndUnpublished() : SimpleSitemapInterface {
    $this->fetchByStatus = self::FETCH_BY_STATUS_ALL;
    return $this;
  }
  public function getType() : SimpleSitemapTypeInterface {
    if ($this->sitemapType === NULL) {
      $this->sitemapType = \Drupal::entityTypeManager()
        ->getStorage('simple_sitemap_type')
        ->load($this
        ->get('type'));
    }
    return $this->sitemapType;
  }
  public function toString(?int $delta = NULL) : string {
    $status = $this->fetchByStatus ?? self::FETCH_BY_STATUS_PUBLISHED;
    $storage = \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap');
    if ($delta) {
      try {
        return $storage
          ->getChunk($this, $status, $delta);
      } catch (SitemapNotExistsException $e) {
      }
    }
    if ($storage
      ->hasIndex($this, $status)) {
      return $storage
        ->getIndex($this, $status);
    }
    try {
      return $storage
        ->getChunk($this, $status);
    } catch (SitemapNotExistsException $e) {
      return '';
    }
  }
  public function publish() : SimpleSitemapInterface {
    \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->publish($this);
    return $this;
  }
  public function deleteContent() : SimpleSitemapInterface {
    \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->deleteContent($this);
    return $this;
  }
  public function addChunk(array $links) : SimpleSitemapInterface {
    $xml = $this
      ->getType()
      ->getSitemapGenerator()
      ->setSitemapVariant($this)
      ->getChunkXml($links);

    //todo automatically set variant
    \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->addChunk($this, $xml, count($links));
    return $this;
  }
  public function generateIndex() : SimpleSitemapInterface {
    if ($this
      ->isIndexable()) {
      $xml = $this
        ->getType()
        ->getSitemapGenerator()
        ->setSitemapVariant($this)
        ->getIndexXml();

      //todo automatically set variant
      \Drupal::entityTypeManager()
        ->getStorage('simple_sitemap')
        ->generateIndex($this, $xml);
    }
    return $this;
  }
  public function getChunk(int $delta = SimpleSitemapStorage::SITEMAP_CHUNK_FIRST_DELTA) : string {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->getChunk($this, $this->fetchByStatus, $delta);
  }
  public function getChunkCount() : int {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->getChunkCount($this, $this->fetchByStatus);
  }
  public function hasIndex() : bool {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->hasIndex($this, $this->fetchByStatus);
  }
  protected function isIndexable() : bool {
    try {
      \Drupal::entityTypeManager()
        ->getStorage('simple_sitemap')
        ->getChunk($this, self::FETCH_BY_STATUS_UNPUBLISHED, 2);
      return TRUE;
    } catch (SitemapNotExistsException $e) {
      return FALSE;
    }
  }
  public function getIndex() : string {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->getIndex($this, $this->fetchByStatus);
  }
  public function status() : bool {
    return parent::status() && $this
      ->contentStatus();
  }
  public function contentStatus() : ?int {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->status($this);
  }
  public function getCreated() : ?string {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->getCreated($this, $this->fetchByStatus);
  }
  public function getLinkCount() : int {
    return \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->getLinkCount($this, $this->fetchByStatus);
  }
  public function toUrl($rel = 'canonical', array $options = []) {
    if ($rel !== 'canonical') {
      return parent::toUrl($rel, $options);
    }
    $parameters = isset($options['delta']) ? [
      'page' => $options['delta'],
    ] : [];
    unset($options['delta']);
    $options['base_url'] = $options['base_url'] ?? (\Drupal::service('simple_sitemap.settings')
      ->get('base_url') ?: $GLOBALS['base_url']);
    $options['language'] = \Drupal::languageManager()
      ->getLanguage(LanguageInterface::LANGCODE_NOT_APPLICABLE);
    return $this
      ->isDefault() ? Url::fromRoute('simple_sitemap.sitemap_default', $parameters, $options) : Url::fromRoute('simple_sitemap.sitemap_variant', $parameters + [
      'variant' => $this
        ->id(),
    ], $options);
  }
  public function isDefault() : bool {
    return $this
      ->id() === \Drupal::service('simple_sitemap.settings')
      ->get('default_variant');
  }

  /**
   * Determines if the sitemap is to be a multilingual sitemap based on several
   * factors.
   *
   * A hreflang/multilingual sitemap is only wanted if there are indexable
   * languages available and if there is a language negotiation method enabled
   * that is based on URL discovery. Any other language negotiation methods
   * should be irrelevant, as a sitemap can only use URLs to guide to the
   * correct language.
   *
   * @see https://www.drupal.org/project/simple_sitemap/issues/3154570#comment-13730522
   *
   * @return bool
   */
  public function isMultilingual() : bool {
    if (!\Drupal::service('module_handler')
      ->moduleExists('language')) {
      return FALSE;
    }
    $url_negotiation_method_enabled = FALSE;
    $language_negotiator = \Drupal::service('language_negotiator');
    foreach ($language_negotiator
      ->getNegotiationMethods(LanguageInterface::TYPE_URL) as $method) {
      if ($language_negotiator
        ->isNegotiationMethodEnabled($method['id'])) {
        $url_negotiation_method_enabled = TRUE;
        break;
      }
    }
    $has_multiple_indexable_languages = count(array_diff_key(\Drupal::languageManager()
      ->getLanguages(), \Drupal::service('simple_sitemap.settings')
      ->get('excluded_languages', []))) > 1;
    return $url_negotiation_method_enabled && $has_multiple_indexable_languages;
  }
  public static function purgeContent($variants = NULL, ?bool $status = self::FETCH_BY_STATUS_ALL) {
    \Drupal::entityTypeManager()
      ->getStorage('simple_sitemap')
      ->purgeContent($variants, $status);
  }

  /**
   * {@inheritdoc}
   */
  public function set($property_name, $value) {
    if ($property_name === 'type') {
      $this->sitemapType = NULL;
    }
    return parent::set($property_name, $value);
  }

}

Members

Namesort descending 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
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
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::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
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::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::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
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::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 2
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::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::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
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 18
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
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.
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
SimpleSitemap::$fetchByStatus protected property
SimpleSitemap::$sitemapType protected property
SimpleSitemap::addChunk public function Overrides SimpleSitemapInterface::addChunk
SimpleSitemap::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
SimpleSitemap::contentStatus public function Overrides SimpleSitemapInterface::contentStatus
SimpleSitemap::deleteContent public function Overrides SimpleSitemapInterface::deleteContent
SimpleSitemap::FETCH_BY_STATUS_ALL public constant
SimpleSitemap::FETCH_BY_STATUS_PUBLISHED public constant
SimpleSitemap::FETCH_BY_STATUS_UNPUBLISHED public constant
SimpleSitemap::fromPublished public function Overrides SimpleSitemapInterface::fromPublished
SimpleSitemap::fromPublishedAndUnpublished public function Overrides SimpleSitemapInterface::fromPublishedAndUnpublished
SimpleSitemap::fromUnpublished public function Overrides SimpleSitemapInterface::fromUnpublished
SimpleSitemap::generateIndex public function Overrides SimpleSitemapInterface::generateIndex
SimpleSitemap::getChunk public function Overrides SimpleSitemapInterface::getChunk
SimpleSitemap::getChunkCount public function Overrides SimpleSitemapInterface::getChunkCount
SimpleSitemap::getCreated public function Overrides SimpleSitemapInterface::getCreated
SimpleSitemap::getIndex public function Overrides SimpleSitemapInterface::getIndex
SimpleSitemap::getLinkCount public function Overrides SimpleSitemapInterface::getLinkCount
SimpleSitemap::getType public function Overrides SimpleSitemapInterface::getType
SimpleSitemap::hasIndex public function Overrides SimpleSitemapInterface::hasIndex
SimpleSitemap::isDefault public function Overrides SimpleSitemapInterface::isDefault
SimpleSitemap::isIndexable protected function
SimpleSitemap::isMultilingual public function Determines if the sitemap is to be a multilingual sitemap based on several factors. Overrides SimpleSitemapInterface::isMultilingual
SimpleSitemap::publish public function Overrides SimpleSitemapInterface::publish
SimpleSitemap::purgeContent public static function Overrides SimpleSitemapInterface::purgeContent
SimpleSitemap::set public function Sets the value of a property. Overrides ConfigEntityBase::set
SimpleSitemap::SITEMAP_PUBLISHED public constant
SimpleSitemap::SITEMAP_PUBLISHED_GENERATING public constant
SimpleSitemap::SITEMAP_UNPUBLISHED public constant
SimpleSitemap::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityBase::status
SimpleSitemap::toString public function Overrides SimpleSitemapInterface::toString
SimpleSitemap::toUrl public function Gets the URL object for the entity. Overrides ConfigEntityBase::toUrl
SimpleSitemap::__toString 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