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

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

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

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

 getTitle ()
 
 getDescription ()
 
 getShortName ()
 
 canOnlinePay ()
 
 isAllowResultUrl ()
 
 loadOptions (array $opt=null,\Shop\Model\Orm\Order $order=null,\Shop\Model\Orm\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 (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Address $address=null)
 
 getFormObject ()
 
 getAdminHTML (\Shop\Model\Orm\Order $order)
 
 actionOrderQuery (\Shop\Model\Orm\Order $order)
 
 getFormHtml ()
 
 getDocsName ()
 
 getDocUrl ($doc_key=null, $absolute=false)
 
 getDocHtml ($dockey=null)
 
 onCreateOrder ()
 
 getCompany ()
 
 getPayUrl (Transaction $transaction)
 
 getTransactionIdFromRequest (\RS\Http\Request $request)
 
 onResult (Transaction $transaction,\RS\Http\Request $request)
 
 onSuccess (Transaction $transaction,\RS\Http\Request $request)
 
 onFail (Transaction $transaction,\RS\Http\Request $request)
 

Поля данных

 $order
 
 $transaction
 

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

 $post_params = array()
 

Методы

actionOrderQuery ( \Shop\Model\Orm\Order  $order)

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

addPostParam (   $key,
  $value 
)

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

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

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

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

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

Возвращает
bool
getAdminHTML ( \Shop\Model\Orm\Order  $order)

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

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

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

Возвращает
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
getFormHtml ( )

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

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

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

Возвращает
| null
getOption (   $key = null,
  $default = null 
)

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

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

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

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

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

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

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

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

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

Возвращает
string
getTransactionIdFromRequest ( \RS\Http\Request  $request)

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

Аргументы
\RS\Http\Request$request
Возвращает
mixed
isAllowResultUrl ( )

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

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

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

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

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

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

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

Возвращает
void
onFail ( Transaction  $transaction,
\RS\Http\Request  $request 
)

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

Аргументы
Transaction$transaction
\RS\Http\Request$request
Возвращает
void
onOrderCreate ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Address  $address = null 
)

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

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

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

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

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

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

Поля

$order
$post_params = array()
protected
$transaction