Skip to content

Commit

Permalink
doc: replace unreleased tags
Browse files Browse the repository at this point in the history
  • Loading branch information
glaubersilva committed Sep 6, 2024
1 parent f66bc2c commit 0e1693d
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* the gateway API response to an object of this class is made. You should edit this method according to the
* gateway you are integrating since the API response probably should differ.
*
* @unreleased
* @since 1.0.0
*/
class OffSiteGatewayPayment
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* notification to an object of this class is made. You should edit this method according to the gateway you
* are integrating since the webhook notification attributes probably should differ.
*
* @unreleased
* @since 1.0.0
*/
class OffSiteGatewayWebhookNotification
{
Expand All @@ -33,7 +33,7 @@ class OffSiteGatewayWebhookNotification
public $merchantPaymentId;

/**
* @unreleased
* @since 1.0.0
*/
public static function fromRequest(array $request): OffSiteGatewayWebhookNotification
{
Expand Down
8 changes: 4 additions & 4 deletions src/OffSiteGateway/Gateway/OffSiteCheckoutPageSimulation.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
/**
* IMPORTANT: you don't need to keep this file in your integration; this is just a sample to demonstrate how off-site gateway integrations should work.
*
* @unreleased
* @since 1.0.0
*/
class OffSiteCheckoutPageSimulation
{
/**
* @unreleased
* @since 1.0.0
*/
public function __invoke()
{
Expand All @@ -37,7 +37,7 @@ public function __invoke()
}

/**
* @unreleased
* @since 1.0.0
*/
private function isLegacyFormReferrer(): bool
{
Expand All @@ -47,7 +47,7 @@ private function isLegacyFormReferrer(): bool
}

/**
* @unreleased
* @since 1.0.0
*/
private function loadOffSiteGatewaySimulationMarkup()
{
Expand Down
38 changes: 19 additions & 19 deletions src/OffSiteGateway/Gateway/OffSiteGateway.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,59 +17,59 @@
use GiveAddon\OffSiteGateway\Webhooks\OffSiteGatewaysWebhookNotificationHandler;

/**
* @unreleased
* @since 1.0.0
*/
class OffSiteGateway extends PaymentGateway
{
/**
* @unreleased
* @since 1.0.0
*/
public $secureRouteMethods = [
'handleSuccessPaymentReturn',
'handleCanceledPaymentReturn',
];

/**
* @unreleased
* @since 1.0.0
*/
public $routeMethods = [
'webhookNotificationsListener',
];

/**
* @unreleased
* @since 1.0.0
*/
public function getWebhookNotificationsListener(): string
{
return $this->routeMethods[0];
}

/**
* @unreleased
* @since 1.0.0
*/
public static function id(): string
{
return 'ADDON_ID-off-site-gateway';
}

/**
* @unreleased
* @since 1.0.0
*/
public function getId(): string
{
return self::id();
}

/**
* @unreleased
* @since 1.0.0
*/
public function getName(): string
{
return __('ADDON_NAME - Off-Site Gateway', 'ADDON_TEXTDOMAIN');
}

/**
* @unreleased
* @since 1.0.0
*/
public function getPaymentMethodLabel(): string
{
Expand All @@ -79,7 +79,7 @@ public function getPaymentMethodLabel(): string
/**
* Add support to v2 forms
*
* @unreleased
* @since 1.0.0
*/
public function getLegacyFormFieldMarkup(int $formId, array $args): string
{
Expand All @@ -94,7 +94,7 @@ public function getLegacyFormFieldMarkup(int $formId, array $args): string
/**
* Add support to v3 forms
*
* @unreleased
* @since 1.0.0
*/
public function enqueueScript(int $formId)
{
Expand All @@ -117,7 +117,7 @@ public function enqueueScript(int $formId)
}

/**
* @unreleased
* @since 1.0.0
*
* @throws Exception
*/
Expand Down Expand Up @@ -175,15 +175,15 @@ public function createPayment(Donation $donation, $gatewayData): RedirectOffsite
}

/**
* @unreleased
* @since 1.0.0
*/
public function refundDonation(Donation $donation)
{
// TODO: Implement refundDonation() method.
}

/**
* @unreleased
* @since 1.0.0
*/
public function getPaymentParameters(Donation $donation, $gatewayData): array
{
Expand Down Expand Up @@ -218,7 +218,7 @@ protected function createGiveAddonOffSiteGatewayPaymentApi(Donation $donation):
}

/**
* @unreleased
* @since 1.0.0
*
* @throws Exception
*/
Expand All @@ -239,7 +239,7 @@ protected function handleSuccessPaymentReturn(array $queryParams): RedirectRespo
}

/**
* @unreleased
* @since 1.0.0
*
* @throws Exception
*/
Expand All @@ -254,7 +254,7 @@ protected function handleCanceledPaymentReturn(array $queryParams): RedirectResp
}

/**
* @unreleased
* @since 1.0.0
*/
protected function webhookNotificationsListener()
{
Expand All @@ -272,7 +272,7 @@ protected function webhookNotificationsListener()
}

/**
* @unreleased
* @since 1.0.0
*/
private function getPaymentsReturnURL(Donation $donation, $gatewayData): string
{
Expand All @@ -291,7 +291,7 @@ private function getPaymentsReturnURL(Donation $donation, $gatewayData): string
}

/**
* @unreleased
* @since 1.0.0
*/
private function getPaymentsCancelURL(Donation $donation, $gatewayData): string
{
Expand All @@ -310,7 +310,7 @@ private function getPaymentsCancelURL(Donation $donation, $gatewayData): string
}

/**
* @unreleased
* @since 1.0.0
*/
private function getPaymentsWebhookUrl(Donation $donation): string
{
Expand Down
6 changes: 3 additions & 3 deletions src/OffSiteGateway/OffSiteGatewayServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@
use GiveAddon\OffSiteGateway\Gateway\OffSiteGateway;

/**
* @unreleased
* @since 1.0.0
*/
class OffSiteGatewayServiceProvider implements ServiceProvider
{
/**
* @unreleased
* @since 1.0.0
*/
public function register()
{
// TODO: Implement register() method.
}

/**
* @unreleased
* @since 1.0.0
*
* @throws Exception
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@
use GiveAddon\OffSiteGateway\Gateway\OffSiteGateway;

/**
* @unreleased
* @since 1.0.0
*/
class OffSiteGatewaysWebhookNotificationHandler
{
/**
* @unreleased
* @since 1.0.0
*/
public function __invoke(OffSiteGatewayWebhookNotification $webhookNotification)
{
/**
* Allow developers to handle the webhook notification.
*
* @unreleased
* @since 1.0.0
*
* @param OffSiteGatewayWebhookNotification $webhookNotification
*/
Expand Down Expand Up @@ -82,7 +82,7 @@ public function __invoke(OffSiteGatewayWebhookNotification $webhookNotification)
}

/**
* @unreleased
* @since 1.0.0
*/
private function isRecurringDonation(OffSiteGatewayWebhookNotification $webhookNotification): bool
{
Expand Down

0 comments on commit 0e1693d

Please sign in to comment.