class PopupOnLoadSettingsForm in Popup On Load 8

Class PopupOnLoadSettingsForm.

@package Drupal\popup_onload\Form

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\popup_onload\Form\PopupOnLoadSettingsForm

Expanded class hierarchy of PopupOnLoadSettingsForm

1 file declares its use of PopupOnLoadSettingsForm

popup_onload.module in ./popup_onload.module: Contains main popup_onload hooks and functions.

File

src/Form/PopupOnLoadSettingsForm.php, line 15

Namespace

Drupal\popup_onload\Form

View source

class PopupOnLoadSettingsForm extends ConfigFormBase {

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'popup_onload_settings';
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->config('popup_onload.settings')
      ->set(POPUP_ONLOAD_VAR_SORT_METHOD, $form_state
      ->getValue(POPUP_ONLOAD_VAR_SORT_METHOD))
      ->set(POPUP_ONLOAD_VAR_COOKIE_NAME, $form_state
      ->getValue(POPUP_ONLOAD_VAR_COOKIE_NAME))
      ->set(POPUP_ONLOAD_VAR_COOKIE_LIFETIME, $form_state
      ->getValue(POPUP_ONLOAD_VAR_COOKIE_LIFETIME))
      ->set(POPUP_ONLOAD_VAR_DISPLAY_DELAY, $form_state
      ->getValue(POPUP_ONLOAD_VAR_DISPLAY_DELAY))
      ->set(POPUP_ONLOAD_VAR_INCLUDE_PATHS, $form_state
      ->getValue(POPUP_ONLOAD_VAR_INCLUDE_PATHS))
      ->save();
  }

  /**
   * Defines the settings form for Popup On Load entities.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   Form definition array.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);

    // Create the list of all sorting methods to be used in the form.
    $methods = popup_onload_sort_methods();
    $form['sort_methods'] = array(
      '#type' => 'fieldset',
      '#title' => t('Popup sort methods'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
      '#description' => t('How to determine the popup, displayed to the user.'),
    );
    $form['sort_methods'][POPUP_ONLOAD_VAR_SORT_METHOD] = array(
      '#type' => 'radios',
      '#options' => $methods,
      '#default_value' => $this
        ->popupOnLoadGetDefaults(POPUP_ONLOAD_VAR_SORT_METHOD, POPUP_ONLOAD_DEFAULT_SORT_METHOD),
    );
    $form['misc'] = array(
      '#type' => 'fieldset',
      '#title' => t('Miscellaneous'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
      '#description' => t('Misc settings.'),
    );
    $form['misc'][POPUP_ONLOAD_VAR_COOKIE_NAME] = array(
      '#type' => 'textfield',
      '#title' => t('Popup cookie name'),
      '#description' => t('Override this only if your server configuration filters out cookies with certain pattern.'),
      '#default_value' => $this
        ->popupOnLoadGetDefaults(POPUP_ONLOAD_VAR_COOKIE_NAME, POPUP_ONLOAD_DEFAULT_COOKIE_NAME),
    );
    $form['misc'][POPUP_ONLOAD_VAR_COOKIE_LIFETIME] = array(
      '#type' => 'number',
      '#title' => t('Popup cookie lifetime'),
      '#description' => t('How many seconds popups will not be displayed to the user after the first display.'),
      '#default_value' => $this
        ->popupOnLoadGetDefaults(POPUP_ONLOAD_VAR_COOKIE_LIFETIME, POPUP_ONLOAD_DEFAULT_COOKIE_LIFETIME),
    );
    $form['misc'][POPUP_ONLOAD_VAR_DISPLAY_DELAY] = array(
      '#type' => 'number',
      '#title' => t('Popup display delay'),
      '#description' => t('Delay in milliseconds before the popup is displayed to the user.'),
      '#default_value' => $this
        ->popupOnLoadGetDefaults(POPUP_ONLOAD_VAR_DISPLAY_DELAY, POPUP_ONLOAD_DEFAULT_DELAY),
    );
    return $form;
  }

  /**
   * Configs getter with default value.
   */
  public static function popupOnLoadGetDefaults($key, $default) {
    $configs = \Drupal::config('popup_onload.settings');
    $config = $configs
      ->get($key);
    return isset($config) ? $config : $default;
  }

}

Members

Name	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.
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.
PopupOnLoadSettingsForm::buildForm	public	function	Defines the settings form for Popup On Load entities. Overrides ConfigFormBase::buildForm
PopupOnLoadSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PopupOnLoadSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PopupOnLoadSettingsForm::popupOnLoadGetDefaults	public static	function	Configs getter with default value.
PopupOnLoadSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class PopupOnLoadSettingsForm in Popup On Load 8

Hierarchy

File

Namespace

Members

API Navigation