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

Widget::__toString() A
last analyzed 2017-02-16 07:48 UTC

↳ Parent: Widget

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
c	0
b	0
f	0
rs	9.4285
cc	2
eloc	6
nc	2
nop	0

<?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 Exception;
use ReflectionObject;

/**
 * Widget
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
abstract class Widget
{

	/**
	 * @var string id of the widget.
	 */
	private $_id;

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

	/**
	 * Configuration
	 * @var mixed[]
	 */
	private $config = [];

	/**
	 * Id counter for automatically generated id's
	 * @var intr
	 */
	private static $idCounter = 0;

	/**
	 * Owner, default to current class
	 * @var Widget
	 */
	private $owner;

	/**
	 * Create widget with optional config
	 * @param mixed[] $config
	 */
	public function __construct($config = [], $owner = null)
	{
		$class = new ReflectionObject($this);
		$this->_path = dirname($class->getFileName());
		if (!empty($owner))
		{
			$this->owner = $owner;
		}
		else
		{
			$this->owner = $this;
		}
		$this->config = $config;
	}

	/**
	 * Initializes the widget
	 */
	abstract public function init();

	/**
	 * Executes the widget.
	 */
	abstract public function run();

	/**
	 * Forward to owner
	 * @param string $name
	 * @return mixed
	 */
	public function __get($name)
	{
		return $this->_owner->$name;

	}

	/**
	 * Forward to owner
	 * @param string $name
	 * @param mixed $value
	 */
	public function __set($name, $value)
	{
		return $this->_owner->$name = $value;

	}

	/**
	 * Forward to owner
	 * @param string $name
	 * @param mixed[] $arguments
	 */
	public function __call($name, $arguments)
	{
		return call_user_func_array([$this->_owner, $name], $arguments);

	}

	/**
	 * Forward to owner
	 * @param string $name
	 * @return bool
	 */
	public function __isset($name)
	{
		return isset($this->_owner->$name);

	}

	/**
	 * Forward to owner
	 * @param string $name
	 */
	public function __unset($name)
	{
		unset($this->_owner->$name);
	}

	/**
	 * Returns the ID of the widget or generates a new one if not set.
	 * @return string id of the widget.
	 */
	public function getId()
	{
		if ($this->_id === null)
		{
			$this->_id = sprtinf('msmv-%s', self::$idCounter++);
		}
		return $this->_id;
	}

	/**
	 * Sets the ID of the widget.
	 * @param string $value id of the widget.
	 */
	public function setId($value)
	{
		$this->_id = $value;
	}

	/**
	 * Returns the owner/creator of this widget.
	 * @return object owner/creator of this widget. It could be either a widget or a controller.
	 */
	public function getOwner()
	{
		return $this->_owner;

	}

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

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
	}

	/**
	 * Render view with data provided.
	 * View name must not contain `php` extension.
	 * @param string $view
	 * @param mixed[] $data
	 * @param bool $return
	 * @return string
	 */
	public function render($view, $data = null, $return = false)
	{
		$viewFile = sprintf('%s/%s/%s.php', $this->_path, $this->_viewsPath, $view);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		return $this->_renderInternal($viewFile, $data, $return);
	}

	/**
	 * 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->_renderInternal($file, $data, $return);
	}

	/**
	 * Renders a view file.
	 * This method includes the view file as a PHP script
	 * and captures the display result if required.
	 * @param string $_viewFile_ view file
	 * @param array $_data_ data to be extracted and made available to the view file
	 * @param boolean $_return_ whether the rendering result should be returned as a string
	 * @return string the rendering result. Null if the rendering result is not required.
	 */
	private function _renderInternal($_viewFile_, $_data_ = null, $_return_ = false)
	{
		// we use special variable names here to avoid conflict when extracting data
		if (is_array($_data_))
		{
			extract($_data_, EXTR_PREFIX_SAME, 'data');
		}
		else
		{
			$data = $_data_;
		}
		if ($_return_)
		{
			ob_start();
			ob_implicit_flush(false);
			require($_viewFile_);
			return ob_get_clean();
		}
		else
		{
			require($_viewFile_);
		}
	}

	/**
	 * Create and run widget. Use this in templates to properly initialize widgets.
	 * This must be called from extending class.
	 * Example:
	 * ```php
	 * echo ProgressBar::widget([
	 * 		'percent' => 40
	 * ]);
	 * ```
	 * @param mixed[] $config
	 * @return string HTML widget
	 */
	public static function widget($config = [])

	{
		ob_start();
		ob_implicit_flush(false);
		/* @var $widget MsWidget */
		if (static::class === __CLASS__)
		{
			throw new WidgetException(sprintf('Method widget must be called from extending class, not from `%s`', __CLASS__));
		}
		if (is_string($config))
		{
			$class = $config;
			$config = [];
			$config['class'] = $class;
		}
		else
		{
			$config['class'] = static::class;
		}
		$widget = EmbeDi::fly()->apply($config);
		$widget->init();
		$out = $widget->run();

		return ob_get_clean() . $out;
	}

	/**
	 * This is equivalent of calling ::widget() with config from constructor.
	 * Could be used for convenient outputting of simple widgets.
	 * Example:
	 * ```php
	 * echo new Flags([], $this);
	 * echo new Head(['title' => 'foot'], $this);
	 * ```
	 * @return string HTML output of widget.
	 */
	public function __toString()
	{
		try
		{
			$class = static::class;
			return $class::widget($this->config);
		}
		catch (Exception $e)
		{
			return nl2br($e->getTraceAsString());
		}
	}

}


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 Exception;
17			use ReflectionObject;
18
19			/**
20			* Widget
21			*
22			* @author Piotr Maselkowski <pmaselkowski at gmail.com>
23			*/
24			abstract class Widget
25			{
26
27			/**
28			* @var string id of the widget.
29			*/
30			private $_id;
31
32			/**
33			* View path
34			* @var string
35			*/
36			private $_path = '';
37
38			/**
39			* Configuration
40			* @var mixed[]
41			*/
42			private $config = [];
43
44			/**
45			* Id counter for automatically generated id's
46			* @var intr
47			*/
48			private static $idCounter = 0;
49
50			/**
51			* Owner, default to current class
52			* @var Widget
53			*/
54			private $owner;
55
56			/**
57			* Create widget with optional config
58			* @param mixed[] $config
59			*/
60			public function __construct($config = [], $owner = null)
61			{
62			$class = new ReflectionObject($this);
63			$this->_path = dirname($class->getFileName());
64			if (!empty($owner))
65			{
66			$this->owner = $owner;
67			}
68			else
69			{
70			$this->owner = $this;
71			}
72			$this->config = $config;
73			}
74
75			/**
76			* Initializes the widget
77			*/
78			abstract public function init();
79
80			/**
81			* Executes the widget.
82			*/
83			abstract public function run();
84
85			/**
86			* Forward to owner
87			* @param string $name
88			* @return mixed
89			*/
90			public function __get($name)
91			{
92			return $this->_owner->$name;
			0 ignored issues – show Bug introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_owner` does not seem to exist. Did you mean `owner`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
93			}
94
95			/**
96			* Forward to owner
97			* @param string $name
98			* @param mixed $value
99			*/
100			public function __set($name, $value)
101			{
102			return $this->_owner->$name = $value;
			0 ignored issues – show Bug introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_owner` does not seem to exist. Did you mean `owner`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
103			}
104
105			/**
106			* Forward to owner
107			* @param string $name
108			* @param mixed[] $arguments
109			*/
110			public function __call($name, $arguments)
111			{
112			return call_user_func_array([$this->_owner, $name], $arguments);
			0 ignored issues – show Bug introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_owner` does not seem to exist. Did you mean `owner`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
113			}
114
115			/**
116			* Forward to owner
117			* @param string $name
118			* @return bool
119			*/
120			public function __isset($name)
121			{
122			return isset($this->_owner->$name);
			0 ignored issues – show Bug introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_owner` does not seem to exist. Did you mean `owner`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
123			}
124
125			/**
126			* Forward to owner
127			* @param string $name
128			*/
129			public function __unset($name)
130			{
131			unset($this->_owner->$name);
132			}
133
134			/**
135			* Returns the ID of the widget or generates a new one if not set.
136			* @return string id of the widget.
137			*/
138			public function getId()
139			{
140			if ($this->_id === null)
141			{
142			$this->_id = sprtinf('msmv-%s', self::$idCounter++);
143			}
144			return $this->_id;
145			}
146
147			/**
148			* Sets the ID of the widget.
149			* @param string $value id of the widget.
150			*/
151			public function setId($value)
152			{
153			$this->_id = $value;
154			}
155
156			/**
157			* Returns the owner/creator of this widget.
158			* @return object owner/creator of this widget. It could be either a widget or a controller.
159			*/
160			public function getOwner()
161			{
162			return $this->_owner;
			0 ignored issues – show Bug introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_owner` does not seem to exist. Did you mean `owner`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
163			}
164
165			/**
166			* Set views path. This is relative path for view resolving.
167			* By default it's `views` folder.
168			* @param string $path
169			*/
170			public function setViewsPath($path)
171			{
172			$this->_viewsPath = $path;
			0 ignored issues – show Documentation introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_viewsPath` does not exist on `object<Maslosoft\MiniView\Widget>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
173			}
174
175			/**
176			* Render view with data provided.
177			* View name must not contain `php` extension.
178			* @param string $view
179			* @param mixed[] $data
180			* @param bool $return
181			* @return string
182			*/
183			public function render($view, $data = null, $return = false)
184			{
185			$viewFile = sprintf('%s/%s/%s.php', $this->_path, $this->_viewsPath, $view);
			0 ignored issues – show Documentation introduced 2016-02-11 08:52 UTC by Report Bug Copy Issue Report The property `_viewsPath` does not exist on `object<Maslosoft\MiniView\Widget>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
186			return $this->_renderInternal($viewFile, $data, $return);
187			}
188
189			/**
190			* Render file with data provided.
191			* @param string $file
192			* @param mixed[] $data
193			* @param bool $return
194			* @return string
195			*/
196			public function renderFile($file, $data = null, $return = false)
197			{
198			return $this->_renderInternal($file, $data, $return);
199			}
200
201			/**
202			* Renders a view file.
203			* This method includes the view file as a PHP script
204			* and captures the display result if required.
205			* @param string $_viewFile_ view file
206			* @param array $_data_ data to be extracted and made available to the view file
207			* @param boolean $_return_ whether the rendering result should be returned as a string
208			* @return string the rendering result. Null if the rendering result is not required.
209			*/
210			private function _renderInternal($_viewFile_, $_data_ = null, $_return_ = false)
211			{
212			// we use special variable names here to avoid conflict when extracting data
213			if (is_array($_data_))
214			{
215			extract($_data_, EXTR_PREFIX_SAME, 'data');
216			}
217			else
218			{
219			$data = $_data_;
220			}
221			if ($_return_)
222			{
223			ob_start();
224			ob_implicit_flush(false);
225			require($_viewFile_);
226			return ob_get_clean();
227			}
228			else
229			{
230			require($_viewFile_);
231			}
232			}
233
234			/**
235			* Create and run widget. Use this in templates to properly initialize widgets.
236			* This must be called from extending class.
237			* Example:
238			* ```php
239			* echo ProgressBar::widget([
240			* 'percent' => 40
241			* ]);
242			* ```
243			* @param mixed[] $config
244			* @return string HTML widget
245			*/
246			public static function widget($config = [])
			0 ignored issues – show Best Practice introduced 2016-05-25 16:15 UTC by Report Bug Copy Issue Report Using PHP4-style constructors that are named like the class is not recommend; better use the more explicit `__construct` method. Loading history...
247			{
248			ob_start();
249			ob_implicit_flush(false);
250			/* @var $widget MsWidget */
251			if (static::class === __CLASS__)
252			{
253			throw new WidgetException(sprintf('Method widget must be called from extending class, not from `%s`', __CLASS__));
254			}
255			if (is_string($config))
256			{
257			$class = $config;
258			$config = [];
259			$config['class'] = $class;
260			}
261			else
262			{
263			$config['class'] = static::class;
264			}
265			$widget = EmbeDi::fly()->apply($config);
266			$widget->init();
267			$out = $widget->run();
268
269			return ob_get_clean() . $out;
270			}
271
272			/**
273			* This is equivalent of calling ::widget() with config from constructor.
274			* Could be used for convenient outputting of simple widgets.
275			* Example:
276			* ```php
277			* echo new Flags([], $this);
278			* echo new Head(['title' => 'foot'], $this);
279			* ```
280			* @return string HTML output of widget.
281			*/
282			public function __toString()
283			{
284			try
285			{
286			$class = static::class;
287			return $class::widget($this->config);
288			}
289			catch (Exception $e)
290			{
291			return nl2br($e->getTraceAsString());
292			}
293			}
294
295			}
296

Maslosoft / MiniView

Widget::__toString() A last analyzed 2017-02-16 07:48 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Widget::__toString() A
last analyzed 2017-02-16 07:48 UTC