vB_Api_Paidsubscription
extends vB_Api
in package
vB_Api_Paidsubscription
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- callNamed() : The
- Call the given api function by name with a named arguments list.
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- checkStatus() : void
- Check whether paid subscriptions system is active or not
- clearCache() : mixed
- Clears all previously loaded API objects.
- completePayPalOrder() : mixed
- completePaypalSubscription() : mixed
- endsubscription() : mixed
- User End a subscription by its own
- fetchActivePaymentApis() : array<string|int, mixed>
- Fetch all active payment APIs.
- fetchAll() : array<string|int, mixed>
- Fetch all subscriptions that an user can join and already joined It also fetches active payment APIs
- fetchPayPalJsArray() : array<string|int, mixed>
- fetchSubscribed() : mixed
- Fetch all active subscriptions current user is subscribed too
- getApiClassName() : mixed
- instance() : vB_Api
- Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
- instanceInternal() : vB_Api
- Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
- map_vb4_input_to_vb5() : string
- Returns vb5 api method name.
- map_vb5_errors_to_vb4() : mixed
- Alters the error array in any way necessary to interface correctly with vb4.
- map_vb5_output_to_vb4() : mixed
- Alters the output array in any way necessary to interface correctly with vb4.
- placeOrder() : mixed
- Prepares or places a subscription order, if applicable, and shows the payment buttons.
- preparePayPalOrder() : mixed
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
callNamed()
Call the given api function by name with a named arguments list.
public
callNamed() : The
Used primarily to translate REST requests into API calls.
Return values
The —return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.
checkApiState()
This method checks whether the API method is enabled.
public
checkApiState(mixed $method) : mixed
For extensions check make sure $controller property is already set.
Parameters
- $method : mixed
checkStatus()
Check whether paid subscriptions system is active or not
public
checkStatus() : void
Tags
clearCache()
Clears all previously loaded API objects.
public
static clearCache() : mixed
Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.
completePayPalOrder()
public
completePayPalOrder(string $order_id) : mixed
Parameters
- $order_id : string
completePaypalSubscription()
public
completePaypalSubscription(string $subscription_id, string $order_id) : mixed
Parameters
- $subscription_id : string
- $order_id : string
endsubscription()
User End a subscription by its own
public
endsubscription(mixed $subscriptionid) : mixed
Parameters
- $subscriptionid : mixed
-
int The id of the subscription
fetchActivePaymentApis()
Fetch all active payment APIs.
public
fetchActivePaymentApis() : array<string|int, mixed>
Return values
array<string|int, mixed> —Payment APIs
fetchAll()
Fetch all subscriptions that an user can join and already joined It also fetches active payment APIs
public
fetchAll([bool $isreg = false ]) : array<string|int, mixed>
Parameters
- $isreg : bool = false
-
Whether to fetch subscriptions for signup page
Return values
array<string|int, mixed> —Paid subscriptions info for the user.
fetchPayPalJsArray()
public
fetchPayPalJsArray() : array<string|int, mixed>
Return values
array<string|int, mixed>fetchSubscribed()
Fetch all active subscriptions current user is subscribed too
public
fetchSubscribed() : mixed
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
instance()
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
public
static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_ApiinstanceInternal()
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
public
static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Apimap_vb4_input_to_vb5()
Returns vb5 api method name.
public
static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string
May alter request array.
Parameters
- $method : string
-
-- vb4 method name
- $request : array<string|int, mixed>
-
-- $_REQUEST array for this api request
Return values
stringmap_vb5_errors_to_vb4()
Alters the error array in any way necessary to interface correctly with vb4.
public
static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- error array from vb5
map_vb5_output_to_vb4()
Alters the output array in any way necessary to interface correctly with vb4.
public
static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- output array from vb5
placeOrder()
Prepares or places a subscription order, if applicable, and shows the payment buttons.
public
placeOrder(mixed $subscriptionid, mixed $subscriptionsubid, mixed $paymentapiclass, mixed $currency[, mixed $context = 'usersettings' ]) : mixed
Note, this legacy method name is a misnomer for many payment APIs. Nowadays, an "order" is frequently not actually placed until a user physically clicks a button. In many cases this function only prepares the order button, and loads the necessary code to initialize the client SDK (if applicable) that allows the various frontend payment flows, before sending data back through prepareTransaction() & completeTransaction() to actually charge the user and complete the order.
Parameters
- $subscriptionid : mixed
- $subscriptionsubid : mixed
- $paymentapiclass : mixed
- $currency : mixed
- $context : mixed = 'usersettings'
preparePayPalOrder()
public
preparePayPalOrder(string $paymentapiclass, string $hash, string $currency, float $cost) : mixed
Parameters
- $paymentapiclass : string
- $hash : string
- $currency : string
- $cost : float