Možnosti rozšírenia – hooks

Plugin Comgate pre WooCommerce od Pluginatora Vám umožňuje upravovať jeho funkcionalitu pomocou WordPress hooks (akcií a filtrov).

V rámci úprav je možné využiť nasledovné hooks pre úpravu údajov odosielaných do Comgate.

• comgateAvailablePaymentMethods – slúži na úpravu zoznamu dostupných platobných metód. Tento zoznam sa využíva predovšetkým pri zobrazení platobných metód zákazníkom.

/**
 * $value - obsahuje 
 * $currency - mena objednávky
 * $country - krajina objednávky
 */
add_filter("comgateAvailablePaymentMethods", function($value, $currency, $country) {
    return $value;
}, 10, 3);

• comgateSelectedPaymentMethod – slúži na predvybratie konkrétnej platobnej metódy. Táto platobná metóda bude pre zákazníkov predvolená a teda automaticky zvolená v prípade, že si zákazník nezvolí inú platobnú metódu.

/**
 * $value - obsahuje predvybranú platobnú metódu
 * $availablePaymentMethods - dostupné platobné metódy, ktoré budú používateľovi zobrazené
 */
add_filter("comgateSelectedPaymentMethod", function($value, $availablePaymentMethods) {
    return $value;
}, 10, 2);

• wf_payment_order_state_on_payment_initialized – slúži na nastavenie stavu objednávky po úspešnej inicializácii platby. Pod inicializáciou platby sa myslí vytvorenie platby na platobnej bráne pred presmerovaním používateľa na platobnú bránu. Stav objednávky bude teda zmenený tesne pred presmerovaním na platobnú bránu. Stav objednávky môže nadobúdať hodnotu „default“, alebo identifikátory/kľúče stavu objednávky WooCommerce (napr.: pending, on-hold, …).
  Default: default

/**
 * $value - požadovaný stav objednávky. 
 * $order - objednávka
 * $gateway - identifikátor platobnej brány.
 */
add_filter('wf_payment_order_state_on_payment_initialized', function($value, $order, $gateway) {
	return $value;
}, 10, 3);

• wf_payment_reduce_order_stock_before_payment – slúži na nastavenie automatickej úpravy skladových zásob. Plugin automaticky rezervuje množstvo skladových zásob tesne pred presmerovaním na platobnú bránu. Ak chcete toto nastavenie vypnúť, je to možné pomocou tohoto filter-hooku.
  Default: true

/**
 * $value - true/false, či sa majú upraviť skladové zásoby pred platbou. 
 * $gateway - identifikátor platobnej brány.
 * $order - objednávka
 */
add_filter('wf_payment_reduce_order_stock_before_payment', function($value, $gateway, $order) {
	return $value;
}, 10, 3);

Úprava zobrazenia

Nasledovné hooky je možné využiť pre drobné úpravy v rámci základnej šablóny zobrazenia.

• wf_payment_comgate_payment_method_name – slúži na úpravu názvu zobrazenia platobnej metódy.

/**
 * $value - názov platobnej metódy. 
 * $paymentMethod - objekt platobnej metódy.
 */
add_filter('wf_payment_comgate_payment_method_name', function($value, $paymentMethod) {
	return $value;
}, 10, 2);

• wf_payment_comgate_payment_method_image – slúži na úpravu obrázku prislúchajúcemu ku konkrétnej platobnej metóde.

/**
 * $value - URL pre obrázok. 
 * $paymentMethod - objekt platobnej metódy.
 */
add_filter('wf_payment_comgate_payment_method_image', function($value, $paymentMethod) {
	return $value;
}, 10, 2);

Úprava čísla objednávky

Nasledujúce dva „hook-y“ je potrebné použiť vždy spolu. Upravujú totiž jedinečný identifikátor objednávky, ktorý je odosielaný na platobnú bránu a taktiež na následné párovanie platby k objednávke. Je však nevyhnutné, aby identifikátor objednávky bol vždy jedinečný v rámci všetkých objednávok.

Takýmto spôsobom je možné upraviť číslo objednávky pre interné účely – napr.: iné číslovanie objednávok ako ponúka WooCommerce, čísla objednávok obsahujúce dátum, … .

• wf_payments_woo_order_identifier – slúži na úpravu identifikátora objednávky, ktorý je odosielaný do Comgate ako číslo objednávky. Default: $order->get_id()

/**
 * $value - obsahuje $order->get_id()
 * $order obsahuje objednávku
 */
add_filter("wf_payments_woo_order_identifier", function($value, $order) {
    return $value;
}, 10, 2);

• wf_payments_woo_get_order_by_identifier – slúži na získanie objednávky na základe identifikátora. Default: wc_get_order($orderId)

/**
 * $value - obsahuje wc_get_order($orderId)
 * $orderId obsahuje identifikátor objednávky z platobnej brány
 */
add_filter("wf_payments_woo_get_order_by_identifier", function($value, $orderId) {
    return $value;
}, 10, 2);

Úprava nastavení pluginu

Nasledujúce filtre umožňujú upraviť tieto nastavenia, ktoré sa nastavujú v rámci administrácie platobných brán WooCommerce.

Takýmto spôsobom je možné upraviť napríklad autentifikačné údaje platobnej brány na základe dodatočných podmienok – napr. pre rôzne domény, ktoré sú poskytované jednou WooCommerce inštanciou.

• wf_payments_comgate_settings_merchant – slúži na úpravu „Merchant ID„

/**
 * $value - obsahuje merchant ID
 */
add_filter("wf_payments_comgate_settings_merchant", function($value) {
    return $value;
});

• wf_payments_comgate_settings_secret – slúži na úpravu „Secret key„

/**
 * $value - obsahuje tajný kľúč
 */
add_filter("wf_payments_comgate_settings_secret", function($value) {
    return $value;
});