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

Defined in /modules/shop/models/shop_country.php, lines 19-180
Inheritance Phpr_Extension » Phpr_Extensible » Phpr_Validatable » Db_Base » Db_WhereBase » Db_SqlBase » Db_ActiveRecord » Shop_Country
Author LemonStand eCommerce Inc.
Represents a country.

See Also

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
calculated_columns array contains a list of calculated columns. Db_ActiveRecord
code string specifies a two symbol country code (US). Shop_Country
code_3 string specifies a three symbol country code (USA). Shop_Country
code_iso_numeric string specifies a three digit country code (840). Shop_Country
custom_columns array contains a list of custom fields definition. Db_ActiveRecord
enabled boolean indicates whether the country is enabled on the front-end. Shop_Country
enabled_in_backend boolean indicates whether the country is enabled on the Administration Area. Shop_Country
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_one array contains a list of Has One relations. Db_ActiveRecord
id integer specifies the country record identifier. Shop_Country
name string specifies the country name. Shop_Country
primary_key string specifies a name of the table primary key. Db_ActiveRecord
states Db_DataCollection a list of the country states. Shop_Country
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_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
create() creates an object of the class. Shop_Country
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_id() loads a country by its identifier. Shop_Country
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

Property details

code property

public string $code;
Specifies a two symbol country code (US).

code_3 property

public string $code_3;
Specifies a three symbol country code (USA).

code_iso_numeric property

public string $code_iso_numeric;
Specifies a three digit country code (840).

enabled property

public boolean $enabled;
Indicates whether the country is enabled on the front-end.

enabled_in_backend property

public boolean $enabled_in_backend;
Indicates whether the country is enabled on the Administration Area.

id property

public integer $id;
Specifies the country record identifier.

name property

public string $name;
Specifies the country name.

states property

public Db_DataCollection $states;
A list of the country states. Each object in the collection is an instance of Shop_CountryState class.

Method details

create() method

public static Shop_Country create(boolean $no_column_info=false)
$no_column_info boolean determines whether column objects should be loaded into the memory.
{return} Shop_Country returns the country object.
Creates an object of the class. You can use this method with find_by_code() method to load a country by its code: 
$usa = Shop_Country::create()->find_by_code('US');

find_by_id() method

public static Shop_Country find_by_id(integer $id)
$id integer specifies the country identifier.
{return} Shop_Country returns a country object or NULL if the country is not found.
Loads a country by its identifier. This method uses internal memory cache and it is preferable to use this method for loading country objects.