Разработка:storages/accounts - История изменений

Polikarpov в 13:31, 1 декабря 2014

2014-12-01T13:31:45Z

Polikarpov: переименовал «Разработка: storages/accounts» в «Разработка:storages/accounts»

2014-11-18T05:55:09Z

переименовал «Разработка: storages/accounts» в «Разработка:storages/accounts»

Polikarpov в 06:50, 17 ноября 2014

2014-11-17T06:50:07Z

Polikarpov: Новая страница: «{{Infobox_Plugin | name = accounts | type = storages }} ===Таблица в базе данных=== ''accounts'' - справочник счетов для уче...»

2014-11-17T06:48:49Z

Новая страница: «{{Infobox_Plugin | name = accounts | type = storages }} ===Таблица в базе данных=== ''accounts'' - справочник счетов для уче...»

Новая страница

{{Infobox_Plugin
| name = accounts
| type = storages
}}

===Таблица в базе данных===
''accounts'' - справочник счетов для учета биллинговых операций. Все операции по счетам хранятся в справочнике [[Разработка:storages/accentryes]].

====Подробный формат полей в таблице:====
* id - идентификатор счета.
* plugintype - тип плагина-владельца счета.
* plugincode - код плагина владельца счета.
* code - код объекта в плагине (например, основной и бонусный счет).
* objectid - id объекта, к которому привязан счет.
* type - тип счета (asset - активный счет, passive - пассивный счет)
* createdate - UTC создания счета
* md5code - уникальный код счета для импорта-экспорта (если не задан - инициализируем уникальным значением на основе md5 от времени генерации, параметров счета и случайного числа).
* name - название счета (удобно в некоторых случаях для отображения, без обращения к плагину-владельцу).
* status - для мягкого удаления.

===Дополнительные методы:===

====```Публичные методы:```====

====```add_account($ptype, $pcode, $objectid, $code, $type, $name, $params, $status = 'active')```====

Добавляет новый счет в справочник.

''Аргументы:''
* $ptype(string) - Тип плагина-владельца.
* $pcode(string) - Код плагина-владельца.
* $objectid(int) - ID объекта - владельца.
* $code(string) - код счета (main , additional и тп.).
* $type(string) - тип счета (asset, passive и тп.).
* $name(string) - имя счета.
* $params(string) - параметры для определения уникальности счета.
* $status(string) - статус счета.

''Возвращаемые значения:''
* object - объект счета.
* bool - false в случае ошибки.
''Структура работы:''
# Создаем и заполняем объект для добавления в БД
# Проверяем, есть ли в БД счет с такими же параметрами? ( md5 от $params ). Если счет найден, то метод возвращает false.
# Производим добавление в БД, Возвращаем результат выполнения.

====```find_accounts($begindate = 0, $enddate = 0, $ptype = '', $pcode = '', $objectid = 0, $code = '', $type = '', $name = '', $params = '', $status = '')```====

Возвращает счета, удовлетворяющие переданным параметрам. Если статус не указан, то фильтрует удаленные записи.

''Аргументы:''
* $begindate(int) - начальная дата создания договора. Unixtime. Возвращает записи, старше или равные этой дате
* $enddate(int) - конечная дата создания договора. Unixtime. Возвращает записи, младше или равные этой дате. В совокупности с первым параметром позволяют установить временной интервал.
* $ptype(string) - тип плагина-владельца. (storage, moodlib, im ...)
* $pcode(string) - код плагина-владельца.
* $objectid(int) - id объекта-владельца.
* $code(string) - код счета (main , additional и тп.).
* $type(string) - тип счета (asset, passive и тп.).
* $name(string) - имя счета.
* $params(string) - уникальные параметры счета, Фильтрация по полю md5code. Метод сам преобразует параметры в md5 строку.
* $status(string) - статус счета. Если не указан, то возвращает все не удаленные записи, Если параметр передан, то возвращает записи только указанного статуса.
''Возвращаемые значения:''
* array - массив объектов, удовлетворяющих критериям.
* bool - false в случае ошибки.
''Структура работы:''
# Метод формирует фрагмент sql - запроса.
# С помощью метода get_records_select получаем результат поиска в виде массива объектов.

====```Приватные методы:```====

====```get_md5 ($str)```====

Возвращает md5-хэш из строки

''Аргументы:''
* $str(string) - строка параметров счета
''Возвращаемые значения:''
* string - md5-хэш

@@ Строка 25: / Строка 25: @@
 ===='''add_account($ptype, $pcode, $objectid, $code, $type, $name, $params, $status = 'active')'''====
-Добавляет новый счет в справочник.
+Добавить новый счет в Справочник на основе переданных данных
 ''Аргументы:''
@@ Строка 38: / Строка 38: @@
 ''Возвращаемые значения:''
-* object - объект счета.
+* int - id счета.
 * bool - false в случае ошибки.
 ''Структура работы:''
 # Создаем и заполняем объект для добавления в БД
-# Проверяем, есть ли в БД счет с такими же параметрами? ( md5 от $params ). Если счет найден, то метод  возвращает false.
+# Проверяем, есть ли в БД счет с такими же параметрами ( md5 от $params ). Если счет найден, то метод  возвращает false.
 # Производим добавление в БД, Возвращаем результат выполнения.
@@ Строка 61: / Строка 62: @@
 * $params(string) - уникальные параметры счета, Фильтрация по полю md5code. Метод сам преобразует параметры в md5 строку.
 * $status(string) - статус счета. Если не указан, то возвращает все не удаленные записи, Если параметр передан, то возвращает записи только указанного статуса.
 ''Возвращаемые значения:''
 * array - массив объектов, удовлетворяющих критериям.
 * bool - false в случае ошибки.
 ''Структура работы:''
 # Метод формирует фрагмент sql - запроса.
@@ Строка 70: / Строка 73: @@
 ===='''Приватные методы:'''====
-===='''get_md5 ($str)'''====
+===='''get_hash ($data)'''====
-Возвращает md5-хэш из строки
+Возвращает md5-хэш из строки или массива
 ''Аргументы:''
-* $str(string) - строка параметров счета
+* $data(string|array) - строка параметра счета, или массив параметоров
 ''Возвращаемые значения:''
 * string - md5-хэш

← Предыдущая	Версия 05:55, 18 ноября 2014
(нет различий)

@@ Строка 21: / Строка 21: @@
 ===Дополнительные методы:===
-====```Публичные методы:```====
+===='''Публичные методы:'''====
-====```add_account($ptype, $pcode, $objectid, $code, $type, $name, $params, $status = 'active')```====
+===='''add_account($ptype, $pcode, $objectid, $code, $type, $name, $params, $status = 'active')'''====
 Добавляет новый счет в справочник.
@@ Строка 46: / Строка 46: @@
-====```find_accounts($begindate = 0, $enddate = 0, $ptype = '', $pcode = '', $objectid = 0, $code = '', $type = '', $name = '', $params = '', $status = '')```====
+===='''find_accounts($begindate = 0, $enddate = 0, $ptype = '', $pcode = '', $objectid = 0, $code = '', $type = '', $name = '', $params = '', $status = '')'''====
 Возвращает счета, удовлетворяющие переданным параметрам. Если статус не указан, то фильтрует удаленные записи.
@@ Строка 68: / Строка 68: @@
 # С помощью метода get_records_select получаем результат поиска в виде массива объектов.
-====```Приватные методы:```====
+===='''Приватные методы:'''====
-====```get_md5 ($str)```====
+===='''get_md5 ($str)'''====
 Возвращает md5-хэш из строки