From afd445a85ccd12d05f18543097722274fde8487a Mon Sep 17 00:00:00 2001 From: Vladimir & Alina <96434373+MoneyTegro@users.noreply.github.com> Date: Sun, 9 Jul 2023 22:22:46 +0300 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fe7df53..5789f1b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ -# sviatoslavtesttask -### Hi there 👋, Плагин для подключения Tegro API к WooCommerce -#### Этот плагин был написан на базе PHP 7.0+ -Для подключение необходимо скачать папку с плагином и поместить ее по следущему пути wp_coontent/plugins/имя папки -В файле woocommerce_tegro_plugin.php необходимо изменить следующие данные -На 65 строчке поставте свой shop id -На 69 строке поставте свой secret key -Далее для подключения зайдите в Wordpress в раздел плагина и включите плагин под названием WooCommerce Tegro Plugin +# Документация к плагину "WooCommerce Tegro Plugin" +## Введение +"WooCommerce Tegro Plugin" - это плагин для WordPress, который интегрирует Tegro API с WooCommerce. Он разработан для добавления дополнительного способа оплаты через Tegro в вашем интернет-магазине на WooCommerce. +## Основные функции +### add_tegro_payment_gateway($gateways) +Эта функция регистрирует новый метод оплаты в WooCommerce. Она добавляет 'WC_Tegro_Payment_Gateway' к списку доступных способов оплаты и возвращает обновленный список. +### WC_Tegro_Payment_Gateway +Это класс, который реализует оплату через Tegro. Он расширяет класс `WC_Payment_Gateway`, предоставляемый WooCommerce. + +#### __construct() +Конструктор класса инициализирует базовую информацию о способе оплаты и добавляет действие для обновления настроек в административной панели WooCommerce. + +#### init_form_fields() +Этот метод инициализирует поля формы для настройки способа оплаты. Он определяет следующие поля: + +- Включить/Выключить: чекбокс, который определяет, активен ли этот метод оплаты. +- Название: текстовое поле для имени способа оплаты, которое будет отображаться для клиента. +- Описание: текстовая область для описания способа оплаты, которое будет отображаться для клиента. + +#### process_payment($order_id) +Этот метод обрабатывает оплату заказа. Он получает идентификатор заказа в качестве аргумента, затем получает общую сумму заказа, валюту и идентификатор заказа. Он формирует данные для создания подписи, создает подпись, формирует URL для оплаты и перенаправляет пользователя на страницу оплаты. + +## Примечание +Для использования этого плагина вам потребуется заменить `your shop_id` и `your secret_key` на ваши собственные значения Shop ID и Secret Key, предоставленные Tegro.