App::render_blocks() - Code Metrics - Inspection of "System now knows which classes store state that ch..." - nazar-pc/CleverStyle-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b7b84b...78616b )

by Nazar

created 2016-03-23 01:56 UTC

App::render_blocks() C

↳ Parent: App

Complexity

Conditions	10
Paths	9

Size

Total Lines	90
Code Lines	55

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	90
rs	5.1578
cc	10
eloc	55
nc	9
nop	0

How to fix Long Method Complexity

<?php
/**
 * @package   CleverStyle CMS
 * @author    Nazar Mokrynskyi <[email protected]>
 * @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs;
use
	cs\App\Router;

/**
 * Provides next events:
 *  System/App/block_render
 *  [
 *      'index'           => $index,        //Block index
 *      'blocks_array'    => &$blocks_array //Reference to array in form ['top' => '', 'left' => '', 'right' => '', 'bottom' => '']
 *  ]
 *
 *  System/App/construct
 *
 *  System/App/render/before
 *
 *  System/App/render/after
 */
class App {
	use
		Singleton,
		Router;
	const INIT_STATE_METHOD = 'init';
	/**
	 * @var string
	 */
	protected $working_directory;
	protected function init () {
		$this->working_directory = '';
		$this->controller_path   = ['index'];
	}
	/**
	 * Executes plugins processing, blocks and module page generation
	 *
	 * @throws ExitException
	 */
	function execute () {
		$Config  = Config::instance();
		$Request = Request::instance();
		if (!preg_match('/^[0-9a-z_]+$/i', $Request->method)) {
			throw new ExitException(400);
		}
		$this->handle_closed_site(!$Config->core['site_mode'], $Request);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->working_directory = MODULES."/$Request->current_module";
		if ($Request->admin_path) {
			$this->working_directory .= '/admin';
		} elseif ($Request->api_path) {
			$this->working_directory .= '/api';
		}
		if (!is_dir($this->working_directory)) {
			throw new ExitException(404);
		}
		if (!$this->check_permission('index')) {
			throw new ExitException(403);
		}
		Event::instance()->fire('System/Index/construct');
		Event::instance()->fire('System/App/construct');
		/**
		 * Plugins processing
		 */
		foreach ($Config->components['plugins'] as $plugin) {
			_include(PLUGINS."/$plugin/index.php", false, false);
		}
		_include("$this->working_directory/prepare.php", false, false);
		Event::instance()->fire('System/Index/load/before');
		Event::instance()->fire('System/App/render/before');
		/**
		 * Title only for non-API calls
		 */
		$Request->api_path || $this->render_title();
		$this->render_content();
		/**
		 * Blocks only for non-API calls
		 */
		$Request->api_path || $this->render_blocks();
		Event::instance()->fire('System/Index/load/after');
		Event::instance()->fire('System/App/render/after');
		Page::instance()->render();
	}
	/**
	 * @param bool    $closed_site
	 * @param Request $Request
	 *
	 * @throws ExitException
	 */
	protected function handle_closed_site ($closed_site, $Request) {
		if (!$closed_site) {
			return;
		}
		/**
		 * If site is closed
		 */
		if (!$this->allow_closed_site_request($Request)) {
			throw new ExitException(
				[
					get_core_ml_text('closed_title'),
					get_core_ml_text('closed_text')
				],
				503
			);
		}
		/**
		 * Warning about closed site for administrator
		 */
		Page::instance()->warning(get_core_ml_text('closed_title'));
	}
	/**
	 * Check if visitor is allowed to make current request to closed site
	 *
	 * @param Request $Request
	 *
	 * @return bool
	 */
	protected function allow_closed_site_request ($Request) {
		return
			User::instance()->admin() ||
			(
				$Request->api_path &&
				$Request->current_module == 'System' &&
				$Request->route === ['user', 'sign_in']
			);
	}
	/**
	 * Check whether user allowed to access to specified label
	 *
	 * @param string $label
	 *
	 * @return bool
	 */
	protected function check_permission ($label) {
		$Request          = Request::instance();
		$permission_group = $Request->current_module;
		if ($Request->admin_path) {
			$permission_group = "admin/$permission_group";
		} elseif ($Request->api_path) {
			$permission_group = "api/$permission_group";
		}
		return User::instance()->get_permission($permission_group, $label);
	}
	/**
	 * Render page title
	 */
	protected function render_title () {
		$Page    = Page::instance();
		$Request = Request::instance();
		/**
		 * Add generic Home or Module name title
		 */
		if (!$Request->api_path) {
			$L = Language::instance();
			if ($Request->admin_path) {
				$Page->title($L->system_admin_administration);
			}
			$Page->title(
				$L->{$Request->home_page ? 'system_home' : $Request->current_module}
			);
		}
	}
	/**
	 * Render page content (without blocks, just module content)
	 *
	 * @throws ExitException
	 */
	protected function render_content () {
		$Page = Page::instance();
		/**
		 * If module consists of index.html only
		 */
		if (file_exists("$this->working_directory/index.html")) {
			ob_start();
			_include("$this->working_directory/index.html", false, false);
			$Page->content(ob_get_clean());
			return;
		}
		$this->execute_router();
	}
	/**
	 * Blocks rendering
	 */
	protected function render_blocks () {
		$blocks = Config::instance()->components['blocks'];
		/**
		 * It is frequent that there is no blocks - so, no need to to anything here
		 */
		if (!$blocks) {
			return;
		}
		$Page         = Page::instance();
		$blocks_array = [
			'top'    => '',
			'left'   => '',
			'right'  => '',
			'bottom' => ''
		];
		foreach ($blocks as $block) {
			/**
			 * If there is no need to show block or it was rendered by even handler - skip further processing
			 */
			if (
				!$this->should_block_be_rendered($block) ||
				!Event::instance()->fire(
					'System/Index/block_render',
					[
						'index'        => $block['index'],
						'blocks_array' => &$blocks_array
					]
				) ||
				!Event::instance()->fire(
					'System/App/block_render',
					[
						'index'        => $block['index'],
						'blocks_array' => &$blocks_array
					]
				)
			) {
				/**
				 * Block was rendered by event handler
				 */
				continue;
			}
			$block['title'] = $this->ml_process($block['title']);
			switch ($block['type']) {
				default:
					$block['content'] = ob_wrapper(
						function () use ($block) {
							include BLOCKS."/block.$block[type].php";
						}
					);
					break;
				case 'html':
				case 'raw_html':
					$block['content'] = $this->ml_process($block['content']);
					break;
			}
			/**
			 * Template file will have access to `$block` variable, so it can use that
			 */
			$content = str_replace(
				[
					'<!--id-->',
					'<!--title-->',
					'<!--content-->'
				],
				[
					$block['index'],
					$block['title'],
					$block['content']
				],
				ob_wrapper(
					function () use ($block) {
						$template = file_exists(TEMPLATES."/blocks/block.$block[template]") ? $block['template'] : 'default.html';
						include TEMPLATES."/blocks/block.$template";
					}
				)
			);
			if ($block['position'] == 'floating') {
				$Page->replace(
					"<!--block#$block[index]-->",
					$content
				);
			} else {
				$blocks_array[$block['position']] .= $content;
			}
		}
		$Page->Top .= $blocks_array['top'];
		$Page->Left .= $blocks_array['left'];
		$Page->Right .= $blocks_array['right'];
		$Page->Bottom .= $blocks_array['bottom'];
	}
	/**
	 * Check whether to render block or not based on its properties (active state, when start to show, when it expires and permissions)
	 *
	 * @param array $block
	 *
	 * @return bool
	 */
	protected function should_block_be_rendered ($block) {
		return
			$block['active'] &&
			$block['start'] <= time() &&
			(
				!$block['expire'] ||
				$block['expire'] >= time()
			) &&
			User::instance()->get_permission('Block', $block['index']);
	}
	/**
	 * @param string $text
	 *
	 * @return string
	 */
	protected function ml_process ($text) {
		return Text::instance()->process(Config::instance()->module('System')->db('texts'), $text, true);
	}
	/**
	 * Getter for `controller_path` property (no other properties supported currently)
	 *
	 * @param string $property
	 *
	 * @return false|string[]
	 */
	function __get ($property) {
		if ($property == 'controller_path') {
			return $this->controller_path;
		}
		return false;
	}
}


1			<?php
2			/**
3			* @package CleverStyle CMS
4			* @author Nazar Mokrynskyi <[email protected]>
5			* @copyright Copyright (c) 2011-2016, Nazar Mokrynskyi
6			* @license MIT License, see license.txt
7			*/
8			namespace cs;
9			use
10			cs\App\Router;
11
12			/**
13			* Provides next events:
14			* System/App/block_render
15			* [
16			* 'index' => $index, //Block index
17			* 'blocks_array' => &$blocks_array //Reference to array in form ['top' => '', 'left' => '', 'right' => '', 'bottom' => '']
18			* ]
19			*
20			* System/App/construct
21			*
22			* System/App/render/before
23			*
24			* System/App/render/after
25			*/
26			class App {
27			use
28			Singleton,
29			Router;
30			const INIT_STATE_METHOD = 'init';
31			/**
32			* @var string
33			*/
34			protected $working_directory;
35			protected function init () {
36			$this->working_directory = '';
37			$this->controller_path = ['index'];
38			}
39			/**
40			* Executes plugins processing, blocks and module page generation
41			*
42			* @throws ExitException
43			*/
44			function execute () {
45			$Config = Config::instance();
46			$Request = Request::instance();
47			if (!preg_match('/^[0-9a-z_]+$/i', $Request->method)) {
48			throw new ExitException(400);
49			}
50			$this->handle_closed_site(!$Config->core['site_mode'], $Request);
			1 ignored issue – show Documentation introduced 2016-03-23 02:01 UTC by Report Bug Copy Issue Report `$Request` is of type `object<cs\False_class>\|object<cs\Singleton\Base>`, but the function expects a `object<cs\Request>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51			$this->working_directory = MODULES."/$Request->current_module";
52			if ($Request->admin_path) {
53			$this->working_directory .= '/admin';
54			} elseif ($Request->api_path) {
55			$this->working_directory .= '/api';
56			}
57			if (!is_dir($this->working_directory)) {
58			throw new ExitException(404);
59			}
60			if (!$this->check_permission('index')) {
61			throw new ExitException(403);
62			}
63			Event::instance()->fire('System/Index/construct');
64			Event::instance()->fire('System/App/construct');
65			/**
66			* Plugins processing
67			*/
68			foreach ($Config->components['plugins'] as $plugin) {
69			_include(PLUGINS."/$plugin/index.php", false, false);
70			}
71			_include("$this->working_directory/prepare.php", false, false);
72			Event::instance()->fire('System/Index/load/before');
73			Event::instance()->fire('System/App/render/before');
74			/**
75			* Title only for non-API calls
76			*/
77			$Request->api_path \|\| $this->render_title();
78			$this->render_content();
79			/**
80			* Blocks only for non-API calls
81			*/
82			$Request->api_path \|\| $this->render_blocks();
83			Event::instance()->fire('System/Index/load/after');
84			Event::instance()->fire('System/App/render/after');
85			Page::instance()->render();
86			}
87			/**
88			* @param bool $closed_site
89			* @param Request $Request
90			*
91			* @throws ExitException
92			*/
93			protected function handle_closed_site ($closed_site, $Request) {
94			if (!$closed_site) {
95			return;
96			}
97			/**
98			* If site is closed
99			*/
100			if (!$this->allow_closed_site_request($Request)) {
101			throw new ExitException(
102			[
103			get_core_ml_text('closed_title'),
104			get_core_ml_text('closed_text')
105			],
106			503
107			);
108			}
109			/**
110			* Warning about closed site for administrator
111			*/
112			Page::instance()->warning(get_core_ml_text('closed_title'));
113			}
114			/**
115			* Check if visitor is allowed to make current request to closed site
116			*
117			* @param Request $Request
118			*
119			* @return bool
120			*/
121			protected function allow_closed_site_request ($Request) {
122			return
123			User::instance()->admin() \|\|
124			(
125			$Request->api_path &&
126			$Request->current_module == 'System' &&
127			$Request->route === ['user', 'sign_in']
128			);
129			}
130			/**
131			* Check whether user allowed to access to specified label
132			*
133			* @param string $label
134			*
135			* @return bool
136			*/
137			protected function check_permission ($label) {
138			$Request = Request::instance();
139			$permission_group = $Request->current_module;
140			if ($Request->admin_path) {
141			$permission_group = "admin/$permission_group";
142			} elseif ($Request->api_path) {
143			$permission_group = "api/$permission_group";
144			}
145			return User::instance()->get_permission($permission_group, $label);
146			}
147			/**
148			* Render page title
149			*/
150			protected function render_title () {
151			$Page = Page::instance();
152			$Request = Request::instance();
153			/**
154			* Add generic Home or Module name title
155			*/
156			if (!$Request->api_path) {
157			$L = Language::instance();
158			if ($Request->admin_path) {
159			$Page->title($L->system_admin_administration);
160			}
161			$Page->title(
162			$L->{$Request->home_page ? 'system_home' : $Request->current_module}
163			);
164			}
165			}
166			/**
167			* Render page content (without blocks, just module content)
168			*
169			* @throws ExitException
170			*/
171			protected function render_content () {
172			$Page = Page::instance();
173			/**
174			* If module consists of index.html only
175			*/
176			if (file_exists("$this->working_directory/index.html")) {
177			ob_start();
178			_include("$this->working_directory/index.html", false, false);
179			$Page->content(ob_get_clean());
180			return;
181			}
182			$this->execute_router();
183			}
184			/**
185			* Blocks rendering
186			*/
187			protected function render_blocks () {
188			$blocks = Config::instance()->components['blocks'];
189			/**
190			* It is frequent that there is no blocks - so, no need to to anything here
191			*/
192			if (!$blocks) {
193			return;
194			}
195			$Page = Page::instance();
196			$blocks_array = [
197			'top' => '',
198			'left' => '',
199			'right' => '',
200			'bottom' => ''
201			];
202			foreach ($blocks as $block) {
203			/**
204			* If there is no need to show block or it was rendered by even handler - skip further processing
205			*/
206			if (
207			!$this->should_block_be_rendered($block) \|\|
208			!Event::instance()->fire(
209			'System/Index/block_render',
210			[
211			'index' => $block['index'],
212			'blocks_array' => &$blocks_array
213			]
214			) \|\|
215			!Event::instance()->fire(
216			'System/App/block_render',
217			[
218			'index' => $block['index'],
219			'blocks_array' => &$blocks_array
220			]
221			)
222			) {
223			/**
224			* Block was rendered by event handler
225			*/
226			continue;
227			}
228			$block['title'] = $this->ml_process($block['title']);
229			switch ($block['type']) {
230			default:
231			$block['content'] = ob_wrapper(
232			function () use ($block) {
233			include BLOCKS."/block.$block[type].php";
234			}
235			);
236			break;
237			case 'html':
238			case 'raw_html':
239			$block['content'] = $this->ml_process($block['content']);
240			break;
241			}
242			/**
243			* Template file will have access to `$block` variable, so it can use that
244			*/
245			$content = str_replace(
246			[
247			'<!--id-->',
248			'<!--title-->',
249			'<!--content-->'
250			],
251			[
252			$block['index'],
253			$block['title'],
254			$block['content']
255			],
256			ob_wrapper(
257			function () use ($block) {
258			$template = file_exists(TEMPLATES."/blocks/block.$block[template]") ? $block['template'] : 'default.html';
259			include TEMPLATES."/blocks/block.$template";
260			}
261			)
262			);
263			if ($block['position'] == 'floating') {
264			$Page->replace(
265			"<!--block#$block[index]-->",
266			$content
267			);
268			} else {
269			$blocks_array[$block['position']] .= $content;
270			}
271			}
272			$Page->Top .= $blocks_array['top'];
273			$Page->Left .= $blocks_array['left'];
274			$Page->Right .= $blocks_array['right'];
275			$Page->Bottom .= $blocks_array['bottom'];
276			}
277			/**
278			* Check whether to render block or not based on its properties (active state, when start to show, when it expires and permissions)
279			*
280			* @param array $block
281			*
282			* @return bool
283			*/
284			protected function should_block_be_rendered ($block) {
285			return
286			$block['active'] &&
287			$block['start'] <= time() &&
288			(
289			!$block['expire'] \|\|
290			$block['expire'] >= time()
291			) &&
292			User::instance()->get_permission('Block', $block['index']);
293			}
294			/**
295			* @param string $text
296			*
297			* @return string
298			*/
299			protected function ml_process ($text) {
300			return Text::instance()->process(Config::instance()->module('System')->db('texts'), $text, true);
301			}
302			/**
303			* Getter for `controller_path` property (no other properties supported currently)
304			*
305			* @param string $property
306			*
307			* @return false\|string[]
308			*/
309			function __get ($property) {
310			if ($property == 'controller_path') {
311			return $this->controller_path;
312			}
313			return false;
314			}
315			}
316

nazar-pc / CleverStyle-Framework

Push — master ( b7b84b...78616b )

App::render_blocks() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like