You are here

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

class CustomLinksForm in Simple XML sitemap 4.x

Class CustomLinksForm

Hierarchy

Expanded class hierarchy of CustomLinksForm

1 string reference to 'CustomLinksForm'
simple_sitemap.routing.yml in ./simple_sitemap.routing.yml
simple_sitemap.routing.yml

File

src/Form/CustomLinksForm.php, line 16

Namespace

Drupal\simple_sitemap\Form
View source 
class CustomLinksForm extends SimpleSitemapFormBase {

  /**
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * CustomLinksForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   * @param \Drupal\simple_sitemap\Manager\Generator $generator
   * @param \Drupal\simple_sitemap\Settings $settings
   * @param \Drupal\simple_sitemap\Form\FormHelper $form_helper
   * @param \Drupal\Core\Path\PathValidator $path_validator
   */
  public function __construct(ConfigFactoryInterface $config_factory, Generator $generator, Settings $settings, FormHelper $form_helper, PathValidator $path_validator) {
    parent::__construct($config_factory, $generator, $settings, $form_helper);
    $this->pathValidator = $path_validator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('simple_sitemap.generator'), $container
      ->get('simple_sitemap.settings'), $container
      ->get('simple_sitemap.form_helper'), $container
      ->get('path.validator'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'simple_sitemap_custom_links_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['simple_sitemap_custom'] = [
      '#title' => $this
        ->t('Custom links'),
      '#type' => 'fieldset',
      '#markup' => '<div class="description">' . $this
        ->t('Add custom internal drupal paths to the XML sitemap.') . '</div>',
      '#prefix' => FormHelper::getDonationText(),
    ];
    $form['simple_sitemap_custom']['custom_links'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Relative Drupal paths'),
      '#default_value' => $this
        ->customLinksToString($this->generator
        ->setVariants(TRUE)
        ->customLinkManager()
        ->get(NULL, FALSE)),
      '#description' => $this
        ->t("Please specify drupal internal (relative) paths, one per line. Do not forget to prepend the paths with a '/'.<br>Optionally link priority <em>(0.0 - 1.0)</em> can be added by appending it after a space.<br> Optionally link change frequency <em>(always / hourly / daily / weekly / monthly / yearly / never)</em> can be added by appending it after a space.<br/<br><strong>Examples:</strong><br><em>/ 1.0 daily</em> -> home page with the highest priority and daily change frequency<br><em>/contact</em> -> contact page with the default priority and no change frequency information"),
    ];
    $form['simple_sitemap_custom']['variants'] = [
      '#type' => 'select',
      '#multiple' => TRUE,
      '#title' => $this
        ->t('Sitemap variants'),
      '#description' => $this
        ->t('The sitemaps to include the above links in.<br>Sitemaps can be configured <a href="@url">here</a>.', [
        '@url' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap',
      ]),
      '#options' => array_map(function ($variant) {
        return $this
          ->t($variant
          ->label());
      }, SimpleSitemap::loadMultiple()),
      '#default_value' => array_keys(array_filter($this->generator
        ->setVariants(TRUE)
        ->customLinkManager()
        ->get(NULL, FALSE, TRUE), function ($e) {
        return !empty($e);
      })),
    ];
    $form['simple_sitemap_custom']['include_images'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Include images'),
      '#description' => $this
        ->t('If a custom link points to an entity, include its referenced images in the sitemap.'),
      '#default_value' => $this->settings
        ->get('custom_links_include_images', FALSE),
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
    ];
    $this->formHelper
      ->displayRegenerateNow($form['simple_sitemap_custom']);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (!empty($form_state
      ->getValue('custom_links')) && empty($form_state
      ->getValue('variants'))) {
      $form_state
        ->setErrorByName('variants', $this
        ->t('Custom links must be assigned to at least one sitemap variant.'));
    }
    foreach ($this
      ->stringToCustomLinks($form_state
      ->getValue('custom_links')) as $i => $link_config) {
      $placeholders = [
        '@line' => ++$i,
        '@path' => $link_config['path'],
        '@priority' => isset($link_config['priority']) ? $link_config['priority'] : '',
        '@changefreq' => isset($link_config['changefreq']) ? $link_config['changefreq'] : '',
        '@changefreq_options' => implode(', ', FormHelper::getChangefreqOptions()),
      ];

      // Checking if internal path exists.
      if (!(bool) $this->pathValidator
        ->getUrlIfValidWithoutAccessCheck($link_config['path']) || strpos($link_config['path'], '//') !== FALSE) {
        $form_state
          ->setErrorByName('', $this
          ->t('<strong>Line @line</strong>: The path <em>@path</em> does not exist.', $placeholders));
      }

      // Making sure the paths start with a slash.
      if ($link_config['path'][0] !== '/') {
        $form_state
          ->setErrorByName('', $this
          ->t("<strong>Line @line</strong>: The path <em>@path</em> needs to start with a '/'.", $placeholders));
      }

      // Making sure the priority is formatted correctly.
      if (isset($link_config['priority']) && !FormHelper::isValidPriority($link_config['priority'])) {
        $form_state
          ->setErrorByName('', $this
          ->t('<strong>Line @line</strong>: The priority setting <em>@priority</em> for path <em>@path</em> is incorrect. Set the priority from 0.0 to 1.0.', $placeholders));
      }

      // Making sure changefreq is formatted correctly.
      if (isset($link_config['changefreq']) && !FormHelper::isValidChangefreq($link_config['changefreq'])) {
        $form_state
          ->setErrorByName('', $this
          ->t('<strong>Line @line</strong>: The changefreq setting <em>@changefreq</em> for path <em>@path</em> is incorrect. The following are the correct values: <em>@changefreq_options</em>.', $placeholders));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->generator
      ->setVariants(TRUE)
      ->customLinkManager()
      ->remove();
    if (!empty($variants = $form_state
      ->getValue('variants')) && !empty($links = $form_state
      ->getValue('custom_links'))) {
      $this->generator
        ->setVariants(array_values($variants));
      foreach ($this
        ->stringToCustomLinks($links) as $link_config) {
        $this->generator
          ->customLinkManager()
          ->add($link_config['path'], $link_config);
      }
    }
    $this->settings
      ->save('custom_links_include_images', (bool) $form_state
      ->getValue('include_images'));
    parent::submitForm($form, $form_state);

    // Regenerate sitemaps according to user setting.
    if ($form_state
      ->getValue('simple_sitemap_regenerate_now')) {
      $this->generator
        ->setVariants(TRUE)
        ->rebuildQueue()
        ->generateSitemap();
    }
  }

  /**
   * @param string $custom_links_string
   *
   * @return array
   */
  protected function stringToCustomLinks(string $custom_links_string) : array {

    // Unify newline characters and explode into array.
    $custom_links_string_lines = explode("\n", str_replace("\r\n", "\n", $custom_links_string));

    // Remove empty values and whitespaces from array.
    $custom_links_string_lines = array_filter(array_map('trim', $custom_links_string_lines));
    $custom_links = [];
    foreach ($custom_links_string_lines as $i => &$line) {
      $link_settings = explode(' ', $line);
      $custom_links[$i]['path'] = $link_settings[0];

      // If two arguments are provided for a link, assume the first to be
      // priority, the second to be changefreq.
      if (!empty($link_settings[1]) && !empty($link_settings[2])) {
        $custom_links[$i]['priority'] = $link_settings[1];
        $custom_links[$i]['changefreq'] = $link_settings[2];
      }
      else {

        // If one argument is provided for a link, guess if it is priority or
        // changefreq.
        if (!empty($link_settings[1])) {
          if (is_numeric($link_settings[1])) {
            $custom_links[$i]['priority'] = $link_settings[1];
          }
          else {
            $custom_links[$i]['changefreq'] = $link_settings[1];
          }
        }
      }
    }
    return $custom_links;
  }

  /**
   * @param array $links
   * @return string
   */
  protected function customLinksToString(array $links) : string {
    $setting_string = '';
    foreach ($links as $custom_link) {
      $setting_string .= $custom_link['path'];
      $setting_string .= isset($custom_link['priority']) ? ' ' . $this->formHelper
        ->formatPriority($custom_link['priority']) : '';
      $setting_string .= isset($custom_link['changefreq']) ? ' ' . $custom_link['changefreq'] : '';
      $setting_string .= "\r\n";
    }
    return $setting_string;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
CustomLinksForm::$pathValidator protected property
CustomLinksForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
CustomLinksForm::create public static function Instantiates a new instance of this class. Overrides SimpleSitemapFormBase::create
CustomLinksForm::customLinksToString protected function
CustomLinksForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CustomLinksForm::stringToCustomLinks protected function
CustomLinksForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
CustomLinksForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
CustomLinksForm::__construct public function CustomLinksForm constructor. Overrides SimpleSitemapFormBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SimpleSitemapFormBase::$formHelper protected property
SimpleSitemapFormBase::$generator protected property
SimpleSitemapFormBase::$settings protected property
SimpleSitemapFormBase::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.