README.md

StMarksSmarty

A wrapper for Smarty to provide a consistent UI for our scripts and apps.

Install

Because this makes use of front-end files managed via Bower, as well as the back-end managed by Composer, it is really, really, super-helpful to run the following command before trying to work with this package:

composer global require "fxp/composer-asset-plugin:^1.1"

Find out more about fxp/composer-asset-plugin and Bower.

And then, include in composer.json:

"require": {
  "smtech/stmarkssmarty": "dev-master"
}

Use

If you have no templates of your own:

$smarty = StMarksSmarty::getSmarty();

// ...app logic...

$smarty->assign('content', '<p>whatever content you want displayed</p>');
$smarty->display();

If you have your own templates directory:

$smarty->addTemplateDir('<path-to-your-templates-dir>');

If your app will be presented as an embedded iframe:

$smarty = StMarksSmarty::getSmarty(true);

Complete API documentation is included in the repo and the Smarty API documentation is also online.