forked from PrestaShop/PrestaShop
/
CurrencyDataProviderInterface.php
114 lines (105 loc) · 3.76 KB
/
CurrencyDataProviderInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<?php
/**
* 2007-2019 PrestaShop and Contributors
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2019 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
namespace PrestaShop\PrestaShop\Core\Currency;
use Currency;
use Exception;
use PrestaShopException;
/**
* This class will provide data from DB / ORM about Currency.
*/
interface CurrencyDataProviderInterface
{
/**
* Return available currencies.
*
* @param bool $object
* @param bool $active
* @param bool $group_by
*
* @return array Currencies
*/
public function getCurrencies($object = false, $active = true, $group_by = false);
/**
* Return raw currencies data from the database.
*
* @param bool $currentShopOnly If true returns only currencies associated to current shop
*
* @return array[] Installed currencies
*/
public function findAll($currentShopOnly = true);
/**
* Get a Currency entity instance by ISO code.
*
* @param string $isoCode
* An ISO 4217 currency code
* @param int|null $idLang
* Set this parameter if you want the currency in a specific language.
* If null, default language will be used
*
* @return currency|null
* The asked Currency object, or null if not found
*/
public function getCurrencyByIsoCode($isoCode, $idLang = null);
/**
* Get a Currency entity instance.
* If the passed ISO code is known, this Currency entity will be loaded with known data.
*
* @param string $isoCode
* An ISO 4217 currency code
* @param int|null $idLang
* Set this parameter if you want the currency in a specific language.
* If null, default language will be used
*
* @return currency
* The asked Currency object, loaded with relevant data if passed ISO code is known
*/
public function getCurrencyByIsoCodeOrCreate($isoCode, $idLang = null);
/**
* Persists a Currency entity into DB.
* If this entity already exists in DB (has a known currency_id), it will be updated.
*
* @param Currency $currencyEntity
* Currency object model to save
*
* @throws PrestaShopException
* If something wrong happened with DB when saving $currencyEntity
* @throws Exception
* If an unexpected result is retrieved when saving $currencyEntity
*/
public function saveCurrency(Currency $currencyEntity);
/**
* Gets a legacy Currency instance by ID.
*
* @param int $currencyId
*
* @return Currency
*/
public function getCurrencyById($currencyId);
/**
* Get Default currency Iso code.
*/
public function getDefaultCurrencyIsoCode();
}