SimpleSitemapController.php in Simple XML sitemap 4.x

Namespace

Drupal\simple_sitemap\Controller

File

src/Controller/SimpleSitemapController.php

<?php

namespace Drupal\simple_sitemap\Controller;

use Drupal\Core\Controller\ControllerBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Drupal\simple_sitemap\Manager\Generator;
use Symfony\Component\HttpFoundation\Request;

/**
 * Class SimpleSitemapController
 */
class SimpleSitemapController extends ControllerBase {

  /**
   * @var \Drupal\simple_sitemap\Manager\Generator
   */
  protected $generator;

  /**
   * SimpleSitemapController constructor.
   *
   * @param \Drupal\simple_sitemap\Manager\Generator $generator
   */
  public function __construct(Generator $generator) {
    $this->generator = $generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : SimpleSitemapController {
    return new static($container
      ->get('simple_sitemap.generator'));
  }

  /**
   * Returns the whole sitemap variant, its requested chunk,
   * or its sitemap index file.
   * Caches the response in case of expected output, prevents caching otherwise.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *  The request object.
   * @param string|null $variant
   *  Optional name of sitemap variant.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *  Returns an XML response.
   * @throws NotFoundHttpException
   */
  public function getSitemap(Request $request, ?string $variant = NULL) : Response {
    $output = $this->generator
      ->setVariants($variant)
      ->getSitemap($request->query
      ->get('page'));
    if (!$output) {
      throw new NotFoundHttpException();
    }
    return new Response($output, Response::HTTP_OK, [
      'Content-type' => 'application/xml; charset=utf-8',
      'X-Robots-Tag' => 'noindex, follow',
    ]);
  }

  /**
   * Returns the XML stylesheet for the sitemap.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   */
  public function getSitemapXsl() : Response {

    // Read the XSL content from the file.
    $module_path = drupal_get_path('module', 'simple_sitemap');
    $xsl_content = file_get_contents($module_path . '/xsl/simple_sitemap.xsl');

    // Replace custom tokens in the XSL content with appropriate values.
    $replacements = [
      '[title]' => $this
        ->t('Sitemap file'),
      '[generated-by]' => $this
        ->t('Generated by the <a href="@link">@module_name</a> Drupal module.', [
        '@link' => 'https://www.drupal.org/project/simple_sitemap',
        '@module_name' => 'Simple XML Sitemap',
      ]),
      '[number-of-sitemaps]' => $this
        ->t('Number of sitemaps in this index'),
      '[sitemap-url]' => $this
        ->t('Sitemap URL'),
      '[number-of-urls]' => $this
        ->t('Number of URLs in this sitemap'),
      '[url-location]' => $this
        ->t('URL location'),
      '[lastmod]' => $this
        ->t('Last modification date'),
      '[changefreq]' => $this
        ->t('Change frequency'),
      '[priority]' => $this
        ->t('Priority'),
      '[translation-set]' => $this
        ->t('Translation set'),
      '[images]' => $this
        ->t('Images'),
      '[image-title]' => $this
        ->t('Title'),
      '[image-caption]' => $this
        ->t('Caption'),
      '[jquery]' => base_path() . 'core/assets/vendor/jquery/jquery.min.js',
      '[jquery-tablesorter]' => base_path() . $module_path . '/xsl/jquery.tablesorter.min.js',
      '[parser-date-iso8601]' => base_path() . $module_path . '/xsl/parser-date-iso8601.min.js',
      '[xsl-js]' => base_path() . $module_path . '/xsl/simple_sitemap.xsl.js',
      '[xsl-css]' => base_path() . $module_path . '/xsl/simple_sitemap.xsl.css',
    ];

    // Output the XSL content.
    return new Response(strtr($xsl_content, $replacements), Response::HTTP_OK, [
      'Content-type' => 'application/xml; charset=utf-8',
      'X-Robots-Tag' => 'noindex, nofollow',
    ]);
  }

}

Classes

Name	Description
SimpleSitemapController	Class SimpleSitemapController