windwalker/view

Windwalker View package

Windwalker View

Installation via Composer

Add this to the require block in your composer.json., _(*1)

``` json { "require": { "windwalker/view": "~2.0" } }, <sub>(*2)</sub>

## Create A Simple View

### AbstractView

`AbstractView` is very simple, it only need a render method to render what you want.

``` php
use Windwalker\View\AbstractView;

class MyView extends AbstractView
{
    public function render()
    {
        $tmpl = <<<TMPL
# The is a Markdown Article

Hello %s~~~!
TMPL;

        return MyMarkdown::render(sprintf($tmpl, $this->data['foo']));
    }
}

// Create view and set data
$view = new MyView;

$view->set('foo', 'World');

$view->render();

The Result will be:, <sub>(*3)</sub>

``` html, <sub>(*4)</sub>

The is a Markdown Article

Hello World~~~!, <sub>(*5)</sub>

### SimpleHtmlView

`SimpleHtmlView` can set a php file to render:

``` php
use Windwalker\View\SimpleHtmlView;

class MyHtmlView extends SimpleHtmlView
{
    public function prepare($data)
    {
        // Format dome data
        $data['time'] = $data['time']->format('Y-m-d H:i:s');

        $data['link'] = '/flower/' . OutputFilter::stringUrlSafe($data['name']) . '.html';
    }
}

$view = new MyHtmlView;

$view->set('time', new DateTime);
$view->set('name', $name);

$view->setLayout('/path/to/template.php')->render();

The template file:, <sub>(*6)</sub>

``` php , <sub>(*7)</sub>

Now is: escape($time); ?> I'm: escape($data['name']); ?> , <sub>(*8)</sub>

## HtmlView

`HtmlView` is more powerful than `SimpleHtmlView`, we can set [Renderer](https://github.com/ventoviro/windwalker-renderer)
 as a render engine into it, and find template in several paths.

``` php
use Windwalker\View\HtmlView;

$paths = new SplPriorityQueue;
$paths->insert('path/of/system', 300);
$paths->insert('path/of/theme', 500);

$data = array(
    'time' => new DateTime
);

$view = new HtmlView($data, new PhpRenderer($paths));

$view->setLayout('foo')->render(); // Will find foo.php in every paths.

See also: Windwalker Renderer, <sub>(*9)</sub>

Extends It

``` php use Windwalker\View\HtmlView; use Windwalker\Renderer\BladeRenderer;, <sub>(*10)</sub>

// A Blade View class BladeHtmlView extends HtmlView { public function __construct($data = array(), BladeRenderer $renderer = null) { $renderer = $renderer ? : new BladeRenderer('default/path', array('cache_path' => 'cache/path')), <sub>(*11)</sub>

    parent::__construct($data, $renderer);
}

}, <sub>(*12)</sub>

// View for different MVC structures class ArticleHtmlView extends BladeHtmlView { public function prepare($data) { $data['time'] = $data['time']->format('Y-m-d H:i:s'); } }, <sub>(*13)</sub>

$view = new MyHtmlView;, <sub>(*14)</sub>

$view->['time'] = new DateTime; // Use array access, <sub>(*15)</sub>

$view->setLayout('template')->render(); // Will find template.blade.php, <sub>(*16)</sub>

### The Data object

HtmlView use `Windwalker\Data\Data` as data store, we don't need to worry about data exists or not.

``` php
<?php

$time = $data['time']; // Exists
$name = $data['name']; // Not exists, just return null.
$title = $data->title; // Also support object access.

See Windwalker Data, <sub>(*17)</sub>

JsonView

JsonView use Registry as data store, we can separate different level by dot(.)., <sub>(*18)</sub>

``` php $view = new JsonView;, <sub>(*19)</sub>

$view['foo.bar'] = 'baz';, <sub>(*20)</sub>

$view->render();, <sub>(*21)</sub>

The result will be:

``` json
{
    "foo": {
        "bar": "baz"
    }
}