interface CurrencyInterface in Commerce Core 8.2
Defines the interface for currencies.
Hierarchy
- interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\commerce_price\Entity\CurrencyInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of CurrencyInterface
All classes that implement CurrencyInterface
6 files declare their use of CurrencyInterface
- CurrencyImporter.php in modules/
price/ src/ CurrencyImporter.php - CurrencyRepository.php in modules/
price/ src/ Repository/ CurrencyRepository.php - LegacyNumberFormatter.php in modules/
price/ src/ LegacyNumberFormatter.php - RounderTest.php in modules/
price/ tests/ src/ Unit/ RounderTest.php - Store.php in modules/
store/ src/ Entity/ Store.php
File
- modules/
price/ src/ Entity/ CurrencyInterface.php, line 10
Namespace
Drupal\commerce_price\EntityView source
interface CurrencyInterface extends ConfigEntityInterface {
/**
* Gets the alphabetic currency code.
*
* @return string
* The alphabetic currency code.
*/
public function getCurrencyCode();
/**
* Sets the alphabetic currency code.
*
* @param string $currency_code
* The alphabetic currency code.
*
* @return $this
*/
public function setCurrencyCode($currency_code);
/**
* Gets the currency name.
*
* @return string
* The currency name.
*/
public function getName();
/**
* Sets the currency name.
*
* @param string $name
* The currency name.
*
* @return $this
*/
public function setName($name);
/**
* Gets the numeric currency code.
*
* The numeric code has three digits, and the first one can be a zero,
* hence the need to pass it around as a string.
*
* @return string
* The numeric currency code.
*/
public function getNumericCode();
/**
* Sets the numeric currency code.
*
* @param string $numeric_code
* The numeric currency code.
*
* @return $this
*/
public function setNumericCode($numeric_code);
/**
* Gets the currency symbol.
*
* @return string
* The currency symbol.
*/
public function getSymbol();
/**
* Sets the currency symbol.
*
* @param string $symbol
* The currency symbol.
*
* @return $this
*/
public function setSymbol($symbol);
/**
* Gets the number of fraction digits.
*
* Used when rounding or formatting an amount for display.
*
* @return int
* The number of fraction digits.
*/
public function getFractionDigits();
/**
* Sets the number of fraction digits.
*
* @param int $fraction_digits
* The number of fraction digits.
*
* @return $this
*/
public function setFractionDigits($fraction_digits);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
CurrencyInterface:: |
public | function | Gets the alphabetic currency code. | 1 |
CurrencyInterface:: |
public | function | Gets the number of fraction digits. | 1 |
CurrencyInterface:: |
public | function | Gets the currency name. | 1 |
CurrencyInterface:: |
public | function | Gets the numeric currency code. | 1 |
CurrencyInterface:: |
public | function | Gets the currency symbol. | 1 |
CurrencyInterface:: |
public | function | Sets the alphabetic currency code. | 1 |
CurrencyInterface:: |
public | function | Sets the number of fraction digits. | 1 |
CurrencyInterface:: |
public | function | Sets the currency name. | 1 |
CurrencyInterface:: |
public | function | Sets the numeric currency code. | 1 |
CurrencyInterface:: |
public | function | Sets the currency symbol. | 1 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |