class ConfigForm in Insert 8

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\insert\Form\ConfigForm

1 string reference to 'ConfigForm'

insert.routing.yml in ./insert.routing.yml

insert.routing.yml

File

src/Form/ConfigForm.php, line 10

Namespace

Drupal\insert\Form

class ConfigForm extends ConfigFormBase {

  /**
   * @inheritdoc
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
  }

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

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

  /**
   * @inheritdoc
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('insert.config');
    $text_formats = array_map(function ($format) {

      /** @var FilterFormat $format */
      return $format
        ->label();
    }, filter_formats());
    $form['text_formats'] = [
      '#type' => 'checkboxes',
      '#options' => $text_formats,
      '#title' => $this
        ->t('Automatic text format support'),
      '#description' => $this
        ->t('Drupal core\'s HTML filter removes tags and attributes not explicitly white-listed from the output. This might strip tags and attributes generated by the Insert module. Enabling automatic text format support alters allowed HTML tags of the HTML filter when saving a text format configuration. Since managing the tags and attributes is prone to errors, enabling text format support here will ensure that required tags and attributes are always set. <strong>Note: After enabling text format support, you need to save the corresponding text format(s) at least once for the necessary tags to be added. When disabling support of a text format tags and attributes added to the format are not removed, they just do not get added automatically anymore when saving the text format(s).</strong>'),
      '#default_value' => $config
        ->get('text_formats') ? $config
        ->get('text_formats') : [],
    ];
    $form['css_classes'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Additional CSS classes'),
      '#description' => $this
        ->t('CSS classes to be added to items inserted using the Insert module.'),
    ];
    $form['css_classes']['file'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Classes to be added to file links (File Insert widget)'),
      '#default_value' => $config
        ->get('css_classes.file') ? $config
        ->get('css_classes.file') : '',
      '#element_validate' => [
        [
          get_called_class(),
          'validate_css_classes',
        ],
      ],
    ];
    $form['css_classes']['image'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Classes to be added to images and image links (Image Insert widget)'),
      '#default_value' => $config
        ->get('css_classes.image') ? $config
        ->get('css_classes.image') : '',
      '#element_validate' => [
        [
          get_called_class(),
          'validate_css_classes',
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * @inheritdoc
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('insert.config');
    $config
      ->set('text_formats', array_keys(array_filter($form_state
      ->getValue('text_formats'), function ($value) {
      return !!$value;
    })));
    $config
      ->set('css_classes.file', $form_state
      ->getValue('file'));
    $config
      ->set('css_classes.image', $form_state
      ->getValue('image'));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * @param array $element
   * @param FormStateInterface $form_state
   * @param array $form
   */
  public static function validate_css_classes($element, &$form_state) {

    // Sanitize white-space.
    $segments = preg_split('/\\s+/', trim($element['#value']));
    $form_state
      ->setValueForElement($element, join(' ', $segments));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigForm::buildForm	public	function	@inheritdoc Overrides ConfigFormBase::buildForm
ConfigForm::getEditableConfigNames	protected	function	@inheritdoc Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId	public	function	@inheritdoc Overrides FormInterface::getFormId
ConfigForm::submitForm	public	function	@inheritdoc Overrides ConfigFormBase::submitForm
ConfigForm::validate_css_classes	public static	function
ConfigForm::__construct	public	function	@inheritdoc Overrides ConfigFormBase::__construct
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
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.