You are here

Home » API reference » AP Style Date 8 » DateAPStyleSettings.php

class DateAPStyleSettings in AP Style Date 8

Configuration for the default AP Style Date settings.

Hierarchy

Expanded class hierarchy of DateAPStyleSettings

1 string reference to 'DateAPStyleSettings'
date_ap_style.routing.yml in ./date_ap_style.routing.yml
date_ap_style.routing.yml

File

src/Form/DateAPStyleSettings.php, line 11

Namespace

Drupal\date_ap_style\Form
View source 
class DateAPStyleSettings extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('date_ap_style.dateapstylesettings');
    $form['date_ap_style_settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('AP Style Date Display Settings'),
      '#description' => $this
        ->t('Configure AP date style default settings when using the AP date style format.'),
    ];
    $form['date_ap_style_settings']['always_display_year'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always display year'),
      '#description' => $this
        ->t('When unchecked, the year will not be displayed if the date is in the same year as the current date.'),
      '#default_value' => $config
        ->get('always_display_year'),
    ];
    $form['date_ap_style_settings']['use_today'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use today'),
      '#default_value' => $config
        ->get('use_today'),
    ];
    $form['date_ap_style_settings']['cap_today'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Capitalize today'),
      '#default_value' => $config
        ->get('cap_today'),
    ];
    $form['date_ap_style_settings']['display_day'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display day of the week'),
      '#default_value' => $config
        ->get('display_day'),
      '#description' => $this
        ->t('Display the day of the week when the date is in the same week as the current date. (Not available for date range fields.)'),
    ];
    $form['date_ap_style_settings']['display_time'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display time'),
      '#default_value' => $config
        ->get('display_time'),
    ];
    $form['date_ap_style_settings']['time_before_date'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display time before date'),
      '#description' => $this
        ->t('When checked, the time will be displayed before the date. Otherwise it will be displayed after the date.'),
      '#default_value' => $config
        ->get('time_before_date'),
      '#states' => [
        'visible' => [
          ':input[name="display_time"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['date_ap_style_settings']['use_all_day'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show "All Day" instead of midnight'),
      '#default_value' => $config
        ->get('display_noon_and_midnight'),
      '#states' => [
        'visible' => [
          ':input[name="display_time"]' => [
            'checked' => TRUE,
          ],
        ],
        'unchecked' => [
          ':input[name="display_noon_and_midnight"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['date_ap_style_settings']['display_noon_and_midnight'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display noon and midnight'),
      '#description' => $this
        ->t('Converts 12:00 p.m. to "noon" and 12:00 a.m. to "midnight."'),
      '#default_value' => $config
        ->get('display_noon_and_midnight'),
      '#states' => [
        'visible' => [
          ':input[name="display_time"]' => [
            'checked' => TRUE,
          ],
        ],
        'unchecked' => [
          ':input[name="use_all_day"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['date_ap_style_settings']['capitalize_noon_and_midnight'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Capitalize noon and midnight'),
      '#default_value' => $config
        ->get('capitalize_noon_and_midnight'),
      '#states' => [
        'visible' => [
          ':input[name="display_time"]' => [
            'checked' => TRUE,
          ],
          ':input[name="display_noon_and_midnight"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['date_ap_style_settings']['separator'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Date range separator'),
      '#options' => [
        'endash' => $this
          ->t('En dash'),
        'to' => $this
          ->t('to'),
      ],
      '#default_value' => $config
        ->get('separator'),
    ];
    $form['date_ap_style_settings']['timezone'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Time zone'),
      '#options' => [
        '' => $this
          ->t('- Default site/user time zone -'),
      ] + system_time_zones(FALSE),
      '#size' => 1,
      '#default_value' => $config
        ->get('timezone'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('date_ap_style.dateapstylesettings')
      ->set('date_ap_style_settings', $form_state
      ->getValue('date_ap_style_settings'))
      ->set('always_display_year', $form_state
      ->getValue('always_display_year'))
      ->set('use_today', $form_state
      ->getValue('use_today'))
      ->set('cap_today', $form_state
      ->getValue('cap_today'))
      ->set('display_day', $form_state
      ->getValue('display_day'))
      ->set('display_time', $form_state
      ->getValue('display_time'))
      ->set('time_before_date', $form_state
      ->getValue('time_before_date'))
      ->set('use_all_day', $form_state
      ->getValue('use_all_day'))
      ->set('display_noon_and_midnight', $form_state
      ->getValue('display_noon_and_midnight'))
      ->set('capitalize_noon_and_midnight', $form_state
      ->getValue('capitalize_noon_and_midnight'))
      ->set('timezone', $form_state
      ->getValue('timezone'))
      ->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.
DateAPStyleSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
DateAPStyleSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DateAPStyleSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DateAPStyleSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.