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

Материал из Umicms
Перейти к:навигация, поиск
(Новая страница: «=Класс discountModificator и его дочерние классы= == Описание == Класс является абстрактным - базовый…»)
 
Строка 32: Строка 32:
 
<br/>
 
<br/>
  
=== getDiscountRules() ===
+
=== getList() ===
  
Метод <span style="font-weight:bold">getDiscountRules()</span> получает список правил скидки
+
Метод <span style="font-weight:bold">getList()</span> получает список доступных можификаторов типа скидки
<p>'''Параметры:''' </p>
+
<p>'''Параметры:''' </p>  
  отсутствуют
+
  int<span style="font-weight:bold"> $discountTypeId=false</span>:
<p>'''Результат:'''array список правил скидки (массив объектов класса discountRule)</p>
+
идентификатор типа скидки
 +
<p>'''Результат:'''array список модификаторов</p>
 
<br/>
 
<br/>
  
=== appendDiscountRule()===
+
=== recalcPrice()===
  
Метод <span style="font-weight:bold">appendDiscountRule()</span> добавляет правило скидки
+
Метод <span style="font-weight:bold">recalcPrice()</span> пересчитывает цену с учетом модификатора.
 +
Метод является абстрактным и определяется в дочерних классах
  
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
  discountRule<span style="font-weight:bold"> $discountRule</span>:
+
  int<span style="font-weight:bold"> $price</span>:
правило скидки
+
цена на товар, заказа и т.п.
 
<p>'''Результат:'''</p>
 
<p>'''Результат:'''</p>
 
<br/>
 
<br/>
  
=== getDiscountModificator()===
+
== Дочерние классы ==
 
 
Метод <span style="font-weight:bold">getDiscountModificator()</span> получает модификатор цены скидки
 
<p>'''Параметры:''' </p>
 
отсутствуют
 
<p>'''Результат:''' объект класса discountModificator - модификатор цены</p>
 
<br/>
 
 
 
=== setDiscountModificator() ===
 
 
 
Метод <span style="font-weight:bold">setDiscountModificator()</span> устанавливает модификатор цены скидки
 
<p>'''Параметры:''' </p>
 
discountModificator<span style="font-weight:bold"> $discountModificator</span>:
 
модификатор цены скидки
 
<p>'''Результат:''' </p>
 
<br/>
 
 
 
=== recalcPrice() ===
 
 
 
Метод <span style="font-weight:bold">recalcPrice()</span> выполняет пересчет цены $price
 
<p>'''Параметры:''' </p>
 
Float<span style="font-weight:bold"> $price</span>:
 
цена
 
<p>'''Результат:''' Float пересчитанная цена с учетом скидки</p>
 
<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() ===
 
 
 
Метод <span style="font-weight:bold">add()</span> создает новую скидку
 
<p>'''Параметры:''' </p>
 
String<span style="font-weight:bold"> $discountName</span>:
 
название скидки<br/>
 
Integer<span style="font-weight:bold"> $discountTypeId</span>:
 
тип скидки
 
<p>'''Результат:'''discount скидка </p>
 
<br/>
 
 
 
=== getTypeId() ===
 
 
 
Метод <span style="font-weight:bold">getTypeId()</span> получает id типа скидки по ее идентификатору
 
<p>'''Параметры:''' </p>
 
String<span style="font-weight:bold"> $discountCode</span>:
 
строковой идентификатор типа скидки
 
<p>'''Результат:''' Integer id типа скидки или false, если тип получить не удалось</p>
 
<br/>
 
 
 
=== init() ===
 
 
 
Метод <span style="font-weight:bold">init()</span> инициализирует систему скидок
 
<p>'''Параметры:''' </p>
 
отсутствуют
 
<p>'''Результат:''' </p>
 

Версия 15:27, 16 апреля 2014

Класс discountModificator и его дочерние классы

Описание

Класс является абстрактным - базовый класс для модификаторов цен скидок. Классами наследниками являются классы, представляющие типы модификаторов цен - процентный модификатор и абсолютный. Исходный код класса находится в файле classes\modules\emarket\classes\discount\discountModificator.php


Методы

create()

Метод create() создает объект скидки нужного типа(класса)

Параметры:

discount $discount:

объект представляющий собой скидку

umiObject $modTypeObject:

объект представляющий тип модификатора

Результат: объект модификатор цены скидки нужного типа


get()

Метод get() получает объект скидки

Параметры:

int $modObjectId:

идентификатор объекта модификатора скидки

discount $discount:

объект представляющий собой скидку

Результат: объект модификатор цены скидки нужного типа


getList()

Метод getList() получает список доступных можификаторов типа скидки

Параметры:

int $discountTypeId=false:

идентификатор типа скидки

Результат:array список модификаторов


recalcPrice()

Метод recalcPrice() пересчитывает цену с учетом модификатора. Метод является абстрактным и определяется в дочерних классах

Параметры:

int $price:

цена на товар, заказа и т.п.

Результат:


Дочерние классы