You are here

Home » API reference » Simple XML sitemap 8.3 » SimplesitemapEnginesForm.php

class SimplesitemapEnginesForm in Simple XML sitemap 8.3

Same name and namespace in other branches
  1. 4.x modules/simple_sitemap_engines/src/Form/SimplesitemapEnginesForm.php \Drupal\simple_sitemap_engines\Form\SimplesitemapEnginesForm

Form for managing search engine submission settings.

Hierarchy

Expanded class hierarchy of SimplesitemapEnginesForm

1 string reference to 'SimplesitemapEnginesForm'
simple_sitemap_engines.routing.yml in modules/simple_sitemap_engines/simple_sitemap_engines.routing.yml
modules/simple_sitemap_engines/simple_sitemap_engines.routing.yml

File

modules/simple_sitemap_engines/src/Form/SimplesitemapEnginesForm.php, line 17

Namespace

Drupal\simple_sitemap_engines\Form
View source 
class SimplesitemapEnginesForm extends ConfigFormBase {

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The sitemap manager service.
   *
   * @var \Drupal\simple_sitemap\SimplesitemapManager
   */
  protected $sitemapManager;

  /**
   * SimplesitemapEnginesForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   *   The date formatter service.
   * @param \Drupal\simple_sitemap\SimplesitemapManager $sitemap_manager
   *   The sitemap manager service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, DateFormatter $date_formatter, SimplesitemapManager $sitemap_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->dateFormatter = $date_formatter;
    $this->sitemapManager = $sitemap_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('date.formatter'), $container
      ->get('simple_sitemap.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'simple_sitemap_engines.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simple_sitemap_engines.settings');
    $form['#tree'] = TRUE;
    $form['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('General submission settings'),
      '#prefix' => FormHelper::getDonationText(),
    ];
    $form['settings']['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Submit the sitemap to search engines'),
      '#description' => $this
        ->t('This enables/disables sitemap submitting; don\'t forget to choose variants below.'),
      '#default_value' => $config
        ->get('enabled'),
    ];
    $form['settings']['submission_interval'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Submission interval'),
      '#options' => FormHelper::getCronIntervalOptions(),
      '#default_value' => $config
        ->get('submission_interval'),
      '#states' => [
        'visible' => [
          ':input[name="settings[enabled]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['engines'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Variant specific settings'),
      '#markup' => '<div class="description">' . $this
        ->t('Choose which sitemap variants are to be submitted to which search engines.<br>Variants can be configured <a href="@url">here</a>.', [
        '@url' => $GLOBALS['base_url'] . '/admin/config/search/simplesitemap/variants',
      ]) . '</div>',
    ];
    $engines = $this->entityTypeManager
      ->getStorage('simple_sitemap_engine')
      ->loadMultiple();
    foreach ($engines as $engine_id => $engine) {
      $form['engines'][$engine_id] = [
        '#type' => 'details',
        '#title' => $engine
          ->label(),
        '#open' => !empty($engine->sitemap_variants) || count($engines) === 1,
      ];
      $form['engines'][$engine_id]['variants'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Sitemap variants'),
        '#options' => array_map(function ($variant) {
          return $this
            ->t($variant['label']);
        }, $this->sitemapManager
          ->getSitemapVariants(NULL, FALSE)),
        '#default_value' => $engine->sitemap_variants,
        '#multiple' => TRUE,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ($this->entityTypeManager
      ->getStorage('simple_sitemap_engine')
      ->loadMultiple() as $engine_id => $engine) {
      if (!empty($values = $form_state
        ->getValue([
        'engines',
        $engine_id,
        'variants',
      ]))) {
        $submit = TRUE;
      }
      $engine->sitemap_variants = $values;
      $engine
        ->save();
    }
    $config = $this
      ->config('simple_sitemap_engines.settings');
    $enabled = (bool) $form_state
      ->getValue([
      'settings',
      'enabled',
    ]);
    $config
      ->set('enabled', $enabled);
    $config
      ->set('submission_interval', $form_state
      ->getValue([
      'settings',
      'submission_interval',
    ]));
    $config
      ->save();
    if ($enabled && empty($submit)) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('No sitemap variants have been selected for submission.'));
    }
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
SimplesitemapEnginesForm::$dateFormatter protected property The date formatter service.
SimplesitemapEnginesForm::$entityTypeManager protected property The entity type manager service.
SimplesitemapEnginesForm::$sitemapManager protected property The sitemap manager service.
SimplesitemapEnginesForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimplesitemapEnginesForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SimplesitemapEnginesForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimplesitemapEnginesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimplesitemapEnginesForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SimplesitemapEnginesForm::__construct public function SimplesitemapEnginesForm constructor. Overrides ConfigFormBase::__construct
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.