You are here

Home » API reference » Back To Top 8 » BackToTopSettingsForm.php

class BackToTopSettingsForm in Back To Top 8

Same name and namespace in other branches
  1. 2.x src/Form/BackToTopSettingsForm.php \Drupal\back_to_top\Form\BackToTopSettingsForm

Administration settings form.

Hierarchy

Expanded class hierarchy of BackToTopSettingsForm

1 string reference to 'BackToTopSettingsForm'
back_to_top.routing.yml in ./back_to_top.routing.yml
back_to_top.routing.yml

File

src/Form/BackToTopSettingsForm.php, line 11

Namespace

Drupal\back_to_top\Form
View source 
class BackToTopSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'back_to_top_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('back_to_top.settings');
    $settings = $config
      ->get();

    // Include Farbtastic color picker library and other necessary resources.
    $form['#attached']['library'][] = 'core/jquery.farbtastic';
    $form['#attached']['library'][] = 'back_to_top/back_to_top';
    $form['back_to_top_prevent_on_mobile'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prevent on mobile and touch devices'),
      '#description' => $this
        ->t('Do you want to prevent Back To Top on touch devices?'),
      '#default_value' => $settings['back_to_top_prevent_on_mobile'],
    ];
    $form['back_to_top_prevent_in_admin'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prevent on administration pages and node edit'),
      '#description' => $this
        ->t('Do you want to prevent Back To Top on admin pages?'),
      '#default_value' => $settings['back_to_top_prevent_in_admin'],
    ];
    $form['back_to_top_prevent_in_front'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Prevent on front page'),
      '#description' => $this
        ->t('Do you want to prevent Back To Top on front page?'),
      '#default_value' => $settings['back_to_top_prevent_in_front'],
    ];
    $form['back_to_top_button_trigger'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Trigger'),
      '#description' => $this
        ->t('Set the number of pixel which trigger the Back To Top button default 100'),
      '#default_value' => $settings['back_to_top_button_trigger'],
      '#size' => 10,
      '#maxlength' => 4,
    ];
    $form['back_to_top_button_place'] = [
      '#title' => $this
        ->t('Placement'),
      '#description' => $this
        ->t('Where should the Back To Top button appear?'),
      '#type' => 'select',
      '#options' => [
        1 => $this
          ->t('Bottom right'),
        2 => $this
          ->t('Bottom left'),
        3 => $this
          ->t('Botton center'),
        4 => $this
          ->t('Top right'),
        5 => $this
          ->t('Top left'),
        6 => $this
          ->t('Top center'),
        7 => $this
          ->t('Mid right'),
        8 => $this
          ->t('Mid left'),
        9 => $this
          ->t('Mid center'),
      ],
      '#default_value' => $settings['back_to_top_button_place'],
    ];
    $form['back_to_top_button_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Button text'),
      '#description' => $this
        ->t('Set the text of the Back To Top button'),
      '#default_value' => $settings['back_to_top_button_text'],
      '#size' => 30,
      '#maxlength' => 30,
    ];
    $form['back_to_top_button_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Do you want Back To Top to use a PNG-24 image or a Text/Css button?'),
      '#options' => [
        'image' => $this
          ->t('Image (default)'),
        'text' => $this
          ->t('Text/Css'),
      ],
      '#default_value' => $settings['back_to_top_button_type'],
    ];

    // Wrap Text/Css button settings in a fieldset.
    $form['text_button'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Text/Css button settings'),
      '#collapsible' => TRUE,
      '#collapsed' => $form['back_to_top_button_type']['#default_value'] == 'image' ? TRUE : FALSE,
    ];
    $form['text_button']['back_to_top_bg_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Background color'),
      '#description' => $this
        ->t('Button background color default #F7F7F7'),
      '#default_value' => $settings['back_to_top_bg_color'],
      '#size' => 10,
      '#maxlength' => 7,
      '#suffix' => '<div class="color-field" id="back_to_top_bg_color"></div>',
    ];
    $form['text_button']['back_to_top_border_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Border color'),
      '#description' => $this
        ->t('Border color default #CCCCCC'),
      '#default_value' => $settings['back_to_top_border_color'],
      '#size' => 10,
      '#maxlength' => 7,
      '#suffix' => '<div class="color-field" id="back_to_top_border_color"></div>',
    ];
    $form['text_button']['back_to_top_hover_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Hover color'),
      '#description' => $this
        ->t('Hover color default #EEEEEE'),
      '#default_value' => $settings['back_to_top_hover_color'],
      '#size' => 10,
      '#maxlength' => 7,
      '#suffix' => '<div class="color-field" id="back_to_top_hover_color"></div>',
    ];
    $form['text_button']['back_to_top_text_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Text color'),
      '#description' => $this
        ->t('Text color default #333333'),
      '#default_value' => $settings['back_to_top_text_color'],
      '#size' => 10,
      '#maxlength' => 7,
      '#suffix' => '<div class="color-field" id="back_to_top_text_color"></div>',
    ];
    return parent::buildForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->getEditable('back_to_top.settings');
    $form_values = $form_state
      ->getValues();
    $config
      ->set('back_to_top_prevent_on_mobile', $form_values['back_to_top_prevent_on_mobile'])
      ->set('back_to_top_prevent_in_admin', $form_values['back_to_top_prevent_in_admin'])
      ->set('back_to_top_prevent_in_front', $form_values['back_to_top_prevent_in_front'])
      ->set('back_to_top_button_trigger', $form_values['back_to_top_button_trigger'])
      ->set('back_to_top_button_place', $form_values['back_to_top_button_place'])
      ->set('back_to_top_button_text', $form_values['back_to_top_button_text'])
      ->set('back_to_top_button_type', $form_values['back_to_top_button_type'])
      ->set('back_to_top_bg_color', $form_values['back_to_top_bg_color'])
      ->set('back_to_top_border_color', $form_values['back_to_top_border_color'])
      ->set('back_to_top_hover_color', $form_values['back_to_top_hover_color'])
      ->set('back_to_top_text_color', $form_values['back_to_top_text_color'])
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BackToTopSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
BackToTopSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BackToTopSettingsForm::getFormID public function
BackToTopSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
BackToTopSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.
FormInterface::getFormId public function Returns a unique string identifying the form. 236
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.