Dataface_SkinTool

Usage example

  $tool =& Dataface_SkinTool::getInstance();
  $context = array('var1'=>'value1', 'var2'=>'value2');
  	// context to provide information to the template.
  	// var1 will be available as {$var1} in the template, etc...

  $template = 'MyTemplate.html';
  	// The name of the template to use.  Location of templates directory stored in
  	// $GLOBALS['Dataface_Globals_Templates']

  $tool->display($context, $template);
  	// prints the template
 

Templates can use any of the standard smarty markup in addition to new markup that is added by the Skin Tool. Dataface-specific variables are available via the $ENV variable, which is an associative array of values relating to Dataface and the current context.

Some useful variables include:

$ENV.DATAFACE_PATH

The file path (not the URL path) to the current Dataface installation directory. e.g. /var/www/dataface

$ENV.DATAFACE_URL

The URL to the Dataface installation directory. Useful for including resources such as images in your templates. e.g. http://yourdomain.com/path/to/dataface

$ENV.DATAFACE_SITE_PATH

The file path (not the URL path) to your application's directory. e.g. /var/www/your/app

$ENV.DATAFACE_SITE_URL

The URL to your application's directory. e.g. http://yourdomain.com/path/to/your/app

$ENV.DATAFACE_SITE_HREF

The URL to your application's entry point script. e.g. http://yourdomain.com/path/to/your/app/index.php

$ENV.APPLICATION

The application's configuration array. This includes any settings that you added to your conf.ini file. e.g. {ENV.APPLICATION._database.host} will display the host name of the mysql database as specified in the conf.ini file.

$ENV.APPLICATION_OBJECT

A reference to the application object (Dataface_Application).

$ENV.action

The name of the action that is currently being performed. e.g. view, edit, new_related_record, etc..

$ENV.table

The name of the current database table.

$ENV.relationship

If there is a relationship currently specified in the request, this is the name of it.

$ENV.limit

The maximum number of records to show per page.

$ENV.start

The start position in the current result set.

$ENV.resultSet

A reference to the current record result set. This is a Dataface_QueryTool object.

$ENV.record

A reference to the current record. (if in browse mode).

$ENV.mode

The current application mode. e.g. browse, list, find

$ENV.language

The 2-digit language code of the currently selected language.

$ENV.prefs

The user's preferences array which decides which parts of the interface should be visible (among other settings).

$ENV.search

The current search term if a search has been performed in the search box.