https://github.com/statix-php/petals

A PHP templating engine based on Laravel Blade
https://github.com/statix-php/petals

Last synced: 8 months ago
JSON representation

A PHP templating engine based on Laravel Blade

• Host: GitHub
• URL: https://github.com/statix-php/petals
• Owner: statix-php
• License: mit
• Created: 2022-12-09T18:25:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T13:35:59.000Z (over 2 years ago)
• Last Synced: 2025-06-22T00:02:03.501Z (10 months ago)
• Language: PHP
• Size: 95.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# A PHP templating engine based on Laravel Blade

[![Latest Version on Packagist](https://img.shields.io/packagist/v/statix/petals.svg?style=flat-square)](https://packagist.org/packages/statix/petals)

[![Tests](https://github.com/statix-php/petals/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/statix-php/petals/actions/workflows/run-tests.yml)

[![Total Downloads](https://img.shields.io/packagist/dt/statix/petals.svg?style=flat-square)](https://packagist.org/packages/statix/petals)

![Banner image](.github/banner.jpg)

Petals is a zero dependency PHP templating engine based on Laravel Blade. This was built as a fun experiment to play with ChatGPT and GitHub Co-pilot, between the two AI tools they wrote ~60% of the code.

## Installation

You can install the package via composer:

```bash

composer require statix-php/petals

```

## Usage

```php

use Statix\Petals\TemplatingEngine;

// require the composer autoloader

require __DIR__.'/vendor/autoload.php';

$engine = new TemplatingEngine(

    templates: __DIR__.'/templates',

    cachePath: __DIR__.'/cache',

);

$engine = new TemplatingEngine(

    templates: [

        __DIR__ . '/templates-one',

        __DIR__ . '/templates-two',

    ],

    cachePath: __DIR__.'/cache',

);

// Render the templates/app.blade.php template

$content = $engine->render('app', [

    'message' => 'Hello world!',

]);

// Render the given string

$content = $engine->renderString('Hello {{ $name }}! The unix timestamp is {{ $time }}', [

    'name' => 'world',

    'time' => time(),

]);

// Compile the template to the cache directory, the compiled template will be used to render the template when render is called

$engine->compile('app');

// Compile the given string to the cache directory, if render is called on the same string, it will be rendered from the compiled cache template

$engine->compileString('Hello {{ $name }}! The unix timestamp is {{ $time }}');

// Clear the compiled templates

$engine->clearCache();

```

## Testing

```bash

composer test

```

## Formatting

```bash

composer format

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

- [Wyatt Castaneda](https://github.com/statix-php)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.