class CloseBlockSettingsForm in Close Block 8

Provides a module settings 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\closeblock\Form\CloseBlockSettingsForm

Expanded class hierarchy of CloseBlockSettingsForm

1 string reference to 'CloseBlockSettingsForm'

closeblock.routing.yml in ./closeblock.routing.yml: closeblock.routing.yml

File

src/Form/CloseBlockSettingsForm.php, line 12

Namespace

Drupal\closeblock\Form

View source

class CloseBlockSettingsForm extends ConfigFormBase {

  /**
   * Configuration Factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactory $configFactory
   *   Configuration Factory.
   */
  public function __construct(ConfigFactory $configFactory) {
    parent::__construct($configFactory);
    $this->configFactory = $configFactory;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('closeblock.settings');
    $form['closeblock'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Closeblock selectors'),
      '#weight' => 0,
      '#attributes' => [
        'id' => 'close_block_form',
      ],
    ];
    $form['closeblock']['close_block_button_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Button text'),
      '#default_value' => $config
        ->get('close_block_button_text'),
      '#description' => $this
        ->t('Button text for block'),
    ];
    $form['closeblock']['close_block_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Block close behavior'),
      '#options' => [
        'fadeOut' => $this
          ->t('Fade Out'),
        'slideUp' => $this
          ->t('Slide Up'),
        'none' => $this
          ->t('None'),
      ],
      '#description' => $this
        ->t('The animation type for hiding block.'),
      '#default_value' => $config
        ->get('close_block_type'),
    ];
    $form['closeblock']['close_block_speed'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Animation speed'),
      '#description' => $this
        ->t('The animation speed in milliseconds.'),
      '#default_value' => $config
        ->get('close_block_speed'),
    ];
    $form['closeblock']['reset_cookie_time'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Reset Cookie Value'),
      '#description' => $this
        ->t('How long cooke is valid (in days).'),
      '#default_value' => $config
        ->get('reset_cookie_time'),
    ];
    $form['closeblock']['resetCookie'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Reset Cookie'),
      '#description' => $this
        ->t('Reset cookie to visible block'),
      '#id' => 'closeblock-clear-cookie-button',
    ];
    $form['#attached']['library'][] = 'closeblock/closeblock';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('close_block_speed') < 0) {
      $form_state
        ->setErrorByName('close_block_speed', $this
        ->t('Animation speed can not be negative.'));
    }
    elseif ($form_state
      ->getValue('close_block_speed') > 5000) {
      $form_state
        ->setErrorByName('close_block_speed', $this
        ->t('Animation speed can not be more that 5000'));
    }
    if ($form_state
      ->getValue('reset_cookie_time') < 0) {
      $form_state
        ->setErrorByName('reset_cookie_time', $this
        ->t('Reset Cookie Value cannot be negative.'));
    }
    elseif ($form_state
      ->getValue('reset_cookie_time') > 2030) {
      $form_state
        ->setErrorByName('reset_cookie_time', $this
        ->t('Reset Cookie Value cannot be more that 2030'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $factory = $this->configFactory
      ->getEditable('closeblock.settings');
    $factory
      ->set('close_block_type', $form_state
      ->getValue('close_block_type'));
    $factory
      ->set('close_block_speed', $form_state
      ->getValue('close_block_speed'));
    $factory
      ->set('reset_cookie_time', $form_state
      ->getValue('reset_cookie_time'));
    $factory
      ->set('close_block_button_text', $form_state
      ->getValue('close_block_button_text'));
    $factory
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CloseBlockSettingsForm::$configFactory	protected	property	Configuration Factory. Overrides FormBase::$configFactory
CloseBlockSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
CloseBlockSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
CloseBlockSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CloseBlockSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
CloseBlockSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
CloseBlockSettingsForm::__construct	public	function	Constructor. Overrides ConfigFormBase::__construct
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
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::$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.
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 CloseBlockSettingsForm in Close Block 8

Hierarchy

File

Namespace

Members

API Navigation