class IntervalsForm in Subscriptions 2.0.x

Defines the intervals settings form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\subscriptions\Form\IntervalsForm

1 string reference to 'IntervalsForm'

subscriptions.routing.yml in ./subscriptions.routing.yml

subscriptions.routing.yml

File

src/Form/IntervalsForm.php, line 11

Namespace

Drupal\subscriptions\Form

class IntervalsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('subscriptions.settings');
    $form['intervals'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Intervals'),
      '#description' => $this
        ->t('Each interval is defined by a single line in the format
        <em>seconds|label</em>. Adding a new interval is simple, but removing an
        interval that is already in use is not recommended.'),
      '#placeholder' => "1|As soon as possible\n900|Every 15 minutes",
      '#default_value' => $config
        ->get('intervals'),
      '#element_validate' => [
        [
          $this,
          'validateIntervals',
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Element validation callback.
   */
  public function validateIntervals($element, FormStateInterface $form_state, $form) {

    // Get the form value.
    $intervals = explode("\n", $form_state
      ->cleanValues()
      ->getValue('intervals', ''));
    $intervals = array_filter($intervals);

    // Regex for matching seconds|label values.
    $pattern = '/^([0-9]+)\\|(.+)$/';
    $errors = [];

    // Check each line individually.
    foreach ($intervals as &$interval) {

      // Trim whitespace off of each line.
      $interval = trim($interval);
      if (empty($interval)) {
        continue;
      }
      $match = preg_match($pattern, $interval);

      // If the line did not match the regex, add it as an error.
      if ($match != TRUE) {
        $errors[] = $interval;
      }
    }

    // If any errors built up, set an error message.
    if (!empty($errors)) {
      $error_message = $this
        ->formatPlural(count($errors), 'Invalid format: @interval', 'Invalid formats: @interval', [
        '@interval' => implode(', ', $errors),
      ]);
      $form_state
        ->setError($element, $error_message);
    }

    // Clean up the final value and set it back in the form state.
    $intervals = array_values(array_filter($intervals));
    $form_state
      ->setValueForElement($element, implode("\n", $intervals));
  }

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

    // Set values from the form.
    $form_state
      ->cleanValues();
    $config = $this
      ->config('subscriptions.settings');
    $config
      ->set('intervals', $form_state
      ->getValue('intervals', []));
    $config
      ->save();
  }

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

}

Members

Name	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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
IntervalsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
IntervalsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
IntervalsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
IntervalsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
IntervalsForm::validateIntervals	public	function	Element validation callback.
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.