class ColorboxSettingsForm in Colorbox 8

General configuration form for controlling the colorbox behaviour..

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\colorbox\Form\ColorboxSettingsForm

1 string reference to 'ColorboxSettingsForm'

colorbox.routing.yml in ./colorbox.routing.yml

colorbox.routing.yml

File

src/Form/ColorboxSettingsForm.php, line 15

Namespace

Drupal\colorbox\Form

class ColorboxSettingsForm extends ConfigFormBase {

  /**
   * The list of available modules.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList
   */
  protected $extensionListModule;

  /**
   * A state that represents the custom settings being enabled.
   */
  const STATE_CUSTOM_SETTINGS = 0;

  /**
   * A state that represents the slideshow being enabled.
   */
  const STATE_SLIDESHOW_ENABLED = 1;

  /**
   * Drupal\Core\Extension\ModuleHandlerInterface definition.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  private $moduleHandler;

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The Configuration Factory.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler service.
   * @param \Drupal\Core\Extension\ModuleExtensionList $extension_list_module
   *   The list of available modules.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler, ModuleExtensionList $extension_list_module) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
    $this->extensionListModule = $extension_list_module;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'), $container
      ->get('extension.list.module'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $module_path = $this->extensionListModule
      ->getPath('colorbox');
    $img_folder_path = $base_url . '/' . $module_path . '/images/admin';
    $config = $this->configFactory
      ->get('colorbox.settings');
    $form['colorbox_custom_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Styles and options'),
      '#open' => TRUE,
    ];
    $colorbox_styles = [
      'default' => $this
        ->t('Default'),
      'plain' => $this
        ->t('Plain (mainly for images)'),
      'stockholmsyndrome' => $this
        ->t('Stockholm Syndrome'),
      'example1' => $this
        ->t('Example 1'),
      'example2' => $this
        ->t('Example 2'),
      'example3' => $this
        ->t('Example 3'),
      'example4' => $this
        ->t('Example 4'),
      'example5' => $this
        ->t('Example 5'),
      'none' => $this
        ->t('None'),
    ];
    $form['colorbox_custom_settings']['colorbox_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Style'),
      '#options' => $colorbox_styles,
      '#default_value' => $config
        ->get('custom.style'),
      '#description' => $this
        ->t('Select the style to use for the Colorbox. The example styles are the ones that come with the Colorbox plugin. Select "None" if you have added Colorbox styles to your theme.  <br> <strong>Examples</strong>: <ul><li><a href="@img_folder_path/example_default.png" target="blank">Default</a></li><li><a href="@img_folder_path/example_plain.png" target="blank">Plain</a></li><li><a href="@img_folder_path/example_stockholm_syndrome.png" target="blank">Stockholm Syndrome</a></li><li><a href="@img_folder_path/colorbox_example_1.png" target="blank">Example 1</a></li><li><a href="@img_folder_path/colorbox_example_2.png" target="blank">Example 2</a></li><li><a href="@img_folder_path/colorbox_example_3.png" target="blank">Example 3</a></li><li><a href="@img_folder_path/colorbox_example_4.png" target="blank">Example 4</a></li><li><a href="@img_folder_path/example_none.png" target="blank">None</a></li></ul>', [
        '@img_folder_path' => $img_folder_path,
      ]),
    ];
    $form['colorbox_custom_settings']['colorbox_custom_settings_activate'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Options'),
      '#options' => [
        0 => $this
          ->t('Default'),
        1 => $this
          ->t('Custom'),
      ],
      '#default_value' => $config
        ->get('custom.activate'),
      '#description' => $this
        ->t('Use the default or custom options for Colorbox.'),
    ];
    $form['colorbox_custom_settings']['colorbox_transition_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Transition type'),
      '#options' => [
        'elastic' => $this
          ->t('Elastic'),
        'fade' => $this
          ->t('Fade'),
        'none' => $this
          ->t('None'),
      ],
      '#default_value' => $config
        ->get('custom.transition_type'),
      '#description' => $this
        ->t('The transition type.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_transition_speed'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Transition speed'),
      '#options' => $this
        ->optionsRange(100, 600, 50),
      '#default_value' => $config
        ->get('custom.transition_speed'),
      '#description' => $this
        ->t('Sets the speed of the fade and elastic transitions, in milliseconds.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_opacity'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Opacity'),
      '#options' => $this
        ->optionsRange(0, 1, 0.05),
      '#default_value' => $config
        ->get('custom.opacity'),
      '#description' => $this
        ->t('The overlay opacity level. Range: 0 to 1.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_text_current'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Current'),
      '#default_value' => $config
        ->get('custom.text_current'),
      '#size' => 30,
      '#description' => $this
        ->t('Text format for the content group / gallery count. {current} and {total} are detected and replaced with actual numbers while Colorbox runs.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_text_previous'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Previous'),
      '#default_value' => $config
        ->get('custom.text_previous'),
      '#size' => 30,
      '#description' => $this
        ->t('Text for the previous button in a shared relation group.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_text_next'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next'),
      '#default_value' => $config
        ->get('custom.text_next'),
      '#size' => 30,
      '#description' => $this
        ->t('Text for the next button in a shared relation group.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_text_close'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Close'),
      '#default_value' => $config
        ->get('custom.text_close'),
      '#size' => 30,
      '#description' => $this
        ->t('Text for the close button. The "Esc" key will also close Colorbox.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_maxwidth'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Max width'),
      '#default_value' => $config
        ->get('custom.maxwidth'),
      '#size' => 30,
      '#description' => $this
        ->t('Set a maximum width for loaded content. Example: "100%", 500, "500px".'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_maxheight'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Max height'),
      '#default_value' => $config
        ->get('custom.maxheight'),
      '#size' => 30,
      '#description' => $this
        ->t('Set a maximum height for loaded content. Example: "100%", 500, "500px".'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_initialwidth'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Initial width'),
      '#default_value' => $config
        ->get('custom.initialwidth'),
      '#size' => 30,
      '#description' => $this
        ->t('Set the initial width, prior to any content being loaded. Example: "100%", 500, "500px".'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_initialheight'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Initial height'),
      '#default_value' => $config
        ->get('custom.initialheight'),
      '#size' => 30,
      '#description' => $this
        ->t('Set the initial height, prior to any content being loaded. Example: "100%", 500, "500px".'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_overlayclose'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Overlay close'),
      '#default_value' => $config
        ->get('custom.overlayclose'),
      '#description' => $this
        ->t('Enable closing Colorbox by clicking on the background overlay.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_returnfocus'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Return focus'),
      '#default_value' => $config
        ->get('custom.returnfocus'),
      '#description' => $this
        ->t('Return focus when Colorbox exits to the element it was launched from.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_fixed'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fixed'),
      '#default_value' => $config
        ->get('custom.fixed'),
      '#description' => $this
        ->t("If the Colorbox should be displayed in a fixed position within the visitor's viewport or relative to the document."),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_scrolling'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Scrollbars'),
      '#default_value' => $config
        ->get('custom.scrolling'),
      '#description' => $this
        ->t('If unchecked, Colorbox will hide scrollbars for overflowing content. This could be used on conjunction with the resize method for a smoother transition if you are appending content to an already open instance of Colorbox.'),
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Slideshow settings'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#states' => $this
        ->getState(static::STATE_CUSTOM_SETTINGS),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings']['colorbox_slideshow'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Slideshow'),
      '#options' => [
        0 => $this
          ->t('Off'),
        1 => $this
          ->t('On'),
      ],
      '#default_value' => $config
        ->get('custom.slideshow.slideshow'),
      '#description' => $this
        ->t('An automatic slideshow to a content group / gallery.'),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings']['colorbox_slideshowauto'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Slideshow autostart'),
      '#default_value' => $config
        ->get('custom.slideshow.auto'),
      '#description' => $this
        ->t('If the slideshow should automatically start to play.'),
      '#states' => $this
        ->getState(static::STATE_SLIDESHOW_ENABLED),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings']['colorbox_slideshowspeed'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Slideshow speed'),
      '#options' => $this
        ->optionsRange(1000, 6000, 500),
      '#default_value' => $config
        ->get('custom.slideshow.speed'),
      '#description' => $this
        ->t('Sets the speed of the slideshow, in milliseconds.'),
      '#states' => $this
        ->getState(static::STATE_SLIDESHOW_ENABLED),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings']['colorbox_text_start'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Start slideshow'),
      '#default_value' => $config
        ->get('custom.slideshow.text_start'),
      '#size' => 30,
      '#description' => $this
        ->t('Text for the slideshow start button.'),
      '#states' => $this
        ->getState(static::STATE_SLIDESHOW_ENABLED),
    ];
    $form['colorbox_custom_settings']['colorbox_slideshow_settings']['colorbox_text_stop'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stop slideshow'),
      '#default_value' => $config
        ->get('custom.slideshow.text_stop'),
      '#size' => 30,
      '#description' => $this
        ->t('Text for the slideshow stop button.'),
      '#states' => $this
        ->getState(static::STATE_SLIDESHOW_ENABLED),
    ];
    $form['colorbox_advanced_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced settings'),
    ];
    $form['colorbox_advanced_settings']['colorbox_unique_token'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Unique per-request gallery token'),
      '#options' => [
        1 => $this
          ->t('On'),
        0 => $this
          ->t('Off'),
      ],
      '#default_value' => $config
        ->get('advanced.unique_token'),
      '#description' => $this
        ->t('If On (default), Colorbox will add a unique per-request token to the gallery id to avoid images being added manually to galleries. The token was added as a security fix but some see the old behavoiur as an feature and this settings makes it possible to remove the token.'),
    ];
    $form['colorbox_advanced_settings']['colorbox_mobile_detect'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Mobile detection'),
      '#options' => [
        1 => $this
          ->t('On'),
        0 => $this
          ->t('Off'),
      ],
      '#default_value' => $config
        ->get('advanced.mobile_detect'),
      '#description' => $this
        ->t('If on (default) Colorbox will not be active for devices with the max width set below.'),
    ];
    $form['colorbox_advanced_settings']['colorbox_mobile_device_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Device width'),
      '#default_value' => $config
        ->get('advanced.mobile_device_width'),
      '#size' => 30,
      '#description' => $this
        ->t('Set the mobile device max width. Default: 480px.'),
      '#states' => [
        'visible' => [
          ':input[name="colorbox_mobile_detect"]' => [
            'value' => '1',
          ],
        ],
      ],
    ];
    $form['colorbox_advanced_settings']['colorbox_caption_trim'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Caption shortening'),
      '#options' => [
        0 => $this
          ->t('Default'),
        1 => $this
          ->t('Yes'),
      ],
      '#default_value' => $config
        ->get('advanced.caption_trim'),
      '#description' => $this
        ->t('If the caption should be made shorter in the Colorbox to avoid layout problems. The default is to shorten for the example styles, they need it, but not for other styles.'),
    ];
    $form['colorbox_advanced_settings']['colorbox_caption_trim_length'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Caption max length'),
      '#options' => $this
        ->optionsRange(40, 120, 5),
      '#default_value' => $config
        ->get('advanced.caption_trim_length'),
      '#states' => [
        'visible' => [
          ':input[name="colorbox_caption_trim"]' => [
            'value' => '1',
          ],
        ],
      ],
    ];
    $form['colorbox_advanced_settings']['colorbox_compression_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Choose Colorbox compression level'),
      '#options' => [
        'minified' => $this
          ->t('Production (Minified)'),
        'source' => $this
          ->t('Development (Uncompressed Code)'),
      ],
      '#default_value' => $config
        ->get('advanced.compression_type'),
    ];
    if (!$this->moduleHandler
      ->moduleExists('colorbox_load') || !$this->moduleHandler
      ->moduleExists('colorbox_inline')) {
      $form['colorbox_extras'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Extras'),
      ];
      $form['colorbox_extras']['colorbox_additional_tips'] = [
        '#markup' => $this
          ->t('You can find new features in the <a href="@url_colorbox_load" target="blank">Colorbox Load</a> and <a href="@url_colorbox_inline" target="blank">Colorbox Inline</a>', [
          '@url_colorbox_load' => 'https://www.drupal.org/project/colorbox_load',
          '@url_colorbox_inline' => 'https://www.drupal.org/project/colorbox_inline',
        ]),
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->getEditable('colorbox.settings');
    $config
      ->set('custom.style', $form_state
      ->getValue('colorbox_style'))
      ->set('custom.activate', $form_state
      ->getValue('colorbox_custom_settings_activate'))
      ->set('custom.transition_type', $form_state
      ->getValue('colorbox_transition_type'))
      ->set('custom.transition_speed', $form_state
      ->getValue('colorbox_transition_speed'))
      ->set('custom.opacity', $form_state
      ->getValue('colorbox_opacity'))
      ->set('custom.text_current', $form_state
      ->getValue('colorbox_text_current'))
      ->set('custom.text_previous', $form_state
      ->getValue('colorbox_text_previous'))
      ->set('custom.text_next', $form_state
      ->getValue('colorbox_text_next'))
      ->set('custom.text_close', $form_state
      ->getValue('colorbox_text_close'))
      ->set('custom.overlayclose', $form_state
      ->getValue('colorbox_overlayclose'))
      ->set('custom.returnfocus', $form_state
      ->getValue('colorbox_returnfocus'))
      ->set('custom.maxwidth', $form_state
      ->getValue('colorbox_maxwidth'))
      ->set('custom.maxheight', $form_state
      ->getValue('colorbox_maxheight'))
      ->set('custom.initialwidth', $form_state
      ->getValue('colorbox_initialwidth'))
      ->set('custom.initialheight', $form_state
      ->getValue('colorbox_initialheight'))
      ->set('custom.fixed', $form_state
      ->getValue('colorbox_fixed'))
      ->set('custom.scrolling', $form_state
      ->getValue('colorbox_scrolling'))
      ->set('custom.slideshow.slideshow', $form_state
      ->getValue('colorbox_slideshow'))
      ->set('custom.slideshow.auto', $form_state
      ->getValue('colorbox_slideshowauto'))
      ->set('custom.slideshow.speed', $form_state
      ->getValue('colorbox_slideshowspeed'))
      ->set('custom.slideshow.text_start', $form_state
      ->getValue('colorbox_text_start'))
      ->set('custom.slideshow.text_stop', $form_state
      ->getValue('colorbox_text_stop'))
      ->set('advanced.unique_token', $form_state
      ->getValue('colorbox_unique_token'))
      ->set('advanced.mobile_detect', $form_state
      ->getValue('colorbox_mobile_detect'))
      ->set('advanced.mobile_device_width', $form_state
      ->getValue('colorbox_mobile_device_width'))
      ->set('advanced.caption_trim', $form_state
      ->getValue('colorbox_caption_trim'))
      ->set('advanced.caption_trim_length', $form_state
      ->getValue('colorbox_caption_trim_length'))
      ->set('advanced.compression_type', $form_state
      ->getValue('colorbox_compression_type'));
    if ($form_state
      ->getValue('colorbox_image_style')) {
      $config
        ->set('insert.image_style', $form_state
        ->getValue('colorbox_image_style'));
    }
    if ($form_state
      ->getValue('colorbox_insert_gallery')) {
      $config
        ->set('insert.insert_gallery', $form_state
        ->getValue('colorbox_insert_gallery'));
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Get one of the pre-defined states used in this form.
   *
   * @param string $state
   *   The state to get that matches one of the state class constants.
   *
   * @return array
   *   A corresponding form API state.
   */
  protected function getState($state) {
    $states = [
      static::STATE_CUSTOM_SETTINGS => [
        'visible' => [
          ':input[name="colorbox_custom_settings_activate"]' => [
            'value' => '1',
          ],
        ],
      ],
      static::STATE_SLIDESHOW_ENABLED => [
        'visible' => [
          ':input[name="colorbox_slideshow"]' => [
            'value' => '1',
          ],
        ],
      ],
    ];
    return $states[$state];
  }

  /**
   * Create a range for a series of options.
   *
   * @param int $start
   *   The start of the range.
   * @param int $end
   *   The end of the range.
   * @param int $step
   *   The interval between elements.
   *
   * @return array
   *   An options array for the given range.
   */
  protected function optionsRange($start, $end, $step) {
    $range = range($start, $end, $step);
    return array_combine($range, $range);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ColorboxSettingsForm::$extensionListModule	protected	property	The list of available modules.
ColorboxSettingsForm::$moduleHandler	private	property	Drupal\Core\Extension\ModuleHandlerInterface definition.
ColorboxSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ColorboxSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ColorboxSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ColorboxSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ColorboxSettingsForm::getState	protected	function	Get one of the pre-defined states used in this form.
ColorboxSettingsForm::optionsRange	protected	function	Create a range for a series of options.
ColorboxSettingsForm::STATE_CUSTOM_SETTINGS		constant	A state that represents the custom settings being enabled.
ColorboxSettingsForm::STATE_SLIDESHOW_ENABLED		constant	A state that represents the slideshow being enabled.
ColorboxSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ColorboxSettingsForm::__construct	public	function	Class constructor. Overrides ConfigFormBase::__construct
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.
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.