thelia/customer-family-module

For creating customer families

3.1.12 2024-11-28 10:18 UTC

Requires

• thelia/installer: ~1.0

LGPL-3.0+

README

Create customer families (professional, private individual, ...) and manage specific prices.

Also allow to define purchase prices for products.

Compatibility

Thelia >= 2.3.x

For use with lower version of Thelia look for older tags on this module.

Installation

Manually

• Copy the module into <thelia_root>/local/modules/CustomerFamily directory and be sure that the name of the module is CustomerFamily.
• Activate it in your thelia administration panel

Composer

Add it in your main thelia composer.json file

composer require thelia/customer-family-module:~1.5.0

Usage

This module is visible in the BackOffice Customer Edit.

Use the first tab to create, edit or remove families. You can also define default family, use to show specific price to unlogged customers.

The second tab allows you to define how prices are calculated for each family, depending on the products purchase price.

Product's prices are automatically changed in the 'product' loop, you don't need to use 'customer_family_pse_calculated_prices' loop (see below) to get product's prices.

Loops

Use provided loops to display for example taxed or untaxed price depending on the customer's family.

customer_family

This loop returns client families

Input arguments

Output values

Example

{loop type="customer_family" name="customer_family_loop" current_product=$product_id limit="4"}
    {$CODE} ({$TITLE_CUSTOMER_FAMILY})
{/loop}

customer_customer_family

This loop returns customer family for specific customer or inverse

Input arguments

Output values

Example

{loop type="customer_customer_family" name="customer_customer_family_loop" customer_id="4"}

{/loop}

customer_family_price

This loop returns the customer family's equation data

Input arguments

Output values

Example

{loop type="customer_family_price" name="customer_family_price_loop" customer_family_id=1 promo=0}
    {$AMOUNT_ADDED_BEFORE}
    ...
{/loop}

customer_family_pse_calculated_prices

This loop returns the PSE's calculated price based on the given customer family & currency

Input arguments

Output values

Example

{loop type="customer_family_pse_calculated_prices" name="customer_family_pse_calculated_prices_loop" pse_id=22 customer_family_id=1}
    {$CALCULATED_TAXED_PRICE}
    ...
{/loop}

Form customer_family_customer_create_form

This form extend customer_create_form

Fields

Default

By default, two families are created

• Private individual
• Professional