class PluginBasedExchangeRateProviderForm in Currency 8.3

Provides the configuration form for \Drupal\currency\PluginBasedExchangeRateProvider.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\currency\Form\PluginBasedExchangeRateProviderForm implements ContainerInjectionInterface

Expanded class hierarchy of PluginBasedExchangeRateProviderForm

2 files declare their use of PluginBasedExchangeRateProviderForm

PluginBasedExchangeRateProviderFormTest.php in tests/src/Unit/Controller/PluginBasedExchangeRateProviderFormTest.php
PluginBasedExchangeRateProviderFormTest.php in tests/src/Unit/Form/PluginBasedExchangeRateProviderFormTest.php

1 string reference to 'PluginBasedExchangeRateProviderForm'

currency.routing.yml in ./currency.routing.yml: currency.routing.yml

File

src/Form/PluginBasedExchangeRateProviderForm.php, line 17

Namespace

Drupal\currency\Form

View source

class PluginBasedExchangeRateProviderForm extends FormBase implements ContainerInjectionInterface {

  /**
   * The plugin-based currency exchange rate provider.
   *
   * @var \Drupal\currency\PluginBasedExchangeRateProvider
   */
  protected $exchangeRateProvider;

  /**
   * The currency exchange rate provider manager.
   *
   * @var \Drupal\currency\Plugin\Currency\ExchangeRateProvider\ExchangeRateProviderManagerInterface
   */
  protected $currencyExchangeRateProviderManager;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   * @param \Drupal\currency\PluginBasedExchangeRateProvider $exchange_rate_provider
   *   The currency exchange rate provider.
   * @param \Drupal\currency\Plugin\Currency\ExchangeRateProvider\ExchangeRateProviderManagerInterface $currency_exchange_rate_provider_manager
   *   The currency exchange rate provider manager.
   */
  public function __construct(TranslationInterface $string_translation, PluginBasedExchangeRateProvider $exchange_rate_provider, ExchangeRateProviderManagerInterface $currency_exchange_rate_provider_manager) {
    $this->exchangeRateProvider = $exchange_rate_provider;
    $this->currencyExchangeRateProviderManager = $currency_exchange_rate_provider_manager;
    $this->stringTranslation = $string_translation;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $definitions = $this->currencyExchangeRateProviderManager
      ->getDefinitions();
    $configuration = $this->exchangeRateProvider
      ->loadConfiguration();
    $form['exchange_rate_providers'] = array(
      '#header' => array(
        $this
          ->t('Title'),
        $this
          ->t('Enabled'),
        $this
          ->t('Weight'),
        $this
          ->t('Operations'),
      ),
      '#tabledrag' => array(
        array(
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'form-select',
        ),
      ),
      '#type' => 'table',
    );
    $weight = 0;
    foreach ($configuration as $plugin_id => $enabled) {
      $weight++;
      $plugin_definition = $definitions[$plugin_id];
      $form['exchange_rate_providers'][$plugin_id] = array(
        '#attributes' => array(
          'class' => array(
            'draggable',
          ),
        ),
        '#weight' => $weight,
      );
      $form['exchange_rate_providers'][$plugin_id]['label'] = array(
        '#description' => $plugin_definition['description'],
        '#markup' => $plugin_definition['label'],
        '#title' => $this
          ->t('Title'),
        '#title_display' => 'invisible',
        '#type' => 'item',
      );
      $form['exchange_rate_providers'][$plugin_id]['enabled'] = array(
        '#default_value' => $enabled,
        '#title' => $this
          ->t('Enabled'),
        '#title_display' => 'invisible',
        '#type' => 'checkbox',
      );
      $form['exchange_rate_providers'][$plugin_id]['weight'] = array(
        '#default_value' => $weight,
        '#title' => $this
          ->t('Weight'),
        '#title_display' => 'invisible',
        '#type' => 'weight',
      );
      $operations_provider = $this->currencyExchangeRateProviderManager
        ->getOperationsProvider($plugin_id);
      $form['exchange_rate_providers'][$plugin_id]['operations'] = array(
        '#links' => $operations_provider ? $operations_provider
          ->getOperations($plugin_id) : [],
        '#title' => $this
          ->t('Operations'),
        '#type' => 'operations',
      );
    }
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['save'] = array(
      '#button_type' => 'primary',
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    uasort($values['exchange_rate_providers'], [
      SortArray::class,
      'sortByWeightElement',
    ]);
    $configuration = array();
    foreach ($values['exchange_rate_providers'] as $plugin_id => $exchanger_configuration) {
      $configuration[$plugin_id] = (bool) $exchanger_configuration['enabled'];
    }
    $this->exchangeRateProvider
      ->saveConfiguration($configuration);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The configuration options have been saved.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::config	protected	function	Retrieves a configuration object.
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.
PluginBasedExchangeRateProviderForm::$currencyExchangeRateProviderManager	protected	property	The currency exchange rate provider manager.
PluginBasedExchangeRateProviderForm::$exchangeRateProvider	protected	property	The plugin-based currency exchange rate provider.
PluginBasedExchangeRateProviderForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PluginBasedExchangeRateProviderForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
PluginBasedExchangeRateProviderForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PluginBasedExchangeRateProviderForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PluginBasedExchangeRateProviderForm::__construct	public	function	Constructs a new instance.
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 PluginBasedExchangeRateProviderForm in Currency 8.3

Hierarchy

File

Namespace

Members

API Navigation