You are here

Home » API reference » Front Page 9.1.x » FrontPageSettingsForm.php

class FrontPageSettingsForm in Front Page 9.1.x

Same name and namespace in other branches
  1. 8 src/Form/FrontPageSettingsForm.php \Drupal\front_page\Form\FrontPageSettingsForm

Configure site information settings for this site.

Hierarchy

Expanded class hierarchy of FrontPageSettingsForm

1 string reference to 'FrontPageSettingsForm'
front_page.routing.yml in ./front_page.routing.yml
front_page.routing.yml

File

src/Form/FrontPageSettingsForm.php, line 13

Namespace

Drupal\front_page\Form
View source 
class FrontPageSettingsForm extends ConfigFormBase {

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormID() {
    return 'front_page_admin';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = \Drupal::configFactory()
      ->get('front_page.settings');
    $form['front_page_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Front Page Override'),
      '#description' => $this
        ->t('Enable this if you want the front page module to manage the home page.'),
      '#default_value' => $config
        ->get('enable') ?: false,
    ];

    // Load any existing settings and build the by redirect by role form.
    $form['roles'] = [
      '#tree' => TRUE,
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Roles'),
    ];

    // Build the form for roles.
    $roles = user_roles();

    // Iterate each role.
    foreach ($roles as $rid => $role) {
      $role_config = $config
        ->get('rid_' . $rid);
      $form['roles'][$rid] = [
        '#type' => 'details',
        '#open' => FALSE,
        '#title' => $this
          ->t('Front Page for @rolename', [
          '@rolename' => $role
            ->label(),
        ]),
      ];
      $form['roles'][$rid]['enabled'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Enable'),
        '#value' => isset($role_config['enabled']) ? $role_config['enabled'] : false,
      ];
      $form['roles'][$rid]['weigth'] = [
        '#type' => 'number',
        '#title' => $this
          ->t('Weigth'),
        '#value' => isset($role_config['weigth']) ? $role_config['weigth'] : 0,
      ];
      $form['roles'][$rid]['path'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Path'),
        '#default_value' => isset($role_config['path']) ? $role_config['path'] : '',
        '#cols' => 20,
        '#rows' => 1,
        '#description' => $this
          ->t('A redirect path can contain a full URL including get parameters and fragment string (eg "/node/51?page=5#anchor").'),
      ];
    }
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save Settings'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    //    parent::validateForm($form, $form_state);
    $rolesList = $form_state
      ->getUserInput()['roles'];
    if ($rolesList) {
      foreach ($rolesList as $rid => $role) {
        if (!empty($role['enabled']) && empty($role['path'])) {
          $form_state
            ->setErrorByName('roles][' . $rid . '][path', $this
            ->t('You must set the path field for redirect mode.'));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = \Drupal::configFactory()
      ->getEditable('front_page.settings');

    //Set if all config are enabled or not.
    $config
      ->set('enable', $form_state
      ->getValue('front_page_enable'));

    //Set config by role.
    $rolesList = $form_state
      ->getUserInput()['roles'];
    if (is_array($rolesList)) {
      foreach ($rolesList as $rid => $role) {
        $config
          ->set('rid_' . $rid, $role);
      }
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
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
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.
FormInterface::getFormId public function Returns a unique string identifying the form. 264
FrontPageSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
FrontPageSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FrontPageSettingsForm::getFormID public function Implements \Drupal\Core\Form\FormInterface::getFormID().
FrontPageSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
FrontPageSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
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.