library php-message-code-mapper {🖫 3,838, ⚐ 5, ★ 0}

heidelpay/php-message-code-mapper

A library to convert heidelpay message codes into customer friendly messages.

Thursday, March 1, 2018
by heidelpay
Repository
4 Watchers
0 Stars
3,838 Installations

PHP
2 Dependents
1 Suggesters
0 Forks
1 Open issues
5 Versions
116 % Grown

The README.md

, _(*1)

Logo , _(*2)

heidelpay message code mapper

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

1. Installation, _(*4)

Composer, _(*5)

composer require heidelpay/php-message-code-mapper

manual Installation, _(*6)

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

2. Implementation, _(*8)

Composer, _(*9)

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

manual Installation, _(*10)

require_once 'path/to/php-message-code-mapper/lib/MessageCodeMapper.php';

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

3. Usage, _(*12)

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 MessageCodeMapper instance:, _(*13)

$instance = new \Heidelpay\MessageCodeMapper\MessageCodeMapper('de_DE');

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

The locale (e.g. 'en_US', 'de_DE')
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., _(*15)

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

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

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

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