class SettingsForm in File Upload Secure Validator 8

A configuration settings form.

This form is used by administrators to configure options such as the MIME types equivalence groups.

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\file_upload_secure_validator\Form\SettingsForm

Expanded class hierarchy of SettingsForm

2 string references to 'SettingsForm'

file_upload_secure_validator.routing.yml in ./file_upload_secure_validator.routing.yml: file_upload_secure_validator.routing.yml
file_upload_secure_validator.routing.yml in ./file_upload_secure_validator.routing.yml: file_upload_secure_validator.routing.yml

File

src/Form/SettingsForm.php, line 16

Namespace

Drupal\file_upload_secure_validator\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * The internally used delimiter for encoding to CSV.
   *
   * @var string
   */
  const CSV_DELIMITER = ',';

  /**
   * ConfigFactoryInterface definition.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * FileUploadSecureValidator definition.
   *
   * @var \Drupal\file_upload_secure_validator\Service\FileUploadSecureValidator
   */
  protected $fileUploadSecureValidator;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->configFactory = $container
      ->get('config.factory');
    $instance->fileUploadSecureValidator = $container
      ->get('file_upload_secure_validator');
    return $instance;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'file-upload-secure-validator-settings';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['mime_types_equivalence_groups'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('MIME types equivalence group(s)'),
      '#description' => $this
        ->t('A CSV-like list of MIME types groups; if two MIME types are part of the same group, then, File Upload Secure Validator will not protest.'),
      '#default_value' => $this
        ->getConfigurationAsCsvString(),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    // Provides backward compatibility.
    $options = [];
    if (defined('CsvEncoder::NO_HEADERS_KEY')) {
      $options[CsvEncoder::NO_HEADERS_KEY] = TRUE;
    }
    $mimeTypesGroups = (new CsvEncoder())
      ->decode($form_state
      ->getValue('mime_types_equivalence_groups'), 'csv', $options);
    $this
      ->config('file_upload_secure_validator.settings')
      ->set('mime_types_equivalence_groups', $mimeTypesGroups)
      ->save();
  }

  /**
   * Returns a CSV representation of the configuration stored in the database.
   */
  private function getConfigurationAsCsvString() {
    $configuration = $this
      ->config('file_upload_secure_validator.settings')
      ->get('mime_types_equivalence_groups');

    // Provides backward compatibility.
    $options = [
      CsvEncoder::DELIMITER_KEY => ',',
    ];
    if (defined('CsvEncoder::NO_HEADERS_KEY')) {
      $options[CsvEncoder::NO_HEADERS_KEY] = TRUE;
    }
    $csvString = (new CsvEncoder())
      ->encode($configuration, CsvEncoder::FORMAT, $options);
    return preg_replace('#' . self::CSV_DELIMITER . '+$#m', '', $csvString);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$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.
SettingsForm::$configFactory	protected	property	ConfigFactoryInterface definition. Overrides FormBase::$configFactory
SettingsForm::$fileUploadSecureValidator	protected	property	FileUploadSecureValidator definition.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::CSV_DELIMITER		constant	The internally used delimiter for encoding to CSV.
SettingsForm::getConfigurationAsCsvString	private	function	Returns a CSV representation of the configuration stored in the database.
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 SettingsForm in File Upload Secure Validator 8

Hierarchy

File

Namespace

Members

API Navigation