Версия: 5.x
Класс AbstractType

Подробное описание

Абстрактный класс типа оплаты.

Открытые члены

 getTitle ()
 
 getDescription ()
 
 getShortName ()
 
 canOnlinePay ()
 
 cashOnDelivery ()
 
 isAllowResultUrl ()
 
 checkPaymentStatus (Transaction $transaction)
 
 loadOptions (array $opt=null, Order $order=null, Transaction $transaction=null)
 
 getOption ($key=null, $default=null)
 
 isPostQuery ()
 
 addPostParam ($key, $value)
 
 addPostParams (array $post_params)
 
 getPostParams ()
 
 setOption ($key_or_array=null, $value=null)
 
 onOrderCreate (Order $order, Address $address=null)
 
 getFormObject ()
 
 getAdminHTML (Order $order)
 
 actionOrderQuery (Order $order)
 
 getFormHtml ()
 
 getDocsName ()
 
 getDocUrl ($doc_key=null, $absolute=false)
 
 getDocHtml ($dockey=null)
 
 onCreateOrder ()
 
 getCompany ()
 
 getPayUrl (Transaction $transaction)
 
 getTransactionIdFromRequest (HttpRequest $request)
 
 onResult (Transaction $transaction, HttpRequest $request)
 
 wrapOnResultArray ($result_array)
 
 onSuccess (Transaction $transaction,\RS\Http\Request $request)
 
 onFail (Transaction $transaction, HttpRequest $request)
 
 onStatus (Transaction $transaction, HttpRequest $request)
 
 getAvailableTransactionActions (Transaction $transaction)
 
 executeTransactionAction (Transaction $transaction, string $action)
 
 makeRightAbsoluteUrl ($relative_url)
 

Защищенные члены

 getNdsCode (array $taxes, Address $address)
 

Защищенные статические члены

static handbookNds ()
 

Защищенные данные

 $post_params = array()
 
 $order
 
 $transaction
 

Методы

actionOrderQuery ( Order  $order)

Действие с запросами к заказу для получения дополнительной информации от доставки

Аргументы
Order$order- объект заказа
addPostParam (   $key,
  $value 
)

Добавляет один параметр поста в определённый ключ

Аргументы
string$key- ключ
string | array$value- значение
addPostParams ( array  $post_params)

Добавляет параметры для Пост запроса

Аргументы
array$post_params- массив параметров
canOnlinePay ( )
abstract

Возвращает true, если данный тип поддерживает проведение платежа через интернет

Возвращает
bool
cashOnDelivery ( )

Возвращает true, если данный тип подразумевает наложенный платеж при оплате заказа

Возвращает
bool
checkPaymentStatus ( Transaction  $transaction)

Проверяет статус платежа Актуально только для типов поддерживающих online оплату

Аргументы
Transaction$transaction
Исключения
DbException
executeTransactionAction ( Transaction  $transaction,
string  $action 
)

Исполняет действие с транзакцией При успехе - возвращает текст сообщения для администратора, при неудаче - бросает исключение

Аргументы
Transaction$transaction- транзакция
string$action- идентификатор исполняемого действия
Возвращает
string
Исключения
RSException
getAdminHTML ( Order  $order)

Возвращает дополнительный HTML для админ части в заказе

Аргументы
Order$order- объект заказа
Возвращает
string
getAvailableTransactionActions ( Transaction  $transaction)

Возвращает список возможных действий с транзакцией

Аргументы
Transaction$transaction- транзакция
Возвращает
TransactionAction[]
getCompany ( )

Возвращает объект компании, которая предоставляет услуги

Возвращает
Company
getDescription ( )
abstract

Возвращает описание типа оплаты. Возможен HTML

Возвращает
string
getDocHtml (   $dockey = null)

Возвращает html документа для печати пользователем

Аргументы
mixed$dockey
getDocsName ( )

Возвращает список названий документов и ссылки, по которым можно открыть данные документы, генерируемых данным типом оплаты

Возвращает
array
getDocUrl (   $doc_key = null,
  $absolute = false 
)

Возвращает URL к печтной форме документа

Аргументы
string$doc_key- ключ документа
bool$absolute- если true, то вернуть абсолютный URL
Возвращает
string
Исключения
Exception
getFormHtml ( )

Возвращает HTML форму данного типа оплаты, для ввода дополнительных параметров

Возвращает
string
Исключения
SmartyException
getFormObject ( )

Возвращает ORM объект для генерации формы в административной панели или null

Возвращает
FormObject|void
getNdsCode ( array  $taxes,
Address  $address 
)
protected

Возвращает правильный код НДС

Аргументы
Tax[]$taxes - список налогов
Address$address- объект адреса
Возвращает
string|null
getOption (   $key = null,
  $default = null 
)

Получает значение опции способа оплаты

Аргументы
string$key- ключ опции
mixed$default- значение по умолчанию
Возвращает
mixed
getPayUrl ( Transaction  $transaction)

Возвращает URL для перехода на сайт сервиса оплаты для совершения платежа Используется только для Online-платежей

Аргументы
Transaction$transaction
Возвращает
string
getPostParams ( )

Возвращает параметры - ключ значение для выполнения поста

Возвращает
array
getShortName ( )
abstract

Возвращает идентификатор данного типа оплаты. (только англ. буквы)

Возвращает
string
getTitle ( )
abstract

Возвращает название расчетного модуля (типа доставки)

Возвращает
string
getTransactionIdFromRequest ( HttpRequest  $request)

Возвращает ID заказа исходя из REQUEST-параметров соотвествующего типа оплаты Используется только для Online-платежей

Аргументы
HttpRequest$request- входящий запрос
Возвращает
mixed
static handbookNds ( )
staticprotected

Справочник кодов НДС Ключи справочника должны соответствовать списку кодов НДС в TaxApi

Возвращает
string[]
isAllowResultUrl ( )

Возвращает true, если можно обращаться к ResultUrl для данного метода оплаты. Обычно необходимо для способов оплаты, которые применяются только на мобильных приложениях. По умолчанию возвращает то же, что и canOnlinePay.

Возвращает
bool
isPostQuery ( )

Возвращает true, если необходимо использовать POST запрос для открытия страницы платежного сервиса

Возвращает
bool
loadOptions ( array  $opt = null,
Order  $order = null,
Transaction  $transaction = null 
)

Устанавливает настройки, которые были заданы в способе оплаты. В случае, если расчетный класс вызывается у готового заказа, то дополнительно устанавливаются order и transaction

Аргументы
mixed$optНастройки расчетного класса
Order$orderЗаказ
Transaction$transactionТранзакция
makeRightAbsoluteUrl (   $relative_url)

Возвращает абсолютную ссылку для текущего сайта или партнерского сайта. Итоговая ссылка зависит от текущего партнерского сайта

Аргументы
string$relative_urlотносительный URL
Возвращает
string
onCreateOrder ( )

Вызывается единоразово при оформлении заказа

Возвращает
void
onFail ( Transaction  $transaction,
HttpRequest  $request 
)

Вызывается при открытии страницы неуспешного проведения платежа Используется только для Online-платежей

Аргументы
Transaction$transaction
HttpRequest$request
Возвращает
void
onOrderCreate ( Order  $order,
Address  $address = null 
)

Функция срабатывает после создания заказа

Аргументы
Order$order- объект заказа
Address$address- Объект адреса
Возвращает
mixed
onResult ( Transaction  $transaction,
HttpRequest  $request 
)

Вызывается при оплате сервером платежной системы. Возвращает строку - ответ серверу платежной системы. В случае неверной подписи бросает исключение Используется только для Online-платежей

Аргументы
Transaction$transaction- транзакция
HttpRequest$request- входящий запрос
Возвращает
ChangeTransaction|string
onStatus ( Transaction  $transaction,
HttpRequest  $request 
)

Вызывается при открытии страницы проверки статуса проведения платежа Используется только для Online-платежей

Аргументы
Transaction$transaction
HttpRequest$request
Возвращает
void
onSuccess ( Transaction  $transaction,
\RS\Http\Request  $request 
)

Вызывается при открытии страницы успеха, после совершения платежа В случае неверной подписи бросает исключение Используется только для Online-платежей

Аргументы
Transaction$transaction
HttpRequest$request
Возвращает
void
setOption (   $key_or_array = null,
  $value = null 
)
wrapOnResultArray (   $result_array)

Собирает результаты обработки нескольких платежей в один ответ (используется только у оплат, которые в одном уведомлении отправляют информацию по нескольким платежам)

Аргументы
string[]$result_array - результаты обработки платежей
Возвращает
string

Поля

$order
protected
$post_params = array()
protected
$transaction
protected