ViewService::canonical() - Code Metrics - Inspection of "Update wpemerge-theme release steps to update docs" - htmlburger/wpemerge - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 141f54...437209 )

by Atanas

created 2020-07-03 23:16 UTC

ViewService::canonical() A

↳ Parent: ViewService

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	2
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php
/**
 * @package   WPEmerge
 * @author    Atanas Angelov <[email protected]>
 * @copyright 2017-2019 Atanas Angelov
 * @license   https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
 * @link      https://wpemerge.com/
 */

namespace WPEmerge\View;

use Closure;
use WPEmerge\Helpers\Handler;
use WPEmerge\Helpers\HandlerFactory;
use WPEmerge\Helpers\MixedType;

/**
 * Provide general view-related functionality.
 */
class ViewService {
	/**
	 * Configuration.
	 *
	 * @var array<string, mixed>
	 */
	protected $config = [];

	/**
	 * View engine.
	 *
	 * @var ViewEngineInterface
	 */
	protected $engine = null;

	/**
	 * Handler factory.
	 *
	 * @var HandlerFactory
	 */
	protected $handler_factory = null;

	/**
	 * Global variables.
	 *
	 * @var array
	 */
	protected $globals = [];

	/**
	 * View composers.
	 *
	 * @var array
	 */
	protected $composers = [];

	/**
	 * Constructor.
	 *
	 * @codeCoverageIgnore
	 * @param array<string, mixed> $config
	 * @param ViewEngineInterface  $engine
	 * @param HandlerFactory       $handler_factory
	 */
	public function __construct( $config, ViewEngineInterface $engine, HandlerFactory $handler_factory ) {
		$this->config = $config;
		$this->engine = $engine;
		$this->handler_factory = $handler_factory;
	}

	/**
	 * Get global variables.
	 *
	 * @return array
	 */
	public function getGlobals() {
		return $this->globals;
	}

	/**
	 * Set a global variable.
	 *
	 * @param  string $key
	 * @param  mixed  $value
	 * @return void
	 */
	public function addGlobal( $key, $value ) {
		$this->globals[ $key ] = $value;
	}

	/**
	 * Set an array of global variables.
	 *
	 * @param  array $globals
	 * @return void
	 */
	public function addGlobals( $globals ) {
		foreach ( $globals as $key => $value ) {
			$this->addGlobal( $key, $value );
		}
	}

	/**
	 * Get view composer.
	 *
	 * @param  string    $view
	 * @return Handler[]
	 */
	public function getComposersForView( $view ) {
		$view = $this->engine->canonical( $view );

		$composers = [];

		foreach ( $this->composers as $composer ) {
			if ( in_array( $view, $composer['views'], true ) ) {
				$composers[] = $composer['composer'];
			}
		}

		return $composers;
	}

	/**
	 * Add view composer.
	 *
	 * @param  string|string[] $views
	 * @param  string|Closure  $composer
	 * @return void
	 */
	public function addComposer( $views, $composer ) {
		$views = array_map( function ( $view ) {
			return $this->engine->canonical( $view );
		}, MixedType::toArray( $views ) );

		$handler = $this->handler_factory->make( $composer, 'compose', $this->config['namespace'] );

		$this->composers[] = [
			'views' => $views,
			'composer' => $handler,
		];
	}

	/**
	 * Composes a view instance with contexts in the following order: Global, Composers, Local.
	 *
	 * @param  ViewInterface $view
	 * @return void
	 */
	public function compose( ViewInterface $view ) {
		$global = ['global' => $this->getGlobals()];
		$local = $view->getContext();

		$view->with( $global );

		$composers = $this->getComposersForView( $view->getName() );
		foreach ( $composers as $composer ) {
			$composer->execute( $view );
		}

		$view->with( $local );
	}

	/**
	 * Check if a view exists.
	 *
	 * @param  string  $view
	 * @return boolean
	 */
	public function exists( $view ) {
		return $this->engine->exists( $view );
	}

	/**
	 * Return a canonical string representation of the view name.
	 *
	 * @param  string $view
	 * @return string
	 */
	public function canonical( $view ) {
		return $this->engine->canonical( $view );
	}

	/**
	 * Create a view instance from the first view name that exists.
	 *
	 * @param  string|string[] $views
	 * @return ViewInterface
	 */
	public function make( $views ) {
		return $this->engine->make( MixedType::toArray( $views ) );
	}

	/**
	 * Trigger core hooks for a partial, if any.
	 *
	 * @codeCoverageIgnore
	 * @param  string $name
	 * @return void
	 */
	public function triggerPartialHooks( $name ) {
		if ( ! function_exists( 'apply_filters' ) ) {
			// We are not in a WordPress environment - skip triggering hooks.
			return;
		}

		$core_partial = '/^(header|sidebar|footer)(?:-(.*?))?(\.|$)/i';
		$matches = [];
		$is_partial = preg_match( $core_partial, $name, $matches );

		if ( $is_partial && apply_filters( "wpemerge.partials.{$matches[1]}.hook", true ) ) {
			do_action( "get_{$matches[1]}", $matches[2] );
		}
	}

	/**
	 * Render a view.
	 *
	 * @codeCoverageIgnore
	 * @param  string|string[]      $views
	 * @param  array<string, mixed> $context
	 * @return void
	 */
	public function render( $views, $context = [] ) {
		$view = $this->make( $views )->with( $context );
		$this->triggerPartialHooks( $view->getName() );
		echo $view->toString();
	}
}


1		<?php
2		/**
3		* @package WPEmerge
4		* @author Atanas Angelov <[email protected]>
5		* @copyright 2017-2019 Atanas Angelov
6		* @license https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
7		* @link https://wpemerge.com/
8		*/
9
10		namespace WPEmerge\View;
11
12		use Closure;
13		use WPEmerge\Helpers\Handler;
14		use WPEmerge\Helpers\HandlerFactory;
15		use WPEmerge\Helpers\MixedType;
16
17		/**
18		* Provide general view-related functionality.
19		*/
20		class ViewService {
21		/**
22		* Configuration.
23		*
24		* @var array<string, mixed>
25		*/
26		protected $config = [];
27
28		/**
29		* View engine.
30		*
31		* @var ViewEngineInterface
32		*/
33		protected $engine = null;
34
35		/**
36		* Handler factory.
37		*
38		* @var HandlerFactory
39		*/
40		protected $handler_factory = null;
41
42		/**
43		* Global variables.
44		*
45		* @var array
46		*/
47		protected $globals = [];
48
49		/**
50		* View composers.
51		*
52		* @var array
53		*/
54		protected $composers = [];
55
56		/**
57		* Constructor.
58		*
59		* @codeCoverageIgnore
60		* @param array<string, mixed> $config
61		* @param ViewEngineInterface $engine
62		* @param HandlerFactory $handler_factory
63		*/
64		public function __construct( $config, ViewEngineInterface $engine, HandlerFactory $handler_factory ) {
65		$this->config = $config;
66		$this->engine = $engine;
67		$this->handler_factory = $handler_factory;
68		}
69
70		/**
71		* Get global variables.
72		*
73		* @return array
74		*/
75	2	public function getGlobals() {
76	2	return $this->globals;
77		}
78
79		/**
80		* Set a global variable.
81		*
82		* @param string $key
83		* @param mixed $value
84		* @return void
85		*/
86	1	public function addGlobal( $key, $value ) {
87	1	$this->globals[ $key ] = $value;
88	1	}
89
90		/**
91		* Set an array of global variables.
92		*
93		* @param array $globals
94		* @return void
95		*/
96	1	public function addGlobals( $globals ) {
97	1	foreach ( $globals as $key => $value ) {
98	1	$this->addGlobal( $key, $value );
99		}
100	1	}
101
102		/**
103		* Get view composer.
104		*
105		* @param string $view
106		* @return Handler[]
107		*/
108	1	public function getComposersForView( $view ) {
109	1	$view = $this->engine->canonical( $view );
110
111	1	$composers = [];
112
113	1	foreach ( $this->composers as $composer ) {
114	1	if ( in_array( $view, $composer['views'], true ) ) {
115	1	$composers[] = $composer['composer'];
116		}
117		}
118
119	1	return $composers;
120		}
121
122		/**
123		* Add view composer.
124		*
125		* @param string\|string[] $views
126		* @param string\|Closure $composer
127		* @return void
128		*/
129	1	public function addComposer( $views, $composer ) {
130		$views = array_map( function ( $view ) {
131	1	return $this->engine->canonical( $view );
132	1	}, MixedType::toArray( $views ) );
133
134	1	$handler = $this->handler_factory->make( $composer, 'compose', $this->config['namespace'] );
135
136	1	$this->composers[] = [
137	1	'views' => $views,
138	1	'composer' => $handler,
139		];
140	1	}
141
142		/**
143		* Composes a view instance with contexts in the following order: Global, Composers, Local.
144		*
145		* @param ViewInterface $view
146		* @return void
147		*/
148	4	public function compose( ViewInterface $view ) {
149	4	$global = ['global' => $this->getGlobals()];
150	4	$local = $view->getContext();
151
152	4	$view->with( $global );
153
154	4	$composers = $this->getComposersForView( $view->getName() );
155	4	foreach ( $composers as $composer ) {
156	3	$composer->execute( $view );
157		}
158
159	4	$view->with( $local );
160	4	}
161
162		/**
163		* Check if a view exists.
164		*
165		* @param string $view
166		* @return boolean
167		*/
168	1	public function exists( $view ) {
169	1	return $this->engine->exists( $view );
170		}
171
172		/**
173		* Return a canonical string representation of the view name.
174		*
175		* @param string $view
176		* @return string
177		*/
178	1	public function canonical( $view ) {
179	1	return $this->engine->canonical( $view );
180		}
181
182		/**
183		* Create a view instance from the first view name that exists.
184		*
185		* @param string\|string[] $views
186		* @return ViewInterface
187		*/
188	1	public function make( $views ) {
189	1	return $this->engine->make( MixedType::toArray( $views ) );
190		}
191
192		/**
193		* Trigger core hooks for a partial, if any.
194		*
195		* @codeCoverageIgnore
196		* @param string $name
197		* @return void
198		*/
199		public function triggerPartialHooks( $name ) {
200		if ( ! function_exists( 'apply_filters' ) ) {
201		// We are not in a WordPress environment - skip triggering hooks.
202		return;
203		}
204
205		$core_partial = '/^(header\|sidebar\|footer)(?:-(.*?))?(\.\|$)/i';
206		$matches = [];
207		$is_partial = preg_match( $core_partial, $name, $matches );
208
209		if ( $is_partial && apply_filters( "wpemerge.partials.{$matches[1]}.hook", true ) ) {
210		do_action( "get_{$matches[1]}", $matches[2] );
211		}
212		}
213
214		/**
215		* Render a view.
216		*
217		* @codeCoverageIgnore
218		* @param string\|string[] $views
219		* @param array<string, mixed> $context
220		* @return void
221		*/
222		public function render( $views, $context = [] ) {
223		$view = $this->make( $views )->with( $context );
224		$this->triggerPartialHooks( $view->getName() );
225		echo $view->toString();
226		}
227		}
228

htmlburger / wpemerge

Push — master ( 141f54...437209 )

ViewService::canonical() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like