vendor/moneyphp/money/src/Currency.php line 86

Open in your IDE?
  1. <?php
  3. namespace Money;
  5. /**
  6.  * Currency Value Object.
  7.  *
  8.  * Holds Currency specific data.
  9.  *
  10.  * @author Mathias Verraes
  11.  *
  12.  * @psalm-immutable
  13.  */
  14. final class Currency implements \JsonSerializable
  15. {
  16.     /**
  17.      * Currency code.
  18.      *
  19.      * @var string
  20.      */
  21.     private $code;
  23.     /**
  24.      * @param string $code
  25.      */
  26.     public function __construct($code)
  27.     {
  28.         if (!is_string($code)) {
  29.             throw new \InvalidArgumentException('Currency code should be string');
  30.         }
  32.         if ($code === '') {
  33.             throw new \InvalidArgumentException('Currency code should not be empty string');
  34.         }
  36.         $this->code = $code;
  37.     }
  39.     /**
  40.      * Returns the currency code.
  41.      *
  42.      * @return string
  43.      */
  44.     public function getCode()
  45.     {
  46.         return $this->code;
  47.     }
  49.     /**
  50.      * Checks whether this currency is the same as an other.
  51.      *
  52.      * @param Currency $other
  53.      *
  54.      * @return bool
  55.      */
  56.     public function equals(Currency $other)
  57.     {
  58.         return $this->code === $other->code;
  59.     }
  61.     /**
  62.      * Checks whether this currency is available in the passed context.
  63.      *
  64.      * @param Currencies $currencies
  65.      *
  66.      * @return bool
  67.      */
  68.     public function isAvailableWithin(Currencies $currencies)
  69.     {
  70.         return $currencies->contains($this);
  71.     }
  73.     /**
  74.      * @return string
  75.      */
  76.     public function __toString()
  77.     {
  78.         return $this->code;
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      *
  84.      * @return string
  85.      */
  86.     public function jsonSerialize()
  87.     {
  88.         return $this->code;
  89.     }
  90. }