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

Материал из Umicms
Перейти к:навигация, поиск
 
(не показано 17 промежуточных версий 1 участника)
Строка 6: Строка 6:
 
Исходный код класса находится в файле classes\modules\emarket\classes\discount\discount.php
 
Исходный код класса находится в файле classes\modules\emarket\classes\discount\discount.php
  
−
== Свойства класса ==
 
  
−
$items, хранит информацию о предметах в заказе или корзине
+
== Методы ==
−
<source lang="php">
+
 
−
protected $items = Array();
+
=== getName() ===
−
</source>
+
 
 +
Метод  <span style="font-weight:bold">getName()</span> получает название скидки
 +
 
 +
<p>'''Параметры:''' </p>
 +
отсутсвуют
 +
<p>'''Результат:'''String название скидки</p>
 +
<br/>
 +
 
 +
=== setName() ===
 +
 
 +
Метод <span style="font-weight:bold">setName()</span> изменяет название скидки
 +
<p>'''Параметры:''' </p>  
 +
String<span style="font-weight:bold"> $name</span>:
 +
новое название скидки
 +
<p>'''Результат:''' </p>
 +
<br/>
 +
 
 +
=== getDiscountRules() ===
  
−
$actualPrice хранит  актуальную цену на заказ(с учетом скидки)
+
Метод <span style="font-weight:bold">getDiscountRules()</span> получает список правил скидки
−
<source lang="php">
+
<p>'''Параметры:''' </p>
−
protected $actualPrice;
+
отсутствуют
−
</source>
+
<p>'''Результат:'''array список правил скидки (массив объектов класса discountRule)</p>
 +
<br/>
  
 +
=== appendDiscountRule()===
  
−
== Методы ==
+
Метод <span style="font-weight:bold">appendDiscountRule()</span> добавляет правило скидки
 +
 
 +
<p>'''Параметры:''' </p>
 +
discountRule<span style="font-weight:bold"> $discountRule</span>:
 +
правило скидки
 +
<p>'''Результат:'''</p>
 +
<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/>
  
−
=== create() ===
+
=== recalcPrice() ===
  
−
Метод <span style="font-weight:bold">create()</span> создает объект доставки нужного типа(класса).
+
Метод <span style="font-weight:bold">recalcPrice()</span> выполняет пересчет цены $price
−
Сначала создается экземпляр umiObject, затем на его основании создается экземпляр нужного класса(типа доставки) с помощью метода get()
+
<p>'''Параметры:''' </p>  
−
<p>'''Параметры:''' </p><br/>  
+
  Float<span style="font-weight:bold"> $price</span>:
−
  umiObject<span style="font-weight:bold"> $deliveryTypeObject</span>:
+
цена
−
объект тип доставки
+
<p>'''Результат:''' Float пересчитанная цена с учетом скидки</p>
−
<p>'''Результат:'''$object объект доставки нужного типа</p>
+
<br/>
  
 
=== get() ===
 
=== get() ===
  
−
Метод <span style="font-weight:bold">get()</span> получает объект доставки нужного типа(класса)
+
Метод <span style="font-weight:bold">get()</span> получает экземпляр скидки по ее id
−
<p>'''Параметры:''' </p><br/>  
+
<p>'''Параметры:''' </p>
−
  iUmiObject<span style="font-weight:bold"> $objectId</span>:
+
Integer<span style="font-weight:bold"> $discountId</span>:
−
идентификатор umiObject объекта доставки
+
id скидки
−
<p>'''Результат:'''$object объект доставки нужного типа </p>
+
<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() ===
  
−
=== getList() ===
+
Метод <span style="font-weight:bold">getTypeId()</span> получает id типа скидки по ее идентификатору
 +
<p>'''Параметры:''' </p>
 +
String<span style="font-weight:bold"> $discountCode</span>:
 +
строковой идентификатор типа скидки
 +
<p>'''Результат:''' Integer id типа скидки или false, если тип получить не удалось</p>
 +
<br/>
  
−
Метод <span style="font-weight:bold">getList()</span> получает список объектов способов доставки
+
=== init() ===
−
<p>'''Параметры:''' </p><br/>
 
−
boolean<span style="font-weight:bold"> $selfDeliveryOnly=false</span>:
 
−
только самовывоз<br/>
 
  
−
<p>'''Результат:'''array результат выборки объектов способов доставки</p>
+
Метод <span style="font-weight:bold">init()</span> инициализирует систему скидок
 +
<p>'''Параметры:''' </p>
 +
отсутствуют
 +
<p>'''Результат:''' </p>
  
−
=== validate()===
 
  
−
Метод <span style="font-weight:bold">validate()</span> подтверждает заказ в качестве текущего.
+
== Дополнительно ==
−
Метод является абстрактным и определяется в дочерних классах
 
−
<p>'''Параметры:''' </p><br/>
 
−
order<span style="font-weight:bold"> $order</span>:
 
−
объект заказ<br/>
 
  
−
=== getDeliveryPrice()===
+
Другие статьи по классам emarket:
  
−
Метод <span style="font-weight:bold">getDeliveryPrice()</span> получает цену данного способа доставки
+
<ul>
−
Метод является абстрактным и определяется в дочерних классах
+
<li>[[Класс customer модуля emarket]]</li>
−
<p>'''Параметры:''' </p><br/>  
+
<li>[[Класс order модуля emarket]]</li>
−
order<span style="font-weight:bold"> $order</span>:
+
<li>[[Класс orderItem модуля emarket]]</li>
−
объект заказ<br/>
+
<li>[[Класс optionedOrderItem модуля emarket]]</li>
 +
<li>[[Класс delivery модуля emarket]]</li>
 +
<li>[[Дочерние классы класса delivery модуля emarket]]</li>
 +
<li>[[Класс discountModificator и его дочерние классы (модуль emarket) ]]</li>
 +
<li>[[Дочерние классы класса discount модуля emarket]]</li>
 +
<li>[[Класс discountRule и его дочерние классы (модуль emarket) ]]</li>
 +
<li>[[Класс payment модуля emarket ]]</li>
 +
<li>[[Класс emarketTop модуля emarket ]]</li>
 +
<li>[[Класс currencyUpdater модуля emarket ]]</li>
 +
</ul>
 +
[[category:Модуль Интернет магазин]]

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

Класс discount

Описание

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


Методы

getName()

Метод getName() получает название скидки

Параметры: 

отсутсвуют

Результат:String название скидки


setName()

Метод setName() изменяет название скидки

Параметры: 

String $name:

новое название скидки

Результат:


getDiscountRules()

Метод getDiscountRules() получает список правил скидки

Параметры: 

отсутствуют

Результат:array список правил скидки (массив объектов класса discountRule)


appendDiscountRule()

Метод appendDiscountRule() добавляет правило скидки

Параметры: 

discountRule $discountRule:

правило скидки

Результат:


getDiscountModificator()

Метод getDiscountModificator() получает модификатор цены скидки

Параметры: 

отсутствуют

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


setDiscountModificator()

Метод setDiscountModificator() устанавливает модификатор цены скидки

Параметры: 

discountModificator $discountModificator:

модификатор цены скидки

Результат:


recalcPrice()

Метод recalcPrice() выполняет пересчет цены $price

Параметры: 

Float $price:

цена

Результат: Float пересчитанная цена с учетом скидки


get()

Метод get() получает экземпляр скидки по ее id

Параметры: 

Integer $discountId:

id скидки

Результат:discount объект скидки, экземпляр класса-потомка discount


add()

Метод add() создает новую скидку

Параметры: 

String $discountName:
название скидки
 
Integer $discountTypeId:

тип скидки

Результат:discount скидка


getTypeId()

Метод getTypeId() получает id типа скидки по ее идентификатору

Параметры: 

String $discountCode:

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

Результат: Integer id типа скидки или false, если тип получить не удалось


init()

Метод init() инициализирует систему скидок

Параметры: 

отсутствуют

Результат:


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

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

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