class FixedRatesForm in Currency 8.3

Provides the configuration form for the currency_fixed_rates plugin.

Hierarchy

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

Expanded class hierarchy of FixedRatesForm

2 files declare their use of FixedRatesForm

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

1 string reference to 'FixedRatesForm'

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

File

src/Form/FixedRatesForm.php, line 19

Namespace

Drupal\currency\Form

View source

class FixedRatesForm extends FormBase implements ContainerInjectionInterface {

  /**
   * The currency storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $currencyStorage;

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

  /**
   * The form helper
   *
   * @var \Drupal\currency\FormHelperInterface
   */
  protected $formHelper;

  /**
   * Constructs a new instance.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translator.
   * @param \Drupal\Core\Entity\EntityStorageInterface $currency_storage
   *   The currency storage.
   * @param \Drupal\currency\Plugin\Currency\ExchangeRateProvider\ExchangeRateProviderManagerInterface $currency_exchange_rate_provider_manager
   *   The currency exchange rate provider plugin manager.
   * @param \Drupal\currency\FormHelperInterface
   *   The form helper.
   */
  public function __construct(ConfigFactoryInterface $configFactory, TranslationInterface $string_translation, EntityStorageInterface $currency_storage, ExchangeRateProviderManagerInterface $currency_exchange_rate_provider_manager, FormHelperInterface $form_helper) {
    $this
      ->setConfigFactory($configFactory);
    $this->currencyStorage = $currency_storage;
    $this->currencyExchangeRateProviderManager = $currency_exchange_rate_provider_manager;
    $this->formHelper = $form_helper;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
    $entity_type_manager = $container
      ->get('entity_type.manager');
    return new static($container
      ->get('config.factory'), $container
      ->get('string_translation'), $entity_type_manager
      ->getStorage('currency'), $container
      ->get('plugin.manager.currency.exchange_rate_provider'), $container
      ->get('currency.form_helper'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $currency_code_from = 'XXX', $currency_code_to = 'XXX') {
    $plugin = $this->currencyExchangeRateProviderManager
      ->createInstance('currency_fixed_rates');
    $rate = $plugin
      ->load($currency_code_from, $currency_code_to);
    $options = $this->formHelper
      ->getCurrencyOptions();
    unset($options['XXX']);
    $form['currency_code_from'] = array(
      '#default_value' => $currency_code_from,
      '#disabled' => !is_null($rate),
      '#empty_value' => '',
      '#options' => $options,
      '#required' => TRUE,
      '#title' => $this
        ->t('Source currency'),
      '#type' => 'select',
    );
    $form['currency_code_to'] = array(
      '#default_value' => $currency_code_to,
      '#disabled' => !is_null($rate),
      '#empty_value' => '',
      '#options' => $options,
      '#required' => TRUE,
      '#title' => $this
        ->t('Destination currency'),
      '#type' => 'select',
    );
    $form['rate'] = array(
      '#limit_currency_codes' => array(
        $currency_code_to,
      ),
      '#default_value' => array(
        'amount' => !is_null($rate) ? $rate
          ->getRate() : NULL,
        'currency_code' => $currency_code_to,
      ),
      '#required' => TRUE,
      '#title' => $this
        ->t('Exchange rate'),
      '#type' => 'currency_amount',
    );
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['save'] = array(
      '#button_type' => 'primary',
      '#name' => 'save',
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    );
    if (!is_null($rate)) {
      $form['actions']['delete'] = array(
        '#button_type' => 'danger',
        '#limit_validation_errors' => array(
          array(
            'currency_code_from',
          ),
          array(
            'currency_code_to',
          ),
        ),
        '#name' => 'delete',
        '#type' => 'submit',
        '#value' => $this
          ->t('Delete'),
      );
    }
    return $form;
  }

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

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

    /** @var \Drupal\currency\Plugin\Currency\ExchangeRateProvider\FixedRates $plugin */
    $plugin = $this->currencyExchangeRateProviderManager
      ->createInstance('currency_fixed_rates');
    $values = $form_state
      ->getValues();
    $currency_code_from = $values['currency_code_from'];
    $currency_code_to = $values['currency_code_to'];
    $currency_from = $this->currencyStorage
      ->load($currency_code_from);
    $currency_to = $this->currencyStorage
      ->load($currency_code_to);
    $triggering_element = $form_state
      ->getTriggeringElement();
    switch ($triggering_element['#name']) {
      case 'save':
        $plugin
          ->save($currency_code_from, $currency_code_to, $values['rate']['amount']);
        $this
          ->messenger()
          ->addMessage($this
          ->t('The exchange rate for @currency_title_from to @currency_title_to has been saved.', array(
          '@currency_title_from' => $currency_from
            ->label(),
          '@currency_title_to' => $currency_to
            ->label(),
        )));
        break;
      case 'delete':
        $plugin
          ->delete($currency_code_from, $currency_code_to);
        $this
          ->messenger()
          ->addMessage($this
          ->t('The exchange rate for @currency_title_from to @currency_title_to has been deleted.', array(
          '@currency_title_from' => $currency_from
            ->label(),
          '@currency_title_to' => $currency_to
            ->label(),
        )));
        break;
    }
    $form_state
      ->setRedirect('currency.exchange_rate_provider.fixed_rates.overview');
  }

}

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
FixedRatesForm::$currencyExchangeRateProviderManager	protected	property	The currency exchange rate provider manager.
FixedRatesForm::$currencyStorage	protected	property	The currency storage.
FixedRatesForm::$formHelper	protected	property	The form helper
FixedRatesForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
FixedRatesForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
FixedRatesForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FixedRatesForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
FixedRatesForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
FixedRatesForm::__construct	public	function	Constructs a new instance.
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.
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.

You are here

class FixedRatesForm in Currency 8.3

Hierarchy

File

Namespace

Members

API Navigation