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_CustomAttribute class

Defined in /modules/shop/models/shop_customattribute.php, lines 14-380
Inheritance Phpr_Extension » Phpr_Extensible » Phpr_Validatable » Db_Base » Db_WhereBase » Db_SqlBase » Db_ActiveRecord » Shop_CustomAttribute
Author LemonStand eCommerce Inc.
Represents a product option. Objects of this class are available through the Shop_Product::$options property.

See Also

Public properties

Show inherited properties.

Property Type Description Defined By
attribute_values string specifies the option values as string - one value in each line. Shop_CustomAttribute
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
calculated_columns array contains a list of calculated columns. Db_ActiveRecord
custom_columns array contains a list of custom fields definition. Db_ActiveRecord
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 option record identifier. Shop_CustomAttribute
name string specifies the option name. Shop_CustomAttribute
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_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_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_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
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_related_records_deferred() returns a list of relation objects, taking into account deferred relations. Db_ActiveRecord
list_unique_names() returns a full list of unique product option names. Shop_CustomAttribute
list_unique_values() returns a full list of unique product option values. Shop_CustomAttribute
list_values() returns a list of the option values. Shop_CustomAttribute
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
value_exists() checks whether a specified value exists in the option. Shop_CustomAttribute
where() allows to limit the result of the find() and find_all() methods with SQL filter. Db_WhereBase

Events

Event Description
shop:onExtendOptionForm Allows to add new fields to the Create/Edit Product Option form in the Administration Area.
shop:onExtendOptionModel Allows to define new columns in the product option model.
shop:onGetOptionFieldOptions Allows to populate drop-down, radio- or checkbox list fields, which have been added with shop:onExtendOptionForm event.

Property details

attribute_values property

public string $attribute_values;
Specifies the option values as string - one value in each line.

id property

public integer $id;
Specifies the option record identifier.

name property

public string $name;
Specifies the option name.

Method details

list_unique_names() method

public static array list_unique_names()
{return} array returns an array of option names.
Returns a full list of unique product option names.

See Also

list_unique_values() method

public static array list_unique_values($name)
$name
{return} array returns an array of option values.
Returns a full list of unique product option values.

See Also

list_values() method

public array list_values($limit_to_om=true)
$limit_to_om
{return} array returns an array of option values.
Returns a list of the option values.

value_exists() method

public boolean value_exists(string $option_value)
$option_value string specifies the option value.
{return} boolean returns TRUE if a specified value exists in the option
Checks whether a specified value exists in the option.