class StickyConfigurationForm in Sticky 8

Same name and namespace in other branches

2.0.x src/Form/StickyConfigurationForm.php \Drupal\sticky\Form\StickyConfigurationForm

This class creates the Sticky configuration form.

@package Drupal\sticky\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\sticky\Form\StickyConfigurationForm

Expanded class hierarchy of StickyConfigurationForm

1 string reference to 'StickyConfigurationForm'

sticky.routing.yml in ./sticky.routing.yml: sticky.routing.yml

File

src/Form/StickyConfigurationForm.php, line 13

Namespace

Drupal\sticky\Form

View source

class StickyConfigurationForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('sticky.settings');
    $form['active_on'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Active on'),
    ];
    $form['active_on']['selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('DOM Selector'),
      '#default_value' => $config
        ->get('selector') ? $config
        ->get('selector') : '.menu--main',
      '#description' => $this
        ->t('The selector that defines the element should become Sticky. For example .menu--main, .header-wrapper or #footer'),
    ];
    $form['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Javascript settings'),
    ];
    $form['settings']['top_spacing'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Top spacing'),
      '#default_value' => $config
        ->get('top_spacing') ? $config
        ->get('top_spacing') : 0,
      '#description' => $this
        ->t("Pixels between the page top and the element's top."),
    ];
    $form['settings']['bottom_spacing'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Bottom spacing'),
      '#default_value' => $config
        ->get('bottom_spacing') ? $config
        ->get('bottom_spacing') : 0,
      '#description' => $this
        ->t("Pixels between the page bottom and the element's bottom."),
    ];
    $form['settings']['class_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Class name'),
      '#default_value' => $config
        ->get('class_name') ? $config
        ->get('class_name') : 'is-sticky',
      '#description' => $this
        ->t("CSS class added to the element's wrapper when 'sticked'."),
    ];
    $form['settings']['wrapper_class_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Wrapper class name'),
      '#default_value' => $config
        ->get('wrapper_class_name') ? $config
        ->get('wrapper_class_name') : 'sticky-wrapper',
      '#description' => $this
        ->t('CSS class added to the wrapper.'),
    ];
    $form['settings']['center'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Center'),
      '#default_value' => $config
        ->get('center') ? $config
        ->get('center') : FALSE,
      '#description' => $this
        ->t('Boolean determining whether the sticky element should be horizontally centered in the page.'),
    ];
    $form['settings']['get_width_from'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Get width from'),
      '#default_value' => $config
        ->get('get_width_from') ? $config
        ->get('get_width_from') : '',
      '#description' => $this
        ->t('Selector of element referenced to set fixed width of "sticky" element.'),
    ];
    $form['settings']['width_from_wrapper'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Width from wrapper'),
      '#default_value' => $config
        ->get('width_from_wrapper') ? $config
        ->get('width_from_wrapper') : TRUE,
      '#description' => $this
        ->t("Boolean determining whether width of the 'sticky' element should be updated to match the wrapper's width. Wrapper is a placeholder for 'sticky' element while it is fixed (out of static elements flow), and its width depends on the context and CSS rules. Works only as long getWidthForm isn't set."),
    ];
    $form['settings']['responsive_width'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Responsive width'),
      '#default_value' => $config
        ->get('responsive_width') ? $config
        ->get('responsive_width') : FALSE,
      '#description' => $this
        ->t('Boolean determining whether widths will be recalculated on window resize (using getWidthfrom).'),
    ];
    $form['settings']['z_index'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Z-index'),
      '#default_value' => $config
        ->get('z_index') ? $config
        ->get('z_index') : 'auto',
      '#description' => $this
        ->t('Controls z-index of the sticked element.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('sticky.settings')
      ->set('selector', $values['selector'])
      ->set('top_spacing', $values['top_spacing'])
      ->set('bottom_spacing', $values['bottom_spacing'])
      ->set('class_name', $values['class_name'])
      ->set('wrapper_class_name', $values['wrapper_class_name'])
      ->set('center', $values['center'])
      ->set('get_width_from', $values['get_width_from'])
      ->set('width_from_wrapper', $values['width_from_wrapper'])
      ->set('responsive_width', $values['responsive_width'])
      ->set('z_index', $values['z_index'])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
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.
StickyConfigurationForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
StickyConfigurationForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StickyConfigurationForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
StickyConfigurationForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 StickyConfigurationForm in Sticky 8

Hierarchy

File

Namespace

Members

API Navigation