https://github.com/ncou/chiron-phprenderer

Simple php render for PSR7 response
https://github.com/ncou/chiron-phprenderer

Last synced: about 2 months ago
JSON representation

Simple php render for PSR7 response

• Host: GitHub
• URL: https://github.com/ncou/chiron-phprenderer
• Owner: ncou
• License: mit
• Archived: true
• Created: 2018-04-02T12:24:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-09T13:40:11.000Z (over 4 years ago)
• Last Synced: 2024-09-30T18:09:38.786Z (about 2 months ago)
• Language: PHP
• Size: 54.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/ncou/Chiron-PhpRenderer.svg?branch=master)](https://travis-ci.org/ncou/Chiron-PhpRenderer)

[![Coverage Status](https://coveralls.io/repos/github/ncou/Chiron-PhpRenderer/badge.svg?branch=master)](https://coveralls.io/github/ncou/Chiron-PhpRenderer?branch=master)

[![CodeCov](https://codecov.io/gh/ncou/Chiron-PhpRenderer/branch/master/graph/badge.svg)](https://codecov.io/gh/ncou/Chiron-PhpRenderer)

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

[![Monthly Downloads](https://img.shields.io/packagist/dm/chiron/php-renderer.svg?style=flat-square)](https://packagist.org/packages/chiron/php-renderer/stats)

[![StyleCI](https://styleci.io/repos/127752796/shield?style=flat)](https://styleci.io/repos/127752796)

[![PHP-Eye](https://php-eye.com/badge/chiron/php-renderer/tested.svg?style=flat)](https://php-eye.com/package/chiron/php-renderer)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat)](https://github.com/phpstan/phpstan)

## PHP Renderer

This is a renderer for rendering PHP view scripts into a PSR-7 Response object. It works well with Chiron Framework.

### Cross-site scripting (XSS) risks

Note that PHP-View has no built-in mitigation from XSS attacks. It is the developer's responsibility to use `htmlspecialchars()` or a component like [zend-escaper](https://github.com/zendframework/zend-escaper). Alternatively, consider  [Twig-View](https://github.com/slimphp/Twig-View).

## Templates

You may use `$this` inside your php templates. `$this` will be the actual PhpRenderer object will allow you to render sub-templates

## Installation

Install with [Composer](http://getcomposer.org):

    composer require chiron/php-renderer

## Usage with Chiron

```php

use Chiron\Views\PhpRenderer;

include "vendor/autoload.php";

$app = new Chiron\App();

$container = $app->getContainer();

$container['renderer'] = new PhpRenderer("./templates");

$app->get('/hello/{name}', function ($request, $response, $args) use ($container) {

    $text = $container->get('renderer')->render("/hello.php", $args);

    return $response->write($text);

});

$app->run();

```

## Usage with any PSR-7 Project

```php

//Construct the View

$phpView = new PhpRenderer("./path/to/templates");

//Render a Template

$text = $phpView->render("/path/to/template.php", $yourData);

$response = $response->write($text);

```

## Template Variables

You can now add variables to your renderer that will be available to all templates you render.

```php

// via the constructor

$templateVariables = [

    "title" => "Title"

];

$phpView = new PhpRenderer("./path/to/templates", $templateVariables);

// or setter

$phpView->setAttributes($templateVariables);

// or individually

$phpView->addAttribute($key, $value);

```

Data passed in via `->render()` takes precedence over attributes.

```php

$templateVariables = [

    "title" => "Title"

];

$phpView = new PhpRenderer("./path/to/templates", $templateVariables);

//...

$phpView->render($template, [

    "title" => "My Title"

]);

// In the view above, the $title will be "My Title" and not "Title"

```

## Exceptions

`\RuntimeException` - if template does not exist