Simple Template Engine: Template engine based on text replacement

Recommend this page to a friend!
  Info   View files Documentation   View files View files (6)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2021-08-23 (1 month ago) RSS 2.0 feedStarStarStarStar 61%Total: 3,741 All time: 877 This week: 185Up
Version License PHP version Categories
simple_tpl 1.0.5GNU General Publi...7.0.0Templates
Description Author

This class implements a simple template engine that works by replacing text.

It can read a template file into a string. Then it searches and replaces all occurrences of the template place holder marks with the values of one or more template arguments.

Picture of Eric Sizemore
  Performance   Level  
Name: Eric Sizemore <contact>
Classes: 7 packages by
Country: United States United States
Age: 34
All time rank: 15318 in United States United States
Week rank: 187 Down12 in United States United States Up

Details

Simple Template Engine - Text based template parser.

Simple Template Engine is a small, simple text-based template parsing engine that works on text replacement.

Installation

Simply drop Template.php in any project and call include 'src/Template.php';, where 'src/' is the path to where you placed the template engine file(s).

For example:

<?php

include 'src/simple_tpl/Template.php';

?>

Basic Usage

<?php

include 'src/simple_tpl/Template.php';

$tpl = new \Esi\Template();

?>

There are three main methods of the Template class that are used to parse and display a template. An example is provided with the 'examples' directory. Those methods are 'assign()', 'parse()' and 'display()'. The 'display()' method is a wrapper for 'parse()' with the only difference being that 'display()' will echo the contents of the template instead of returning them as a string.

A Simple Example

PHP Code

<?php

// Include class file and instantiate.
require_once '../src/Template.php';
$tpl = new \Esi\Template();

/
* assign expects an array of:
*     variable => value
*
* Variables in your template(s) should be in the form of:
*     {variable}
*/
$tpl->assign([
    'title'   => 'Simple Template Engine Test',
    'content' => 'This is a test of the <a href="http://www.phpclasses.org/browse/package/3171.html">Simple Template Engine</a> class by Eric Sizemore.'
]);

// Parse the template file
$tpl->display('../src/example.tpl');

?>

Template HTML

<!DOCTYPE HTML>
<html>
<head>
	<meta http-equiv="content-type" content="text/html" />
	<title>{title}</title>
</head>

<body>

<p>{content}</p>

</body>
</html>

About

Requirements

  • Simple Template Engine works with PHP 7.0.0 or above.

Submitting bugs and feature requests

Bugs and feature requests are tracked on GitHub

Issues are the quickest way to report a bug. If you find a bug or documentation error, please check the following first:

  • That there is not an Issue already open concerning the bug
  • That the issue has not already been addressed (within closed Issues, for example)

Contributing

Simple Template Engine accepts contributions of code and documentation from the community. These contributions can be made in the form of Issues or Pull Requests on the Simple Template Engine repository.

Simple Template Engine is licensed under the GNU GPL v3 license. When submitting new features or patches to Simple Template Engine, you are giving permission to license those features or patches under the GNU GPL v3 license.

Guidelines

Before we look into how, here are the guidelines. If your Pull Requests fail to pass these guidelines it will be declined and you will need to re-submit when you?ve made the changes. This might sound a bit tough, but it is required for me to maintain quality of the code-base.

PHP Style

Please ensure all new contributions match the PSR-2 coding style guide. The project is not fully PSR-2 compatible, yet; however, to ensure the easiest transition to the coding guidelines, I would like to go ahead and request that any contributions follow them.

Documentation

If you change anything that requires a change to documentation then you will need to add it. New methods, parameters, changing default values, adding constants, etc are all things that will require a change to documentation. The change-log must also be updated for every change. Also PHPDoc blocks must be maintained.

Branching

One thing at a time: A pull request should only contain one change. That does not mean only one commit, but one change - however many commits it took. The reason for this is that if you change X and Y but send a pull request for both at the same time, we might really want X but disagree with Y, meaning we cannot merge the request. Using the Git-Flow branching model you can create new branches for both of these features and send two requests.

Author

Eric Sizemore - <admin@secondversion.com> - <http://www.secondversion.com>

License

Simple Template Engine is licensed under the GNU GPL v3 License - see the LICENSE file for details

  Files folder image Files  
File Role Description
Files folder imageexamples (3 files)
Files folder imagesrc (1 file)
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  examples  
File Role Description
  Accessible without login Plain text file customDelimiter.php Example Example script
  Accessible without login Plain text file example.php Example Example script
  Accessible without login Plain text file example.tpl Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
  Plain text file Template.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:3,741
This week:0
All time:877
This week:185Up
 User Ratings  
 
 All time
Utility:87%StarStarStarStarStar
Consistency:90%StarStarStarStarStar
Documentation:-
Examples:87%StarStarStarStarStar
Tests:-
Videos:-
Overall:61%StarStarStarStar
Rank:1210
  
For more information send a message to info at phpclasses dot org.