class Lightbox2SlideshowSettingsForm in Lightbox2 8

Same name in this branch

8 src/Lightbox2SlideshowSettingsForm.php \Drupal\lightbox2\Lightbox2SlideshowSettingsForm
8 src/Form/Lightbox2SlideshowSettingsForm.php \Drupal\lightbox2\Form\Lightbox2SlideshowSettingsForm

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\lightbox2\Form\Lightbox2SlideshowSettingsForm

Expanded class hierarchy of Lightbox2SlideshowSettingsForm

1 string reference to 'Lightbox2SlideshowSettingsForm'

lightbox2.routing.yml in ./lightbox2.routing.yml: lightbox2.routing.yml

File

src/Form/Lightbox2SlideshowSettingsForm.php, line 14: Contains \Drupal\lightbox2\Form\Lightbox2SlideshowSettingsForm.

Namespace

Drupal\lightbox2\Form

View source

class Lightbox2SlideshowSettingsForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('lightbox2.settings');
    foreach (Element::children($form) as $variable) {
      $config
        ->set($variable, $form_state
        ->getValue($form[$variable]['#parents']));
    }
    $config
      ->save();
    if (method_exists($this, '_submitForm')) {
      $this
        ->_submitForm($form, $form_state);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'lightbox2.settings',
    ];
  }
  public function buildForm(array $form, \Drupal\Core\Form\FormStateInterface $form_state) {

    // Add the javascript which disables / enables form elements.
    drupal_add_js(drupal_get_path('module', 'lightbox2') . '/js/lightbox2.js', 'module');

    // Set up a hidden variable.
    $form['lightbox2_lite'] = [
      '#type' => 'hidden',
      '#value' => variable_get('lightbox2_lite', FALSE),
    ];

    // Add text box for slideshow interval.
    $form['lightbox2_slideshow_interval'] = [
      '#type' => 'textfield',
      '#title' => t('Interval seconds'),
      '#description' => t('The slideshow interval is the length of time in seconds an image is visible before the slideshow shows the next image.'),
      '#default_value' => variable_get('lightbox2_slideshow_interval', 5),
      '#size' => 20,
    ];

    // Add checkbox for slideshow automatic start.
    $form['lightbox2_slideshow_automatic_start'] = [
      '#type' => 'checkbox',
      '#title' => t('Automatically start slideshow'),
      '#description' => t('When enabled the slideshow will automatically start.'),
      '#default_value' => variable_get('lightbox2_slideshow_automatic_start', TRUE),
    ];

    // Add checkbox for slideshow automatic exit.
    $form['lightbox2_slideshow_automatic_exit'] = [
      '#type' => 'checkbox',
      '#title' => t('Automatically exit slideshow'),
      '#description' => t('When enabled the lightbox will automatically close after displaying the last image.'),
      '#default_value' => variable_get('lightbox2_slideshow_automatic_exit', TRUE),
    ];

    // Add checkbox for showing hte play / pause button.
    $form['lightbox2_slideshow_show_play_pause'] = [
      '#type' => 'checkbox',
      '#title' => t('Show play / pause button'),
      '#description' => t('When enabled, a play / pause button will be shown in the slideshow allowing the user more control over their viewing experience.'),
      '#default_value' => variable_get('lightbox2_slideshow_show_play_pause', TRUE),
    ];

    // Add checkbox for "pausing on next click".
    $form['lightbox2_slideshow_pause_on_next_click'] = [
      '#type' => 'checkbox',
      '#title' => t('Pause slideshow on "Next Image" click'),
      '#description' => t('When enabled the slideshow is automatically paused, and the following image shown, when the "Next" button is clicked.'),
      '#default_value' => variable_get('lightbox2_slideshow_pause_on_next_click', FALSE),
    ];

    // Add checkbox for "pausing on prev click".
    $form['lightbox2_slideshow_pause_on_previous_click'] = [
      '#type' => 'checkbox',
      '#title' => t('Pause slideshow on "Previous Image" click'),
      '#description' => t('When enabled the slideshow is automatically paused, and the previous image shown, when the "Previous" button is clicked.'),
      '#default_value' => variable_get('lightbox2_slideshow_pause_on_previous_click', TRUE),
    ];

    // Add checkbox for "looping through slides'.
    $form['lightbox2_loop_slides'] = [
      '#type' => 'checkbox',
      '#title' => t('Continuous loop'),
      '#description' => t('When enabled the slideshow will automatically start over after displaying the last slide.  This prevents the slideshow from automatically exiting when enabled.'),
      '#default_value' => variable_get('lightbox2_loop_slides', FALSE),
    ];
    return parent::buildForm($form, $form_state);
  }
  public function validateForm(array &$form, \Drupal\Core\Form\FormStateInterface $form_state) {
    if (!is_numeric($form_state
      ->getValue([
      'lightbox2_slideshow_interval',
    ]))) {
      $form_state
        ->setErrorByName('lightbox2_slideshow_interval', t('The "interval seconds" value must be numeric.'));
    }
  }

}

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

Hierarchy

File

Namespace

Members

API Navigation