XenForo Reference Guide for Developer
Back to top  

Handles user upgrade processing with PayPal.

package XenForo_UserUpgrade

 Methods

Get details for use in the log.

getLogDetails() : array

Returns

array

Gets the ID of the processor.

getProcessorId() : string

Returns

string

Gets the transaction ID.

getTransactionId() : string

Returns

string

Gets the ID of the upgrade record changed.

getUpgradeRecordId() : integer

Returns

integer

Initializes handling for processing a request callback.

initCallbackHandling(\Zend_Controller_Request_Http $request) 

Parameters

$request

\Zend_Controller_Request_Http

Logs the request.

log(string $type, string $message, array $extra) 

Parameters

$type

string

Log type (info, payment, cancel, error)

$message

string

Log message

$extra

array

Extra details to log (not including output from getLogDetails)

Once all conditions are validated, process the transaction.

processTransaction() : array

Returns

array[0] => log type (payment, cancel, info), [1] => log message

Validates pre-conditions on the callback.

validatePreConditions(string $errorString) : boolean

These represent things that likely wouldn't get fixed (and generally shouldn't happen), so retries are not necessary.

Parameters

$errorString

string

Returns

boolean

Validates the callback request is valid.

validateRequest(string $errorString) : boolean

If failure happens, the response should tell the processor to retry.

Parameters

$errorString

string

Output error string

Returns

boolean

 Properties

 

$_filtered : array
 

$_input : \XenForo_Input
 

$_request : \Zend_Controller_Request_Http
 

$_upgrade : array | false
 

$_upgradeModel : \XenForo_Model_UserUpgrade
 

$_upgradeRecord : array | false
 

$_upgradeRecordId : integer | null
 

$_user : array | false