Граф наследования:YandexKassaApi:

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

Способ оплаты - ЮKassa (ранее Яндекс.Касса)

Открытые члены
	__construct ()

	getTitle ()

	getDescription ()

	getShortName ()

	canOnlinePay ()

	getFormObject ()

	getTypeUnique ()

	getPayUrl (Transaction $transaction)

	getTransactionIdFromRequest (HttpRequest $request)

	onResult (Transaction $transaction, HttpRequest $request)

	recurringPayOrder (Order $order, SavedPaymentMethod $saved_payment_method)

	recurringPayBalanceFounds (User $user, float $cost, SavedPaymentMethod $saved_payment_method)

	refundBindingTransaction (Transaction $transaction)

	deleteSavedPaymentMethod (SavedPaymentMethod $saved_payment_method)

	createPayment (Transaction $transaction)

	getAvailableTransactionActions (Transaction $transaction, Order $order)

	executeTransactionAction (Transaction $transaction, string $action)

	getTelegramProviderData (Transaction $transaction)

Открытые члены унаследованные от AbstractType
	__construct (?array $options=null)

	processOptions ($options)

	beforesave ()

	getCheckboxParam ($key=null)

	set ($value)

	setListenPost ($boolean)

	isListenPost ()

	get ()

	getHint ()

	setHint ($text)

	setEscapeType ($escape_type)

	getEscapeType ()

	unsetvalue ()

	validate ($value)

	setChecker ($callmethod, $errortxt= '')

	removeAllCheckers ()

	getCheckers ()

	setVisible ($bool, $switch=null)

	isVisible ($switch=null, $use_default_visible=true)

	isMeVisible ($switch=null, $use_default_visible=true)

	setMeVisible ($bool)

	getTreeList ()

	setTree ($tree_function,...$params)

	getListFunc ()

	setList ($listfunc,...$params)

	setListFromArray (array $list)

	setChangeSizeForList ($bool)

	getList ()

	setCheckboxView ($onValue, $offValue)

	setCheckboxListView ($bool)

	setRadioListView ($bool, $inline=false)

	isRadioListInline ()

	selfSave ()

	normalizePost ()

	addClass (string $class)

	setAttr (array $view_attr)

	getAttr ()

	getAttrArray ()

	getAttrByKey ($key)

	isHaveAttrKey ($key)

	textView ()

	formView ($view_options=null, $orm_object=null)

	setName ($name)

	getName ()

	setArrayWrap ($array_wrap_name)

	setFormName ($form_name)

	getFormName ()

	setMaxLength ($length)

	getMaxLength ()

	isAlwaysModify ()

	setAlwaysModify ($bool)

	setReadOnly ($readonly=true)

	setErrors (array $errors)

	getErrors ()

	hasErrors ()

	getDescription ()

	setDescription ($description)

	setUseToSave ($bool)

	isUseToSave ()

	isRuntime ()

	setRuntime ($bool)

	isAutoincrement ()

	setAutoincrement ($bool)

	hasLength ()

	setAllowEmpty ($bool)

	isAllowEmpty ()

	getSQLNotation ()

	getSQLTypeParameter ()

	setDecimal ($decimal)

	getDecimal ()

	setPrimaryKey ($bool)

	isPrimaryKey ()

	setUnique ($bool)

	isUnique ()

	setIndex ($bool)

	isIndex ()

	setDefault ($default, $is_func=false)

	getDefault ($db_format=false)

	isDefaultFunc ()

	getPhpType ()

	setPhpType ($type)

	setTemplate ($template)

	setMeTemplate ($template)

	getOriginalTemplate ()

	getRenderTemplate ($multiedit=false)

	getTitle ()

	setHidden ($bool)

	isHidden ()

	escape ($value)

	checkDefaultRequestValue ($value)

	setRequestType ($var_type)

	getFromRequest (array $src)

	callPropertyFunction ($property_name,...$params)

	setTrimString ($bool)

	getTrimString ()

	isHtmlEncodedField ()

	__set ($name, $value)

	__get ($name)

	__isset ($name)

	__unset ($name)

Открытые члены унаследованные от InterfaceRecurringPayments
	isRecurringPaymentsActive ()

	getRecurringPaymentsType ()

	getSavedPaymentMethods (User $user)

	getAdminRecurringPaymentsHtml (Order $order)

	executeInterfaceRecurringPaymentsAction (Order $order, string $action)

Поля данных
const	API_URL = 'https://api.yookassa.ru/v3/'

const	TRANSACTION_ACTION_HOLD_CAPTURE = 'hold_capture'

const	TRANSACTION_ACTION_HOLD_CANCEL = 'hold_cancel'

const	TRANSACTION_EXTRA_KEY_PAYMENT_ID = 'payment_id'

Поля данных унаследованные от AbstractType
const	ESCAPE_TYPE_NONE = false

const	ESCAPE_TYPE_ENTITY = 'entity'

const	ESCAPE_TYPE_HTML = 'html'

	$name

	$description

	$formtype = "input"

Поля данных унаследованные от InterfaceRecurringPayments
const	RECURRING_TYPE_NONE = 'none'

const	RECURRING_TYPE_SAVE_METHOD = 'save_method'

const	RECURRING_TYPE_ONLY_SAVE_METHOD = 'only_save_method'

const	TRANSACTION_EXTRA_KEY_SAVED_METHOD = 'saved_payment_method'

const	RECURRING_ACTION_SAVED_METHODS_FORM = 'saved_methods_form'

const	RECURRING_ACTION_SELECT_SAVED_METHOD = 'select_saved_method'

const	RECURRING_ACTION_PAY_WITH_SAVED_METHOD = 'pay_with_saved_method'

Защищенные члены
	getParamsForFZ54Check ($transaction)

	getFZ54CheckCustomerData (Transaction $transaction)

	apiRequest (string $url, string $method, array $params, string $log_level, string $idempotence_key= '')

	changeTransactionFromResponse (Transaction $transaction, array $response, bool $is_notice=false)

	savePaymentMethod (Transaction $transaction, array $response)

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

static	handbookNds ()

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

Защищенные данные унаследованные от AbstractType
	$listfunc

	$listfunc_param = []

	$tree_function

	$tree_function_params = []

	$list

	$parent_object

	$value

	$hidden = false

	$requesttype

	$checkers = []

	$use_to_save = true

	$read_only = false

	$array_wrap_name = false

	$form_template = '%system%/coreobject/type/form/string.tpl'

	$template

	$me_template

	$change_size_for_list = true

	$always_modify = false

	$errors = []

	$listen_post = true

	$hint = ''

	$checkbox_param = []

	$checkbox_list = false

	$radio_list = false

	$radio_list_inline = false

	$vis_form = true

	$me_visible

	$view_attr = []

	$php_type = ''

	$escape_type = self::ESCAPE_TYPE_ENTITY

	$runtime = false

	$sql_notation = ''

	$autoincrement = false

	$allowempty = true

	$primary_key = false

	$default = null

	$is_default_func

	$unique = false

	$index = false

	$has_len = true

	$max_len

	$decimal

	$form_name

	$trim_string = false

	$options = []

Конструктор(ы)

__construct ( )

Методы

apiRequest	(	string	$url,
		string	$method,
		array	$params,
		string	$log_level,
		string	$idempotence_key = `''`
	)

protected

Отправляет запрос по API

Аргументы

string	$url	- адрес запроса
string	$method	- метод запроса
array	$params	- параметры
string	$log_level	- уровень логирования
string	$idempotence_key	- ключ идемпотентности

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

Исключения

ShopException

canOnlinePay ( )

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

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

changeTransactionFromResponse	(	Transaction	$transaction,
		array	$response,
		bool	$is_notice = `false`
	)

protected

Создаёт "изменение транзакции" на основе данных о платеже

Аргументы

Transaction	$transaction	- транзакция
array	$response	- данные о платеже
bool	$is_notice	- изменение вызвано уведомлением от ЯКассы

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

createPayment ( Transaction $transaction )

Создаёт платёж в ЯКассе

Аргументы

Transaction $transaction

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

Исключения

ShopException
RSException

deleteSavedPaymentMethod ( SavedPaymentMethod $saved_payment_method )

Удаляет сохранённый способ платежа

Аргументы

SavedPaymentMethod $saved_payment_method - Сохранённый способ платежа

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

Исключения

ShopException

Замещает InterfaceRecurringPayments.

executeTransactionAction	(	Transaction	$transaction,
		string	$action
	)

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

Аргументы

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

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

Исключения

ShopException
RSException

getAvailableTransactionActions	(	Transaction	$transaction,
		Order	$order
	)

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

Аргументы

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

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

getDescription ( )

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

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

getFormObject ( )

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

Возвращает: FormObject | null

getFZ54CheckCustomerData ( Transaction $transaction )

protected

Возвращает данные секции "пользователь" для чека ФЗ-54

Аргументы

Transaction $transaction - объект транзакции

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

getParamsForFZ54Check ( $transaction )

protected

Возвращает дополнительные параметры для печати чека по ФЗ-54

Аргументы

Transaction $transaction - объект транзакции

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

Исключения

RSException

getPayUrl ( Transaction $transaction )

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

Аргументы

Transaction $transaction

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

Исключения

RSException

getShortName ( )

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

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

getTelegramProviderData ( Transaction $transaction )

Возвращает данные для секции provider_data в Telegram Payments

Аргументы

Transaction $transaction

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

getTitle ( )

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

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

getTransactionIdFromRequest ( HttpRequest $request )

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

Аргументы

HttpRequest $request

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

getTypeUnique ( )

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

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

static handbookNds ( )

staticprotected

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

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

static handbookPaymentCancellationReasons ( )

staticprotected

Справочник "Причины отмены платежа"

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

onResult	(	Transaction	$transaction,
		HttpRequest	$request
	)

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

Аргументы

Transaction	$transaction
HttpRequest	$request

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

Исключения

ResultException
ShopException

recurringPayBalanceFounds	(	User	$user,
		float	$cost,
		SavedPaymentMethod	$saved_payment_method
	)

Производит "рекуррентное" пополнение лицевого счёта

Аргументы

User	$user	- пользователь
float	$cost	- сумма пополнения
SavedPaymentMethod	$saved_payment_method	- сохранённый спосб оплаты

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

Исключения

RSException
ShopException

Замещает InterfaceRecurringPayments.

recurringPayOrder	(	Order	$order,
		SavedPaymentMethod	$saved_payment_method
	)

Производит "рекуррентную" оплату заказа

Аргументы

Order	$order	- заказ
SavedPaymentMethod	$saved_payment_method	- сохранённый спосб оплаты

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

Исключения

RSException
ShopException

Замещает InterfaceRecurringPayments.

refundBindingTransaction ( Transaction $transaction )

Производит возврат транзакции, привязывающей новый способ оплаты

Аргументы

Transaction $transaction - транзакция

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

Исключения

ShopException
RSException

Замещает InterfaceRecurringPayments.

savePaymentMethod	(	Transaction	$transaction,
		array	$response
	)

protected

Сохраняет способ платежа

Аргументы

Transaction	$transaction	- транзакция
array	$response	- данные о платеже

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

Поля

$log

protected

const API_URL = 'https://api.yookassa.ru/v3/'

const TRANSACTION_ACTION_HOLD_CANCEL = 'hold_cancel'

const TRANSACTION_ACTION_HOLD_CAPTURE = 'hold_capture'

const TRANSACTION_EXTRA_KEY_PAYMENT_ID = 'payment_id'

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

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

Поля данных

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

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

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

Конструктор(ы)

Методы

Поля