PHP Classes

Contemplate: Template engine that provides programming controls

Recommend this page to a friend!
  Info   View files Documentation   Screenshots Screenshots   View files View files (132)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2022-09-22 (9 days ago) RSS 2.0 feedNot yet rated by the usersTotal: 72 This week: 1All time: 10,023 This week: 206Up
Version License PHP version Categories
contemplate 1.6.0Artistic License5PHP 5, Templates
Description Author

This package implements a template engine that provides programming controls.

It can process a given template string to render it by processing the template tags like a programming language.

The template format may contain placeholder marks that define where values may be inserted from variables or supported functions.

It also supports programming controls like process sections depending on the evaluation of conditions and iteration of sections like loops.

The package also provides the implementation of the same template engine in JavaScript and Python besides PHP.

Picture of Nikos M.
Name: Nikos M. is available for providing paid consulting. Contact Nikos M. .
Classes: 17 packages by
Country: Greece Greece
Age: 46
All time rank: 9119 in Greece Greece
Week rank: 98 Up1 in Greece Greece Up
Innovation award
Innovation award
Nominee: 7x

Winner: 2x

Details

Contemplate

Light-weight, fast and flexible object-oriented template engine for PHP, Python and JavaScript (Node.js, Browser and XPCOM)

Contemplate

version: 1.6.0

The original inspiration came from an old post by John Resig (http://ejohn.org/blog/javascript-micro-templating/)

see also:

  • ModelView a simple, fast, powerful and flexible MVVM framework for JavaScript
  • tico a tiny, super-simple MVC framework for PHP
  • LoginManager a simple, barebones agnostic login manager for PHP, JavaScript, Python
  • SimpleCaptcha a simple, image-based, mathematical captcha with increasing levels of difficulty for PHP, JavaScript, Python
  • Dromeo a flexible, and powerful agnostic router for PHP, JavaScript, Python
  • PublishSubscribe a simple and flexible publish-subscribe pattern implementation for PHP, JavaScript, Python
  • Importer simple class & dependency manager and loader for PHP, JavaScript, Python
  • Contemplate a fast and versatile isomorphic template engine for PHP, JavaScript, Python
  • HtmlWidget html widgets, made as simple as possible, both client and server, both desktop and mobile, can be used as (template) plugins and/or standalone for PHP, JavaScript, Python (can be used as plugins for Contemplate)
  • Paginator simple and flexible pagination controls generator for PHP, JavaScript, Python
  • Formal a simple and versatile (Form) Data validation framework based on Rules for PHP, JavaScript, Python
  • Dialect a cross-vendor & cross-platform SQL Query Builder, based on GrammarTemplate, for PHP, JavaScript, Python
  • DialectORM an Object-Relational-Mapper (ORM) and Object-Document-Mapper (ODM), based on Dialect, for PHP, JavaScript, Python
  • Unicache a simple and flexible agnostic caching framework, supporting various platforms, for PHP, JavaScript, Python
  • Xpresion a simple and flexible eXpression parser engine (with custom functions and variables support), based on GrammarTemplate, for PHP, JavaScript, Python
  • Regex Analyzer/Composer Regular Expression Analyzer and Composer for PHP, JavaScript, Python

Contemplate

Contents

Features:

  • Uniform functionality, Engine Implementations for PHP , Python , JavaScript (NOTE `javascript` engine supports both sync and async operations both callback-based and promise-based)
  • Simple and light-weight (only one relatively small class for each implementation, no other dependencies) `~50kB` minified, `~16kB` zipped
  • Fast both in parsing and rendering. Can cache templates dynamically (filesystem caching has 3 modes, `NONE` which uses only in-memory caching, `NOUPDATE` which caches the templates only once and `AUTOUPDATE` which re-creates the cached template if original template has changed, useful for debugging)
  • Generated cached template code is formatted and annotated with comments, for easy debugging (note: `javascript` cached templates are UMD modules which can be used in both `node.js`/`AMD`/`XPCOM`/`browser`/`es6 module fallback`)
  • Syntax close to PHP (there was an effort to keep the engine syntax as close to `PHP` syntax as possible, to avoid learning another language syntax)
  • Easily extensible , configurable
  • Object-oriented, templates implement inheritance and polymorphism in a full object-oriented manner (see below)
  • Template Inheritance , templates can extend/inherit other templates using `extends` directive and override blocks using `block` , `endblock` directives (see examples)
  • Direct Super reference , templates can use the `super` template function to directly reference (and call) a super block if needed in OO manner (see examples)
  • Nested Blocks , template blocks can be nested and repeated in multiple ways (see examples)
  • Supports multiple dynamic contexts , and contextual settings so that different modules of an application can use the engine independantly (see examples and manual)
  • Date manipulation similar to `PHP` format (ie `date` function).
  • Loops can have optional `elsefor` statement when no data, or data is empty (see tests)
  • Templates can `include` other templates (similar to `PHP` `include` directive), these includes wil be compiled into the the template that called them
  • Templates can call another template using `tpl` function, these templates are called as templates subroutines and parsed by themselves
  • Custom Plugins , can be used as template functions to enhance/extend the engine functionality (see examples)
  • Support for literal PHP/JS/PY code. Literal php or javascript or python code can be included as is (properly indented) and will be merged into the compiled output (see examples). Same template can include literal code in all supported languages, only the code relevant to the current engine will actually be compiled and used.

Dependencies

  • Only 3 classes are used (`Contemplate.php`, `Contemplate.js`, `Contemplate.py`), no other dependencies
  • `PHP` `5.2+` supported
  • `Node` `0.8+` supported
  • `Python` `2.x` or `3.x` supported
  • all browsers
  • `Contemplate` is also a `XPCOM JavaScript Component` (Firefox) (e.g to be used in firefox browser addons/plugins for templating)

Performance

Note: The engines included in the following tests have different philosophy and in general provide different features. These are only illustrative modulo all the other features.

Render Time

The following tests were made on a revision of a 2013 jsperf test for resig micro-templating, handlebars, contemplate, mustache, underscore, doT and kendoui template engines.

Previous tests are here jsperf/0.6.5, jsperf/0.6.7, jsperf/0.7, jsperf/0.7.1, jsperf/0.8, jsperf/0.8.1, jsperf/1.0.0, jsperf/1.0.0 (1.0.0+ format)

Contemplate has consistently top performance on all browsers.

contemplate rendering jsperf

Parse / Compilation Time

The following tests involve swig, handlebars, contemplate and mustache template engines.

Previous tests are here jsperf/0.6.7, jsperf/0.7, jsperf/0.7.1, jsperf/0.8, jsperf/0.8.1, jsperf/1.0.0

Contemplate has consistently top performance on all browsers.

contemplate parse jsperf

Screenshots  
  • screenshots/contemplate-interactive.png
  • screenshots/contemplate.jpg
  • screenshots/jsperf-compilation.png
  • screenshots/jsperf-rendering.png
  • screenshots/template_data.png
  • screenshots/template_markup.png
  • screenshots/template_output.png
  Files folder image Files  
File Role Description
Files folder imagesrc (4 directories)
Files folder imagetest (8 directories)
Accessible without login Plain text file changelog.md Data Auxiliary data
Accessible without login Plain text file manual.md Doc. Documentation manual
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
Files folder imagegrammar (1 file)
Files folder imagejs (2 files, 1 directory)
Files folder imagephp (1 file, 1 directory)
Files folder imagepython (2 files, 1 directory)

  Files folder image Files  /  src  /  grammar  
File Role Description
  Accessible without login Plain text file contemplate.js Data Auxiliary data

  Files folder image Files  /  src  /  js  
File Role Description
Files folder imageplugins (1 file)
  Accessible without login Plain text file Contemplate.js Data Auxiliary data
  Accessible without login Plain text file Contemplate.min.js Data Auxiliary data

  Files folder image Files  /  src  /  js  /  plugins  
File Role Description
  Accessible without login Plain text file plugins.txt Doc. Documentation

  Files folder image Files  /  src  /  php  
File Role Description
Files folder imageplugins (1 file)
  Plain text file Contemplate.php Class Class source

  Files folder image Files  /  src  /  php  /  plugins  
File Role Description
  Accessible without login Plain text file plugins.txt Doc. Documentation

  Files folder image Files  /  src  /  python  
File Role Description
Files folder imageplugins (2 files)
  Accessible without login Plain text file Contemplate.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  src  /  python  /  plugins  
File Role Description
  Accessible without login Plain text file plugins.txt Doc. Documentation
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  
File Role Description
Files folder image01-inheritance (19 files)
Files folder image02-contexts (29 files)
Files folder image03-literal-code (15 files)
Files folder image04-functions (6 files)
Files folder image05-asynchronous (1 file, 2 directories)
Files folder image06-variables (12 files)
Files folder image07-folders (4 files, 2 directories)
Files folder image08-web (3 files, 3 directories)

  Files folder image Files  /  test  /  01-inheritance  
File Role Description
  Accessible without login Plain text file out-js.txt Doc. Documentation
  Accessible without login Plain text file out-php.txt Doc. Documentation
  Accessible without login Plain text file out-py.txt Doc. Documentation
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data
  Accessible without login HTML file tpl1.html Doc. Documentation
  Accessible without login Plain text file tpl1_tpl__global.js Data Auxiliary data
  Plain text file tpl1_tpl__global.php Class Class source
  Accessible without login Plain text file tpl1_tpl__global.py Data Auxiliary data
  Accessible without login HTML file tpl2.html Doc. Documentation
  Accessible without login Plain text file tpl2_tpl__global.js Data Auxiliary data
  Plain text file tpl2_tpl__global.php Class Class source
  Accessible without login Plain text file tpl2_tpl__global.py Data Auxiliary data
  Accessible without login HTML file tpl3.html Doc. Documentation
  Accessible without login Plain text file tpl3_tpl__global.js Data Auxiliary data
  Plain text file tpl3_tpl__global.php Class Class source
  Accessible without login Plain text file tpl3_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  /  02-contexts  
File Role Description
  Accessible without login HTML file global.html Doc. Documentation
  Accessible without login Plain text file global_tpl__ctx1.js Data Auxiliary data
  Plain text file global_tpl__ctx1.php Class Class source
  Accessible without login Plain text file global_tpl__ctx1.py Data Auxiliary data
  Accessible without login Plain text file global_tpl__ctx2.js Data Auxiliary data
  Plain text file global_tpl__ctx2.php Class Class source
  Accessible without login Plain text file global_tpl__ctx2.py Data Auxiliary data
  Accessible without login Plain text file global_tpl__ctx3.js Data Auxiliary data
  Plain text file global_tpl__ctx3.php Class Class source
  Accessible without login Plain text file global_tpl__ctx3.py Data Auxiliary data
  Accessible without login Plain text file out-js.txt Doc. Documentation
  Accessible without login Plain text file out-php.txt Doc. Documentation
  Accessible without login Plain text file out-py.txt Doc. Documentation
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data
  Accessible without login HTML file tpl1.html Doc. Documentation
  Accessible without login HTML file tpl2.html Doc. Documentation
  Accessible without login HTML file tpl3.html Doc. Documentation
  Accessible without login Plain text file tpl_tpl__ctx1.js Data Auxiliary data
  Plain text file tpl_tpl__ctx1.php Class Class source
  Accessible without login Plain text file tpl_tpl__ctx1.py Data Auxiliary data
  Accessible without login Plain text file tpl_tpl__ctx2.js Data Auxiliary data
  Plain text file tpl_tpl__ctx2.php Class Class source
  Accessible without login Plain text file tpl_tpl__ctx2.py Data Auxiliary data
  Accessible without login Plain text file tpl_tpl__ctx3.js Data Auxiliary data
  Plain text file tpl_tpl__ctx3.php Class Class source
  Accessible without login Plain text file tpl_tpl__ctx3.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  /  03-literal-code  
File Role Description
  Accessible without login Plain text file out-js.txt Doc. Documentation
  Accessible without login Plain text file out-php.txt Doc. Documentation
  Accessible without login Plain text file out-py.txt Doc. Documentation
  Accessible without login HTML file reserved.html Doc. Documentation
  Accessible without login Plain text file reserved.js Data Auxiliary data
  Accessible without login Plain text file reserved.php Aux. Auxiliary script
  Accessible without login Plain text file reserved.py Data Auxiliary data
  Accessible without login HTML file test.html Doc. Documentation
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data
  Accessible without login Plain text file test_tpl__global.js Data Auxiliary data
  Plain text file test_tpl__global.php Class Class source
  Accessible without login Plain text file test_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  /  04-functions  
File Role Description
  Accessible without login Plain text file out-js.txt Doc. Documentation
  Accessible without login Plain text file out-php.txt Doc. Documentation
  Accessible without login Plain text file out-py.txt Doc. Documentation
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data

  Files folder image Files  /  test  /  05-asynchronous  
File Role Description
Files folder image_tplcache (1 file, 2 directories)
Files folder image_tpls (1 file, 3 directories)
  Accessible without login Plain text file test.js Data Auxiliary data

  Files folder image Files  /  test  /  05-asynchronous  /  _tplcache  
File Role Description
Files folder imagecommon (2 files)
Files folder imagelayout (1 file)
  Accessible without login Plain text file demo_tpl_html_tpl__global.js Data Auxiliary data

  Files folder image Files  /  test  /  05-asynchronous  /  _tplcache  /  common  
File Role Description
  Accessible without login Plain text file bar_tpl_html_tpl__global.js Data Auxiliary data
  Accessible without login Plain text file foo_tpl_html_tpl__global.js Data Auxiliary data

  Files folder image Files  /  test  /  05-asynchronous  /  _tplcache  /  layout  
File Role Description
  Accessible without login Plain text file base_tpl_html_tpl__global.js Data Auxiliary data

  Files folder image Files  /  test  /  05-asynchronous  /  _tpls  
File Role Description
Files folder imagecommon (2 files)
Files folder imageinclude (1 file)
Files folder imagelayout (1 file)
  Accessible without login HTML file demo.tpl.html Doc. Documentation

  Files folder image Files  /  test  /  05-asynchronous  /  _tpls  /  common  
File Role Description
  Accessible without login HTML file bar.tpl.html Doc. Documentation
  Accessible without login HTML file foo.tpl.html Doc. Documentation

  Files folder image Files  /  test  /  05-asynchronous  /  _tpls  /  include  
File Role Description
  Accessible without login HTML file sub.tpl.html Doc. Documentation

  Files folder image Files  /  test  /  05-asynchronous  /  _tpls  /  layout  
File Role Description
  Accessible without login HTML file base.tpl.html Doc. Documentation

  Files folder image Files  /  test  /  06-variables  
File Role Description
  Plain text file dynamic_method_call.php Class Class source
  Accessible without login Plain text file out-js.txt Doc. Documentation
  Accessible without login Plain text file out-php.txt Doc. Documentation
  Accessible without login Plain text file out-py.txt Doc. Documentation
  Accessible without login Plain text file test.js Data Auxiliary data
  Plain text file test.php Class Class source
  Accessible without login Plain text file test.py Data Auxiliary data
  Accessible without login HTML file test.tpl.html Doc. Documentation
  Accessible without login Plain text file test_tpl__global.js Data Auxiliary data
  Plain text file test_tpl__global.php Class Class source
  Accessible without login Plain text file test_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  /  07-folders  
File Role Description
Files folder imagefolder1 (1 directory)
Files folder imagefolder2 (1 file)
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data
  Accessible without login HTML file tpl.html Doc. Documentation

  Files folder image Files  /  test  /  07-folders  /  folder1  
File Role Description
Files folder imagesubfolder1 (1 file)

  Files folder image Files  /  test  /  07-folders  /  folder1  /  subfolder1  
File Role Description
  Accessible without login HTML file tpl1.html Doc. Documentation

  Files folder image Files  /  test  /  07-folders  /  folder2  
File Role Description
  Accessible without login HTML file tpl2.html Doc. Documentation

  Files folder image Files  /  test  /  08-web  
File Role Description
Files folder imagejs (1 file)
Files folder image_tplcache (13 files)
Files folder image_tpls (5 files)
  Accessible without login Plain text file test.js Data Auxiliary data
  Accessible without login Plain text file test.php Aux. Auxiliary script
  Accessible without login Plain text file test.py Data Auxiliary data

  Files folder image Files  /  test  /  08-web  /  js  
File Role Description
  Accessible without login Plain text file Contemplate.min.js Data Auxiliary data

  Files folder image Files  /  test  /  08-web  /  _tplcache  
File Role Description
  Accessible without login Plain text file base_tpl__global.js Data Auxiliary data
  Plain text file base_tpl__global.php Class Class source
  Accessible without login Plain text file base_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file demo_tpl__global.js Data Auxiliary data
  Plain text file demo_tpl__global.php Class Class source
  Accessible without login Plain text file demo_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file main_tpl__global.js Data Auxiliary data
  Plain text file main_tpl__global.php Class Class source
  Accessible without login Plain text file main_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file sub_tpl__global.js Data Auxiliary data
  Plain text file sub_tpl__global.php Class Class source
  Accessible without login Plain text file sub_tpl__global.py Data Auxiliary data
  Accessible without login Plain text file __init__.py Data Auxiliary data

  Files folder image Files  /  test  /  08-web  /  _tpls  
File Role Description
  Accessible without login HTML file base.tpl.html Doc. Documentation
  Accessible without login HTML file date.tpl.html Doc. Documentation
  Accessible without login HTML file demo.tpl.html Doc. Documentation
  Accessible without login HTML file main.tpl.html Doc. Documentation
  Accessible without login HTML file sub.tpl.html Doc. Documentation

 Version Control Unique User Downloads Download Rankings  
 100%
Total:72
This week:1
All time:10,023
This week:206Up
For more information send a message to info at phpclasses dot org.