Класс emarketTop модуля emarket — различия между версиями

Материал из Umicms
Перейти к:навигация, поиск
(Новая страница: «=Класс emarketTop= == Описание == Класс emarketTop позволяет вести статистику по интернет-магазину. И…»)
 
 
(не показано 5 промежуточных версий 1 участника)
Строка 9: Строка 9:
 
== Методы ==
 
== Методы ==
  
−
=== getName() ===
+
=== addOrder() ===
  
−
Метод  <span style="font-weight:bold">getName()</span> получает название скидки
+
Метод  <span style="font-weight:bold">addOrder()</span> добавляет в таблицу cms3_emarket_top статистику по заказу
  
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
−
  отсутсвуют
+
  order<span style="font-weight:bold"> $order</span>:
−
<p>'''Результат:'''String название скидки</p>
+
объект заказ
 +
<p>'''Результат:'''</p>
 
<br/>
 
<br/>
  
−
=== setName() ===
+
=== delOrder() ===
  
−
Метод <span style="font-weight:bold">setName()</span> изменяет название скидки
+
Метод <span style="font-weight:bold">delOrder()</span> удаляет из таблицы cms3_emarket_top
 +
статистику по заказу
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
−
  String<span style="font-weight:bold"> $name</span>:
+
  order<span style="font-weight:bold"> $order</span>:
−
новое название скидки
+
объект заказ
 
<p>'''Результат:''' </p>
 
<p>'''Результат:''' </p>
 
<br/>
 
<br/>
  
−
=== getDiscountRules() ===
+
=== getTop() ===
  
−
Метод <span style="font-weight:bold">getDiscountRules()</span> получает список правил скидки
+
Метод <span style="font-weight:bold">getTop()</span> получает топ популярных товаров
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
−
  отсутствуют
+
  array<span style="font-weight:bold"> $range</span>:
−
<p>'''Результат:'''array список правил скидки (массив объектов класса discountRule)</p>
+
здесь необходимо передать массив, состоящий из двух элементов с ключами fromDate и toDate
−
<br/>
+
int<span style="font-weight:bold"> $numberItems</span>:
−
 
+
количество возвращаемых популярных товаров
−
=== appendDiscountRule()===
+
  string<span style="font-weight:bold"> $sort</span>:
−
 
+
поле сортировки
−
Метод <span style="font-weight:bold">appendDiscountRule()</span> добавляет правило скидки
+
<p>'''Результат:'''array список популярных товаров</p>
−
 
 
−
<p>'''Параметры:''' </p>
 
−
  discountRule<span style="font-weight:bold"> $discountRule</span>:
 
−
правило скидки
 
−
<p>'''Результат:'''</p>
 
 
<br/>
 
<br/>
  
−
=== getDiscountModificator()===
+
=== clearTableTop()===
  
−
Метод <span style="font-weight:bold">getDiscountModificator()</span> получает модификатор цены скидки
+
Метод <span style="font-weight:bold">clearTableTop()</span> удалит всю статистику
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
 
  отсутствуют
 
  отсутствуют
−
<p>'''Результат:''' объект класса discountModificator - модификатор цены</p>
+
<p>'''Результат:'''</p>
 
<br/>
 
<br/>
  
−
=== setDiscountModificator() ===
+
=== allOrdersRecalculate() ===
  
−
Метод <span style="font-weight:bold">setDiscountModificator()</span> устанавливает модификатор цены скидки
+
Метод <span style="font-weight:bold">allOrdersRecalculate()</span>
 +
вернет количество заказов со статусом "готов", оформленных до текущей даты
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
−
  discountModificator<span style="font-weight:bold"> $discountModificator</span>:
+
  отсутствуют
−
модификатор цены скидки
 
−
<p>'''Результат:''' </p>
 
−
<br/>
 
  
−
=== recalcPrice() ===
+
<p>'''Результат:'''int количество заказов</p>
−
 
 
−
Метод <span style="font-weight:bold">recalcPrice()</span> выполняет пересчет цены $price
 
−
<p>'''Параметры:''' </p>
 
−
Float<span style="font-weight:bold"> $price</span>:
 
−
цена
 
−
<p>'''Результат:''' Float пересчитанная цена с учетом скидки</p>
 
 
<br/>
 
<br/>
  
−
=== get() ===
 
  
−
Метод <span style="font-weight:bold">get()</span> получает экземпляр скидки по ее id
+
== Дополнительно ==
−
<p>'''Параметры:''' </p>
 
−
Integer<span style="font-weight:bold"> $discountId</span>:
 
−
id скидки
 
−
<p>'''Результат:'''discount  объект скидки, экземпляр класса-потомка discount </p>
 
−
<br/>
 
  
−
=== add() ===
+
Другие статьи по классам emarket:
  
−
Метод <span style="font-weight:bold">add()</span> создает новую скидку
+
<ul>
−
<p>'''Параметры:''' </p>  
+
<li>[[Класс customer модуля emarket]]</li>
−
String<span style="font-weight:bold"> $discountName</span>:
+
<li>[[Класс order модуля emarket]]</li>
−
название скидки<br/>  
+
<li>[[Класс orderItem модуля emarket]]</li>
−
Integer<span style="font-weight:bold"> $discountTypeId</span>:
+
<li>[[Класс optionedOrderItem модуля emarket]]</li>
−
тип скидки
+
<li>[[Класс delivery модуля emarket]]</li>
−
<p>'''Результат:'''discount скидка </p>
+
<li>[[Класс discount модуля emarket]]</li>
−
<br/>
+
<li>[[Дочерние классы класса delivery модуля emarket]]</li>
−
 
+
<li>[[Класс discountModificator и его дочерние классы (модуль emarket) ]]</li>
−
=== getTypeId() ===
+
<li>[[Дочерние классы класса discount модуля emarket]]</li>
−
 
+
<li>[[Класс discountRule и его дочерние классы (модуль emarket) ]]</li>
−
Метод <span style="font-weight:bold">getTypeId()</span> получает id типа скидки по ее идентификатору
+
<li>[[Класс payment модуля emarket ]]</li>
−
<p>'''Параметры:''' </p>  
+
<li>[[Класс currencyUpdater модуля emarket ]]</li>
−
String<span style="font-weight:bold"> $discountCode</span>:
+
</ul>
−
строковой идентификатор типа скидки
+
[[category:Модуль Интернет магазин]]
−
<p>'''Результат:''' Integer id типа скидки или false, если тип получить не удалось</p>
 
−
<br/>
 
−
 
 
−
=== init() ===
 
−
 
 
−
Метод <span style="font-weight:bold">init()</span> инициализирует систему скидок
 
−
<p>'''Параметры:''' </p>  
 
−
отсутствуют
 
−
<p>'''Результат:''' </p>
 

Текущая версия на 13:28, 16 июля 2018

Класс emarketTop

Описание

Класс emarketTop позволяет вести статистику по интернет-магазину. Исходный код класса находится в файле classes\modules\emarket\classes\stat\emarketTop.php


Методы

addOrder()

Метод addOrder() добавляет в таблицу cms3_emarket_top статистику по заказу

Параметры: 

order $order:

объект заказ

Результат:


delOrder()

Метод delOrder() удаляет из таблицы cms3_emarket_top статистику по заказу

Параметры: 

order $order:

объект заказ

Результат:


getTop()

Метод getTop() получает топ популярных товаров

Параметры: 

array $range:

здесь необходимо передать массив, состоящий из двух элементов с ключами fromDate и toDate 

int $numberItems:

количество возвращаемых популярных товаров 

string $sort:

поле сортировки

Результат:array список популярных товаров


clearTableTop()

Метод clearTableTop() удалит всю статистику

Параметры: 

отсутствуют

Результат:


allOrdersRecalculate()

Метод allOrdersRecalculate() вернет количество заказов со статусом "готов", оформленных до текущей даты

Параметры: 

отсутствуют

Результат:int количество заказов



Дополнительно

Другие статьи по классам emarket:

Источник — «https://wiki.umisoft.ru/index.php?title=Класс_emarketTop_модуля_emarket&oldid=8525»