XmlSitemap.php in XML sitemap 2.x

Namespace

Drupal\xmlsitemap\Entity

File

src/Entity/XmlSitemap.php

<?php

namespace Drupal\xmlsitemap\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBase;
use Drupal\xmlsitemap\XmlSitemapInterface;

/**
 * Defines the XmlSitemap entity.
 *
 * @ConfigEntityType(
 *   id = "xmlsitemap",
 *   label = @Translation("XML sitemap"),
 *   handlers = {
 *     "storage" = "Drupal\xmlsitemap\XmlSitemapStorage",
 *     "list_builder" = "Drupal\xmlsitemap\XmlSitemapListBuilder",
 *     "form" = {
 *       "add" = "Drupal\xmlsitemap\Form\XmlSitemapForm",
 *       "edit" = "Drupal\xmlsitemap\Form\XmlSitemapForm",
 *       "delete" = "Drupal\xmlsitemap\Form\XmlSitemapDeleteForm",
 *     },
 *   },
 *   config_prefix = "xmlsitemap",
 *   admin_permission = "administer site configuration",
 *   entity_keys = {
 *     "id" = "id",
 *     "uuid" = "uuid",
 *     "label" = "label",
 *   },
 *   links = {
 *     "edit-form" = "/admin/config/search/xmlsitemap/{xmlsitemap}/edit",
 *     "delete-form" = "/admin/config/search/xmlsitemap/{xmlsitemap}/delete",
 *   },
 *   config_export = {
 *     "id",
 *     "label",
 *     "context",
 *   },
 * )
 */
class XmlSitemap extends ConfigEntityBase implements XmlSitemapInterface {

  /**
   * Sitemap uri data.
   *
   * @var array
   */
  public $uri;

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

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

  /**
   * The XmlSitemap chunks number.
   *
   * @var int
   */
  public $chunks;

  /**
   * The XmlSitemap links number.
   *
   * @var int
   */
  public $links;

  /**
   * Maximum size for a sitemap.
   *
   * @var int
   */
  public $max_filesize;

  /**
   * The XmlSitemap context.
   *
   * @var array
   */
  public $context;

  /**
   * Last time when sitemap was updated.
   *
   * @var int
   */
  public $updated;

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

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

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

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

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

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

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

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public static function loadByContext(array $context = NULL) {
    if (!isset($context)) {
      $context = xmlsitemap_get_current_context();
    }
    $sitemaps = static::loadMultiple();
    foreach ($sitemaps as $sitemap) {
      if ($sitemap->context == $context) {
        return $sitemap;
      }
    }
    return NULL;
  }

}

Classes

Name	Description
XmlSitemap	Defines the XmlSitemap entity.