LimonetikPayment Input
Interface to Limonetik payment system. More...

Inheritance diagram for LimonetikPayment:

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_transactionPaymentMethod ()

	get_lastError ()

	get_lastErrorMessage ()

	display_error ()

	get_configValue ($item, $default=null)

	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...

Protected Attributes
	$_lastErrorCode = 0
	Last error code. More...

	$_lastErrorMsg = ''
	Last error message. More...

	$_lastErrorDetails = ''
	Last error details. More...

	$config = null
	Plugin configuration object. More...

Private Member Functions
	execute_limonetikRequest ($action, $data, $method='POST')

	set_lastError ($errorCode, $errorMsg, $errorDetails='')

	load_configuration ()

Private Attributes
const	LIMONETIKAPIURLS
	Stores Limonetik API URLs. More...

const	LIMONETIKAPIVERSION = 'V40'
	Stores Limonerik API Version. More...

	$_transactionId = ''
	Transaction id. 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

LimonetikPayment Input
Interface to Limonetik payment system.

Plugin / Input Engine

Author: CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version: 1.0.4

Date: Creation: Oct 2020; Modification: May 2021

Copyright: 2020 - 2021 CaMykS Team

Note: This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. LimonetikPayment Input class.

Constructor & Destructor Documentation

◆ __construct()

LimonetikPayment::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Returns: void

Member Function Documentation

◆ initialise()

LimonetikPayment::initialise ( $params = array() )

Initialise input.

Parameters

array $params

Returns: void

Reimplemented from Input.

◆ prepare_forPayment()

LimonetikPayment::prepare_forPayment ( $params = array() )

Prepare for payment.

Parameters

array $params

Returns: boolean result

◆ load_paymentConfirmation()

LimonetikPayment::load_paymentConfirmation ( )

Load confirmation data Payzen instant notification.

Returns: void

◆ is_paymentConfirmed()

LimonetikPayment::is_paymentConfirmed ( )

Check if payment is confirmed.

Returns: boolean result

◆ is_paymentCancelled()

LimonetikPayment::is_paymentCancelled ( )

Check if payment is cancelled.

Returns: boolean result

◆ get_paymentConfirmationData()

LimonetikPayment::get_paymentConfirmationData ( )

Return response data from confirmation request.

Returns: array

◆ execute_checkout()

LimonetikPayment::execute_checkout ( )

Execute check out.

Returns: array

◆ get_transactionId()

LimonetikPayment::get_transactionId ( )

Return transaction ID.

Returns: string

◆ get_transactionPaymentMethod()

LimonetikPayment::get_transactionPaymentMethod ( )

Return transaction payment method.

Returns: string

◆ execute_limonetikRequest()

LimonetikPayment::execute_limonetikRequest	(	$action,
		$data,
		$method = `'POST'`
	)

private

Execute request to Limonetik server.

Parameters

string	$action
array	$data
string	$method

Returns: array

◆ set_lastError()

LimonetikPayment::set_lastError	(	$errorCode,
		$errorMsg,
		$errorDetails = `''`
	)

private

Define last error.

Parameters

integer	$errorCode
string	$errorMsg
string	$errorDetails

Returns: return void

◆ get_lastError()

LimonetikPayment::get_lastError ( )

Return last error as code.

Returns: integer

◆ get_lastErrorMessage()

LimonetikPayment::get_lastErrorMessage ( )

Return last error as text.

Returns: string

◆ display_error()

LimonetikPayment::display_error ( )

Display error.

Returns: void

◆ get_configValue()

LimonetikPayment::get_configValue	(	$item,
		$default = `null`
	)

Return configuration value.

Parameters

string	$item
mixed	$default

Returns: void

◆ load_configuration()

LimonetikPayment::load_configuration ( )

private

Load plugin configuration.

Returns: void

◆ initialise_configDisplay()

LimonetikPayment::initialise_configDisplay ( )

Initialise object in Admin_Site / view configuration mode.

Returns: void

◆ display_configDisplay()

LimonetikPayment::display_configDisplay ( )

Display object in Admin_Site / view configuration mode.

Returns: void

◆ initialise_configEdition()

LimonetikPayment::initialise_configEdition ( $form )

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object $form

Returns: void

◆ display_configEdition()

LimonetikPayment::display_configEdition ( )

Display object in Admin_Site / edit configuration mode.

Returns: void

◆ save_configuration()

LimonetikPayment::save_configuration ( )

Execute object in Admin_Site / save configuration mode.

Returns: void

Member Data Documentation

◆ LIMONETIKAPIURLS

const LimonetikPayment::LIMONETIKAPIURLS

private

Initial value:

= array(
        'test'  => 'https://api.limonetikqualif.com',
        'live'  => 'https://api.limonetik.com',
    )

Stores Limonetik API URLs.

const array LIMONETIKAPIURLS

◆ LIMONETIKAPIVERSION

const LimonetikPayment::LIMONETIKAPIVERSION = 'V40'

private

Stores Limonerik API Version.

const string LIMONETIKAPIVERSION

◆ $_lastErrorCode

LimonetikPayment::$_lastErrorCode = 0

protected

Last error code.

var integer $_lastErrorCode

◆ $_lastErrorMsg

LimonetikPayment::$_lastErrorMsg = ''

protected

Last error message.

var string $_lastErrorMsg

◆ $_lastErrorDetails

LimonetikPayment::$_lastErrorDetails = ''

protected

Last error details.

var string $_lastErrorDetails

◆ $_transactionId

LimonetikPayment::$_transactionId = ''

private

Transaction id.

var string $_transactionId

◆ $params

LimonetikPayment::$params = array()

Input parameters.

var array $params

◆ $confirmationData

LimonetikPayment::$confirmationData = null

private

Confirmation data received from Payzen instant notifications.

var array $confirmationData

◆ $config

LimonetikPayment::$config = null

protected

Plugin configuration object.

var Object $config

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

CaMykS/plugin/input/LimonetikPayment/LimonetikPayment.php.inc

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ initialise()

◆ prepare_forPayment()

◆ load_paymentConfirmation()

◆ is_paymentConfirmed()

◆ is_paymentCancelled()

◆ get_paymentConfirmationData()

◆ execute_checkout()

◆ get_transactionId()

◆ get_transactionPaymentMethod()

◆ execute_limonetikRequest()

◆ set_lastError()

◆ get_lastError()

◆ get_lastErrorMessage()

◆ display_error()

◆ get_configValue()

◆ load_configuration()

◆ initialise_configDisplay()

◆ display_configDisplay()

◆ initialise_configEdition()

◆ display_configEdition()

◆ save_configuration()

Member Data Documentation

◆ LIMONETIKAPIURLS

◆ LIMONETIKAPIVERSION

◆ $_lastErrorCode

◆ $_lastErrorMsg

◆ $_lastErrorDetails

◆ $_transactionId

◆ $params

◆ $confirmationData

◆ $config