\FAA\Handler\PaymentMethodPaypal

Summary

Methods

Properties

Constants

__construct()
GetFormPreset()
GetDefaultSettings()
GetSettings()
RequireRedirect()
StatusAfterDone()
BasketProcessable()
RegisterOrder()
PlaceOrder()
StoreSettings()
CalculatePrice()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

PrepareShippingAddress()
GetApiContext()
PrepareAmount()
PreparePayer()
PrepareItemList()
GetRedirectUrls()
loadLocalSettings()

$settings
$config_file
$preset_file
$default_config_file

N/A

Properties

$settings

$settings :\stdClass

Setup The local setup object

Type

\stdClass—A setup object

$config_file

$config_file :string

The current config file

Type

string

$preset_file

$preset_file :string

the available setup attributes

Type

string

$default_config_file

$default_config_file :string

the default config file

Type

string

Methods

__construct()

__construct()

construct construct the abstraction layer

GetFormPreset()

GetFormPreset(): \FAA\obj\Result

preset load the common pickup settings preset for generation a form

Returns

\FAA\obj\Result —

A system result object

GetDefaultSettings()

GetDefaultSettings(): \FAA\obj\Result

load defaults load the default settings for this delivery method

Returns

\FAA\obj\Result —

A system result object

GetSettings()

GetSettings(): \FAA\obj\Result

get load the common pickup settings object

Returns

\FAA\obj\Result —

A system result object

RequireRedirect()

RequireRedirect(): boolean

Requires a redirect for payment?

Returns

boolean

StatusAfterDone()

StatusAfterDone(): string

The status for the basket after payment

Returns

string

BasketProcessable()

BasketProcessable(\FAA\Obj\Generic\Basket  $basket): \FAA\obj\Result

Check if the basket can be processed using this method

This method supports all known delivery methods but no recurring payments

Parameters

\FAA\Obj\Generic\Basket

$basket

A system basket object

Returns

\FAA\obj\Result —

A system result object

RegisterOrder()

RegisterOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\obj\Result|\PayPal\Rest\ApiContext|null

register order callback called on register order of related basket

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\FAA\Obj\Request	$request	The related http request

Returns

\FAA\obj\Result|\PayPal\Rest\ApiContext|null

PlaceOrder()

PlaceOrder(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request): \FAA\obj\Result|\PayPal\Rest\ApiContext|null

place order callback called on place order of related basket

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\FAA\Obj\Request	$request	The related http request

Returns

\FAA\obj\Result|\PayPal\Rest\ApiContext|null

StoreSettings()

StoreSettings(\stdClass  $values): \FAA\obj\Result

store store the common pickup settings object

Parameters

\stdClass

$values

The configuration values

Returns

\FAA\obj\Result —

A system result object

CalculatePrice()

CalculatePrice(): \FAA\obj\Result

purge all values delete all files in a specific zone of the pickup

Returns

\FAA\obj\Result —

A system result object

PrepareShippingAddress()

PrepareShippingAddress(\FAA\Obj\Generic\Basket  $basket): \PayPal\Api\ShippingAddress

get shipping address Calculate the shipping address by given basket

Parameters

\FAA\Obj\Generic\Basket

$basket

A system basket object

Returns

\PayPal\Api\ShippingAddress —

The PayPal shipping address

GetApiContext()

GetApiContext(): null|\PayPal\Rest\ApiContext

Get context Get the paypal api context

Returns

null|\PayPal\Rest\ApiContext —

The context

PrepareAmount()

PrepareAmount(\FAA\Obj\Generic\Basket  $basket,\stdClass  $obj): \PayPal\Api\Amount

Prepare amount Calculate the shipping address by given basket

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\stdClass	$obj	A rendered basket object

Returns

\PayPal\Api\Amount —

The PayPal shipping amount

PreparePayer()

PreparePayer(\FAA\Obj\Generic\Basket  $basket): \PayPal\Api\Payer

Prepare the payer Calculate the payer object by given basket

Parameters

\FAA\Obj\Generic\Basket

$basket

Returns

\PayPal\Api\Payer —

The PayPal payer object

PrepareItemList()

PrepareItemList(\FAA\Obj\Generic\Basket  $basket,\FAA\Obj\Request  $request,\stdClass  $obj): \PayPal\Api\ItemList

Prepare items Calculate the shipping item list by given basket

Parameters

\FAA\Obj\Generic\Basket	$basket	A system basket object
\FAA\Obj\Request	$request	A system request
\stdClass	$obj	A rendered basket object

Returns

\PayPal\Api\ItemList —

The PayPal amount and item list

GetRedirectUrls()

GetRedirectUrls()

loadLocalSettings()

loadLocalSettings(): void

connect load settings object from local storage