Класс discountRule и его дочерние классы (модуль emarket) — различия между версиями

Материал из Umicms
Перейти к:навигация, поиск
Строка 272: Строка 272:
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
 
отсутсвтвуют
 
отсутсвтвуют
 +
<p>'''Результат:''' boolean true|false</p>
 +
 +
 +
=== validateOrder()===
 +
 +
 +
Метод <span style="font-weight:bold">validateOrder()</span> проверяет применимо ли данное правило к заказу.
 +
 +
<p>'''Параметры:''' </p>
 +
order<span style="font-weight:bold"> $order</span>:
 +
объект представляющий заказ
 +
<p>'''Результат:''' boolean true|false</p>
 +
 +
 +
=== validateItem()===
 +
 +
 +
Метод <span style="font-weight:bold">validateItem()</span> проверяет применимо ли данное правило к товару в каталоге.
 +
 +
<p>'''Параметры:''' </p>
 +
iUmiHierarchyElement<span style="font-weight:bold"> $element</span>:
 +
страница товара в каталоге
 
<p>'''Результат:''' boolean true|false</p>
 
<p>'''Результат:''' boolean true|false</p>

Версия 14:12, 21 апреля 2014

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

Описание

Класс является абстрактным - базовый класс для правил скидок. Классами наследниками являются классы, представляющие типы правил:

  • На определенные товары
  • На временной промежуток
  • На сумму покупок пользователя
  • На группу пользователей
  • На пользователей
  • На связанные товары
  • На сумму заказа

Исходный код класса находится в файле classes\modules\emarket\classes\discount\discountRule.php


Методы

create()

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

Параметры:

discount $discount:

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

umiObject $ruleTypeObject:

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

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


get()

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

Параметры:

int $modObjectId:

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

discount $discount:

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

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


getList()

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

Параметры:

int $discountTypeId=false:

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

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


Интерфейсы

Здесь также описаны два интерфейса:

  • orderDiscountRule, в котором описан метод validateOrder()
  • itemDiscountRule, в котором описан validateItem()


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

Стандартно у класса discountRule имеются следующие дочерние классы:

  • usersDiscountRule
  • userGroupsDiscountRule
  • relatedItemsDiscountRule
  • orderPriceDiscountRule
  • itemsDiscountRule
  • dateRangeDiscountRule
  • allOrdersPricesDiscountRule


Каждый из дочерних классов реализует либо оба вышеуказанных интерфейса, либо один из них:

Интерфейсы/классы

usersDiscountRule

userGroupsDiscountRule

relatedItemsDiscountRule

orderPriceDiscountRule

itemsDiscountRule

dateRangeDiscountRule

allOrdersPricesDiscountRule

orderDiscountRule

+

+

-

+

-

+

+

itemDiscountRule

+

+

+

-

+

+

+

В дочерних классах могут быть определены, соответственно - validateOrder(),validateItem(), оба или один из них. Также, в некоторых классах имеется метод validate()

Методы/классы

usersDiscountRule

userGroupsDiscountRule

relatedItemsDiscountRule

orderPriceDiscountRule

itemsDiscountRule

dateRangeDiscountRule

allOrdersPricesDiscountRule

validateItem()

+

+

+

-

+

+

+

validateOrder()

+

+

-

+

-

+

+

validate()

+

+

-

-

-

+

-

validate()

Метод validate() проверяет применимо ли данное правило к заказу или товару в каталоге. Он используется в тех классах, в которых описаны оба метода - validateOrder() и validateItem(), и просто вызывается внутри них

Параметры:

отсутсвтвуют

Результат: boolean true|false


validateOrder()

Метод validateOrder() проверяет применимо ли данное правило к заказу.

Параметры:

order $order:

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

Результат: boolean true|false


validateItem()

Метод validateItem() проверяет применимо ли данное правило к товару в каталоге.

Параметры:

iUmiHierarchyElement $element:

страница товара в каталоге

Результат: boolean true|false