You are here

Home » API reference » Site Banner 8 » SiteBannerConfigurationForm.php

class SiteBannerConfigurationForm in Site Banner 8

Same name and namespace in other branches
  1. 2.0.x src/Form/SiteBannerConfigurationForm.php \Drupal\site_banner\Form\SiteBannerConfigurationForm
  2. 1.0.x src/Form/SiteBannerConfigurationForm.php \Drupal\site_banner\Form\SiteBannerConfigurationForm

Class SiteBannerConfigurationForm.

Hierarchy

Expanded class hierarchy of SiteBannerConfigurationForm

1 string reference to 'SiteBannerConfigurationForm'
site_banner.routing.yml in ./site_banner.routing.yml
site_banner.routing.yml

File

src/Form/SiteBannerConfigurationForm.php, line 16

Namespace

Drupal\site_banner\Form
View source 
class SiteBannerConfigurationForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('site_banner.settings');
    $startDate = NULL;
    $endDate = NULL;
    if ($config
      ->get('site_banner_start_date')) {
      $startDate = new DrupalDateTime($config
        ->get('site_banner_start_date'));
    }
    if ($config
      ->get('site_banner_end_date')) {
      $endDate = new DrupalDateTime($config
        ->get('site_banner_end_date'));
    }
    $form['status'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Status'),
      '#description' => $this
        ->t('Enable/disable banner. (If set this value to disabled then the date fields will be cleared)'),
      '#default_value' => $config
        ->get('status'),
    ];
    $form['show_header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Header banner'),
      '#description' => $this
        ->t('Enable/disable banner in the header region'),
      '#default_value' => $config
        ->get('show_header'),
    ];
    $form['show_footer'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Footer banner'),
      '#description' => $this
        ->t('Enable/disable banner in the footer region'),
      '#default_value' => $config
        ->get('show_footer'),
    ];
    $form['site_banner_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Site banner text'),
      '#description' => $this
        ->t('This Text will be display on the top of the page'),
      '#default_value' => $config
        ->get('site_banner_text'),
    ];
    $form['site_banner_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Site banner hex color'),
      '#description' => $this
        ->t('This color will be used as background color (e.g #FFFFFF)'),
      '#default_value' => $config
        ->get('site_banner_color'),
    ];
    $form['site_banner_start_date'] = [
      '#type' => 'datetime',
      '#title' => $this
        ->t('Show banner at specific date'),
      '#description' => $this
        ->t('Show banner at a specific date'),
      '#default_value' => $startDate,
    ];
    $form['site_banner_end_date'] = [
      '#type' => 'datetime',
      '#title' => $this
        ->t('Hide banner at specific date'),
      '#description' => $this
        ->t('Hide banner at specific date (leave empty if you want to display it permanent)'),
      '#default_value' => $endDate,
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $config = $this->configFactory
      ->getEditable('site_banner.settings');
    $config
      ->set('site_banner_text', $form_state
      ->getValue('site_banner_text'));
    $config
      ->set('status', $form_state
      ->getValue('status'));
    $config
      ->set('show_footer', $form_state
      ->getValue('show_footer'));
    $config
      ->set('show_header', $form_state
      ->getValue('show_header'));
    $config
      ->set('site_banner_color', $form_state
      ->getValue('site_banner_color'));
    if (!$form_state
      ->getValue('status')) {
      $config
        ->set('site_banner_start_date', NULL);
      $config
        ->set('site_banner_end_date', NULL);
      $config
        ->save();
      return;
    }
    if ($form_state
      ->getValue('site_banner_start_date')) {
      $config
        ->set('site_banner_start_date', $form_state
        ->getValue('site_banner_start_date')
        ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT));
    }
    if ($form_state
      ->getValue('site_banner_end_date')) {
      $config
        ->set('site_banner_end_date', $form_state
        ->getValue('site_banner_end_date')
        ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT));
    }
    $config
      ->save();
  }

}

Members

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