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

Cms_Theme class

Defined in /modules/cms/models/cms_theme.php, lines 24-780
Inheritance Phpr_Extension » Phpr_Extensible » Phpr_Validatable » Db_Base » Db_WhereBase » Db_SqlBase » Db_ActiveRecord » Cms_Object » Cms_Theme
Author LemonStand eCommerce Inc.
Represents a CMS theme. Cms_Page class represents a front-end website theme.

Public properties

Show inherited properties.

Property Type Description Defined By
agent_detection_code string specifies the user agent detection PHP code for the custom agent detection mode. Cms_Theme
agent_detection_mode string specifies the user agent detection mode. Cms_Theme
agent_list string specifies a list of user agent for the built-in agent detection. Cms_Theme
author_name string specifies the theme author name. Cms_Theme
author_website string specifies an URL of the theme author's website. Cms_Theme
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
code string specifies the theme code. Cms_Theme
custom_columns array contains a list of custom fields definition. Db_ActiveRecord
description string specifies the theme description. Cms_Theme
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 theme identifier in the database. Cms_Theme
is_default boolean determines whether the theme is default. Cms_Theme
is_enabled boolean determines whether the theme is enabled. Cms_Theme
name string specifies the theme name. Cms_Theme
primary_key string specifies a name of the table primary key. Db_ActiveRecord
templating_engine string specifies a templating engine the theme uses. Cms_Theme
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_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
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
cms:onGetActiveTheme Triggered when LemonStand determines an active CMS theme.
cms:onSetDefaultTheme Triggered when a default theme is changed by a user.

Property details

agent_detection_code property

public string $agent_detection_code;
Specifies the user agent detection PHP code for the custom agent detection mode.

agent_detection_mode property

public string $agent_detection_mode;
Specifies the user agent detection mode. Supported options are disabled, built-in, custom.

agent_list property

public string $agent_list;
Specifies a list of user agent for the built-in agent detection.

author_name property

public string $author_name;
Specifies the theme author name.

author_website property

public string $author_website;
Specifies an URL of the theme author's website.

code property

public string $code;
Specifies the theme code.

description property

public string $description;
Specifies the theme description.

id property

public integer $id;
Specifies the theme identifier in the database.

is_default property

public boolean $is_default;
Determines whether the theme is default.

is_enabled property

public boolean $is_enabled;
Determines whether the theme is enabled.

name property

public string $name;
Specifies the theme name.

templating_engine property

public string $templating_engine;
Specifies a templating engine the theme uses. Supported options are php, twig.