You are here

Home » API reference » Domain Menus for Domains 9.x » DomainMenusSettingsForm.php

class DomainMenusSettingsForm in Domain Menus for Domains 9.x

Same name and namespace in other branches
  1. 3.x src/Form/DomainMenusSettingsForm.php \Drupal\domain_menus\Form\DomainMenusSettingsForm
  2. 9.1.x src/Form/DomainMenusSettingsForm.php \Drupal\domain_menus\Form\DomainMenusSettingsForm

Class DomainMenusSettingsForm.

Hierarchy

Expanded class hierarchy of DomainMenusSettingsForm

1 string reference to 'DomainMenusSettingsForm'
domain_menus.routing.yml in ./domain_menus.routing.yml
domain_menus.routing.yml

File

src/Form/DomainMenusSettingsForm.php, line 18

Namespace

Drupal\domain_menus\Form
View source 
class DomainMenusSettingsForm extends ConfigFormBase {

  /**
   * Drupal\Core\Entity\EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Drupal\Core\Messenger\MessengerInterface definition.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'domain_menus.settings';

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, MessengerInterface $messenger, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory);
    $this->messenger = $messenger;
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    $form['domain_menus_menu_names'] = [
      '#type' => 'textarea',
      '#rows' => 5,
      '#columns' => 40,
      '#title' => $this
        ->t('Domain menus'),
      '#default_value' => $config
        ->get('domain_menus_menu_names'),
      '#description' => $this
        ->t('Enter unique menu names/identifiers (less than 10 characters each, alphanumeric only), one per line.'),
    ];
    $form['domain_menus_create'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Operation: Create menus'),
      '#default_value' => 0,
      '#description' => $this
        ->t('Create domain menus (not already existent) for every domain.'),
    ];
    $form['domain_menus_delete'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Operation: Delete menus'),
      '#default_value' => 0,
      '#description' => $this
        ->t('Delete all domain menus and all links in them!'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Returns an array of settings keys.
   */
  public function settingsKeys() {
    return [
      'domain_menus_menu_names',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS);
    foreach ($this
      ->settingsKeys() as $key) {
      $config
        ->set($key, $form_state
        ->getValue($key));
    }
    $config
      ->save();
    if ($form_state
      ->getValue('domain_menus_delete')) {
      $menus = $this->entityTypeManager
        ->getStorage('menu')
        ->loadMultiple();
      foreach ($menus as $menu) {
        $menu_domains = $menu
          ->getThirdPartySetting("domain_menus", "domains");
        if ($menu_domains !== NULL) {
          $menu
            ->delete();
        }
      }
      $this->messenger
        ->addMessage($this
        ->t('Domain menu(s) deleted.'), 'status');
    }
    if ($form_state
      ->getValue('domain_menus_create')) {
      $count = 0;
      $domain_menus_menu_names = $form_state
        ->getValue('domain_menus_menu_names');
      if (!empty($domain_menus_menu_names)) {
        $menu_names = explode("\r\n", $domain_menus_menu_names);
        $domains = $this->entityTypeManager
          ->getStorage('domain')
          ->loadMultiple();
        if (!empty($domains)) {
          foreach ($domains as $domain) {
            $domain_id = $domain
              ->id();
            $domain_domainid = $domain
              ->getDomainId();
            $domain_label = Markup::create($domain
              ->label());
            foreach ($menu_names as $menu_name) {
              if (!empty($menu_name)) {
                $menu_id = trim($this
                  ->t(DOMAIN_MENUS_MENU_ID_PATTERN, [
                  '@domain_domainid' => $domain_domainid,
                  '@menu_name' => $menu_name,
                ]));
                $menu_label = trim($this
                  ->t(DOMAIN_MENUS_MENU_LABEL_PATTERN, [
                  '@domain_label' => $domain_label,
                  '@menu_name' => $menu_name,
                ]));
                if (!($menu = Menu::load($menu_id))) {
                  $menu = Menu::create(array(
                    'id' => $menu_id,
                    'label' => $menu_label,
                  ));
                  $count++;
                }
                $menu
                  ->setThirdPartySetting('domain_menus', 'domains', array(
                  $domain_id => $domain_id,
                ));
                $menu
                  ->setThirdPartySetting('domain_menus', 'auto-created', 1);
                $menu
                  ->save();
              }
            }
          }
        }
      }
      $this->messenger
        ->addMessage($this
        ->t('@count domain menu(s) created.', [
        '@count' => $count,
      ]), 'status');
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $domain_menus_menu_names = $form_state
      ->getValue('domain_menus_menu_names');
    if (!empty($domain_menus_menu_names)) {
      $menu_names = explode("\r\n", $domain_menus_menu_names);
      foreach ($menu_names as $menu_name) {
        if (strlen($menu_name) > 9 || !ctype_alnum($menu_name)) {
          $form_state
            ->setErrorByName('domain_menus_menu_names', $this
            ->t('Domain menu names must be alphanumeric and less than 10 characters each.'));
        }
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DomainMenusSettingsForm::$entityTypeManager protected property Drupal\Core\Entity\EntityTypeManagerInterface definition.
DomainMenusSettingsForm::$messenger protected property Drupal\Core\Messenger\MessengerInterface definition. Overrides MessengerTrait::$messenger
DomainMenusSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
DomainMenusSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
DomainMenusSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DomainMenusSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DomainMenusSettingsForm::SETTINGS constant Config settings.
DomainMenusSettingsForm::settingsKeys public function Returns an array of settings keys.
DomainMenusSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
DomainMenusSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
DomainMenusSettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 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.
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.