PHPackages                             thelia/creditaccount-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. thelia/creditaccount-module

ActiveThelia-module

thelia/creditaccount-module
===========================

2.0.5(1y ago)11.2k↓100%11[1 issues](https://github.com/thelia-modules/CreditAccount/issues)LGPL-3.0+PHPCI failing

Since Mar 10Pushed 1y ago4 watchersCompare

[ Source](https://github.com/thelia-modules/CreditAccount)[ Packagist](https://packagist.org/packages/thelia/creditaccount-module)[ RSS](/packages/thelia-creditaccount-module/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (24)Used By (0)

English Instructions
--------------------

[](#english-instructions)

Credit account
==============

[](#credit-account)

This module is a base for creating module like sponsorship or assets management.

\##Installation

```
$ cd local/modules
$ git clone https://github.com/thelia-modules/CreditAccount

```

You could also download the zip from github.

After that, you just have to activate the module in your back-office.

How to use it
-------------

[](#how-to-use-it)

In your back-office, on each customer edition page you can add a new credit account.

Integration
-----------

[](#integration)

In back-office, the module places itself in the `account.bottom` hook, which is in the customer details page.

Two loops are available with this module. One for the credit account history and the other one for the current credit account.

A route exists allowing customer to consume his credit account, within the limits of order total, excluded shipping. You just have to call the `/creditAccount/use` and the controller will find the credit account of the current customer and put the available amount in the discount amount.

To cancel the use of credit account, use the `/creditAccount/cancel` route.

Invoking these routes will redirect the customer to the `order.invoice` route.

The module creates a hook, `order-invoice.before-discount`, where the code which allows your customer to use their credit is inserted. You have to put the hook in the `order-invoice.html` template file, just before the "Discount" block for example.

### Code to insert in the `order-invoice.html` file in your template:

[](#code-to-insert-in-the-order-invoicehtml-file-in-your-template)

```
{hook name='order-invoice.before-discount'}
```

Expiration
----------

[](#expiration)

Since version 1.3.0 of this module you can enable expiration of credit.
Just go in the CreditAccount configuration end enable it (it's disabled by default) then you can choose the expiration delay (in months).
The date of expiration is computed with the last date of creditation + your expiration delay.
Expiration is checked each time the customer add an item in cart but if you want you can set this a command as cron to force expiration check `php Thelia creditaccount:expiration:check`.

### Hooks

[](#hooks)

The module uses the front office `account.bottom` hook to display account history in the customer "My Account" page.

It also uses the `following back-office hooks

- `account.bottom` to display customer account history in customer details.
- `order-edit.after-order-product-list` to display in order detail the entries added to a credit account by the order.

It creates a `order-invoice.before-discount` which has to be inserted in the `order-invoice.html` template file.

Loops
-----

[](#loops)

### credit\_account\_history loop

[](#credit_account_history-loop)

List the credit account history for a specified credit account.

#### Input arguments

[](#input-arguments)

- credit\_account : credit account id, it's a mandatory parameter.
- order : an order ID, to get only entries related to this order.

#### Output variables

[](#output-variables)

- `$CREDIT_AMOUNT` the entry amount, either positive or negative, in the default currency
- `$ORDER_ID` the related order ID, where an amount has been gained or used. 0 si this entry is a manual operation
- `$HAS_ORDER_ID` false for a manual operation, true if related to an order
- `$WHO_DID_IT` name of the administrator who did a manual operation
- `$CREATE_DATE`
- `$UPDATE_DATE`

#### Example

[](#example)

```
{loop type="order" name="order-account-order" id=$order_id customer="*"}
    {loop type="credit_account" name="credit_account" customer=$CUSTOMER}
        {loop type="credit_account_history" name="credit_account_history" credit_account=$ID order=$order_id}
            {if $CREDIT_AMOUNT  0}

                    {intl l="Use my credit account (%amount available)" amount={format_money number=$CREDIT_AMOUNT symbol=$currencySymbol}}

    {/if}
{/loop}
```

### credit\_account\_usage loop

[](#credit_account_usage-loop)

Returns the credit amount used on the current order for the current customer, or nothing if no credit amount is currently in use.

#### Input argument

[](#input-argument-1)

None.

#### Output variables

[](#output-variables-2)

- `$AMOUNT_USED` `the amount from credit account used on the current order in the default currency.

#### Example usage

[](#example-usage-1)

```
{loop type="credit_account_usage" name="credit-used"}
    {intl l="You're using %amount from your credit account." amount={format_money number=$AMOUNT_USED symbol=$currencySymbol}}
    {intl l='Cancel'}
{/loop}
```

Listeners
---------

[](#listeners)

This module is a base for creating module like sponsorship or assets management. So some listeners are preconfigured for using it in other modules.

### creditAccount.addAccount

[](#creditaccountaddaccount)

This listener is used for adding an amount to a customer's credit account. You have to dispatch a `CreditAccount\Event\CreditAccountEvent` class

#### Example

[](#example-1)

```
//retrieve the dispatcher for using it after. I put it in $dispatcher

// retrieve a customer. For the example I retrieve a random customer, obviously not do that in your application
$customer = \Thelia\Model\CustomerQuery::create()->findOne();

//the amount I want to add to the current customer's credit account
$amount = 10;

// Create the event to dispatch
$event = new \CreditAccount\Event\CreditAccountEvent($customer, $amount)

//dispatch the event
$dispatcher->dispatch(\CreditAccount\CreditAccount::CREDIT_ACCOUNT_ADD_AMOUNT, $event);

```

---

Instructions en Français
------------------------

[](#instructions-en-français)

Crédit client
=============

[](#crédit-client)

Ce module permet d'ajouter un crédit à chacun de vos clients. Il est aussi nécessaire pour des modules du type Fidélisation ou Gestion des avoirs.

\##Installation

```
$ cd local/modules
$ git clone https://github.com/thelia-modules/CreditAccount

```

Vous pouvez aussi téléchargez le zip depuis Github.

Ensuite vous n'avez plus qu'à activer le module dans votre back-office.

Utilisation
-----------

[](#utilisation)

Dans votre back-office, vous pouvez ajouter pour chaque client un crédit fidélité. Pour cela, rendez-vous sur la page d'édition du compte client.

Intégration
-----------

[](#intégration)

Trois boucles sont disponibles pour ce module: une pour l'historique du compte crédit, une pour obtenir le solde du compte, et une pour connaitre l'utilisation du compte sur la commande en cours.

Pour permettre au client d'utiliser son crédit, il suffit d'appeler la route `/creditAccount/use`. Le contrôleur trouvera lui-même le crédit du client en question, et l'ajoutera dans le montant de la réduction. Pour annuler l'utilisation du crédit, utiliser la route `/creditAccount/cancel`

Ce module crée un nouveau point d'accroche, `order-invoice.before-discount`, où le code qui permet à vos clients d'utiliser leur crédit fidélité sera inséré. Placez le code de ce point d'accorche dans le fichier `order-invoice.html` de votre template, juste avant le bloc Remise par exemple.

### Code to insert in the `order-invoice.html` file in your template:

[](#code-to-insert-in-the-order-invoicehtml-file-in-your-template-1)

### Code du point d'accorche à insérer dans le fichier `order-invoice.html` de votre template:

[](#code-du-point-daccorche-à-insérer-dans-le-fichier-order-invoicehtml-de-votre-template)

```
{hook name='order-invoice.before-discount'}
```

Boucles
-------

[](#boucles)

### Boucle credit\_account\_history

[](#boucle-credit_account_history)

Liste l'historique des operations sur un compte donné

### Paramètres

[](#paramètres)

- credit\_account : credit account id, identifiant du compte, paramètre obligatoire

### Résultats

[](#résultats)

- $CREDIT\_AMOUNT
- $ORDER\_ID l'ID de la commande associé, ou 0 si l'operation est manuelle
- $HAS\_ORDER\_ID false pour une opération manuelle, true sinon.
- $WHO\_DID\_IT nom de l'administrateur pour une opération manuelle.
- $CREATE\_DATE
- $UPDATE\_DATE

### Exemple d'utilisation

[](#exemple-dutilisation)

```
{loop type="order" name="order-account-order" id=$order_id customer="*"}
    {loop type="credit_account" name="credit_account" customer=$CUSTOMER}
        {loop type="credit_account_history" name="credit_account_history" credit_account=$ID order=$order_id}
            {if $CREDIT_AMOUNT