You are here

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

class XmlSitemapEntitiesSettingsForm in XML sitemap 8

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

Configure what entities will be included in sitemap.

Hierarchy

Expanded class hierarchy of XmlSitemapEntitiesSettingsForm

1 string reference to 'XmlSitemapEntitiesSettingsForm'
xmlsitemap.routing.yml in ./xmlsitemap.routing.yml
xmlsitemap.routing.yml

File

src/Form/XmlSitemapEntitiesSettingsForm.php, line 18

Namespace

Drupal\xmlsitemap\Form
View source 
class XmlSitemapEntitiesSettingsForm extends ConfigFormBase {

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

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

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

  /**
   * Constructs a XmlSitemapEntitiesSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info.
   * @param \Drupal\Core\State\StateInterface $state
   *   The object State.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, StateInterface $state) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->state = $state;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);

    // Create the list of possible entity types.

    /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
    $entity_types = array_filter($this->entityTypeManager
      ->getDefinitions(), 'xmlsitemap_is_entity_type_supported');

    // Create the list of options as well as the default values based on which
    // entity types have enabled configuration already.
    $labels = array_map(function (EntityTypeInterface $entityType) {
      return $entityType
        ->getLabel();
    }, $entity_types);
    asort($labels);
    $defaults = array_keys(array_filter(array_map(function (EntityTypeInterface $entityType) {
      return xmlsitemap_link_entity_check_enabled($entityType
        ->id());
    }, $entity_types)));
    $form['entity_types'] = [
      '#title' => $this
        ->t('Custom sitemap entities settings'),
      '#type' => 'checkboxes',
      '#options' => $labels,
      '#default_value' => $defaults,
    ];
    $form['settings'] = [
      '#tree' => TRUE,
    ];
    foreach ($labels as $entity_type_id => $label) {
      $entity_type = $entity_types[$entity_type_id];
      $bundle_label = $entity_type
        ->getBundleLabel() ?: $label;
      $bundles = $this->entityTypeBundleInfo
        ->getBundleInfo($entity_type_id);
      $form['settings'][$entity_type_id] = [
        '#type' => 'container',
        '#entity_type' => $entity_type_id,
        '#bundle_label' => $bundle_label,
        '#title' => $bundle_label,
        '#states' => [
          'visible' => [
            ':input[name="entity_types[' . $entity_type_id . ']"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
        'types' => [
          '#type' => 'table',
          '#tableselect' => TRUE,
          '#default_value' => [],
          '#header' => [
            [
              'data' => $bundle_label,
              'class' => [
                'bundle',
              ],
            ],
            [
              'data' => $this
                ->t('Sitemap settings'),
              'class' => [
                'operations',
              ],
            ],
          ],
        ],
        '#access' => !empty($bundles),
      ];
      foreach ($bundles as $bundle => $bundle_info) {
        $form['settings'][$entity_type_id][$bundle]['settings'] = [
          '#type' => 'item',
          '#label' => $bundle_info['label'],
        ];
        $form['settings'][$entity_type_id]['types'][$bundle] = [
          'bundle' => [
            '#markup' => $bundle_info['label'],
          ],
          'operations' => [
            '#type' => 'operations',
            '#links' => [
              'configure' => [
                'title' => $this
                  ->t('Configure'),
                'url' => Url::fromRoute('xmlsitemap.admin_settings_bundle', [
                  'entity' => $entity_type_id,
                  'bundle' => $bundle,
                ]),
                'query' => $this
                  ->getDestinationArray(),
              ],
            ],
          ],
        ];
        $form['settings'][$entity_type_id]['types']['#default_value'][$bundle] = xmlsitemap_link_bundle_check_enabled($entity_type_id, $bundle);
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $bundles = $this->entityTypeBundleInfo
      ->getAllBundleInfo();
    $values = $form_state
      ->getValues();
    $entity_values = $values['entity_types'];
    foreach ($entity_values as $key => $value) {
      if ($value) {
        foreach ($bundles[$key] as $bundle_key => $bundle_value) {
          if (!$values['settings'][$key]['types'][$bundle_key]) {
            xmlsitemap_link_bundle_delete($key, $bundle_key, TRUE);
          }
          elseif (!xmlsitemap_link_bundle_check_enabled($key, $bundle_key)) {
            xmlsitemap_link_bundle_enable($key, $bundle_key);
          }
        }
      }
      else {
        foreach ($bundles[$key] as $bundle_key => $bundle_value) {
          xmlsitemap_link_bundle_delete($key, $bundle_key, TRUE);
        }
      }
    }
    $this->state
      ->set('xmlsitemap_regenerate_needed', TRUE);
    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.
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.
XmlSitemapEntitiesSettingsForm::$entityTypeBundleInfo protected property The entity type bundle info.
XmlSitemapEntitiesSettingsForm::$entityTypeManager protected property The entity type manager.
XmlSitemapEntitiesSettingsForm::$state protected property The state.
XmlSitemapEntitiesSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
XmlSitemapEntitiesSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
XmlSitemapEntitiesSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
XmlSitemapEntitiesSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
XmlSitemapEntitiesSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
XmlSitemapEntitiesSettingsForm::__construct public function Constructs a XmlSitemapEntitiesSettingsForm object. Overrides ConfigFormBase::__construct