Compose::get() - Code Metrics - Inspection of "Implemented template engine composer" - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 31758c...fcf74b )

by Aimeos

created 2017-01-12 23:23 UTC

Compose::get() A

↳ Parent: Compose

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2017
 * @package MW
 * @subpackage View
 */


namespace Aimeos\MW\View;


/**
 * Allow more than one view engine at once
 *
 * @package MW
 * @subpackage View
 */
class Compose implements \Aimeos\MW\View\Iface
{
	private $engines;


	/**
	 * Initializes the logger object.
	 *
	 * @param array $engines Associative list of file name extensions as keys and view objects as values
	 */
	public function __construct( array $engines )
	{
		\Aimeos\MW\Common\Base::checkClassList( '\Aimeos\MW\View\Iface', $engines );

		$this->engines = $engines;
	}


	/**
	 * Calls the view helper with the given name and arguments and returns it's output.
	 *
	 * @param string $name Name of the view helper
	 * @param array $args Arguments passed to the view helper
	 * @return mixed Output depending on the view helper
	 */
	public function __call( $name, array $args )
	{
		foreach( $this->engines as $engine )
		{
			if( ( $result = call_user_func_array( array( $engine, $name ), $args ) ) !== null ) {
				return $result;
			}
		}
	}


	/**
	 * Returns the value associated to the given key.
	 *
	 * @param string $key Name of the value that should be returned
	 * @return mixed Value associated to the given key
	 * @throws \Aimeos\MW\View\Exception If the requested key isn't available
	 */
	public function __get( $key )
	{
		foreach( $this->engines as $engine )
		{
			if( isset( $engine->$key ) ) {
				return $engine->$key;
			}
		}

		throw new \Aimeos\MW\View\Exception( sprintf( 'No value for key "%1$s" found', $key ) );
	}


	/**
	 * Tests if a key with the given name exists.
	 *
	 * @param string $key Name of the value that should be tested
	 * @return boolean True if the key exists, false if not
	 */
	public function __isset( $key )
	{
		foreach( $this->engines as $engine )
		{
			if( isset( $engine->$key ) ) {
				return true;
			}
		}

		return false;
	}


	/**
	 * Removes a key from the stored values.
	 *
	 * @param string $key Name of the value that should be removed
	 * @return void
	 */
	public function __unset( $key )
	{
		foreach( $this->engines as $engine ) {
			unset( $engine->$key );
		}
	}


	/**
	 * Sets a new value for the given key.
	 *
	 * @param string $key Name of the value that should be set
	 * @param mixed $value Value associated to the given key
	 * @return void
	 */
	public function __set( $key, $value )
	{
		foreach( $this->engines as $engine ) {
			$engine->$key = $value;
		}
	}


	/**
	 * Adds a view helper instance to the view.
	 *
	 * @param string $name Name of the view helper as called in the template
	 * @param \Aimeos\MW\View\Helper\Iface $helper View helper instance
	 * @return void
	 */
	public function addHelper( $name, \Aimeos\MW\View\Helper\Iface $helper )
	{
		foreach( $this->engines as $engine ) {
			$engine->addHelper( $name, $helper );
		}
	}


	/**
	 * Assigns a whole set of values at once to the view.
	 * This method overwrites already existing key/value pairs set by the magic method.
	 *
	 * @param array $values Associative list of key/value pairs
	 * @return void
	 */
	public function assign( array $values )
	{
		foreach( $this->engines as $engine ) {
			$engine->assign( $values );
		}
	}


	/**
	 * Returns the value associated to the given key or the default value if the key is not available.
	 *
	 * @param string $key Name of the value that should be returned
	 * @param mixed $default Default value returned if ths key is not available
	 * @return mixed Value associated to the given key or the default value
	 */
	public function get( $key, $default = null )
	{
		foreach( $this->engines as $engine )
		{
			if( ( $value = $engine->get( $key ) ) !== null ) {
				return $value;
			}
		}

		return $default;
	}


	/**
	 * Renders the output based on the given template file name and the key/value pairs.
	 *
	 * @param string $filename File name of the view template
	 * @return string Output generated by the template
	 * @throws \Aimeos\MW\View\Exception If the template isn't found
	 */
	public function render( $filename )
	{
		return $this->getEngine( $filename )->render( $filename );
	}


	/**
	 * Returns the view engine suitable for the given file name
	 *
	 * @param string $filename Name of the template file including the file extension
	 * @return \Aimeos\MW\View\Iface View engine
	 * @throws \Aimeos\MW\View\Exception If no registered view engine for this file extension is found
	 */
	protected function getEngine( $filename )
	{
		foreach( (array) $filename as $file )
		{
			foreach( $this->engines as $fileext => $engine )
			{
				if( substr_compare( $file, $fileext, -strlen( $fileext ) ) === 0 ) {
					return $engine;
				}
			}
		}

		throw new \Aimeos\MW\View\Exception( sprintf( 'No view engine for "%1$s" found', $filename ) );
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2017
6			* @package MW
7			* @subpackage View
8			*/
9
10
11			namespace Aimeos\MW\View;
12
13
14			/**
15			* Allow more than one view engine at once
16			*
17			* @package MW
18			* @subpackage View
19			*/
20			class Compose implements \Aimeos\MW\View\Iface
21			{
22			private $engines;
23
24
25			/**
26			* Initializes the logger object.
27			*
28			* @param array $engines Associative list of file name extensions as keys and view objects as values
29			*/
30			public function __construct( array $engines )
31			{
32			\Aimeos\MW\Common\Base::checkClassList( '\Aimeos\MW\View\Iface', $engines );
33
34			$this->engines = $engines;
35			}
36
37
38			/**
39			* Calls the view helper with the given name and arguments and returns it's output.
40			*
41			* @param string $name Name of the view helper
42			* @param array $args Arguments passed to the view helper
43			* @return mixed Output depending on the view helper
44			*/
45			public function __call( $name, array $args )
46			{
47			foreach( $this->engines as $engine )
48			{
49			if( ( $result = call_user_func_array( array( $engine, $name ), $args ) ) !== null ) {
50			return $result;
51			}
52			}
53			}
54
55
56			/**
57			* Returns the value associated to the given key.
58			*
59			* @param string $key Name of the value that should be returned
60			* @return mixed Value associated to the given key
61			* @throws \Aimeos\MW\View\Exception If the requested key isn't available
62			*/
63			public function __get( $key )
64			{
65			foreach( $this->engines as $engine )
66			{
67			if( isset( $engine->$key ) ) {
68			return $engine->$key;
69			}
70			}
71
72			throw new \Aimeos\MW\View\Exception( sprintf( 'No value for key "%1$s" found', $key ) );
73			}
74
75
76			/**
77			* Tests if a key with the given name exists.
78			*
79			* @param string $key Name of the value that should be tested
80			* @return boolean True if the key exists, false if not
81			*/
82			public function __isset( $key )
83			{
84			foreach( $this->engines as $engine )
85			{
86			if( isset( $engine->$key ) ) {
87			return true;
88			}
89			}
90
91			return false;
92			}
93
94
95			/**
96			* Removes a key from the stored values.
97			*
98			* @param string $key Name of the value that should be removed
99			* @return void
100			*/
101			public function __unset( $key )
102			{
103			foreach( $this->engines as $engine ) {
104			unset( $engine->$key );
105			}
106			}
107
108
109			/**
110			* Sets a new value for the given key.
111			*
112			* @param string $key Name of the value that should be set
113			* @param mixed $value Value associated to the given key
114			* @return void
115			*/
116			public function __set( $key, $value )
117			{
118			foreach( $this->engines as $engine ) {
119			$engine->$key = $value;
120			}
121			}
122
123
124			/**
125			* Adds a view helper instance to the view.
126			*
127			* @param string $name Name of the view helper as called in the template
128			* @param \Aimeos\MW\View\Helper\Iface $helper View helper instance
129			* @return void
130			*/
131			public function addHelper( $name, \Aimeos\MW\View\Helper\Iface $helper )
132			{
133			foreach( $this->engines as $engine ) {
134			$engine->addHelper( $name, $helper );
135			}
136			}
137
138
139			/**
140			* Assigns a whole set of values at once to the view.
141			* This method overwrites already existing key/value pairs set by the magic method.
142			*
143			* @param array $values Associative list of key/value pairs
144			* @return void
145			*/
146			public function assign( array $values )
147			{
148			foreach( $this->engines as $engine ) {
149			$engine->assign( $values );
150			}
151			}
152
153
154			/**
155			* Returns the value associated to the given key or the default value if the key is not available.
156			*
157			* @param string $key Name of the value that should be returned
158			* @param mixed $default Default value returned if ths key is not available
159			* @return mixed Value associated to the given key or the default value
160			*/
161			public function get( $key, $default = null )
162			{
163			foreach( $this->engines as $engine )
164			{
165			if( ( $value = $engine->get( $key ) ) !== null ) {
166			return $value;
167			}
168			}
169
170			return $default;
171			}
172
173
174			/**
175			* Renders the output based on the given template file name and the key/value pairs.
176			*
177			* @param string $filename File name of the view template
178			* @return string Output generated by the template
179			* @throws \Aimeos\MW\View\Exception If the template isn't found
180			*/
181			public function render( $filename )
182			{
183			return $this->getEngine( $filename )->render( $filename );
184			}
185
186
187			/**
188			* Returns the view engine suitable for the given file name
189			*
190			* @param string $filename Name of the template file including the file extension
191			* @return \Aimeos\MW\View\Iface View engine
192			* @throws \Aimeos\MW\View\Exception If no registered view engine for this file extension is found
193			*/
194			protected function getEngine( $filename )
195			{
196			foreach( (array) $filename as $file )
197			{
198			foreach( $this->engines as $fileext => $engine )
199			{
200			if( substr_compare( $file, $fileext, -strlen( $fileext ) ) === 0 ) {
201			return $engine;
202			}
203			}
204			}
205
206			throw new \Aimeos\MW\View\Exception( sprintf( 'No view engine for "%1$s" found', $filename ) );
207			}
208			}
209

aimeos / aimeos-core

Push — master ( 31758c...fcf74b )

Compose::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like