hfw / site

src/Site/View.php

<?php

namespace Helix\Site;

use ArrayAccess;
use DateTimeInterface;

/**
 * Renders a template with data.
 */
class View implements ArrayAccess
{

    /**
     * @var int|DateTimeInterface
     */
    protected $cacheTtl = 0;

    /**
     * Extracted to variables upon render.
     *
     * @var array
     */
    protected $data = [];

    /**
     * @var string
     */
    protected $template;

    public function __construct(string $template, array $data = [])
    {
        $this->template = $template;
        $this->data = $data;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->template;
    }

    /**
     * The minimum TTL, considering the instance itself and any nested views.
     *
     * @return int|DateTimeInterface
     */
    public function getCacheTtl()
    {
        return $this->cacheTtl;
    }

    /**
     * Returns what would be rendered.
     *
     * @return string
     */
    public function getContent(): string
    {
        ob_start();
        $this->render();
        return ob_end_clean();

The expression return ob_end_clean() returns the type boolean which is incompatible with the type-hinted return string.

    }

    /**
     * @param mixed $offset
     * @return bool
     */
    public function offsetExists($offset): bool
    {
        return isset($this->data[$offset]);
    }

    /**
     * @param mixed $key
     * @return mixed
     */
    public function offsetGet($key)
    {
        return $this->data[$key] ?? null;
    }

    /**
     * @param mixed $key
     * @param mixed $value
     */
    public function offsetSet($key, $value): void
    {
        $this->data[$key] = $value;
    }

    /**
     * @param mixed $key
     */
    public function offsetUnset($key): void
    {
        unset($this->data[$key]);
    }

    /**
     * Directly outputs content.
     *
     * Extracts `$data` to variables, and includes the template.
     * `$this` within the template references the view instance.
     */
    public function render(): void
    {
        extract($this->data);
        include "{$this->template}";
    }

    /**
     * @param int|DateTimeInterface $cacheTtl
     * @return $this
     */
    public function setCacheTtl($cacheTtl)
    {
        $this->cacheTtl = $cacheTtl;
        return $this;
    }
}