User Tools

Site Tools


introduction

Get Familiar With LiteCart Components

Library Modules

The core of LiteCart contains of a set of system nodes called library. They are loaded automatically once requested and lack a prefix for their class names.

The main purpose of these nodes is to hold and process niched data. E.g. lib_language holds and maintains everything language related.

To get the session currency maintained by ~/includes/library/lib_currency.inc.php:

currency::$selected['code']

To change the session currency:

currency::set('EUR')

Database

The lib_database library module handles all database activity. A connection to the default database is opened only when first needed.

To perform a MySQL query and fetch the results:

$query = database::query(
  "select * ..."
);

while ($row = database::fetch($query)) {
  ...
}

Functions

No need to keep track of included function files. Functions can be dynamically loaded through the system library module. This means the files defining the functions will be loaded once the functions are requested.

Note: All function names must be begin with the file basename and be stored in ~/includes/functions/.

To load ~/includes/functions/func_form.inc.php (if not previously loaded) and output a textarea:

<?php echo functions::form_draw_textarea('foo'); ?>

Entity Objects

Entity objects are class objects that control entity data and the mappings to the database. By instantiating an entity object LiteCart will autoload the file constructing the class i.e. includes/entities/ent_product.inc.php and perform all the database queries for you.

To create a new product and give it an english name:

$product = new ent_product();
$product->data['name']['en'] = 'Test product';
$product->save();

To load customer 34 and update the email address:

$customer = new ent_customer(34);
$customer->data['email'] = 'user@domain.com';
$customer->save();

Please note prior to LiteCart 2.2.0 entity objects used the prefix ctrl_ instead of ent_.

Reference Objects

Reference objects are read-only class objects that can dynamically return partial parts of a data set.

Access the database and output the english product name for a product:

$product = new ref_product(id);
echo $product->name;

Or

echo reference::product(id)->name;

To redirect to a product page (found in pages/product.inc.php) use document::ilink():

header('Location: ' . document::ilink('product', array('product_id' => 1234)));
exit;

To redirect to an external file e.g. images use document::link():

header('Location: ' . document::link(WS_DIR_IMAGES . 'myimage.png'));
exit;

When special characters are not allowed, i.e. inside HTML element parameters use document::href_link():

<a href="<?php echo document::href_link(WS_DIR_IMAGES . 'myimage.png')); ?>">See Image</a>

Translations

For convenience we are storing translations in the database. Anything that isn't already maintained by an entity object is handled by the language library module.

While fetching a translation you can inject a default translation if not previously stored. This is done by providing the first default translation straight in the code.

English is always the framework language and default translation. If translations are missing for any other languages an english translation will be returned.

To output a translation for title_hello_world and inject an english translation to the database (if not previously injected):

echo language::translate('title_hello_world', 'Hello World'); 

Template Layouts

The document library module holds global snippets of content that are output to placeholders in a layout or view file. Any placeholders that do not have snippet content will be removed before output to browser.

To store a global snippet named foo_bar:

document::$snippets['foo_bar'] = '<h1>Foo bar!</h1>';

To insert a placeholder for the snippet content in a view file:

{snippet:foo_bar}

Then, to change layout file for the output to ~/includes/templates/my_template.catalog/layouts/my_layout.inc.php:

document::$layout = 'my_layout';

Template Views

LiteCart tries to separate logic from the design by the use of views.

Gather some data and pass to a view:

$my_content = new view();
$my_content->snippets['helloworld'] = 'Hello World';
echo $my_content->stitch('views/myview');

The template view file includes/yourtemplate/views/myview.inc.php supports the following syntax:

<h1>{snippet:helloworld}<h1>
<h1><?php echo $helloworld; ?><h1>
introduction.txt · Last modified: 2019/08/28 18:47 by 162.158.134.232