LemonStand Documentation

Shop_CustomerGroup

The Shop_CustomerGroup class represents a customer group. You can manage customer groups on the Shop/Customers/Manage customer groups page. You can use this class for manipulating the customer groups and for assigning a specific customer group to new customers. The Customer registration page article contains an example of this feature.

Parent class: Db_ActiveRecord

Class fields

• $code - an API code of the customer group
• $name - a customer group name
• $description - a customer group description
• $disable_tax_included - indicates whether taxes should not be included to the displayed product prices for customers belonging to this group. This field reflects a state of the Do not include tax into displayed product prices checkbox on the customer group configuration form.

Class methods

• list_groups_by_codes($codes) - returns a list of customer groups by their API codes. The method parameter should be an array of API codes. The method returns an object of the Db_DataCollection class. Each element of the collection is an object of the Shop_CustomerGroup class. Example:

  $groups = Shop_CustomerGroup::list_groups_by_codes(array('registered', 'reseller'));

Next: Shop_ExtraOption
Previous: Shop_Customer
Return to Reference