\Dalenys_Api_FormClient

Implements Dalenys payment API

Summary

Methods

Properties

Constants

__construct()
setCredentials()
setVersion()
buildAuthorizationFormButton()
buildPaymentFormButton()
hash()
checkHash()

No public properties found

No constants found

buildProcessButton()
getVersion()

$version
$identifier
$password
$renderer
$hash

N/A

No private methods found

No private properties found

N/A

File: FormClient.php
Package: Dalenys
Class hierarchy: \Dalenys_Api_FormClient

Properties

$version

$version :

API version

Type

$identifier

$identifier : string

Type

string — Dalenys identifier

$password

$password : string

Type

string — Dalenys password

$renderer

$renderer : \Dalenys_Api_Renderer_Renderable

Type

\Dalenys_Api_Renderer_Renderable — How to render the payment form

$hash

$hash : \Dalenys_Api_Hash_Hashable

Type

\Dalenys_Api_Hash_Hashable — How to hash the payment form

Methods

__construct()

__construct(string  $identifier, string  $password, \Dalenys_Api_Renderer_Renderable  $renderer, \Dalenys_Api_Hash_Hashable  $hash)

Instanciate

Parameters

string	$identifier	The Dalenys identifier
string	$password	The Dalenys password
\Dalenys_Api_Renderer_Renderable	$renderer	How to render the form
\Dalenys_Api_Hash_Hashable	$hash

setCredentials()

setCredentials(string  $identifier, string  $password)

Configure credentials

Parameters

string	$identifier
string	$password

setVersion()

setVersion(string  $version)

Set default Dalenys VERSION parameter

Parameters

string

$version

The VERSION number (ex: 3.0)

buildAuthorizationFormButton()

buildAuthorizationFormButton(integer|array  $amount, string  $orderId, string  $clientIdentifier, string  $description, array  $htmlOptions = array(), array  $options = array()) : string

Build authorization form and submit button

Return the authorization form and all hidden input configuring the dalenys transaction.

Parameters

integer\|array	$amount	The transaction amount in cents. If $amount is an array it will be used as NTime transaction (fragmented payment). In this case, the array should be formatted this way: `$amounts = array('2014-01-01' => 100, '2014-02-01' => 200, '2014-03-01' => 100)` The first entry's date should be the current date (today)
string	$orderId	The orderid (should be unique by transaction, but no unicity check are performed)
string	$clientIdentifier	The client identifier
string	$description	The transaction description
array	$htmlOptions	An array of HTML attributes to add to the submit or form button (allowing to change name, style, class attribute etc.). Example: `$htmlOptions['SUBMIT'] = array('class' => 'my_class'); $htmlOptions['FORM'] = array('class' => 'my_form', 'target' => 'my_target');`
array	$options	Others dalenys options. See Dalenys documentation for more information (3DS, CREATEALIAS, etc.)

Returns

string —

The HTML output to display

Tags

api

buildPaymentFormButton()

buildPaymentFormButton(integer|array  $amount, string  $orderId, string  $clientIdentifier, string  $description, array  $htmlOptions = array(), array  $options = array()) : string

Build payment form and submit button

Return the payment form and all hidden input configuring the dalenys transaction.

Parameters

integer\|array	$amount	The transaction amount in cents. If $amount is an array it will be used as NTime transaction (fragmented payment). In this case, the array should be formatted this way: `$amounts = array('2014-01-01' => 100, '2014-02-01' => 200, '2014-03-01' => 100)` The first entry's date should be the current date (today)
string	$orderId	The orderid (should be unique by transaction, but no unicity check are performed)
string	$clientIdentifier	The client identifier
string	$description	The transaction description
array	$htmlOptions	An array of HTML attributes to add to the submit or form button (allowing to change name, style, class attribute etc.). Example: `$htmlOptions['SUBMIT'] = array('class' => 'my_class'); $htmlOptions['FORM'] = array('class' => 'my_form', 'target' => 'my_target');`
array	$options	Others dalenys options. See Dalenys documentation for more information (3DS, CREATEALIAS, etc.)

Returns

string —

The HTML output to display

string	$operationType
string	$orderId
string	$clientIdentifier
string	$description
array	$htmlOptions
array	$options