class SettingsForm in File metadata manager 8

Same name and namespace in other branches

8.2 src/Form/SettingsForm.php \Drupal\file_mdm\Form\SettingsForm

Configures file_mdm settings for this site.

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

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

file_mdm.routing.yml in ./file_mdm.routing.yml: file_mdm.routing.yml

File

src/Form/SettingsForm.php, line 15

Namespace

Drupal\file_mdm\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * An array containing the available metadata plugins.
   *
   * @var \Drupal\file_mdm\Plugin\FileMetadataPluginInterface[]
   */
  protected $metadataPlugins = [];

  /**
   * Constructs a SettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\file_mdm\Plugin\FileMetadataPluginManager $manager
   *   The file metadata plugin manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, FileMetadataPluginManager $manager) {
    parent::__construct($config_factory);
    foreach ($manager
      ->getDefinitions() as $id => $definition) {
      $this->metadataPlugins[$id] = $manager
        ->createInstance($id);
    }
    uasort($this->metadataPlugins, function ($a, $b) {
      return Unicode::strcasecmp((string) $a
        ->getPluginDefinition()['title'], (string) $b
        ->getPluginDefinition()['title']);
    });
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Cache metadata.
    $form['metadata_cache'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#collapsible' => FALSE,
      '#title' => $this
        ->t('Metadata caching'),
      '#tree' => TRUE,
    ];
    $form['metadata_cache']['settings'] = [
      '#type' => 'file_mdm_caching',
      '#default_value' => $this
        ->config('file_mdm.settings')
        ->get('metadata_cache'),
    ];

    // Settings tabs.
    $form['plugins'] = [
      '#type' => 'vertical_tabs',
      '#tree' => FALSE,
    ];

    // Load subforms from each plugin.
    foreach ($this->metadataPlugins as $id => $plugin) {
      $definition = $plugin
        ->getPluginDefinition();
      $form['file_mdm_plugin_settings'][$id] = [
        '#type' => 'details',
        '#title' => $definition['title'],
        '#description' => $definition['help'],
        '#open' => FALSE,
        '#tree' => TRUE,
        '#group' => 'plugins',
      ];
      $form['file_mdm_plugin_settings'][$id] += $plugin
        ->buildConfigurationForm([], $form_state);
    }
    return parent::buildForm($form, $form_state);
  }

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

    // Call the form validation handler for each of the plugins.
    foreach ($this->metadataPlugins as $plugin) {
      $plugin
        ->validateConfigurationForm($form, $form_state);
    }
  }

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

    // Call the form submit handler for each of the plugins.
    foreach ($this->metadataPlugins as $plugin) {
      $plugin
        ->submitConfigurationForm($form, $form_state);
    }
    $this
      ->config('file_mdm.settings')
      ->set('metadata_cache', $form_state
      ->getValue([
      'metadata_cache',
      'settings',
    ]));

    // Only save settings if they have changed to prevent unnecessary cache
    // invalidations.
    if ($this
      ->config('file_mdm.settings')
      ->getOriginal() != $this
      ->config('file_mdm.settings')
      ->get()) {
      $this
        ->config('file_mdm.settings')
        ->save();
    }
    parent::submitForm($form, $form_state);
  }

}

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.
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::$metadataPlugins	protected	property	An array containing the available metadata plugins.
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::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
SettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
SettingsForm::__construct	public	function	Constructs a SettingsForm object. Overrides ConfigFormBase::__construct
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 metadata manager 8

Hierarchy

File

Namespace

Members

API Navigation