class CurrencyHelper in Commerce Currency Resolver 8

Helper for various parts of the module.

Hierarchy

class \Drupal\commerce_currency_resolver\CurrencyHelper implements CurrencyHelperInterface uses StringTranslationTrait

Expanded class hierarchy of CurrencyHelper

1 file declares its use of CurrencyHelper

ShippingCurrencyOrderProcessor.php in modules/shipping/src/ShippingCurrencyOrderProcessor.php

1 string reference to 'CurrencyHelper'

commerce_currency_resolver.services.yml in ./commerce_currency_resolver.services.yml: commerce_currency_resolver.services.yml

1 service uses CurrencyHelper

commerce_currency_resolver.currency_helper in ./commerce_currency_resolver.services.yml: Drupal\commerce_currency_resolver\CurrencyHelper

File

src/CurrencyHelper.php, line 17

Namespace

Drupal\commerce_currency_resolver

View source

class CurrencyHelper implements CurrencyHelperInterface {
  use StringTranslationTrait;

  /**
   * Use as flag for out other order processor.
   */
  const CURRENCY_ORDER_REFRESH = 'currency_order_refresh';

  /**
   * Current request.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

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

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Core module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Current store.
   *
   * @var \Drupal\commerce_store\CurrentStoreInterface
   */
  protected $currentStore;

  /**
   * CurrencyHelper constructor.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   Request.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   Core language manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   Core module handler.
   * @param \Drupal\commerce_store\CurrentStoreInterface $current_store
   */
  public function __construct(RequestStack $request_stack, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entityTypeManager, LanguageManagerInterface $languageManager, ModuleHandlerInterface $module_handler, CurrentStoreInterface $current_store) {
    $this->requestStack = $request_stack;
    $this->configFactory = $config_factory;
    $this->entityTypeManager = $entityTypeManager;
    $this->languageManager = $languageManager;
    $this->moduleHandler = $module_handler;
    $this->currentStore = $current_store;
  }

  /**
   * {@inheritdoc}
   */
  public function getCurrencies() {

    /** @var \Drupal\commerce_price\Entity\CurrencyInterface[] $currencies */
    $currencies = $this->entityTypeManager
      ->getStorage('commerce_currency')
      ->loadMultiple();

    // Set defaults.
    $active_currencies = [];
    foreach ($currencies as $currency) {
      if ($currency
        ->status()) {
        $active_currencies[$currency
          ->getCurrencyCode()] = $currency
          ->getName();
      }
    }
    return $active_currencies;
  }

  /**
   * {@inheritdoc}
   */
  public function getExchangeRatesProviders() {

    /** @var \Drupal\commerce_exchanger\Entity\ExchangeRatesInterface[] $providers */
    $providers = $this->entityTypeManager
      ->getStorage('commerce_exchange_rates')
      ->loadMultiple();
    $exchange_rates = [];
    foreach ($providers as $provider) {
      if ($provider
        ->status()) {
        $exchange_rates[$provider
          ->id()] = $provider
          ->label();
      }
    }
    return $exchange_rates;
  }

  /**
   * {@inheritdoc}
   */
  public function getLanguages() {
    $languages = $this->languageManager
      ->getLanguages();
    $data = [];
    foreach ($languages as $key => $lang) {
      $data[$key] = $lang
        ->getName();
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function currentLanguage() {
    return $this->languageManager
      ->getCurrentLanguage()
      ->getId();
  }

  /**
   * {@inheritdoc}
   */
  public function getGeoModules() {
    $geo = [];
    if ($this->moduleHandler
      ->moduleExists('smart_ip')) {
      $geo['smart_ip'] = $this
        ->t('Smart IP');
    }
    if ($this->moduleHandler
      ->moduleExists('geoip')) {
      $geo['geoip'] = $this
        ->t('GeoIP');
    }
    return $geo;
  }

  /**
   * {@inheritdoc}
   */
  public function getUserCountry() {
    $service = $this->configFactory
      ->get('commerce_currency_resolver.settings')
      ->get('currency_geo');
    switch ($service) {
      case 'smart_ip':
        $country = \Drupal::service('smart_ip.smart_ip_location')
          ->get('countryCode');
        break;
      case 'geoip':
        $ip_address = $this->requestStack
          ->getCurrentRequest()
          ->getClientIp();
        $country = \Drupal::service('geoip.geolocation')
          ->geolocate($ip_address);
        break;
    }

    // If geolocation fails for any specific reason (most likely on local
    // environment, use default country from Drupal.
    if (empty($country)) {
      $country = $this->configFactory
        ->get('system.date')
        ->get('country.default');
    }
    return $country;
  }

  /**
   * {@inheritdoc}
   */
  public function getSourceType() {
    return $this->configFactory
      ->get('commerce_currency_resolver.settings')
      ->get('currency_mapping');
  }

  /**
   * {@inheritdoc}
   */
  public function getMappingMatrix() {
    return $this->configFactory
      ->get('commerce_currency_resolver.currency_mapping')
      ->get('matrix');
  }

  /**
   * {@inheritdoc}
   */
  public function getDomicileCurrency() {
    return $this->configFactory
      ->get('commerce_currency_resolver.currency_mapping')
      ->get('domicile_currency');
  }

  /**
   * {@inheritdoc}
   */
  public function defaultCurrencyCode() {
    if ($store = $this->currentStore
      ->getStore()) {
      return $store
        ->getDefaultCurrencyCode();
    }
    return $this
      ->fallbackCurrencyCode();
  }

  /**
   * {@inheritdoc}
   */
  public function fallbackCurrencyCode() {
    return $this->configFactory
      ->get('commerce_currency_resolver.settings')
      ->get('currency_default');
  }

  /**
   * {@inheritdoc}
   */
  public function getCookieName() {
    $cookieName =& drupal_static(__FUNCTION__);
    if (!isset($cookieName)) {
      $cookieName = Settings::get('commerce_currency_cookie') ?? 'commerce_currency';
    }
    return $cookieName;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrencyHelper::$configFactory	protected	property	Config factory.
CurrencyHelper::$currentStore	protected	property	Current store.
CurrencyHelper::$entityTypeManager	protected	property	Entity type manager.
CurrencyHelper::$languageManager	protected	property	Language manager.
CurrencyHelper::$moduleHandler	protected	property	Core module handler.
CurrencyHelper::$requestStack	protected	property	Current request.
CurrencyHelper::CURRENCY_ORDER_REFRESH		constant	Use as flag for out other order processor.
CurrencyHelper::currentLanguage	public	function	Return current user language. Overrides CurrencyHelperInterface::currentLanguage
CurrencyHelper::defaultCurrencyCode	public	function	Get default currency from current resolved store. Overrides CurrencyHelperInterface::defaultCurrencyCode
CurrencyHelper::fallbackCurrencyCode	public	function	Return default fallback currency from settings. Overrides CurrencyHelperInterface::fallbackCurrencyCode
CurrencyHelper::getCookieName	public	function	Get cookie name. Overrides CurrencyHelperInterface::getCookieName
CurrencyHelper::getCurrencies	public	function	Return formatted array of available currencies. Overrides CurrencyHelperInterface::getCurrencies
CurrencyHelper::getDomicileCurrency	public	function	Return if domicile currency is used. Overrides CurrencyHelperInterface::getDomicileCurrency
CurrencyHelper::getExchangeRatesProviders	public	function	Return formatted array of available exchange rates plugins. Overrides CurrencyHelperInterface::getExchangeRatesProviders
CurrencyHelper::getGeoModules	public	function	Get list of enabled geo modules if any. Overrides CurrencyHelperInterface::getGeoModules
CurrencyHelper::getLanguages	public	function	Return formatted array of languages. Overrides CurrencyHelperInterface::getLanguages
CurrencyHelper::getMappingMatrix	public	function	Get how currency is mapped in the system. By country, language, cookie. Overrides CurrencyHelperInterface::getMappingMatrix
CurrencyHelper::getSourceType	public	function	Get how currency is mapped in the system. By country, language, cookie. Overrides CurrencyHelperInterface::getSourceType
CurrencyHelper::getUserCountry	public	function	Get user country location from contrib modules. Overrides CurrencyHelperInterface::getUserCountry
CurrencyHelper::__construct	public	function	CurrencyHelper constructor.
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.

You are here

class CurrencyHelper in Commerce Currency Resolver 8

Hierarchy

File

Namespace

Members

API Navigation