class NgLightboxSettingsForm in NG Lightbox 8

Same name and namespace in other branches

2.x src/Form/NgLightboxSettingsForm.php \Drupal\ng_lightbox\Form\NgLightboxSettingsForm

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\ng_lightbox\Form\NgLightboxSettingsForm

Expanded class hierarchy of NgLightboxSettingsForm

1 string reference to 'NgLightboxSettingsForm'

ng_lightbox.routing.yml in ./ng_lightbox.routing.yml: ng_lightbox.routing.yml

File

src/Form/NgLightboxSettingsForm.php, line 12

Namespace

Drupal\ng_lightbox\Form

View source

class NgLightboxSettingsForm extends ConfigFormBase {

  /**
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * An array of Lightbox renderers.
   *
   * @var array
   */
  protected $renderers = [];

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory, array $lightbox_renderers) {
    parent::__construct($config_factory);
    $this->renderers = $lightbox_renderers;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->config = $this
      ->configFactory()
      ->getEditable('ng_lightbox.settings');
    $form['container']['patterns'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Paths'),
      '#default_value' => $this->config
        ->get('patterns'),
      '#description' => $this
        ->t('New line separated paths that must start with a leading slash. Wildcard character is *. E.g. /comment/*/reply.'),
    ];
    $form['container']['default_width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default Width'),
      '#default_value' => $this->config
        ->get('default_width'),
      '#description' => $this
        ->t('The default width for modals opened with NG Lightbox.'),
    ];
    $form['container']['lightbox_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Lightbox Class'),
      '#default_value' => $this->config
        ->get('lightbox_class'),
      '#description' => $this
        ->t('The css custom class for modals opened with NG Lightbox.'),
    ];
    $form['container']['skip_admin_paths'] = [
      '#title' => $this
        ->t('Skip all admin paths'),
      '#type' => 'checkbox',
      '#default_value' => $this->config
        ->get('skip_admin_paths'),
      '#description' => $this
        ->t('This will exclude all admin paths from the lightbox. If you want some paths, see hook_ng_lightbox_ajax_path_alter().'),
    ];
    $form['container']['renderer'] = [
      '#title' => $this
        ->t('Renderer'),
      '#type' => 'select',
      '#default_value' => $this->config
        ->get('renderer') ?: NgLightbox::DEFAULT_MODAL,
      '#description' => $this
        ->t('Select which renderer should be used for the lightbox.'),
      '#options' => $this->renderers,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this->config
      ->set('patterns', $values['patterns'])
      ->set('default_width', $values['default_width'])
      ->set('lightbox_class', $values['lightbox_class'])
      ->set('skip_admin_paths', $values['skip_admin_paths'])
      ->set('renderer', $values['renderer'])
      ->save();
  }

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
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.
NgLightboxSettingsForm::$config	protected	property
NgLightboxSettingsForm::$renderers	protected	property	An array of Lightbox renderers.
NgLightboxSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
NgLightboxSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
NgLightboxSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NgLightboxSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
NgLightboxSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
NgLightboxSettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 NgLightboxSettingsForm in NG Lightbox 8

Hierarchy

File

Namespace

Members

API Navigation