energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: CurrencyConverter

Source Location: /modules/shop/components/CurrencyConverter.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --CurrencyConverter

Конвертер валют


Author(s):

  • dr.Pavka

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 21]
Конвертер валют



Tags:

author:   dr.Pavka


[ Top ]


Class Variables

static $instance =

[line 29]

Инстанс класса



Tags:

access:   private

Type:   CurrencyConverter


[ Top ]

$currencies =

[line 53]

Кэш валют



Tags:

access:   private

Type:   array


[ Top ]

$tableName =

[line 37]

Имя таблицы



Tags:

access:   private

Type:   string


[ Top ]

$transTableName =

[line 45]

Имя таблицы переводов



Tags:

access:   private

Type:   string


[ Top ]



Class Methods


static method getInstance [line 88]

static CurrencyConverter getInstance( )

Возвращает Instance объекта



Tags:

access:   public


[ Top ]

constructor __construct [line 60]

void __construct( )

Конструктор класса



Tags:

access:   public


Overrides DBWorker::__construct() (Конструктор класса.)

[ Top ]

method convert [line 139]

float convert( currencyValue $value, currencyID $currID, [currIDFrom $currIDFrom = false])

Конвертирует из одной валюты в другую



Tags:

access:   public


Parameters:

currencyValue   $value   float
currencyID   $currID   int идентификатор валюты в которую нужно произвести конвертацию
currIDFrom   $currIDFrom   int идентифкатор валюты которую нужно конвертировать

[ Top ]

method format [line 168]

string format( float $value, int $currID)

Форматирует переданное в параметре значение в формат валюты



Tags:

access:   public


Parameters:

float   $value  
int   $currID   currID

[ Top ]

method getCurrencies [line 229]

array getCurrencies( )

Возвращает список идентификаторов валют



Tags:

access:   public


[ Top ]

method getCurrent [line 210]

int getCurrent( )

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



Tags:

access:   public


[ Top ]

method getDefault [line 102]

int getDefault( )

Возвращает идентификатор валюты по умолчанию



Tags:

access:   public


[ Top ]

method getIDByAbbr [line 180]

int getIDByAbbr( string $abbr)

Возвращает идентификатор валюты по переданной аббревиатуре



Tags:

access:   public


Parameters:

string   $abbr  

[ Top ]

method getMain [line 110]

void getMain( )



Tags:

access:   public


[ Top ]

method getRate [line 125]

int getRate( $currID)

Возвращает курс для переданного идентификатора валюты



Tags:

access:   public


Parameters:

   $currID  

[ Top ]

method setCurrent [line 196]

void setCurrent( $currencyID)

Устанавливает идентификатор текущей валюты



Tags:

access:   public


Parameters:

   $currencyID  

[ Top ]

В создании документации нам помог: phpDocumentor