class SitemapParser in Feeds 8.3

Defines a SitemapXML feed parser.

Plugin annotation


@FeedsParser(
  id = "sitemap",
  title = @Translation("Sitemap XML"),
  description = @Translation("Parse Sitemap XML format feeds.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\feeds\Plugin\Type\PluginBase implements FeedsPluginInterface uses DependencyTrait
    class \Drupal\feeds\Feeds\Parser\SitemapParser implements ParserInterface uses XmlParserTrait

Expanded class hierarchy of SitemapParser

1 file declares its use of SitemapParser

SitemapParserTest.php in tests/src/Unit/Feeds/Parser/SitemapParserTest.php

File

src/Feeds/Parser/SitemapParser.php, line 24

Namespace

Drupal\feeds\Feeds\Parser

View source

class SitemapParser extends PluginBase implements ParserInterface {
  use XmlParserTrait;

  /**
   * {@inheritdoc}
   */
  public function parse(FeedInterface $feed, FetcherResultInterface $fetcher_result, StateInterface $state) {

    // Set time zone to GMT for parsing dates with strtotime().
    $tz = date_default_timezone_get();
    date_default_timezone_set('GMT');
    $raw = trim($fetcher_result
      ->getRaw());
    if (!strlen($raw)) {
      throw new EmptyFeedException();
    }

    // Yes, using a DOM parser is a bit inefficient, but will do for now.
    // @todo XML error handling.
    static::startXmlErrorHandling();
    $xml = new \SimpleXMLElement($raw);
    static::stopXmlErrorHandling();
    $result = new ParserResult();
    foreach ($xml->url as $url) {
      $item = new SitemapItem();
      $item
        ->set('url', (string) $url->loc);
      if ($url->lastmod) {
        $item
          ->set('lastmod', strtotime($url->lastmod));
      }
      if ($url->changefreq) {
        $item
          ->set('changefreq', (string) $url->changefreq);
      }
      if ($url->priority) {
        $item
          ->set('priority', (string) $url->priority);
      }
      $result
        ->addItem($item);
    }
    date_default_timezone_set($tz);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function getMappingSources() {
    return [
      'url' => [
        'label' => $this
          ->t('Item URL (link)'),
        'description' => $this
          ->t('URL of the feed item.'),
        'suggestions' => [
          'targets' => [
            'url',
          ],
        ],
      ],
      'lastmod' => [
        'label' => $this
          ->t('Last modification date'),
        'description' => $this
          ->t('Last modified date as UNIX time GMT of the feed item.'),
      ],
      'changefreq' => [
        'label' => $this
          ->t('Change frequency'),
        'description' => $this
          ->t('How frequently the page is likely to change.'),
      ],
      'priority' => [
        'label' => $this
          ->t('Priority'),
        'description' => $this
          ->t('The priority of this URL relative to other URLs on the site.'),
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$feedType	protected	property	The importer this plugin is working for.
PluginBase::$linkGenerator	protected	property	The link generator.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$urlGenerator	protected	property	The url generator.
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	2
PluginBase::container	private	function	Returns the service container.
PluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	7
PluginBase::defaultFeedConfiguration	public	function	Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration	3
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::l	protected	function	Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator	protected	function	Returns the link generator service.
PluginBase::onFeedDeleteMultiple	public	function	A feed is being deleted.	3
PluginBase::onFeedSave	public	function	A feed is being saved.
PluginBase::onFeedTypeDelete	public	function	The feed type is being deleted.	1
PluginBase::onFeedTypeSave	public	function	The feed type is being saved.	1
PluginBase::pluginType	public	function	Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
PluginBase::url	protected	function	Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator	protected	function	Returns the URL generator service.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct	4
SitemapParser::getMappingSources	public	function	Declare the possible mapping sources that this parser produces. Overrides ParserInterface::getMappingSources
SitemapParser::parse	public	function	Parses content returned by fetcher. Overrides ParserInterface::parse
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
XmlParserTrait::$_elementRegex	protected static	property	Matches the characters of an XML element.
XmlParserTrait::$_entityLoader	protected static	property	The previous value of the entity loader.
XmlParserTrait::$_errors	protected static	property	The errors reported during parsing.
XmlParserTrait::$_useError	protected static	property	The previous value of libxml error reporting.
XmlParserTrait::getDomDocument	protected static	function	Returns a new DOMDocument.
XmlParserTrait::getXmlErrors	protected static	function	Returns the errors reported during parsing.
XmlParserTrait::removeDefaultNamespaces	protected static	function	Strips the default namespaces from an XML string.
XmlParserTrait::startXmlErrorHandling	protected static	function	Starts custom error handling.
XmlParserTrait::stopXmlErrorHandling	protected static	function	Stops custom error handling.

You are here

class SitemapParser in Feeds 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation