Версия: 6.x
burger close
Класс CurrencyApi
Граф наследования:CurrencyApi:
EntityList BaseModel

Открытые члены

 __construct ()
 
 getCBRFCourse ($date=false)
 
 getCBRFCourseWithUpdate ($cur_site=true)
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Открытые статические члены

static getCurrentCurrency ()
 
static getDefaultCurrency ()
 
static getBaseCurrency ()
 
static setCurrentCurrency ($alias, $send_header=true)
 
static getCurrecyCode ()
 
static getCurrecyLiter ()
 
static applyCurrency ($cost, Orm\Currency $currency=null)
 
static convertToBase ($cost, Orm\Currency $cost_currency=null)
 
static getByUid ($uid)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Поля данных

const COOKIE_CURRENCY_KEY = 'currency'
 
const CBR_LINK = "http://www.cbr.ru/scripts/XML_daily.asp"
 
- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

Статические открытые данные

static $default_currency
 
static $base_currency
 

Статические защищенные данные

static $current_currency
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

Дополнительные унаследованные члены

- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Конструктор(ы)

__construct ( )

Методы

static applyCurrency (   $cost,
Orm\Currency  $currency = null 
)
static

Корректирует цену с учетом курса валюты относительно базовой валюты

Аргументы
float$cost- Цена в базовой валюте
$currency- объект валюты
Возвращает
float
static convertToBase (   $cost,
Orm\Currency  $cost_currency = null 
)
static

Конвертирует цену в текущей валюте к базовой валюте

Аргументы
float$cost- цена
Orm\Currency$cost_currency- валюта, в которой указана $cost. Если null, то текущая валюта
Возвращает
float
static getBaseCurrency ( )
static

Возвращает объект с базовой валютой. (базовой считается валюта, в которой цены в системе)

Возвращает
Orm
static getByUid (   $uid)
static

Возвращает объект валюты по трехсимвольному идентификатору

Возвращает
Orm
getCBRFCourse (   $date = false)

Получает курсы валют с сайта ЦБ РФ

Аргументы
boolean | string$date- дата за которую нужно получить данные
Возвращает
boolean|
getCBRFCourseWithUpdate (   $cur_site = true)

Получает курсы ЦБ РФ всех валют за исключением базовой (Рублей) И обновляет у них не только значение, но и у товаров обновляются цены, если они указаны в этих валютах Если удалось обновить возвращается true

Аргументы
$cur_site- по умолчанию true; если true - то делать для текщего сайта с обновлением, если integer - Если задано значение то для конкретного сайта если false|null - Обновить для всех валют всех сайтов
Возвращает
boolean
static getCurrecyCode ( )
static

Возвращает код текущей валюты

Возвращает
string
static getCurrecyLiter ( )
static

Возвращает символ текущей валюты

Возвращает
string
static getCurrentCurrency ( )
static

Возращает объект текущей валюты

Возвращает
Orm
static getDefaultCurrency ( )
static

Возвращает валюту по-умолчанию для текущего сайта

Возвращает
Orm
static setCurrentCurrency (   $alias,
  $send_header = true 
)
static

Устанавливает текущую валюту в системе

Аргументы
string$alias- трехсимвольный идентификатор валюты
Возвращает
bool Возвращает true, если установка валюты прошла успешно

Поля

$base_currency
static
$current_currency
staticprotected
$default_currency
static
const CBR_LINK = "http://www.cbr.ru/scripts/XML_daily.asp"
const COOKIE_CURRENCY_KEY = 'currency'