View::output() - Code Metrics - Inspection of "100 code coverage" - samsonframework/view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6552db...3e40c9 )

by Vitaly

created 2016-02-22 15:38 UTC

View::output() B

↳ Parent: View

Complexity

Conditions	3
Paths	4

Size

Total Lines	29
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes	3
Bugs	0	Features	3

Metric	Value
c	3
b	0
f	3
dl	0
loc	29
ccs	13
cts	13
cp	1
rs	8.8571
cc	3
eloc	12
nc	4
nop	0
crap	3

<?php
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 18.02.16 at 14:15
 */
namespace samsonframework\view;

use samsonframework\core\RenderInterface;
use samsonframework\core\ViewInterface;
use samsonframework\view\exception\VariableKeyNotFound;
use samsonframework\view\exception\ViewFileNotFound;

/**
 * View class for rendering.
 * @package samsonframework\view
 */
class View implements ViewInterface
{
    /** Default view file extension */
    const DEFAULT_EXT = 'vphp';

    /** @var array Collection of $key => $value view data */
    protected $data = array();

    /** @var string Full path to view file */
    protected $file;

    /** @var string View source code */
    protected $source;

    /** @var string Rendered view contents */
    protected $output;

    /**
     * Set current view for rendering.
     * Method searches for the shortest matching view path by $pathPattern,
     * from loaded views.
     *
     * Module saves all view data that has been set to a specific view in appropriate
     * view data collection entry. By default module creates vied data entry - VD_POINTER_DEF,
     * and until any call of iModule::view() or iModule::output(), all data that is iModule::set(),
     * is stored to that location.
     *
     * On the first call of iModule::view() or iModule::output(), this method changes the view data
     * pointer to actual relative view path, and copies(actually just sets view data pointer) all view
     * data set before to new view data pointer. This guarantees backward compatibility and gives
     * opportunity not to set the view path before setting view data to it.
     *
     * @param string $pathPattern Path pattern for view searching
     *
     * @return $this Chaining
     * @throws \Exception
     */
    public function view($pathPattern)
    {
        if (file_exists($pathPattern)) {
            $this->file = $pathPattern;
            return $this;
        }

        throw new ViewFileNotFound($pathPattern);
    }

    /**
     * Render current view.
     * Method uses current view context and outputs rendering
     * result.
     *
     * @return string Rendered view
     */
    public function output()
    {
        // Start buffering
        ob_start();

        // Make variables accessible directly in view
        extract($this->data);

        // Render view from source
        if (!empty($this->source)) {
            eval(' ?>' . $this->source . '<?php ');
        } else { // Render view from file
            include($this->file);
        }

        // Store buffer output
        $this->output = ob_get_contents();

        // Clear buffer
        ob_end_clean();

        // Remove variables from context to free memory
        foreach ($this->data as $key => $value) {
            unset($key);
        }

        // Returned rendered view
        return $this->output;
    }

    /**
     * Magic method for getting view variables.
     *
     * @param string $name Variable key
     *
     * @return mixed Value
     * @throws VariableKeyNotFound
     */
    public function __get($name)
    {
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        throw new VariableKeyNotFound($name);
    }

    /**
     * Magic method for setting view variables.
     *
     * @param string $name      Variable key
     * @param array  $arguments Variable value
     *
     * @return $this Chaining
     * @throws VariableKeyNotFound
     */
    public function __call($name, $arguments)
    {
        if (count($arguments)) {
            $this->set($arguments[0], $name);
        }

        return $this;
    }

    /**
     * Set view variable.
     *
     * Passing an array as $value will add array key => values into current
     * view data collection. If $key is passed then an array variable with this
     * key will be added to view data collection beside adding array key => values.
     *
     * @param mixed       $value Variable value
     * @param string|null $key   Variable key\prefix for objects and arrays
     *
     * @return $this Chaining
     */
    public function set($value, $key = null)
    {
        // RenderInterface implementation
        if (is_object($value) && is_a($value, RenderInterface::class)) {
            $this->setRenderableObject($value, $key);
        } elseif (is_array($value)) { // Merge array into view data
            $this->data = array_merge($this->data, $value);
        }

        // Store key value
        $this->data[$key] = $value;

        return $this;
    }

    /**
     * Set renderable object as view variable.
     *
     * @param mixed       $object Object instance for rendering
     * @param string|null $key    Variable key\prefix for objects and arrays
     */
    protected function setRenderableObject($object, $key)
    {
        /** @var RenderInterface $object */
        // Generate objects view array data and merge it with view data
        $this->data = array_merge(
            $this->data,
            $object->toView(null !== $key ? $key : get_class($object))
        );
    }
}


1		<?php
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 18.02.16 at 14:15
5		*/
6		namespace samsonframework\view;
7
8		use samsonframework\core\RenderInterface;
9		use samsonframework\core\ViewInterface;
10		use samsonframework\view\exception\VariableKeyNotFound;
11		use samsonframework\view\exception\ViewFileNotFound;
12
13		/**
14		* View class for rendering.
15		* @package samsonframework\view
16		*/
17		class View implements ViewInterface
18		{
19		/** Default view file extension */
20		const DEFAULT_EXT = 'vphp';
21
22		/** @var array Collection of $key => $value view data */
23		protected $data = array();
24
25		/** @var string Full path to view file */
26		protected $file;
27
28		/** @var string View source code */
29		protected $source;
30
31		/** @var string Rendered view contents */
32		protected $output;
33
34		/**
35		* Set current view for rendering.
36		* Method searches for the shortest matching view path by $pathPattern,
37		* from loaded views.
38		*
39		* Module saves all view data that has been set to a specific view in appropriate
40		* view data collection entry. By default module creates vied data entry - VD_POINTER_DEF,
41		* and until any call of iModule::view() or iModule::output(), all data that is iModule::set(),
42		* is stored to that location.
43		*
44		* On the first call of iModule::view() or iModule::output(), this method changes the view data
45		* pointer to actual relative view path, and copies(actually just sets view data pointer) all view
46		* data set before to new view data pointer. This guarantees backward compatibility and gives
47		* opportunity not to set the view path before setting view data to it.
48		*
49		* @param string $pathPattern Path pattern for view searching
50		*
51		* @return $this Chaining
52		* @throws \Exception
53		*/
54	2	public function view($pathPattern)
55		{
56	2	if (file_exists($pathPattern)) {
57	2	$this->file = $pathPattern;
58	2	return $this;
59		}
60
61	1	throw new ViewFileNotFound($pathPattern);
62		}
63
64		/**
65		* Render current view.
66		* Method uses current view context and outputs rendering
67		* result.
68		*
69		* @return string Rendered view
70		*/
71	2	public function output()
72		{
73		// Start buffering
74	2	ob_start();
75
76		// Make variables accessible directly in view
77	2	extract($this->data);
78
79		// Render view from source
80	2	if (!empty($this->source)) {
81	1	eval(' ?>' . $this->source . '<?php ');
82	1	} else { // Render view from file
83	1	include($this->file);
84		}
85
86		// Store buffer output
87	2	$this->output = ob_get_contents();
88
89		// Clear buffer
90	2	ob_end_clean();
91
92		// Remove variables from context to free memory
93	2	foreach ($this->data as $key => $value) {
94	2	unset($key);
95	2	}
96
97		// Returned rendered view
98	2	return $this->output;
99		}
100
101		/**
102		* Magic method for getting view variables.
103		*
104		* @param string $name Variable key
105		*
106		* @return mixed Value
107		* @throws VariableKeyNotFound
108		*/
109	5	public function __get($name)
110		{
111	5	if (array_key_exists($name, $this->data)) {
112	5	return $this->data[$name];
113		}
114
115	1	throw new VariableKeyNotFound($name);
116		}
117
118		/**
119		* Magic method for setting view variables.
120		*
121		* @param string $name Variable key
122		* @param array $arguments Variable value
123		*
124		* @return $this Chaining
125		* @throws VariableKeyNotFound
126		*/
127	1	public function __call($name, $arguments)
128		{
129	1	if (count($arguments)) {
130	1	$this->set($arguments[0], $name);
131	1	}
132
133	1	return $this;
134		}
135
136		/**
137		* Set view variable.
138		*
139		* Passing an array as $value will add array key => values into current
140		* view data collection. If $key is passed then an array variable with this
141		* key will be added to view data collection beside adding array key => values.
142		*
143		* @param mixed $value Variable value
144		* @param string\|null $key Variable key\prefix for objects and arrays
145		*
146		* @return $this Chaining
147		*/
148	6	public function set($value, $key = null)
149		{
150		// RenderInterface implementation
151	6	if (is_object($value) && is_a($value, RenderInterface::class)) {
152	3	$this->setRenderableObject($value, $key);
153	6	} elseif (is_array($value)) { // Merge array into view data
154	3	$this->data = array_merge($this->data, $value);
155	3	}
156
157		// Store key value
158	6	$this->data[$key] = $value;
159
160	6	return $this;
161		}
162
163		/**
164		* Set renderable object as view variable.
165		*
166		* @param mixed $object Object instance for rendering
167		* @param string\|null $key Variable key\prefix for objects and arrays
168		*/
169	3	protected function setRenderableObject($object, $key)
170		{
171		/** @var RenderInterface $object */
172		// Generate objects view array data and merge it with view data
173	3	$this->data = array_merge(
174	3	$this->data,
175	3	$object->toView(null !== $key ? $key : get_class($object))
176	3	);
177	3	}
178		}
179

samsonframework / view

Push — master ( 6552db...3e40c9 )

View::output() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like