You are here

Home » API reference » Insert 8.2 » ConfigForm.php

class ConfigForm in Insert 8.2

Same name and namespace in other branches
  1. 8 src/Form/ConfigForm.php \Drupal\insert\Form\ConfigForm

Hierarchy

Expanded class hierarchy of ConfigForm

1 string reference to 'ConfigForm'
insert.routing.yml in ./insert.routing.yml
insert.routing.yml

File

src/Form/ConfigForm.php, line 12

Namespace

Drupal\insert\Form
View source 
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 \Drupal\filter\Entity\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['absolute'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use absolute paths'),
      '#description' => $this
        ->t('Includes the full URL prefix "@base_url" in all links and image tags.', [
        '@base_url' => $GLOBALS['base_url'],
      ]),
      '#default_value' => $config
        ->get('absolute') ? '1' : '0',
    ];
    $form['file_field_images_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow inserting &lt;img&gt; tags for images uploaded to generic file fields'),
      '#description' => $this
        ->t('By activating this option, image styles may be selected in the Insert settings on (generic) file field widgets. Then, such may be used to insert images uploaded to file fields, while other files still may be inserted using compatible Insert styles only.'),
      '#default_value' => $config
        ->get('file_field_images_enabled') ? '1' : '0',
    ];
    $form['widgets'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Supported widgets'),
      '#description' => $this
        ->t('Lists of field widget ids that Insert should be available to. Separate widget ids with a space or comma.'),
    ];
    $form['widgets']['widgets__' . INSERT_TYPE_FILE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('File widgets'),
      '#default_value' => join(', ', $config
        ->get('widgets.file')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $form['widgets']['widgets__' . INSERT_TYPE_IMAGE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Image widgets'),
      '#default_value' => join(', ', $config
        ->get('widgets.image')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $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. Separate classes with a space or comma.'),
    ];
    $form['css_classes'][INSERT_TYPE_FILE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Classes to be added to generic file links'),
      '#default_value' => join(' ', $config
        ->get('css_classes.file')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $form['css_classes'][INSERT_TYPE_IMAGE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Classes to be added to images and image links'),
      '#default_value' => join(' ', $config
        ->get('css_classes.image')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $form['file_extensions'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('File type detection'),
      '#description' => $this
        ->t('In order to have Insert detect particular file types (i.e. to allow embedding media files), the module needs be aware of which file extensions map to such particular file types. Be sure to enable these file extensions for upload in the file field settings as well. Separate extensions with a space or comma and do not include the leading dot.'),
    ];
    $form['file_extensions']['audio'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Audio file extensions'),
      '#default_value' => join(', ', $config
        ->get('file_extensions.audio')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $form['file_extensions']['video'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Video file extensions'),
      '#default_value' => join(', ', $config
        ->get('file_extensions.video')),
      '#element_validate' => [
        [
          get_called_class(),
          'string_to_array',
        ],
      ],
    ];
    $form += \Drupal::moduleHandler()
      ->invokeAll('insert_config_form', [
      $form,
    ]);
    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('absolute', !!$form_state
      ->getValue('absolute'));
    $config
      ->set('file_field_images_enabled', !!$form_state
      ->getValue('file_field_images_enabled'));
    $config
      ->set('widgets.' . INSERT_TYPE_FILE, $this
      ->sanitize_array($form_state
      ->getValue('widgets__' . INSERT_TYPE_FILE)));
    $config
      ->set('widgets.' . INSERT_TYPE_IMAGE, $this
      ->sanitize_array($form_state
      ->getValue('widgets__' . INSERT_TYPE_IMAGE)));
    $config
      ->set('css_classes.' . INSERT_TYPE_FILE, $this
      ->sanitize_array($form_state
      ->getValue(INSERT_TYPE_FILE)));
    $config
      ->set('css_classes.' . INSERT_TYPE_IMAGE, $this
      ->sanitize_array($form_state
      ->getValue(INSERT_TYPE_IMAGE)));
    $config
      ->set('file_extensions.audio', $form_state
      ->getValue('audio'));
    $config
      ->set('file_extensions.video', $form_state
      ->getValue('video'));
    $config
      ->save();
    \Drupal::moduleHandler()
      ->invokeAll('insert_config_submit_form', [
      $form_state,
    ]);
    parent::submitForm($form, $form_state);
  }

  /**
   * @param array $source
   * @return array
   */
  protected function sanitize_array(array $source) {
    return array_filter($source, function ($value) {
      return $value !== '';
    });
  }

  /**
   * @param array $element
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public static function string_to_array(array $element, &$form_state) {
    $value = str_replace(',', ' ', trim($element['#value']));
    $form_state
      ->setValueForElement($element, preg_split('/\\s+/', $value));
  }

}

Members

Namesort descending 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::sanitize_array protected function
ConfigForm::string_to_array public static function
ConfigForm::submitForm public function @inheritdoc Overrides ConfigFormBase::submitForm
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.