https://github.com/myerscode/templex
A lightweight, regex based template rendering engine for PHP
https://github.com/myerscode/templex
Last synced: about 2 months ago
JSON representation
A lightweight, regex based template rendering engine for PHP
- Host: GitHub
- URL: https://github.com/myerscode/templex
- Owner: myerscode
- License: mit
- Created: 2021-11-13T08:55:18.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-15T22:13:11.000Z (8 months ago)
- Last Synced: 2025-09-20T02:20:42.408Z (7 months ago)
- Language: PHP
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Templex
> A lightweight, regex based template rendering engine for PHP
[](https://packagist.org/packages/myerscode/templex)
[](https://packagist.org/packages/myerscode/templex)
[](https://packagist.org/packages/myerscode/templex)
[](https://codecov.io/gh/myerscode/templex)
## Why this package is helpful?
This package will allow you to define stubs and then hydrate the template using PHP variables.
As the engine uses RegEx it does not rely on using `eval` or including and running the code as PHP.
This means that you are able to simply generate _*new*_ PHP (or any type of text content filled files for that matter) you need.
## Install
You can install this package via composer:
``` bash
composer require myerscode/templex
```
## Usage
```php
$templateDirectory = __DIR__ . '/Resources/Templates/;
$templateExtentions = 'stub';
$templex = new Templex($templateDirectory, $templateExtentions);
echo $templex->render('index');
```
### Template Directory
## Templates
Templates can be any form of text based files. By default, Templex will look for files with `.stub` or `.template` file extensions.
Templex uses `<{` and `}>` as opening and closing anchor tags to find and process `Slots`, which can be used to generate
dynamic views from placeholders and logic.
## Slots
Slots are the "_magic_" of Templex. They are the isolated functionality that perform replacement and hydrating actions
on a template to create the final rendered output.
The default included slots are:
* IncludeSlot - Includes another templates content
* ControlSlot - Process flow based logic, such as foreach, if statements
* VariableSlot - Replaces single placeholders
## Includes
To include another template, in order to create reusable stubs you can simply include it by its template name.
```text
<{ include partials.header }>
```
## Conditions
Templex can process nested slots, so having nested control conditions are handled in the order they are found.
Conditions can be variables, numbers, booleans or literal strings and can the usual comparison evaluators.
```text
<{ if( $value === 'foobar' ) }>
...
<{ if( $value > 7 ) }>
...
<{ if( $value == true ) }>
...
<{ if( $value != false ) }>
```
Examples
```text
<{ if( $value === $condition ) }>
That value was true!
<{ endif }>
<{ if( $value === 'foobar' ) }>
That value was true!
<{ else }>
That value was false!
<{ endif }>
```
## Loops
Loops will take an array variable to create multiple iterations in your template.
Examples
```text
- <{ $user }>
<{ foreach( $users as $user ) }>
<{ endforeach }>
```
## Variables
Variables are replaced matching anchors are found. They can are passed in at rendering, or created via other slots such as Loops.
Examples
```text
Hi <{ $name }>!
```
## Issues and Contributing
We are very happy to receive pull requests to add functionality or fixes.
Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/myerscode/config/issues).
Please read the Myerscode [contributing](https://github.com/myerscode/docs/blob/main/CONTRIBUTING.md) guide for information on our Code of Conduct.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.