Maslosoft / MiniView

src/MiniView.php

<?php

/**
 * This software package is licensed under `AGPL, Commercial` license[s].
 *
 * @package maslosoft/miniview
 * @license AGPL, Commercial
 *
 * @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
 *
 * @link http://maslosoft.com/miniview/
 */

namespace Maslosoft\MiniView;

use Maslosoft\MiniView\Interfaces\OwnerAwareInterface;
use Maslosoft\MiniView\Interfaces\RendererAwareInterface;
use Maslosoft\MiniView\Interfaces\ViewRendererInterface;
use Maslosoft\MiniView\Renderers\LatteRenderer;
use Maslosoft\MiniView\Renderers\PhpRenderer;
use Maslosoft\MiniView\Renderers\TwigRenderer;
use ReflectionObject;

/**
 * MiniRender
 * Based on Yii CWidget
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @property string @version Current MiniView version
 */
class MiniView implements ViewRendererInterface, OwnerAwareInterface, RendererAwareInterface
{

	use Traits\OwnerAwareTrait,
	  Traits\RendererAwareTrait;

	public $renderers = [
		'latte' => LatteRenderer::class,
		'php' => PhpRenderer::class,
		'twig' => TwigRenderer::class
	];

	/**
	 * Current version
	 * @var string
	 */
	private static $version = null;

	/**
	 * View path
	 * @var string
	 */
	private $path = '';

	/**
	 * View path. This is relative to base path.
	 * @var string
	 */
	private $viewsPath = 'views';

	/**
	 * Create MiniView instance. If path is not set, it will be based on location of owner class.
	 * @param object $owner
	 * @param string $path
	 */
	public function __construct($owner, $path = null)
	{
		$this->path = $path;
		$this->setOwner($owner);
	}

	/**
	 * Get current MiniView version
	 * @return string Version string
	 */
	public function getVersion()
	{
		if (null === self::$version)
		{
			self::$version = require __DIR__ . '/version.php';
		}
		return self::$version;
	}

	/**
	 * Set views path. This is relative path for view resolving.
	 * By default it's `views` folder.
	 * @param string $path
	 * @return static
	 */
	public function setViewsPath($path)
	{
		$this->viewsPath = $path;
		return $this;
	}

	/**
	 * Render view with data provided.
	 * View name may contain `php` extension. If no extension is passed or
	 * it not match extensions from renderer configuration,
	 * it will append extension based on current renderer.
	 *
	 * Example with default or previously set renderer:
	 *
	 * ```php
	 * $view->render('myView');
	 * ```
	 *
	 * Example with enforced php renderer:
	 *
	 * ```php
	 * $view->render('myView.php');
	 * ```
	 *
	 * Example with enforced latte renderer:
	 * 
	 * ```php
	 * $view->render('myView.latte');
	 * ```
	 *
	 * @param string $view
	 * @param mixed[] $data
	 * @param bool $return
	 * @return string
	 */
	public function render($view, $data = null, $return = false)
	{
		$viewFile = sprintf('%s/%s/%s', $this->getPath(), $this->viewsPath, $view);
		$extensions = array_keys($this->renderers);
		$pattern = sprintf('~\.(%s)$~', implode('|', $extensions));
		$currentRenderer = $this->getRenderer();

		// Append extension if not set
		if (!preg_match($pattern, $view, $matches))
		{
			// Get extension from current renderer
			$extension = 'php';
			foreach ($this->renderers as $extension => $rendererMatch)
			{
				if ($currentRenderer instanceof $rendererMatch)
				{
					break;
				}
			}

			// Set proper extension
			$viewFile = sprintf('%s.%s', $viewFile, $extension);
		}

		// Matched extension, detect renderer
		if (!empty($matches) && !empty($matches[1]))
		{
			$key = $matches[1];
			$rendererClass = $this->renderers[$key];
			// Set proper renderer
			if (!$currentRenderer instanceof $rendererClass)
			{
				// Use setRenderer as it contains additional logic
				$this->setRenderer(new $rendererClass);
			}
		}
		$result = $this->getRenderer()->render($viewFile, $data, $return);
		$this->setRenderer($currentRenderer);
		return $result;
	}

	/**
	 * Render file with data provided.
	 * @param string $file
	 * @param mixed[] $data
	 * @param bool $return
	 * @return string
	 */
	public function renderFile($file, $data = null, $return = false)
	{
		return $this->getRenderer()->render($file, $data, $return);
	}

	function getPath()

It is recommend to declare an explicit visibility for getPath.

	{
		if (empty($this->path))
		{
			$class = new ReflectionObject($this->getOwner());
			$this->path = dirname($class->getFileName());
		}
		return $this->path;
	}

}