SchedulerAdminForm.php in Scheduler 8

Namespace

Drupal\scheduler\Form

File

src/Form/SchedulerAdminForm.php

<?php

namespace Drupal\scheduler\Form;

use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Main administration form for the Scheduler module.
 */
class SchedulerAdminForm extends ConfigFormBase {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance
      ->setDateFormatter($container
      ->get('date.formatter'));
    return $instance;
  }

  /**
   * Sets the date formatter.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   */
  protected function setDateFormatter(DateFormatterInterface $date_formatter) {
    $this->dateFormatter = $date_formatter;
  }

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

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

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

    // Options for setting date-only with default time.
    $form['date_only_fieldset'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Date only'),
      '#collapsible' => FALSE,
    ];
    $form['date_only_fieldset']['allow_date_only'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to enter only a date and provide a default time.'),
      '#default_value' => $this
        ->setting('allow_date_only'),
      '#description' => $this
        ->t('When only a date is entered the time will default to a specified value, but the user can change this if required.'),
    ];
    $form['date_only_fieldset']['default_time'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default time'),
      '#default_value' => $this
        ->setting('default_time'),
      '#size' => 20,
      '#maxlength' => 8,
      '#description' => $this
        ->t('Provide a default time in @format format that will be used if the user does not enter a value.', [
        '@format' => $this
          ->setting('hide_seconds') ? 'HH:MM' : 'HH:MM:SS',
      ]),
      '#states' => [
        'visible' => [
          ':input[name="allow_date_only"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Options for configuring the time input field.
    $form['time_fieldset'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Time settings'),
      '#collapsible' => FALSE,
    ];
    $form['time_fieldset']['hide_seconds'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide the seconds.'),
      '#default_value' => $this
        ->setting('hide_seconds'),
      '#description' => $this
        ->t('When entering a time, only show hours and minutes in the input field.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $hide_seconds = $form_state
      ->getValue([
      'hide_seconds',
    ]);

    // If date-only is enabled then check if a valid default time was entered.
    // Leading zeros and seconds can be omitted, eg. 6:30 is considered valid.
    if ($form_state
      ->getValue([
      'allow_date_only',
    ])) {
      $default_time = date_parse($form_state
        ->getValue([
        'default_time',
      ]));
      if ($default_time['error_count'] || strlen($form_state
        ->getValue([
        'default_time',
      ])) < 3) {
        $form_state
          ->setErrorByName('default_time', $this
          ->t('The default time should be in the format @format', [
          '@format' => $hide_seconds ? 'HH:MM' : 'HH:MM:SS',
        ]));
      }
      else {

        // Insert any possibly omitted leading zeroes. If hiding the seconds
        // then ignore any entered seconds and save in H:i format.
        $unix_time = mktime($default_time['hour'], $default_time['minute'], $hide_seconds ? 0 : $default_time['second']);
        $form_state
          ->setValue([
          'default_time',
        ], $this->dateFormatter
          ->format($unix_time, 'custom', $hide_seconds ? 'H:i' : 'H:i:s'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('scheduler.settings')
      ->set('allow_date_only', $form_state
      ->getValue([
      'allow_date_only',
    ]))
      ->set('default_time', $form_state
      ->getValue('default_time'))
      ->set('hide_seconds', $form_state
      ->getValue('hide_seconds'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Helper method to access the settings of this module.
   *
   * @param string $key
   *   The key of the configuration.
   *
   * @return \Drupal\Core\Config\ImmutableConfig
   *   The value of the config setting equested.
   */
  protected function setting($key) {
    return $this->configFactory
      ->get('scheduler.settings')
      ->get($key);
  }

}

Classes

Name	Description
SchedulerAdminForm	Main administration form for the Scheduler module.