class CurrencyImportForm in Price 8

Provides a form for importing currencies from library definitions.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\price\Form\CurrencyImportForm

1 string reference to 'CurrencyImportForm'

price.routing.yml in ./price.routing.yml

price.routing.yml

File

src/Form/CurrencyImportForm.php, line 13

Namespace

Drupal\price\Form

class CurrencyImportForm extends FormBase {

  /**
   * The currency importer.
   *
   * @var \Drupal\price\CurrencyImporterInterface
   */
  protected $importer;

  /**
   * Creates a new CurrencyImportForm object.
   *
   * @param \Drupal\price\CurrencyImporterInterface $importer
   *   The currency importer.
   */
  public function __construct(CurrencyImporterInterface $importer) {
    $this->importer = $importer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('price.currency_importer'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $currencies = $this->importer
      ->getImportable();
    if (empty($currencies)) {
      $form['message'] = [
        '#markup' => $this
          ->t('All currencies have already been imported.'),
      ];
    }
    else {
      $form['currency_codes'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Available currencies'),
        '#options' => $currencies,
        '#multiple' => TRUE,
        '#size' => 10,
      ];
      $form['actions']['#type'] = 'actions';
      $form['actions']['import'] = [
        '#type' => 'submit',
        '#button_type' => 'primary',
        '#name' => 'import',
        '#value' => $this
          ->t('Add'),
        '#submit' => [
          '::submitForm',
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $currency_codes = $form_state
      ->getValue('currency_codes');
    foreach ($currency_codes as $currency_code) {
      $this->importer
        ->import($currency_code);
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t('Imported the selected currencies.'));
    $form_state
      ->setRedirect('entity.price_currency.collection');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrencyImportForm::$importer	protected	property	The currency importer.
CurrencyImportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CurrencyImportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
CurrencyImportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CurrencyImportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
CurrencyImportForm::__construct	public	function	Creates a new CurrencyImportForm 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::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.
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.