Documentation

Currency
in package

Класс для работы с валютами

Class Currency

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Example:

$Client  = new Salesman\Client();
$result = $Client -> add($params);
$clid = $result['data'];

Table of Contents

HTMLCODE  = ["dollar" => "\$", "euro" => "€", "pound" => "£", "yen" => "¥", "yuan" => "￥", "grivna" => "₴", "rouble" => "ք", "frank" => "₣", "tenge" => "₸"]
$db  : mixed
Различные параметры, в основном из GLOBALS
$fpath  : mixed
Различные параметры, в основном из GLOBALS
$identity  : mixed
Различные параметры, в основном из GLOBALS
$iduser1  : mixed
Различные параметры, в основном из GLOBALS
$ivc  : mixed
Различные параметры, в основном из GLOBALS
$opts  : mixed
Различные параметры, в основном из GLOBALS
$params  : array<string|int, mixed>
Передача различных параметров
$rootpath  : string
Абсолютный путь
$skey  : mixed
Различные параметры, в основном из GLOBALS
$sqlname  : mixed
Различные параметры, в основном из GLOBALS
$tmzone  : mixed
Различные параметры, в основном из GLOBALS
__construct()  : mixed
Работает только с объектом.
courseInfo()  : mixed
Информация по Курсу валюты по id валюты
currencyConvert()  : float|int
Конвертация суммы в валюту
currencyConvertSpeka()  : array<string|int, mixed>
Конвертация массива спецификации
currencyInfo()  : array<string|int, mixed>
Информация по валюте
currencyList()  : array<string|int, mixed>
Массив валют и их курса
currencyLog()  : array<string|int, mixed>
Лог изменений валюты
currencyRevert()  : float|int
Обратное преобразование
delete()  : array<string|int, mixed>
Удаление записи
edit()  : int
Добавление/Изменение валюты
logit()  : bool
Логгирование изменения курса валюты

Constants

HTMLCODE

public mixed HTMLCODE = ["dollar" => "\$", "euro" => "€", "pound" => "£", "yen" => "¥", "yuan" => "￥", "grivna" => "₴", "rouble" => "ք", "frank" => "₣", "tenge" => "₸"]

Properties

$db

Различные параметры, в основном из GLOBALS

public mixed $db

$fpath

Различные параметры, в основном из GLOBALS

public mixed $fpath

$identity

Различные параметры, в основном из GLOBALS

public mixed $identity

$iduser1

Различные параметры, в основном из GLOBALS

public mixed $iduser1

$ivc

Различные параметры, в основном из GLOBALS

public mixed $ivc

$opts

Различные параметры, в основном из GLOBALS

public mixed $opts

$params

Передача различных параметров

public array<string|int, mixed> $params = []

$rootpath

Абсолютный путь

public string $rootpath

$skey

Различные параметры, в основном из GLOBALS

public mixed $skey

$sqlname

Различные параметры, в основном из GLOBALS

public mixed $sqlname

$tmzone

Различные параметры, в основном из GLOBALS

public mixed $tmzone

Methods

__construct()

Работает только с объектом.

public __construct() : mixed

Подключает необходимые файлы, задает первоначальные параметры Currency constructor.

Return values
mixed —

courseInfo()

Информация по Курсу валюты по id валюты

public courseInfo( $id) : mixed
Parameters
$id :
  • id курса валюты
Return values
mixed —

currencyConvert()

Конвертация суммы в валюту

public static currencyConvert( $summa,  $idcourse[, bool $symbol = false ][, bool $format = false ][, bool $round = true ]) : float|int
Parameters
$summa :
  • сумма, которую надо конвертировать
$idcourse :
  • id курса валюты ( из лога )
$symbol : bool = false
  • добавлять к сумме символ валюты или написание (если символ не указан)
$format : bool = false
$round : bool = true
Return values
float|int —

currencyConvertSpeka()

Конвертация массива спецификации

public static currencyConvertSpeka([array<string|int, mixed> $speka = [] ], int $idcourse[, array<string|int, mixed> $sumFields = [] ][, bool $symbol = false ]) : array<string|int, mixed>
Parameters
$speka : array<string|int, mixed> = []
  • массив для конвертации
$idcourse : int
  • id курса валюты (из лога)
$sumFields : array<string|int, mixed> = []
  • дополнительные ключи, относящиеся к валютам, кроме ['summa','price','price_in','nds']
$symbol : bool = false
  • добавлять к сумме символ валюты или написание (если символ не указан)
Return values
array<string|int, mixed> —

currencyInfo()

Информация по валюте

public currencyInfo([int|null $id = NULL ]) : array<string|int, mixed>
Parameters
$id : int|null = NULL
  • id валюты
Return values
array<string|int, mixed> —

currencyList()

Массив валют и их курса

public currencyList([int|null $id = NULL ]) : array<string|int, mixed>
Parameters
$id : int|null = NULL
  • если указано, то будет выведен массив для конкретной валюты
Return values
array<string|int, mixed> —

currencyLog()

Лог изменений валюты

public static currencyLog(int $idcurrency[, int $limit = 20 ]) : array<string|int, mixed>
Parameters
$idcurrency : int
  • id валюты
$limit : int = 20
  • ограничение записей
Return values
array<string|int, mixed> —

currencyRevert()

Обратное преобразование

public static currencyRevert( $summa,  $idcourse) : float|int
Parameters
$summa :
$idcourse :
Return values
float|int —

delete()

Удаление записи

public delete( $id) : array<string|int, mixed>
Parameters
$id :
Return values
array<string|int, mixed> —

edit()

Добавление/Изменение валюты

public edit( $id[, array<string|int, mixed> $params = [] ]) : int
Parameters
$id :
  • id валюты
$params : array<string|int, mixed> = []
  • параметры
Return values
int —

logit()

Логгирование изменения курса валюты

public logit([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []
Return values
bool —

Search results