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

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

Открытые члены
	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 ()

	getTypeUnique ()

	getAdminPaymentHtml (Order $order)

	getAdminHTML (Order $order)

	actionOrderQuery (Order $order, $data=[])

	getFormHtml ()

	getDocsName ()

	getDocUrl ($doc_key=null, $absolute=false)

	getDocHtml ($dockey=null)

	getCompany ()

	getPayUrl (Transaction $transaction)

	getTransactionIdFromRequest (HttpRequest $request)

	onResult (Transaction $transaction, HttpRequest $request)

	wrapOnResultArray ($result_array)

	wrapOnResultError ($e)

	onSuccess (Transaction $transaction, HttpRequest $request)

	onFail (Transaction $transaction, HttpRequest $request)

	onStatus (Transaction $transaction, HttpRequest $request)

	getAvailableTransactionActions (Transaction $transaction, Order $order)

	executeTransactionAction (Transaction $transaction, string $action)

	makeRightAbsoluteUrl ($relative_url)

	getPayment ()

	setPayment (Payment $payment)

	getClientSiteAppAdditionalHTML (Order $order, Payment $payment)

Защищенные члены
	getNdsCode (array $taxes, Address $address)

Защищенные статические члены
static	handbookNds ()

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

	$post_params = []

	$order

	$transaction

Методы

actionOrderQuery	(	Order	$order,
			$data = `[]`
	)

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

Аргументы

Order	$order	- объект заказа
	$data	- массив с данными, необходимыми для данной операции. Если не передан, то оплата будет извлекать эти данные из GET или POST

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

executeTransactionAction	(	Transaction	$transaction,
		string	$action
	)

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

Аргументы

Transaction	$transaction	- транзакция
string	$action	- идентификатор исполняемого действия

Возвращает: string

Исключения

RSException

getAdminHTML ( Order $order )

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

Аргументы

Order $order - объект заказа

Возвращает: string

getAdminPaymentHtml ( Order $order )

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

Аргументы

Order $order - объект заказа

Возвращает: string

getAvailableTransactionActions	(	Transaction	$transaction,
		Order	$order
	)

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

Аргументы

Transaction	$transaction	- транзакция
Order	$order	- объект заказа для которого нужно вернуть действия

Возвращает: TransactionAction[]

getClientSiteAppAdditionalHTML	(	Order	$order,
		Payment	$payment
	)

Возвращает шаблон с дополнительной информацией для мобильного приложения v2

Аргументы

Order	$order	- объект заказа
Payment	$payment	- объект оплаты

Возвращает: string

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

getPayment ( )

Возвращает установленный способ оплаты

Возвращает: Payment

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

getTypeUnique ( )

Возвращает идентификатор, уникализирующий продавца в рамках типа оплаты

Возвращает: string

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

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,
		HttpRequest	$request
	)

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

Аргументы

Transaction	$transaction
HttpRequest	$request

Возвращает: void

setOption	(	$key_or_array = `null`,
		$value = `null`
	)

setPayment ( Payment $payment )

Устанавливает способ оплаты

Аргументы

Payment $payment

Возвращает: self

wrapOnResultArray ( $result_array )

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

Аргументы

string[] $result_array - результаты обработки платежей

Возвращает: string

wrapOnResultError ( $e )

Оборачивает ошибку исключения, возникшего при вызове метода onResult

Аргументы

\Exception $e - исключение

Возвращает: string

Поля

$order

protected

$payment

protected

$post_params = []

protected

$transaction

protected

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

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

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

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

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

Методы

Поля