Download the PHP package thelia/customer-family-module without Composer
On this page you can find all versions of the php package thelia/customer-family-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download thelia/customer-family-module
More information about thelia/customer-family-module
Files in thelia/customer-family-module
Package customer-family-module
Short Description For creating customer families
License LGPL-3.0+
Informations about the package customer-family-module
Customer Family
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 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
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
Argument | Description |
---|---|
id | family id |
exclude_id | exclude family id |
is_default | filter default family |
Output values
Argument | Description |
---|---|
CUSTOMER_FAMILY_ID | customer family id |
CODE | customer family code |
TITLE_CUSTOMER_FAMILY | customer family title |
IS_DEFAULT | default customer family |
Example
customer_customer_family
This loop returns customer family for specific customer or inverse
Input arguments
Argument | Description |
---|---|
customer_id | customer id |
customer_family_id | family id |
customer_family_code | family code |
Output values
Argument | Description |
---|---|
CUSTOMER_FAMILY_ID | customer family id |
CUSTOMER_ID | customer id |
Example
customer_family_price
This loop returns the customer family's equation data
Input arguments
Argument | Description |
---|---|
customer_family_id | family id |
promo | equation for the promo price or not |
use_equation | is the equation used to calculate price |
Output values
Argument | Description |
---|---|
CUSTOMER_FAMILY_ID | customer family id |
PROMO | equation for the promo price or not |
USE_EQUATION | is the equation used to calculate price |
AMOUNT_ADDED_BEFORE | amount directly added to the purchase price |
AMOUNT_ADDED_AFTER | amount added to the purchase price after the multiplication |
COEFFICIENT | coefficient the purchase price added to AMOUNT_ADDED_BEFORE is multiplied by |
IS_TAXED | are taxes applied on the final calculated price |
Example
customer_family_pse_calculated_prices
This loop returns the PSE's calculated price based on the given customer family & currency
Input arguments
Argument | Description |
---|---|
pse_id | mandatory, PSE id |
currency_id | currency id (if not given, use default currency) |
customer_family_id | mandatory, customer family id |
Output values
Argument | Description |
---|---|
CALCULATED_PRICE | customer family id |
CALCULATED_TAXED_PRICE | equation for the promo price or not |
CALCULATED_PROMO_PRICE | is the equation used to calculate price |
CALCULATED_TAXED_PROMO_PRICE | amount directly added to the purchase price |
Example
Form customer_family_customer_create_form
This form extend customer_create_form
Fields
Name | Type | Required |
---|---|---|
customer_family_id | integer | true |
Default
By default, two families are created
- Private individual
- Professional