class StickynavSettingsForm in Sticky Navigation 8

Build Sticky Navigation 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\stickynav\Form\StickynavSettingsForm

Expanded class hierarchy of StickynavSettingsForm

1 string reference to 'StickynavSettingsForm'

stickynav.routing.yml in ./stickynav.routing.yml: stickynav.routing.yml

File

src/Form/StickynavSettingsForm.php, line 13

Namespace

Drupal\stickynav\Form

View source

class StickynavSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'stickynav.settings.' . $this
        ->getRequest()->attributes
        ->get('theme'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $theme = '') {
    $config = $this
      ->config('stickynav.settings.' . $theme);
    $form['enabled'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => $config
        ->get('enabled') ? $config
        ->get('enabled') : FALSE,
    );
    $states = array(
      'visible' => array(
        ':input[name="enabled"]' => array(
          'checked' => TRUE,
        ),
      ),
      'invisible' => array(
        ':input[name="enabled"]' => array(
          'checked' => FALSE,
        ),
      ),
    );

    // Selector is only visible when you activate sticky nav for the theme.
    $form['selector'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Selector'),
      '#description' => $this
        ->t('Place your selector for your menu that will be sticky on your theme. Use jquery format.'),
      '#default_value' => $config
        ->get('selector') ? $config
        ->get('selector') : '',
      '#states' => $states,
    );
    $form['offset'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Offset Selector'),
      '#description' => $this
        ->t('Element to use as an offset. For multiple elements on the page separate them with a comma. Use jquery format.'),
      '#default_value' => $config
        ->get('offset') ? $config
        ->get('offset') : '',
      '#states' => $states,
    );
    $form['custom_offset'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom offset'),
      '#description' => $this
        ->t('Custom offset in pixels. This will be added to the elements offsets if they are set.'),
      '#default_value' => $config
        ->get('custom_offset') ? $config
        ->get('custom_offset') : '',
      '#states' => $states,
    );
    $role_options = array();
    $roles = user_roles();
    foreach ($roles as $role) {
      $role_options[$role
        ->id()] = $role
        ->label();
    }
    $form['roles'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Excluded Roles'),
      '#description' => $this
        ->t("Exclude specific roles from using sticky navigation."),
      '#options' => $role_options,
      '#default_value' => $config
        ->get('roles') ? $config
        ->get('roles') : array(),
      '#states' => $states,
    );
    $form['theme'] = [
      '#type' => 'value',
      '#value' => $theme,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $theme = $form_state
      ->getValue('theme');
    $config = $this
      ->config('stickynav.settings.' . $theme);
    $config
      ->set('enabled', $form_state
      ->getValue('enabled'))
      ->set('selector', $form_state
      ->getValue('selector'))
      ->set('offset', $form_state
      ->getValue('offset'))
      ->set('custom_offset', $form_state
      ->getValue('custom_offset'))
      ->set('roles', array_keys(array_filter($form_state
      ->getValue('roles'))))
      ->save();
    $form_state
      ->setRedirect('stickynav.set_admin');
    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.
StickynavSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
StickynavSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StickynavSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
StickynavSettingsForm::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 StickynavSettingsForm in Sticky Navigation 8

Hierarchy

File

Namespace

Members

API Navigation