You are here

Home » API reference » XML sitemap 8 » XmlSitemapCustomEditForm.php

class XmlSitemapCustomEditForm in XML sitemap 8

Same name and namespace in other branches
  1. 2.x xmlsitemap_custom/src/Form/XmlSitemapCustomEditForm.php \Drupal\xmlsitemap_custom\Form\XmlSitemapCustomEditForm

Provides a form for editing a custom link.

Hierarchy

Expanded class hierarchy of XmlSitemapCustomEditForm

1 string reference to 'XmlSitemapCustomEditForm'
xmlsitemap_custom.routing.yml in xmlsitemap_custom/xmlsitemap_custom.routing.yml
xmlsitemap_custom/xmlsitemap_custom.routing.yml

File

xmlsitemap_custom/src/Form/XmlSitemapCustomEditForm.php, line 18

Namespace

Drupal\xmlsitemap_custom\Form
View source 
class XmlSitemapCustomEditForm extends FormBase {

  /**
   * The path of the custom link.
   *
   * @var string
   *
   * @codingStandardsIgnoreStart
   */
  protected $custom_link;

  /**
   * The language manager.
   *
   * @var \Drupal\language\ConfigurableLanguageManagerInterface
   *
   * @codingStandardsIgnoreEnd
   */
  protected $languageManager;

  /**
   * The alias manager service.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * The HTTP client to fetch the feed data with.
   *
   * @var \Drupal\Core\Http\ClientFactory
   */
  protected $httpClientFactory;

  /**
   * The xmlsitemap link storage handler.
   *
   * @var \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface
   */
  protected $linkStorage;

  /**
   * Constructs a new XmlSitemapCustomEditForm object.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager service.
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   The path alias manager service.
   * @param \Drupal\Core\Http\ClientFactory $http_client_factory
   *   A Guzzle client object.
   * @param \Drupal\xmlsitemap\XmlSitemapLinkStorageInterface $link_storage
   *   The xmlsitemap link storage service.
   */
  public function __construct(LanguageManagerInterface $language_manager, AliasManagerInterface $alias_manager, ClientFactory $http_client_factory, XmlSitemapLinkStorageInterface $link_storage) {
    $this->languageManager = $language_manager;
    $this->aliasManager = $alias_manager;
    $this->httpClientFactory = $http_client_factory;
    $this->linkStorage = $link_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('language_manager'), $container
      ->get('path_alias.manager'), $container
      ->get('http_client_factory'), $container
      ->get('xmlsitemap.link_storage'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'xmlsitemap_custom_edit';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $link = '') {
    if (!($custom_link = $this->linkStorage
      ->load('custom', $link))) {
      $this
        ->messenger()
        ->addError($this
        ->t('No valid custom link specified.'));
      $this
        ->redirect('xmlsitemap_custom.list');
    }
    else {
      $this->custom_link = $custom_link;
    }
    $form['type'] = [
      '#type' => 'value',
      '#value' => 'custom',
    ];
    $form['subtype'] = [
      '#type' => 'value',
      '#value' => '',
    ];
    $form['id'] = [
      '#type' => 'value',
      '#value' => $this->custom_link['id'],
    ];
    $form['loc'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path to link'),
      '#field_prefix' => rtrim(Url::fromRoute('<front>', [], [
        'absolute' => TRUE,
      ])
        ->toString(), '/'),
      '#default_value' => $this->custom_link['loc'],
      '#description' => $this
        ->t('Use a relative path with a slash in front. For example, "/about".'),
      '#required' => TRUE,
      '#size' => 30,
    ];
    $form['priority'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Priority'),
      '#options' => xmlsitemap_get_priority_options(),
      '#default_value' => number_format($this->custom_link['priority'], 1),
      '#description' => $this
        ->t('The priority of this URL relative to other URLs on your site.'),
    ];
    $form['changefreq'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Change frequency'),
      '#options' => [
        0 => $this
          ->t('None'),
      ] + xmlsitemap_get_changefreq_options(),
      '#default_value' => $this->custom_link['changefreq'],
      '#description' => $this
        ->t('How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page.'),
    ];
    $form['language'] = [
      '#type' => 'language_select',
      '#title' => $this
        ->t('Language'),
      '#languages' => LanguageInterface::STATE_ALL,
      '#default_value' => $this->custom_link['language'],
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#weight' => 5,
      '#button_type' => 'primary',
    ];
    $form['actions']['cancel'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Cancel'),
      '#url' => Url::fromRoute('xmlsitemap_custom.list'),
      '#weight' => 10,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $link = $form_state
      ->getValues();
    if (strpos($link['loc'], '/') !== 0) {
      $form_state
        ->setErrorByName('loc', $this
        ->t('The path should start with /.'));
      return;
    }

    // Make sure we trim and normalize the path first.
    $link['loc'] = trim($link['loc']);
    $link['loc'] = $this->aliasManager
      ->getPathByAlias($link['loc'], $link['language']);
    $form_state
      ->setValue('loc', $link['loc']);
    try {
      $client = $this->httpClientFactory
        ->fromOptions([
        'config/curl',
        [
          CURLOPT_FOLLOWLOCATION => FALSE,
        ],
      ]);
      $client
        ->get(Url::fromUserInput($link['loc'], [
        'absolute' => TRUE,
      ])
        ->toString());
    } catch (\Exception $e) {
      $form_state
        ->setErrorByName('loc', $this
        ->t('The custom link @link is either invalid or it cannot be accessed by anonymous users.', [
        '@link' => $link['loc'],
      ]));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->cleanValues();
    $link = $form_state
      ->getValues();
    $this->linkStorage
      ->save($link);
    $this
      ->messenger()
      ->addStatus($this
      ->t('The custom link for %loc was saved.', [
      '%loc' => $link['loc'],
    ]));
    $form_state
      ->setRedirect('xmlsitemap_custom.list');
  }

}

Members

Namesort descending 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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
XmlSitemapCustomEditForm::$aliasManager protected property The alias manager service.
XmlSitemapCustomEditForm::$custom_link protected property The path of the custom link.
XmlSitemapCustomEditForm::$httpClientFactory protected property The HTTP client to fetch the feed data with.
XmlSitemapCustomEditForm::$languageManager protected property The language manager.
XmlSitemapCustomEditForm::$linkStorage protected property The xmlsitemap link storage handler.
XmlSitemapCustomEditForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
XmlSitemapCustomEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
XmlSitemapCustomEditForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XmlSitemapCustomEditForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
XmlSitemapCustomEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
XmlSitemapCustomEditForm::__construct public function Constructs a new XmlSitemapCustomEditForm object.