You are here

CurrencyRepositoryInterface.php in Price 2.0.x

Same filename and directory in other branches
  1. 2.x src/Repository/CurrencyRepositoryInterface.php

File

src/Repository/CurrencyRepositoryInterface.php
View source
<?php

namespace Drupal\price\Repository;

use CommerceGuys\Intl\Currency\CurrencyRepositoryInterface as ExternalRepositoryInterface;

/**
 * Defines the currency repository interface.
 */
interface CurrencyRepositoryInterface extends ExternalRepositoryInterface {

  /**
   * Gets the default number of fraction digits for the given currency code.
   *
   * Merchants are allowed to override the fraction digits through the UI,
   * which can have an unexpected effect on payment gateways, which use that
   * information when converting amounts to minor units.
   *
   * @param string $currency_code
   *   The currency code.
   *
   * @return int
   *   The number of fraction digits.
   *
   * @throws \CommerceGuys\Intl\Exception\UnknownCurrencyException
   *   Thrown if the given currency code is unknown.
   */
  public function getDefaultFractionDigits(string $currency_code) : int;

}

Interfaces

Namesort descending Description
CurrencyRepositoryInterface Defines the currency repository interface.