MiniView::__construct() - Code Metrics - Maslosoft/MiniView - Measure and Improve Code Quality continuously with Scrutinizer

MiniView::__construct() A
last analyzed 2017-02-16 07:48 UTC

↳ Parent: MiniView

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

/**
 * This software package is licensed under `AGPL, Commercial` license[s].
 *
 * @package maslosoft/miniview
 * @license AGPL, Commercial
 *
 * @copyright Copyright (c) Peter Maselkowski <[email protected]>
 *
 * @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 <[email protected]>
 * @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()

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

}


1			<?php
2
3			/**
4			* This software package is licensed under `AGPL, Commercial` license[s].
5			*
6			* @package maslosoft/miniview
7			* @license AGPL, Commercial
8			*
9			* @copyright Copyright (c) Peter Maselkowski <[email protected]>
10			*
11			* @link http://maslosoft.com/miniview/
12			*/
13
14			namespace Maslosoft\MiniView;
15
16			use Maslosoft\MiniView\Interfaces\OwnerAwareInterface;
17			use Maslosoft\MiniView\Interfaces\RendererAwareInterface;
18			use Maslosoft\MiniView\Interfaces\ViewRendererInterface;
19			use Maslosoft\MiniView\Renderers\LatteRenderer;
20			use Maslosoft\MiniView\Renderers\PhpRenderer;
21			use Maslosoft\MiniView\Renderers\TwigRenderer;
22			use ReflectionObject;
23
24			/**
25			* MiniRender
26			* Based on Yii CWidget
27			* @author Piotr Maselkowski <pmaselkowski at gmail.com>
28			* @author Qiang Xue <[email protected]>
29			* @property string @version Current MiniView version
30			*/
31			class MiniView implements ViewRendererInterface, OwnerAwareInterface, RendererAwareInterface
32			{
33
34			use Traits\OwnerAwareTrait,
35			Traits\RendererAwareTrait;
36
37			public $renderers = [
38			'latte' => LatteRenderer::class,
39			'php' => PhpRenderer::class,
40			'twig' => TwigRenderer::class
41			];
42
43			/**
44			* Current version
45			* @var string
46			*/
47			private static $version = null;
48
49			/**
50			* View path
51			* @var string
52			*/
53			private $path = '';
54
55			/**
56			* View path. This is relative to base path.
57			* @var string
58			*/
59			private $viewsPath = 'views';
60
61			/**
62			* Create MiniView instance. If path is not set, it will be based on location of owner class.
63			* @param object $owner
64			* @param string $path
65			*/
66			public function __construct($owner, $path = null)
67			{
68			$this->path = $path;
69			$this->setOwner($owner);
70			}
71
72			/**
73			* Get current MiniView version
74			* @return string Version string
75			*/
76			public function getVersion()
77			{
78			if (null === self::$version)
79			{
80			self::$version = require __DIR__ . '/version.php';
81			}
82			return self::$version;
83			}
84
85			/**
86			* Set views path. This is relative path for view resolving.
87			* By default it's `views` folder.
88			* @param string $path
89			* @return static
90			*/
91			public function setViewsPath($path)
92			{
93			$this->viewsPath = $path;
94			return $this;
95			}
96
97			/**
98			* Render view with data provided.
99			* View name may contain `php` extension. If no extension is passed or
100			* it not match extensions from renderer configuration,
101			* it will append extension based on current renderer.
102			*
103			* Example with default or previously set renderer:
104			*
105			* ```php
106			* $view->render('myView');
107			* ```
108			*
109			* Example with enforced php renderer:
110			*
111			* ```php
112			* $view->render('myView.php');
113			* ```
114			*
115			* Example with enforced latte renderer:
116			*
117			* ```php
118			* $view->render('myView.latte');
119			* ```
120			*
121			* @param string $view
122			* @param mixed[] $data
123			* @param bool $return
124			* @return string
125			*/
126			public function render($view, $data = null, $return = false)
127			{
128			$viewFile = sprintf('%s/%s/%s', $this->getPath(), $this->viewsPath, $view);
129			$extensions = array_keys($this->renderers);
130			$pattern = sprintf('~\.(%s)$~', implode('\|', $extensions));
131			$currentRenderer = $this->getRenderer();
132
133			// Append extension if not set
134			if (!preg_match($pattern, $view, $matches))
135			{
136			// Get extension from current renderer
137			$extension = 'php';
138			foreach ($this->renderers as $extension => $rendererMatch)
139			{
140			if ($currentRenderer instanceof $rendererMatch)
141			{
142			break;
143			}
144			}
145
146			// Set proper extension
147			$viewFile = sprintf('%s.%s', $viewFile, $extension);
148			}
149
150			// Matched extension, detect renderer
151			if (!empty($matches) && !empty($matches[1]))
152			{
153			$key = $matches[1];
154			$rendererClass = $this->renderers[$key];
155			// Set proper renderer
156			if (!$currentRenderer instanceof $rendererClass)
157			{
158			// Use setRenderer as it contains additional logic
159			$this->setRenderer(new $rendererClass);
160			}
161			}
162			$result = $this->getRenderer()->render($viewFile, $data, $return);
163			$this->setRenderer($currentRenderer);
164			return $result;
165			}
166
167			/**
168			* Render file with data provided.
169			* @param string $file
170			* @param mixed[] $data
171			* @param bool $return
172			* @return string
173			*/
174			public function renderFile($file, $data = null, $return = false)
175			{
176			return $this->getRenderer()->render($file, $data, $return);
177			}
178
179			function getPath()
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-05-25 16:15 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `getPath`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
180			{
181			if (empty($this->path))
182			{
183			$class = new ReflectionObject($this->getOwner());
184			$this->path = dirname($class->getFileName());
185			}
186			return $this->path;
187			}
188
189			}
190

Maslosoft / MiniView

MiniView::__construct() A last analyzed 2017-02-16 07:48 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MiniView::__construct() A
last analyzed 2017-02-16 07:48 UTC