thelia/customer-group-module

CustomerGroup

This module adds customer groups, in which you can put customers., _(*1)

Installation

Manually

• Copy the module into the <thelia_root>/local/modules/ directory and make sure that the name of the module is CustomerGroup
• Activate it in your Thelia administration panel

Composer

Add it in your main Thelia composer.json file, _(*2)

composer require thelia/customer-group-module:~0.1

Configuration

Modules that use customer groups must define them in the customer-group.xml file in the module configuration directory. The groups will be created when the module is activated., _(*3)

One the groups can be defined as the default group. All new customers will be automatically added to this group., _(*4)

<customergroups xmlns="urn:thelia:module:customer-group">
    <customergroup code="customer">
        <descriptive locale="en_US">
            <title>Customer</title>
            <description>Basic customer<description>
        </descriptive>
        <descriptive locale="fr_FR">
            <title>Client</title>
            <description>Client de base<description>
        </descriptive>
    </customergroup>

    <customergroup code="vip">
        <descriptive locale="en_US">
            <title>VIP</title>
            <description>VIP customer !<description>
        </descriptive>
        <descriptive locale="fr_FR">
            <title>VIP</title>
            <description>Client VIP !<description>
        </descriptive>
    </customergroup>

    <default>customer</default>
</customergroups>

Events

Events should be used to perform actions related to customer groups., _(*5)

The CustomerGroup\Event\CustomerGroupEvents class contains event name constants for this module. Event classes are also in the CustomerGroup\Event namespace., _(*6)

Add a customer to a group

$event = new AddCustomerToCustomerGroupEvent();
$event->setCustomerId($myCustomer->getId());
$event->setCustomerGroupId($myGroup->getId());

$dispatcher->dispatch(
    CustomerGroupEvents::ADD_CUSTOMER_TO_CUSTOMER_GROUP,
    $event
);

Handler

The customer_group.handler service provide functions to check if a customer belongs to a group. See the CustomerGroupHandler class for available methods., _(*7)

Get handler (service)

$groupHandler = $container->get("customer_group.handler");

Get session customer's customerGroup info

// get customerGroup of the current customer (session)
$groupHandler->getGroup();
// get customerGroup code of the current customer (session)
$groupHandler->checkGroupCode();

Check if a customer belongs to a group

// check a customer
$groupHandler->checkCustomerHasGroup($myCustomer, "vip");

// check the customer currently logged-in
$groupHandler->checkGroup("vip");

Loops

customergroup

This loop list customer groups., _(*8)

Input arguments

The order can be one of these:, _(*9)

• position (default)
• position-reverse
• id
• id-reverse
• code
• code-reverse
• title
• title-reverse
• is_default
• is_default-reverse

Output variables

customercustomergroup

This group lists the associations between customers and customer groups., _(*10)

Input arguments

Output variables

customer

This module also adds group information to the customer loop and allows filtering the customers using groups., _(*11)

Additional input arguments

Additional output variables

Query

CustomerQuery

This module provides a CustomerQuery class that extends the base Thelia query and provides methods to filter customers by group., _(*12)

It can be used in replacement of the base CustomerQuery., _(*13)

use CustomerGroup\Model\CustomerQuery as CustomerGroupCustomerQuery;

$customers = CustomerGroupCustomerQuery::create()
    ->filterByCustomerGroup("myGroup")
    ->find();

Or mixed in your own query class by using the static methods. These methods take a ModelCriteria query class and will act on it., _(*14)

They assume that the customer table is already present in the query scope, so your query must for exemple extends CustomerQuery or make a join to the customer table., _(*15)

use CustomerGroup\Model\CustomerQuery as CustomerGroupCustomerQuery;

// MyQuery extends CustomerQuery
// or MyQuery has a join to the customer table somewhere
$myQuery = MyQuery::create();

CustomerGroupCustomerQuery::addCustomerGroupFilter($myQuery, "myGroup");