classes/XLite/Model/Currency.php line 22

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.      * Format value
  196.      *
  197.      * @param float $value Value
  198.      *
  199.      * @return string
  200.      */
  201.     public function formatValue($value)
  202.     {
  203.         return \XLite\Logic\Math::getInstance()->formatValue($value, $this);
  204.     }
  206.     /**
  207.      * Get minimum value
  208.      *
  209.      * @return float
  210.      */
  211.     public function getMinimumValue()
  212.     {
  213.         return $this->convertIntegerToFloat(1);
  214.     }
  216.     /**
  217.      * Constructor
  218.      *
  219.      * @param array $data Entity properties OPTIONAL
  220.      *
  221.      * @return void
  222.      */
  223.     public function __construct(array $data = [])
  224.     {
  225.         $this->orders    = new \Doctrine\Common\Collections\ArrayCollection();
  226.         $this->countries = new \Doctrine\Common\Collections\ArrayCollection();
  228.         parent::__construct($data);
  229.     }
  231.     /**
  232.      * Format value as parts list
  233.      *
  234.      * @param float $value Value
  235.      *
  236.      * @return array
  237.      */
  238.     public function formatParts($value)
  239.     {
  240.         return \XLite\Logic\Math::getInstance()->formatParts($value, $this);
  241.     }
  244.     /**
  245.      * Get currency_id
  246.      *
  247.      * @return integer
  248.      */
  249.     public function getCurrencyId()
  250.     {
  251.         return $this->currency_id;
  252.     }
  254.     /**
  255.      * Set code
  256.      *
  257.      * @param string $code
  258.      * @return Currency
  259.      */
  260.     public function setCode($code)
  261.     {
  262.         $this->code = $code;
  263.         return $this;
  264.     }
  266.     /**
  267.      * Get code
  268.      *
  269.      * @return string
  270.      */
  271.     public function getCode()
  272.     {
  273.         return $this->code;
  274.     }
  276.     /**
  277.      * Set symbol
  278.      *
  279.      * @param string $symbol
  280.      * @return Currency
  281.      */
  282.     public function setSymbol($symbol)
  283.     {
  284.         $this->symbol = $symbol;
  285.         return $this;
  286.     }
  288.     /**
  289.      * Get symbol
  290.      *
  291.      * @return string
  292.      */
  293.     public function getSymbol()
  294.     {
  295.         return $this->symbol;
  296.     }
  298.     /**
  299.      * Set prefix
  300.      *
  301.      * @param string $prefix
  302.      * @return Currency
  303.      */
  304.     public function setPrefix($prefix)
  305.     {
  306.         $this->prefix = $prefix;
  307.         return $this;
  308.     }
  310.     /**
  311.      * Get prefix
  312.      *
  313.      * @return string
  314.      */
  315.     public function getPrefix()
  316.     {
  317.         return $this->prefix;
  318.     }
  320.     /**
  321.      * Set suffix
  322.      *
  323.      * @param string $suffix
  324.      * @return Currency
  325.      */
  326.     public function setSuffix($suffix)
  327.     {
  328.         $this->suffix = $suffix;
  329.         return $this;
  330.     }
  332.     /**
  333.      * Get suffix
  334.      *
  335.      * @return string
  336.      */
  337.     public function getSuffix()
  338.     {
  339.         return $this->suffix;
  340.     }
  342.     /**
  343.      * Set e
  344.      *
  345.      * @param smallint $e
  346.      * @return Currency
  347.      */
  348.     public function setE($e)
  349.     {
  350.         $this->e = $e;
  351.         return $this;
  352.     }
  354.     /**
  355.      * Get e
  356.      *
  357.      * @return smallint
  358.      */
  359.     public function getE()
  360.     {
  361.         return $this->e;
  362.     }
  364.     /**
  365.      * Set decimalDelimiter
  366.      *
  367.      * @param string $decimalDelimiter
  368.      * @return Currency
  369.      */
  370.     public function setDecimalDelimiter($decimalDelimiter)
  371.     {
  372.         $this->decimalDelimiter = $decimalDelimiter;
  373.         return $this;
  374.     }
  376.     /**
  377.      * Get decimalDelimiter
  378.      *
  379.      * @return string
  380.      */
  381.     public function getDecimalDelimiter()
  382.     {
  383.         return $this->decimalDelimiter;
  384.     }
  386.     /**
  387.      * Set thousandDelimiter
  388.      *
  389.      * @param string $thousandDelimiter
  390.      * @return Currency
  391.      */
  392.     public function setThousandDelimiter($thousandDelimiter)
  393.     {
  394.         $this->thousandDelimiter = $thousandDelimiter;
  395.         return $this;
  396.     }
  398.     /**
  399.      * Get thousandDelimiter
  400.      *
  401.      * @return string
  402.      */
  403.     public function getThousandDelimiter()
  404.     {
  405.         return $this->thousandDelimiter;
  406.     }
  408.     /**
  409.      * Add orders
  410.      *
  411.      * @param \XLite\Model\Order $orders
  412.      * @return Currency
  413.      */
  414.     public function addOrders(\XLite\Model\Order $orders)
  415.     {
  416.         $this->orders[] = $orders;
  417.         return $this;
  418.     }
  420.     /**
  421.      * Get orders
  422.      *
  423.      * @return \Doctrine\Common\Collections\Collection
  424.      */
  425.     public function getOrders()
  426.     {
  427.         return $this->orders;
  428.     }
  430.     /**
  431.      * Add countries
  432.      *
  433.      * @param \XLite\Model\Country $countries
  434.      * @return Currency
  435.      */
  436.     public function addCountries(\XLite\Model\Country $countries)
  437.     {
  438.         $this->countries[] = $countries;
  439.         return $this;
  440.     }
  442.     /**
  443.      * Get countries
  444.      *
  445.      * @return \Doctrine\Common\Collections\Collection
  446.      */
  447.     public function getCountries()
  448.     {
  449.         return $this->countries;
  450.     }
  452.     /**
  453.      * Return RoundUp
  454.      *
  455.      * @return string
  456.      */
  457.     public function getRoundUp()
  458.     {
  459.         return $this->roundUp;
  460.     }
  462.     /**
  463.      * Set RoundUp
  464.      *
  465.      * @param string $roundUp
  466.      *
  467.      * @return $this
  468.      */
  469.     public function setRoundUp($roundUp)
  470.     {
  471.         $this->roundUp = $roundUp;
  472.         return $this;
  473.     }
  474. }