This is the API docs for LemonStand V1, which has been discontinued. LemonStand is now a cloud based platform, available at lemonstand.com.

LemonStand API

Shop_CustomerGroup class

Defined in /modules/shop/models/shop_customergroup.php, lines 14-314
Inheritance Phpr_Extension » Phpr_Extensible » Phpr_Validatable » Db_Base » Db_WhereBase » Db_SqlBase » Db_ActiveRecord » Shop_CustomerGroup
Author LemonStand eCommerce Inc.
Represents a customer group.

Public properties

Show inherited properties.

Property Type Description Defined By
auto_create_timestamps array a list of create timestamp columns. Db_ActiveRecord
auto_timestamps boolean determines whether create and update timestamp field should be set automatically. Db_ActiveRecord
auto_update_timestamps array a list of update timestamp columns. Db_ActiveRecord
belongs_to array contains a list of Belongs To Many relations. Db_ActiveRecord
code string specifies the customer group API code. Shop_CustomerGroup
custom_columns array contains a list of custom fields definition. Db_ActiveRecord
description string specifies the customer group description. Shop_CustomerGroup
disable_tax_included boolean indicates whether taxes should not be included to the displayed product prices for customers belonging to this group. Shop_CustomerGroup
fetched array contains an associative array of table column values fetched from the database. Db_ActiveRecord
has_and_belongs_to_many array contains a list of Has and Belongs To Many relations. Db_ActiveRecord
has_many array contains a list of Has Many relations. Db_ActiveRecord
has_one array contains a list of Has One relations. Db_ActiveRecord
id integer specifies the customer group record identifier. Shop_CustomerGroup
name string specifies the customer group name. Shop_CustomerGroup
primary_key string specifies a name of the table primary key. Db_ActiveRecord
validation Phpr_Validation contains the model's validation object. Db_ActiveRecord

Public methods

Show inherited methods.

Method Description Defined By
add_form_custom_area() adds a form custom area. Db_ActiveRecord
add_form_field() makes a column visible in forms. Db_ActiveRecord
add_form_partial() adds a custom form partial. Db_ActiveRecord
add_form_section() adds a form section. Db_ActiveRecord
after_create() called after a new object is saved to the database. Db_ActiveRecord
after_create_saved() called after a new object is saved to the database. Db_ActiveRecord
after_delete() called after an existing or new record is deleted from the database. Db_ActiveRecord
after_modify() called after an existing or new record was modified. Db_ActiveRecord
after_save() called after an existing or new record is created or updated in the database. Db_ActiveRecord
after_update() called after an existing record is updated in the database. Db_ActiveRecord
after_validation() triggered after the model column values are validated. Db_ActiveRecord
after_validation_on_create() triggered after a new model column values are validated. Db_ActiveRecord
after_validation_on_update() triggered after an existing model column values are validated. Db_ActiveRecord
before_create() called before a new object is saved to the database. Db_ActiveRecord
before_save() called before an existing or new record is created or updated in the database. Db_ActiveRecord
before_update() called before an existing record is updated in the database. Db_ActiveRecord
before_validation() triggered before the model column values are validated. Db_ActiveRecord
before_validation_on_create() triggered before a new model column values are validated. Db_ActiveRecord
before_validation_on_update() triggered before an existing model column values are validated. Db_ActiveRecord
collection() executes the find_all() method and returns a collection. Db_ActiveRecord
columnValue() alias for the displayField() method. Db_ActiveRecord
define_column() adds a column definition to the model. Db_ActiveRecord
define_multi_relation_column() adds column definition for has_and_belongs_to_many or has_many relation field. Db_ActiveRecord
define_relation_column() adds column definition for has_on or belongs_to relation field. Db_ActiveRecord
delete() deletes the record from the database. Db_ActiveRecord
delete_form_field() deletes a form field by its corresponding column name. Db_ActiveRecord
displayField() returns a formatted column value. The field should be defined with define_column(), Db_ActiveRecord
find() finds a record by its primary key value. Db_ActiveRecord
find_all() finds all records and returns the Db_DataCollection object, containing a list of models. Db_ActiveRecord
find_by() finds a record by a field value. Db_ActiveRecord
find_by_code() returns a customer group by its API code. Shop_CustomerGroup
find_by_id() returns a customer group by its identifier. Shop_CustomerGroup
find_column_definition() finds a column definition by the column name. Db_ActiveRecord
find_form_field() finds a form field definition by its corresponding column name. Db_ActiveRecord
get_guest_group() returns the Guest customer group. Shop_CustomerGroup
join() adds a table to the query with JOIN statement. Db_SqlBase
limit() allows to limit the result of the find_all() method with the specified number of records. Db_ActiveRecord
list_groups() returns a list of a all customer groups. Shop_CustomerGroup
list_groups_by_codes() returns a list of customer groups by their API codes. Shop_CustomerGroup
list_related_records_deferred() returns a list of relation objects, taking into account deferred relations. Db_ActiveRecord
order() allows to order the result of the find_all() method by a specific table column. Db_SqlBase
orWhere() adds OR statement to the where clause, allowing to to limit the result of the find() and find_all() methods with SQL filter. Db_WhereBase
paginate() allows to limit the result of the find_all() method with a single page of records. Db_ActiveRecord
requestRowCount() returns a number of rows which would be returned with find_all() method. Db_ActiveRecord
save() saves record to the database. Db_ActiveRecord
where() allows to limit the result of the find() and find_all() methods with SQL filter. Db_WhereBase

Events

Event Description
shop:onExtendCustomerGroupForm Allows to add new fields to the Create/Edit Customer Group form in the Administration Area.
shop:onExtendCustomerGroupModel Allows to define new columns in the customer group model.
shop:onGetCustomerGroupFieldOptions Allows to populate drop-down, radio- or checkbox list fields, which have been added with shop:onExtendCustomerGroupForm event.

Property details

code property

public string $code;
Specifies the customer group API code.

description property

public string $description;
Specifies the customer group description.

disable_tax_included property

public boolean $disable_tax_included;
Indicates whether taxes should not be included to the displayed product prices for customers belonging to this group.

id property

public integer $id;
Specifies the customer group record identifier.

name property

public string $name;
Specifies the customer group name.

Method details

find_by_code() method

public static Shop_CustomerGroup find_by_code(string $code)
$code string specifies the group API code.
{return} Shop_CustomerGroup returns the customer group object. Returns NULL if the customer group is not found.
Returns a customer group by its API code.

find_by_id() method

public static Shop_CustomerGroup find_by_id(integer $id)
$id integer specifies the group identifier.
{return} Shop_CustomerGroup returns the customer group object. Returns NULL if the customer group is not found.
Returns a customer group by its identifier.

get_guest_group() method

public static Shop_CustomerGroup get_guest_group()
{return} Shop_CustomerGroup returns the Guest customer group object.
Returns the Guest customer group.

list_groups() method

public static array list_groups()
{return} array returns an array of Shop_CustomerGroup objects.
Returns a list of a all customer groups.

list_groups_by_codes() method

public static Db_DataCollection list_groups_by_codes(array $codes)
$codes array specifies a list of customer group API codes.
{return} Db_DataCollection returns a collection of customer group objects (Shop_CustomerGroup).
Returns a list of customer groups by their API codes. Example: 
$groups = Shop_CustomerGroup::list_groups_by_codes(array('registered', 'reseller'));