Класс payment модуля emarket — различия между версиями
Williwaw (обсуждение | вклад)  (Новая страница: «=Класс payment=  == Описание ==  Класс является абстрактным - базовый класс для способов оплаты. К…»)  | 
				Williwaw (обсуждение | вклад)   | 
				||
| Строка 9: | Строка 9: | ||
== Методы ==  | == Методы ==  | ||
| − | ===   | + | === create() ===  | 
| − | Метод  <span style="font-weight:bold">  | + | Метод  <span style="font-weight:bold">create()</span> создает объект способа оплаты нужного типа(класса)  | 
<p>'''Параметры:''' </p>  | <p>'''Параметры:''' </p>  | ||
| − | + |   iUmiObject<span style="font-weight:bold"> $paymentTypeObject</span>:  | |
| − | <p>'''Результат:'''  | + | объект представляющий тип оплаты  | 
| + | <p>'''Результат:'''объект представляющий способ оплаты</p>  | ||
<br/>  | <br/>  | ||
| − | ===   | + | === get() ===  | 
| − | Метод <span style="font-weight:bold">  | + | Метод <span style="font-weight:bold">get()</span> получает объект способа оплаты. Вызывается внутри метода create().  | 
<p>'''Параметры:''' </p>    | <p>'''Параметры:''' </p>    | ||
| − | + |   int<span style="font-weight:bold"> $objectId</span>:  | |
| − | + | идентификатор объекта способа оплаты  | |
| + |  order<span style="font-weight:bold"> $order=null</span>:  | ||
| + | объект заказ  | ||
<p>'''Результат:''' </p>  | <p>'''Результат:''' </p>  | ||
<br/>  | <br/>  | ||
| − | ===   | + | === getList() ===  | 
| − | Метод <span style="font-weight:bold">  | + | Метод <span style="font-weight:bold">getList()</span> получает список способов оплаты  | 
<p>'''Параметры:''' </p>  | <p>'''Параметры:''' </p>  | ||
  отсутствуют  |   отсутствуют  | ||
| − | <p>'''Результат:'''array список   | + | <p>'''Результат:'''array список способов оплаты</p>  | 
<br/>  | <br/>  | ||
| − | ===   | + | === getResponseOrderId()===  | 
| − | Метод <span style="font-weight:bold">  | + | Метод <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/>  | ||
| − | ===   | + | === getCodeName()===  | 
| − | Метод <span style="font-weight:bold">  | + | Метод <span style="font-weight:bold">getCodeName()</span> получает строковый идентификатор типа оплаты  | 
<p>'''Параметры:''' </p>  | <p>'''Параметры:''' </p>  | ||
  отсутствуют  |   отсутствуют  | ||
| − | <p>'''Результат:'''   | + | <p>'''Результат:''' string строковый идентификатор типа оплаты или boolean false</p>  | 
<br/>  | <br/>  | ||
| − | ===   | + | === getOrderId() ===  | 
| − | Метод <span style="font-weight:bold">  | + | Метод <span style="font-weight:bold">getOrderId()</span> ищет идентификатор заказа в параметре специфичном для платежной системы. Здесь метод всегда возвращает false. Данную функцию необходимо переопредилить  в файле платежной системы.  | 
<p>'''Параметры:''' </p>    | <p>'''Параметры:''' </p>    | ||
| − | + |   отсутствуют  | |
| − | + | <p>'''Результат:''' boolean false</p>  | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | <p>'''Результат:'''  | ||
<br/>  | <br/>  | ||
| − | + | Также, в данном классе имеется три абстрактных метода:  | |
| + | *process()  | ||
| + | *validate()  | ||
| + | *poll()  | ||
| − | + | Определяются, соответственно, в дочерних классах  | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Версия 15:30, 23 апреля 2014
Содержание
Класс 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()
 
Определяются, соответственно, в дочерних классах