PayZenPayment Class Reference

Inheritance diagram for PayZenPayment:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	prepare_forPayment ($params=array())
	load_paymentConfirmation ()
	is_paymentConfirmed ()
	is_paymentCancelled ()
	get_paymentConfirmationData ()
	execute_checkout ()
	get_transactionId ()
	get_manualTransferLink ()
	get_lastError ()
	get_lastErrorMessage ()
	load_configuration ()
	compute_signature ($params, $key, $hash)
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Public Attributes
	$params = array()
	Input parameters. More...
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...

Private Member Functions
	set_lastError ($errorCode, $errorMsg)

Private Attributes
	$_lastErrorCode = 0
	Last error code. More...
	$_lastErrorMsg = ''
	Last error message. More...
	$_transactionId = ''
	Transaction id. More...
	$transactionParams
	Transaction params. More...
	$confirmationData = null
	Confirmation data received from Payzen instant notifications. More...

Additional Inherited Members
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

PayZenPayment Input class.

Constructor & Destructor Documentation

__construct()

PayZenPayment::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

initialise()

PayZenPayment::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

prepare_forPayment()

PayZenPayment::prepare_forPayment

(

$params = array()

)

Prepare for payment.

Parameters

array

$params

Returns

boolean result

load_paymentConfirmation()

PayZenPayment::load_paymentConfirmation

(

)

Load confirmation data Payzen instant notification.

Returns

void

is_paymentConfirmed()

PayZenPayment::is_paymentConfirmed

(

)

Check if payment is confirmed.

Returns

boolean result

is_paymentCancelled()

PayZenPayment::is_paymentCancelled

(

)

Check if payment is cancelled.

Returns

boolean result

get_paymentConfirmationData()

PayZenPayment::get_paymentConfirmationData

(

)

Return response data from confirmation request.

Returns

array

execute_checkout()

PayZenPayment::execute_checkout

(

)

Execute check out.

Returns

array

get_transactionId()

PayZenPayment::get_transactionId

(

)

Return transaction ID.

Returns

string

get_manualTransferLink()

PayZenPayment::get_manualTransferLink

(

)

Return manual transfer link.

Returns

string

set_lastError()

PayZenPayment::set_lastError (   $errorCode,   $errorMsg  )

private

Define last error.

Parameters

integer	$errorCode
string	$errorMsg

get_lastError()

PayZenPayment::get_lastError

(

)

Return last error as code.

Returns

integer

get_lastErrorMessage()

PayZenPayment::get_lastErrorMessage

(

)

Return last error as text.

Returns

string

load_configuration()

PayZenPayment::load_configuration

(

)

Load plugin configuration

Returns

void

compute_signature()

PayZenPayment::compute_signature	(		$params,
			$key,
			$hash
	)

Compute signature from params and key.

Parameters

array	$params
string	$key
string	$hash

Returns

string

initialise_configDisplay()

PayZenPayment::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode.

Returns

void

display_configDisplay()

PayZenPayment::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode.

Returns

void

initialise_configEdition()

PayZenPayment::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object

$form

Returns

void

display_configEdition()

PayZenPayment::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode.

Returns

void

save_configuration()

PayZenPayment::save_configuration

(

)

Execute object in Admin_Site / save configuration mode.

Returns

void

Member Data Documentation

$_lastErrorCode

PayZenPayment::$_lastErrorCode = 0

private

Last error code.

var integer $_lastErrorCode

$_lastErrorMsg

PayZenPayment::$_lastErrorMsg = ''

private

Last error message.

var string $_lastErrorMsg

$_transactionId

PayZenPayment::$_transactionId = ''

private

Transaction id.

var string $_transactionId

$transactionParams

PayZenPayment::$transactionParams

private

Initial value:

= array(
        'action_mode'           => 'INTERACTIVE',
        'amount'                => 0,
        'currency'              => '978',
        'page_action'           => 'PAYMENT',
        'payment_config'        => 'SINGLE',
        'trans_date'            => '',
        'trans_id'              => '',
        'version'               => 'V2',
    )

Transaction params.

var array $transactionParams

$params

PayZenPayment::$params = array()

Input parameters.

var array $params

$confirmationData

PayZenPayment::$confirmationData = null

private

Confirmation data received from Payzen instant notifications.

var array $confirmationData

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/PayZenPayment/PayZenPayment.php.inc