library php-customer-messages

heidelpay/php-customer-messages

A libary for heidelpay messages.

, _(*1)

, _(*2)

heidelpay Customer Messages, _(*3)

ATTENTION: This package is abandoned and replaced by heidelpay/php-message-code-mapper., _(*4)

This library provides user-friendly output of (error)-messages coming from the heidelpay API., _(*5)

1. Installation, _(*6)

Composer, _(*7)

composer require heidelpay/php-customer-messages

manual Installation, _(*8)

Download the latest release from github and unpack it into a folder of your choice inside your project., _(*9)

2. Implementation, _(*10)

Composer, _(*11)

require_once 'path/to/autoload.php;
use Heidelpay\CustomerMessages\CustomerMessage;

manual Installation, _(*12)

require_once 'path/to/php-customer-messages/lib/CustomerMessage.php';

Of course, the path needs to match the path from step 1., _(*13)

3. Usage, _(*14)

Assuming you have received an error code from one of our modules or the heidelpay PHP API and stored it in a variable called $errorcode. To get a message from that code, create a CustomerMessage instance:, _(*15)

$instance = new \Heidelpay\CustomerMessages\CustomerMessage('de_DE');

The constructor takes two (optional) arguments:, _(*16)

1. The locale (e.g. 'en_US', 'de_DE')
2. The path to the locales path (for example you want to use your own locale files) containing the .csv files with the codes and messages.

We provide 'de_DE' and 'en_US' locale files with this package. You can find them in the lib/locales folder. If you want to use one of these, the path doesn't need to be provided in the constructor., _(*17)

By default, 'en_US' is used as the locale., _(*18)

Now you can return or print out the message by calling the getNessage() method:, _(*19)

return $instance->getMessage($errorcode); echo $instance->getMessage($errorcode);, _(*20)

Error codes are accepted in either the 'XXX.XXX.XXX' or 'HP-Error-XXX.XXX.XXX' format., _(*21)