Использование сниппета

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$204 per month—let's make that $500!

Learn more

Использование сниппета mhPayPal¶

Этот документ описывает сниппет mhPayPal, его свойства и примеры. Обзор пакета mhPayPal см. в mhPayPal.

Введение¶

Сниппет mhPayPal это ядро пакета mhPayPal. Он выводит форму, валидирует ввод, отправляет посетителя в PayPal для оплаты и обрабатывает настроенные хуки. Есть два основных сценария: пожертвования, где пользователь сам указывает сумму, или оплата одного товара по цене из вызова сниппета.

Результат зависит от пользователя, параметров URL и т. д., поэтому сниппет mhPayPal всегда вызывайте некешированным!

Свойства сниппета¶

Ниже все свойства mhPayPal. Если не знаете, как их использовать, см. Tag Syntax.

&property	Описание	Значение по умолчанию	Версия
currencies	Коды валют через запятую, доступных для оплаты. Список: Currency Codes on PayPal.	EUR,USD,GBP	1.1.0
amount	[float] Для фиксированной цены укажите число больше 0. См. примеры ниже.	0	1.1.0
amountTax	[float] Сумма налога к платежу/пожертвованию.	0	1.1.0
amountFees	[float] Сумма комиссий к платежу/пожертвованию.	0	1.1.0
amountHandling	[float] Сумма расходов на обработку к платежу/пожертвованию.	0	1.1.0
minAmount	[float] Для пожертвований с выбором суммы минимальная сумма.	5.00	1.1.0
decimals	[integer] Количество знаков после запятой.	2	1.1.0
description	[string] Текст описания. Может содержать плейсхолдеры полей вроде currency и amount.	Your `[[+currency]]` `[[+amount]]` Donation	1.1.0
outputSeparator	[string] Текст/разметка между частями вывода. Форма, блок ошибок и вывод хуков разделяются этим значением.	\n	1.1.0
	Обработка формы
formTpl	[string] Имя чанка формы. См. Templating в этой документации. По умолчанию форма с выбором валюты и полем суммы.	mhPayPalTpl (file-based)	1.1.0
formTplAnonymous	[string] Чанк, когда пользователь не авторизован. Можно показать сообщение или форму входа, если платить могут только зарегистрированные. Пустое значение использует formTpl.		1.1.0
errorTpl	[string] Чанк для отдельного сообщения об ошибке. См. templating.	mhPayPalErrorTpl (file-based)	1.1.0
successTpl	[string] Чанк сообщения об успехе. См. templating.	mhPayPalSuccess (file-based)	1.1.0
errorSeparator	[string] Разделитель между отдельными сообщениями об ошибках.		1.1.0
extraRequiredFields	[string] Обязательные поля через запятую для сбора дополнительных данных в кастомном хуке.		1.1.0
method	[GET POST] GET или POST для формы.	POST	1.1.0
submitVar	[string] Имя поля в GET или POST (зависит от &method), при наличии которого сниппет начинает обработку.	makeDonation	1.1.0
id	[string] Для нескольких форм на одной странице, чтобы избежать конфликта ID.	pp	1.1.0
showFormOnSuccess	[1 0] Показывать форму после успешной оплаты.	1	1.1.0
shipping	[1 0] Нужно ли PayPal запрашивать адрес доставки.	0	1.1.0

| | Хуки (по аналогии с FormIt, но хуки FormIt несовместимы с mhPayPal) | | | | preHooks | [string] Хуки через запятую до показа формы. Срабатывают, пока форма не отправлена. | | 1.1.0 | | postHooks | [string] Хуки после успешной отправки формы, но до подключения к PayPal. Например, расчёт налогов или дополнительная валидация. | | 1.1.0 | | postPaymentHooks | [string] Хуки после успешной оплаты и получения данных плательщика от PayPal. Email-уведомления (хук email) или запись в кастомную таблицу. | | 1.1.0 |

Примеры использования¶

Подробнее о хуках и шаблонах см. отдельные страницы. Примеры предполагают корректную установку и настроенный доступ к API PayPal.

Минимальный вызов¶

Стандартная форма с настройками по умолчанию: пожертвование от 5 EUR/USD/GBP.

[[!mhPayPal]]

Фиксированная цена одного товара¶

Пример с формой по умолчанию (для товара, скорее всего, нужен свой чанк): валюта USD, сумма 15 + налог 2.85 и описание. Хорошая база для быстрого checkout с кастомным tpl и хуками.

[[!mhPayPal?
  &amount=`15`
  &amountTax=`2.85`
  &description=`Product XYZ ([[+currency]][[+amount]])`
  &currencies=`USD`
]]

Дополнительная документация mhPayPal¶

mhPayPal.Snippet Usage