class SchedulerAdminForm in Scheduler 8

Same name and namespace in other branches

2.x src/Form/SchedulerAdminForm.php \Drupal\scheduler\Form\SchedulerAdminForm

Main administration form for the Scheduler module.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\scheduler\Form\SchedulerAdminForm

Expanded class hierarchy of SchedulerAdminForm

1 string reference to 'SchedulerAdminForm'

scheduler.routing.yml in ./scheduler.routing.yml: scheduler.routing.yml

File

src/Form/SchedulerAdminForm.php, line 13

Namespace

Drupal\scheduler\Form

View source

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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
SchedulerAdminForm::$dateFormatter	protected	property	The date formatter service.
SchedulerAdminForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SchedulerAdminForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SchedulerAdminForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SchedulerAdminForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SchedulerAdminForm::setDateFormatter	protected	function	Sets the date formatter.
SchedulerAdminForm::setting	protected	function	Helper method to access the settings of this module.
SchedulerAdminForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SchedulerAdminForm::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.

You are here

class SchedulerAdminForm in Scheduler 8

Hierarchy

File

Namespace

Members

API Navigation