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

Материал из Umicms
Перейти к:навигация, поиск
(Новая страница: «=Класс payment= == Описание == Класс является абстрактным - базовый класс для способов оплаты. К…»)
 
 
(не показаны 2 промежуточные версии 1 участника)
Строка 9: Строка 9:
 
== Методы ==
 
== Методы ==
  
=== getName() ===
+
=== create() ===
  
Метод  <span style="font-weight:bold">getName()</span> получает название скидки
+
Метод  <span style="font-weight:bold">create()</span> создает объект способа оплаты нужного типа(класса)
  
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
  отсутсвуют
+
  iUmiObject<span style="font-weight:bold"> $paymentTypeObject</span>:
<p>'''Результат:'''String название скидки</p>
+
объект представляющий тип оплаты
 +
<p>'''Результат:'''объект представляющий способ оплаты</p>
 
<br/>
 
<br/>
  
=== setName() ===
+
=== get() ===
  
Метод <span style="font-weight:bold">setName()</span> изменяет название скидки
+
Метод <span style="font-weight:bold">get()</span> получает объект способа оплаты. Вызывается внутри метода create().
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
  String<span style="font-weight:bold"> $name</span>:
+
  int<span style="font-weight:bold"> $objectId</span>:
новое название скидки
+
идентификатор объекта способа оплаты
 +
order<span style="font-weight:bold"> $order=null</span>:
 +
объект заказ
 
<p>'''Результат:''' </p>
 
<p>'''Результат:''' </p>
 
<br/>
 
<br/>
  
=== getDiscountRules() ===
+
=== getList() ===
  
Метод <span style="font-weight:bold">getDiscountRules()</span> получает список правил скидки
+
Метод <span style="font-weight:bold">getList()</span> получает список способов оплаты
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
 
  отсутствуют
 
  отсутствуют
<p>'''Результат:'''array список правил скидки (массив объектов класса discountRule)</p>
+
<p>'''Результат:'''array список способов оплаты</p>
 
<br/>
 
<br/>
  
=== appendDiscountRule()===
+
=== getResponseOrderId()===
  
Метод <span style="font-weight:bold">appendDiscountRule()</span> добавляет правило скидки
+
Метод <span style="font-weight:bold">getResponseOrderId()</span> ищет идентификатор заказа в ответе платежной системы.
  
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
 
  discountRule<span style="font-weight:bold"> $discountRule</span>:
 
  discountRule<span style="font-weight:bold"> $discountRule</span>:
 
правило скидки
 
правило скидки
<p>'''Результат:'''</p>
+
<p>'''Результат:'''Integer идентификатор заказа либо boolean false</p>
 
<br/>
 
<br/>
  
=== getDiscountModificator()===
+
=== getCodeName()===
  
Метод <span style="font-weight:bold">getDiscountModificator()</span> получает модификатор цены скидки
+
Метод <span style="font-weight:bold">getCodeName()</span> получает строковый идентификатор типа оплаты
 
<p>'''Параметры:''' </p>
 
<p>'''Параметры:''' </p>
 
  отсутствуют
 
  отсутствуют
<p>'''Результат:''' объект класса discountModificator - модификатор цены</p>
+
<p>'''Результат:''' string строковый идентификатор типа оплаты или boolean false</p>
 
<br/>
 
<br/>
  
=== setDiscountModificator() ===
+
=== getOrderId() ===
  
Метод <span style="font-weight:bold">setDiscountModificator()</span> устанавливает модификатор цены скидки
+
Метод <span style="font-weight:bold">getOrderId()</span> ищет идентификатор заказа в параметре специфичном для платежной системы. Здесь метод всегда возвращает false. Данную функцию необходимо переопредилить  в файле платежной системы.
 
<p>'''Параметры:''' </p>  
 
<p>'''Параметры:''' </p>  
  discountModificator<span style="font-weight:bold"> $discountModificator</span>:
+
  отсутствуют
модификатор цены скидки
+
<p>'''Результат:''' boolean false</p>
<p>'''Результат:''' </p>
 
 
<br/>
 
<br/>
  
=== recalcPrice() ===
+
Также, в данном классе имеется три абстрактных метода:
 +
*process()
 +
*validate()
 +
*poll()
  
Метод <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() ===
+
Другие статьи по классам 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>[[Класс emarketTop модуля 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:24, 16 июля 2018

Класс payment

Описание

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


Методы

create()

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

Параметры:

iUmiObject $paymentTypeObject:

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

Результат:объект представляющий способ оплаты


get()

Метод get() получает объект способа оплаты. Вызывается внутри метода create().

Параметры:

int $objectId:

идентификатор объекта способа оплаты

order $order=null:

объект заказ

Результат:


getList()

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

Параметры:

отсутствуют

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


getResponseOrderId()

Метод getResponseOrderId() ищет идентификатор заказа в ответе платежной системы.

Параметры:

discountRule $discountRule:

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

Результат:Integer идентификатор заказа либо boolean false


getCodeName()

Метод getCodeName() получает строковый идентификатор типа оплаты

Параметры:

отсутствуют

Результат: string строковый идентификатор типа оплаты или boolean false


getOrderId()

Метод getOrderId() ищет идентификатор заказа в параметре специфичном для платежной системы. Здесь метод всегда возвращает false. Данную функцию необходимо переопредилить в файле платежной системы.

Параметры:

отсутствуют

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


Также, в данном классе имеется три абстрактных метода:

  • process()
  • validate()
  • poll()

Определяются, соответственно, в дочерних классах


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

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