classes/XLite/Model/Currency.php line 15

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Currency
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table (name="currencies",
  17.  *      indexes = {
  18.  *          @ORM\Index (name="code", columns={"code"})
  19.  *      }
  20.  * )
  21.  */
  22. class Currency extends \XLite\Model\Base\I18n
  23. {
  24.     public const ROUNDUP_NONE = 'N';
  26.     /**
  27.      * Currency unique id (ISO 4217 number)
  28.      *
  29.      * @var integer
  30.      *
  31.      * @ORM\Id
  32.      * @ORM\Column (type="integer", options={ "unsigned": true })
  33.      */
  34.     protected $currency_id;
  36.     /**
  37.      * Currency code (ISO 4217 alpha-3)
  38.      *
  39.      * @var string
  40.      *
  41.      * @ORM\Column (type="string", options={ "fixed": true }, length=3, unique=true)
  42.      */
  43.     protected $code;
  45.     /**
  46.      * Symbol
  47.      *
  48.      * @var string
  49.      *
  50.      * @ORM\Column (type="string", length=16)
  51.      */
  52.     protected $symbol;
  54.     /**
  55.      * Prefix
  56.      *
  57.      * @var string
  58.      *
  59.      * @ORM\Column (type="string", length=32)
  60.      */
  61.     protected $prefix = '';
  63.     /**
  64.      * Suffix
  65.      *
  66.      * @var string
  67.      *
  68.      * @ORM\Column (type="string", length=32)
  69.      */
  70.     protected $suffix = '';
  72.     /**
  73.      * Number of digits after the decimal separator.
  74.      *
  75.      * @var integer
  76.      *
  77.      * @ORM\Column (type="smallint")
  78.      */
  79.     protected $e = 0;
  81.     /**
  82.      * Decimal part delimiter
  83.      * @var string
  84.      *
  85.      * @ORM\Column (type="string", length=8)
  86.      */
  87.     protected $decimalDelimiter = '.';
  89.     /**
  90.      * Thousand delimier
  91.      *
  92.      * @var string
  93.      *
  94.      * @ORM\Column (type="string", length=8)
  95.      */
  96.     protected $thousandDelimiter = '';
  98.     /**
  99.      * Orders
  100.      *
  101.      * @var \Doctrine\Common\Collections\Collection
  102.      *
  103.      * @ORM\OneToMany (targetEntity="XLite\Model\Order", mappedBy="currency")
  104.      */
  105.     protected $orders;
  107.     /**
  108.      * Countries
  109.      *
  110.      * @var \Doctrine\Common\Collections\Collection
  111.      *
  112.      * @ORM\OneToMany (targetEntity="XLite\Model\Country", mappedBy="currency", cascade={"all"})
  113.      */
  114.     protected $countries;
  116.     /**
  117.      * RoundUp
  118.      *
  119.      * @var string
  120.      *
  121.      * @ORM\Column (type="string", options={"default" : "N"})
  122.      */
  123.     protected $roundUp = self::ROUNDUP_NONE;
  125.     /**
  126.      * @var \Doctrine\Common\Collections\Collection
  127.      *
  128.      * @ORM\OneToMany (targetEntity="XLite\Model\CurrencyTranslation", mappedBy="owner", cascade={"all"})
  129.      */
  130.     protected $translations;
  133.     /**
  134.      * Set currency Id
  135.      *
  136.      * @param integer $value Currency id
  137.      * TODO - Doctrine is not generate setter for identifier. We must reworkt it
  138.      *
  139.      * @return void
  140.      */
  141.     public function setCurrencyId($value)
  142.     {
  143.         $this->currency_id = $value;
  144.     }
  146.     /**
  147.      * Get urrency symbol to display in interface
  148.      *
  149.      * @param boolean $strict Flag: true - return only prefix or suffix, false - return code if prefix and suffix isn't specified for currency
  150.      *
  151.      * @return string
  152.      */
  153.     public function getCurrencySymbol($strict = true)
  154.     {
  155.         return $this->getPrefix() ?: ($this->getSuffix() ?: (!$strict ? $this->getCode() : ''));
  156.     }
  158.     /**
  159.      * Round value
  160.      *
  161.      * @param float $value Value
  162.      *
  163.      * @return float
  164.      */
  165.     public function roundValue($value)
  166.     {
  167.         return \XLite\Logic\Math::getInstance()->roundByCurrency($value, $this);
  168.     }
  170.     /**
  171.      * Round value as integer
  172.      *
  173.      * @param float $value Value
  174.      *
  175.      * @return integer
  176.      */
  177.     public function roundValueAsInteger($value)
  178.     {
  179.         return intval(round($this->roundValue($value) * pow(10, $this->getE()), 0));
  180.     }
  182.     /**
  183.      * Convert integer to float
  184.      *
  185.      * @param integer $value Value
  186.      *
  187.      * @return float
  188.      */
  189.     public function convertIntegerToFloat($value)
  190.     {
  191.         return $value / pow(10, $this->getE());
  192.     }
  194.     /**
  195.      * Don't use the method to send prices to 3rd-party API where strict(not like '1 234,99') number is expected,
  196.      * consider using roundValue() calls instead
  197.      *
  198.      * @param float $value Value
  199.      *
  200.      * @return string
  201.      */
  202.     public function formatValue($value)
  203.     {
  204.         return \XLite\Logic\Math::getInstance()->formatValue($value, $this);
  205.     }
  207.     /**
  208.      * Get minimum value
  209.      *
  210.      * @return float
  211.      */
  212.     public function getMinimumValue()
  213.     {
  214.         return $this->convertIntegerToFloat(1);
  215.     }
  217.     /**
  218.      * Constructor
  219.      *
  220.      * @param array $data Entity properties OPTIONAL
  221.      *
  222.      * @return void
  223.      */
  224.     public function __construct(array $data = [])
  225.     {
  226.         $this->orders    = new \Doctrine\Common\Collections\ArrayCollection();
  227.         $this->countries = new \Doctrine\Common\Collections\ArrayCollection();
  229.         parent::__construct($data);
  230.     }
  232.     /**
  233.      * Format value as parts list
  234.      *
  235.      * @param float $value Value
  236.      *
  237.      * @return array
  238.      */
  239.     public function formatParts($value)
  240.     {
  241.         return \XLite\Logic\Math::getInstance()->formatParts($value, $this);
  242.     }
  245.     /**
  246.      * Get currency_id
  247.      *
  248.      * @return integer
  249.      */
  250.     public function getCurrencyId()
  251.     {
  252.         return $this->currency_id;
  253.     }
  255.     /**
  256.      * Set code
  257.      *
  258.      * @param string $code
  259.      * @return Currency
  260.      */
  261.     public function setCode($code)
  262.     {
  263.         $this->code = $code;
  264.         return $this;
  265.     }
  267.     /**
  268.      * Get code
  269.      *
  270.      * @return string
  271.      */
  272.     public function getCode()
  273.     {
  274.         return $this->code;
  275.     }
  277.     /**
  278.      * Set symbol
  279.      *
  280.      * @param string $symbol
  281.      * @return Currency
  282.      */
  283.     public function setSymbol($symbol)
  284.     {
  285.         $this->symbol = $symbol;
  286.         return $this;
  287.     }
  289.     /**
  290.      * Get symbol
  291.      *
  292.      * @return string
  293.      */
  294.     public function getSymbol()
  295.     {
  296.         return $this->symbol;
  297.     }
  299.     /**
  300.      * Set prefix
  301.      *
  302.      * @param string $prefix
  303.      * @return Currency
  304.      */
  305.     public function setPrefix($prefix)
  306.     {
  307.         $this->prefix = $prefix;
  308.         return $this;
  309.     }
  311.     /**
  312.      * Get prefix
  313.      *
  314.      * @return string
  315.      */
  316.     public function getPrefix()
  317.     {
  318.         return $this->prefix;
  319.     }
  321.     /**
  322.      * Set suffix
  323.      *
  324.      * @param string $suffix
  325.      * @return Currency
  326.      */
  327.     public function setSuffix($suffix)
  328.     {
  329.         $this->suffix = $suffix;
  330.         return $this;
  331.     }
  333.     /**
  334.      * Get suffix
  335.      *
  336.      * @return string
  337.      */
  338.     public function getSuffix()
  339.     {
  340.         return $this->suffix;
  341.     }
  343.     /**
  344.      * Set e
  345.      *
  346.      * @param smallint $e
  347.      * @return Currency
  348.      */
  349.     public function setE($e)
  350.     {
  351.         $this->e = $e;
  352.         return $this;
  353.     }
  355.     /**
  356.      * Get e
  357.      *
  358.      * @return smallint
  359.      */
  360.     public function getE()
  361.     {
  362.         return $this->e;
  363.     }
  365.     /**
  366.      * Set decimalDelimiter
  367.      *
  368.      * @param string $decimalDelimiter
  369.      * @return Currency
  370.      */
  371.     public function setDecimalDelimiter($decimalDelimiter)
  372.     {
  373.         $this->decimalDelimiter = $decimalDelimiter;
  374.         return $this;
  375.     }
  377.     /**
  378.      * Get decimalDelimiter
  379.      *
  380.      * @return string
  381.      */
  382.     public function getDecimalDelimiter()
  383.     {
  384.         return $this->decimalDelimiter;
  385.     }
  387.     /**
  388.      * Set thousandDelimiter
  389.      *
  390.      * @param string $thousandDelimiter
  391.      * @return Currency
  392.      */
  393.     public function setThousandDelimiter($thousandDelimiter)
  394.     {
  395.         $this->thousandDelimiter = $thousandDelimiter;
  396.         return $this;
  397.     }
  399.     /**
  400.      * Get thousandDelimiter
  401.      *
  402.      * @return string
  403.      */
  404.     public function getThousandDelimiter()
  405.     {
  406.         return $this->thousandDelimiter;
  407.     }
  409.     /**
  410.      * Add orders
  411.      *
  412.      * @param \XLite\Model\Order $orders
  413.      * @return Currency
  414.      */
  415.     public function addOrders(\XLite\Model\Order $orders)
  416.     {
  417.         $this->orders[] = $orders;
  418.         return $this;
  419.     }
  421.     /**
  422.      * Get orders
  423.      *
  424.      * @return \Doctrine\Common\Collections\Collection
  425.      */
  426.     public function getOrders()
  427.     {
  428.         return $this->orders;
  429.     }
  431.     /**
  432.      * Add countries
  433.      *
  434.      * @param \XLite\Model\Country $countries
  435.      * @return Currency
  436.      */
  437.     public function addCountries(\XLite\Model\Country $countries)
  438.     {
  439.         $this->countries[] = $countries;
  440.         return $this;
  441.     }
  443.     /**
  444.      * Get countries
  445.      *
  446.      * @return \Doctrine\Common\Collections\Collection
  447.      */
  448.     public function getCountries()
  449.     {
  450.         return $this->countries;
  451.     }
  453.     /**
  454.      * Return RoundUp
  455.      *
  456.      * @return string
  457.      */
  458.     public function getRoundUp()
  459.     {
  460.         return $this->roundUp;
  461.     }
  463.     /**
  464.      * Set RoundUp
  465.      *
  466.      * @param string $roundUp
  467.      *
  468.      * @return $this
  469.      */
  470.     public function setRoundUp($roundUp)
  471.     {
  472.         $this->roundUp = $roundUp;
  473.         return $this;
  474.     }
  475. }