ModelAsController::controller_for() - Code Metrics - Inspection of "[Don’t merge] Virtualpage refactor" - silverstripe/silverstripe-cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1605)

by Loz

created 2016-09-22 13:37 UTC

ModelAsController::controller_for() A

↳ Parent: ModelAsController

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace SilverStripe\CMS\Controllers;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Control\NestedController;
use SilverStripe\Control\RequestHandler;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\HTTPResponse_Exception;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\Debug;
use SilverStripe\Dev\Deprecation;
use SilverStripe\ORM\DataModel;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use Exception;
use Translatable;

/**
 * ModelAsController deals with mapping the initial request to the first {@link SiteTree}/{@link ContentController}
 * pair, which are then used to handle the request.
 */
class ModelAsController extends Controller implements NestedController {

	private static $extensions = array('SilverStripe\\CMS\\Controllers\\OldPageRedirector');

	/**
	 * Get the appropriate {@link ContentController} for handling a {@link SiteTree} object, link it to the object and
	 * return it.
	 *
	 * @param SiteTree $sitetree
	 * @param string $action
	 * @return ContentController
	 */
	public static function controller_for(SiteTree $sitetree, $action = null) {
		$controller = $sitetree->getControllerName();

		if ($action && class_exists($controller . '_' . ucfirst($action))) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$controller = $controller . '_' . ucfirst($action);
		}

		return Injector::inst()->create($controller, $sitetree);
	}

	public function init() {
		singleton('SilverStripe\\CMS\\Model\\SiteTree')->extend('modelascontrollerInit', $this);
		parent::init();
	}

	protected function beforeHandleRequest(HTTPRequest $request, DataModel $model) {

		parent::beforeHandleRequest($request, $model);
		// If the database has not yet been created, redirect to the build page.
		/** @skipUpgrade */
		if(!DB::is_active() || !ClassInfo::hasTable('SiteTree')) {
			$this->getResponse()->redirect(Controller::join_links(
				Director::absoluteBaseURL(),
				'dev/build',
				'?' . http_build_query(array(
					'returnURL' => isset($_GET['url']) ? $_GET['url'] : null,
				))
			));
		}
	}

	/**
	 * @uses ModelAsController::getNestedController()
	 * @param HTTPRequest $request
	 * @param DataModel $model
	 * @return HTTPResponse
	 */
	public function handleRequest(HTTPRequest $request, DataModel $model) {
		$this->beforeHandleRequest($request, $model);

		// If we had a redirection or something, halt processing.
		if($this->getResponse()->isFinished()) {
			$this->popCurrent();
			return $this->getResponse();
		}

		// If the database has not yet been created, redirect to the build page.
		/** @skipUpgrade */
		if(!DB::is_active() || !ClassInfo::hasTable('SiteTree')) {

			$this->getResponse()->redirect(Director::absoluteBaseURL() . 'dev/build?returnURL=' . (isset($_GET['url']) ? urlencode($_GET['url']) : null));
			$this->popCurrent();

			return $this->getResponse();
		}

		try {
			$result = $this->getNestedController();

			if($result instanceof RequestHandler) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				$result = $result->handleRequest($this->getRequest(), $model);
			} else if(!($result instanceof HTTPResponse)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				user_error("ModelAsController::getNestedController() returned bad object type '" .
					get_class($result)."'", E_USER_WARNING);
			}
		} catch(HTTPResponse_Exception $responseException) {

			$result = $responseException->getResponse();
		}

		$this->popCurrent();
		return $result;
	}

	/**
	 * @return ContentController
	 * @throws Exception If URLSegment not passed in as a request parameter.
	 */
	public function getNestedController() {
		$request = $this->getRequest();

		if(!$URLSegment = $request->param('URLSegment')) {
			throw new Exception('ModelAsController->getNestedController(): was not passed a URLSegment value.');
		}

		// Find page by link, regardless of current locale settings
		if(class_exists('Translatable')) Translatable::disable_locale_filter();

		// Select child page
		$conditions = array('"SiteTree"."URLSegment"' => rawurlencode($URLSegment));
		if(SiteTree::config()->nested_urls) {
			$conditions[] = array('"SiteTree"."ParentID"' => 0);
		}
		/** @var SiteTree $sitetree */
		$sitetree = DataObject::get_one('SilverStripe\\CMS\\Model\\SiteTree', $conditions);

		// Check translation module
		// @todo Refactor out module specific code
		if(class_exists('Translatable')) Translatable::enable_locale_filter();

		if(!$sitetree) {
			$this->httpError(404, 'The requested page could not be found.');
		}

		// Enforce current locale setting to the loaded SiteTree object
		if(class_exists('Translatable') && $sitetree->Locale) Translatable::set_current_locale($sitetree->Locale);

		if(isset($_REQUEST['debug'])) {
			Debug::message("Using record #$sitetree->ID of type $sitetree->class with link {$sitetree->Link()}");
		}

		return self::controller_for($sitetree, $this->getRequest()->param('Action'));
	}

	/**
	 * @deprecated 4.0 Use OldPageRedirector::find_old_page instead
	 *
	 * @param string $URLSegment A subset of the url. i.e in /home/contact/ home and contact are URLSegment.
	 * @param int $parent The ID of the parent of the page the URLSegment belongs to.
	 * @param bool $ignoreNestedURLs
	 * @return SiteTree
	 */
	static public function find_old_page($URLSegment, $parent = null, $ignoreNestedURLs = false) {
		Deprecation::notice('4.0', 'Use OldPageRedirector::find_old_page instead');
		if ($parent) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$parent = SiteTree::get()->byID($parent);
		}
		$url = OldPageRedirector::find_old_page(array($URLSegment), $parent);
		return SiteTree::get_by_link($url);
	}
}


1		<?php
2
3		namespace SilverStripe\CMS\Controllers;
4
5		use SilverStripe\CMS\Model\SiteTree;
6		use SilverStripe\Control\Controller;
7		use SilverStripe\Control\Director;
8		use SilverStripe\Control\NestedController;
9		use SilverStripe\Control\RequestHandler;
10		use SilverStripe\Control\HTTPRequest;
11		use SilverStripe\Control\HTTPResponse;
12		use SilverStripe\Control\HTTPResponse_Exception;
13		use SilverStripe\Core\ClassInfo;
14		use SilverStripe\Core\Config\Config;
15		use SilverStripe\Core\Injector\Injector;
16		use SilverStripe\Dev\Debug;
17		use SilverStripe\Dev\Deprecation;
18		use SilverStripe\ORM\DataModel;
19		use SilverStripe\ORM\DataObject;
20		use SilverStripe\ORM\DB;
21		use Exception;
22		use Translatable;
23
24		/**
25		* ModelAsController deals with mapping the initial request to the first {@link SiteTree}/{@link ContentController}
26		* pair, which are then used to handle the request.
27		*/
28		class ModelAsController extends Controller implements NestedController {
29
30		private static $extensions = array('SilverStripe\\CMS\\Controllers\\OldPageRedirector');
31
32		/**
33		* Get the appropriate {@link ContentController} for handling a {@link SiteTree} object, link it to the object and
34		* return it.
35		*
36		* @param SiteTree $sitetree
37		* @param string $action
38		* @return ContentController
39		*/
40		public static function controller_for(SiteTree $sitetree, $action = null) {
41		$controller = $sitetree->getControllerName();
42
43		if ($action && class_exists($controller . '_' . ucfirst($action))) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The expression `$action` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
44		$controller = $controller . '_' . ucfirst($action);
45		}
46
47		return Injector::inst()->create($controller, $sitetree);
48		}
49
50		public function init() {
51		singleton('SilverStripe\\CMS\\Model\\SiteTree')->extend('modelascontrollerInit', $this);
52		parent::init();
53		}
54
55	View Code Duplication	protected function beforeHandleRequest(HTTPRequest $request, DataModel $model) {
		0 ignored issues – show Duplication introduced 2016-01-18 22:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
56		parent::beforeHandleRequest($request, $model);
57		// If the database has not yet been created, redirect to the build page.
58		/** @skipUpgrade */
59		if(!DB::is_active() \|\| !ClassInfo::hasTable('SiteTree')) {
60		$this->getResponse()->redirect(Controller::join_links(
61		Director::absoluteBaseURL(),
62		'dev/build',
63		'?' . http_build_query(array(
64		'returnURL' => isset($_GET['url']) ? $_GET['url'] : null,
65		))
66		));
67		}
68		}
69
70		/**
71		* @uses ModelAsController::getNestedController()
72		* @param HTTPRequest $request
73		* @param DataModel $model
74		* @return HTTPResponse
75		*/
76		public function handleRequest(HTTPRequest $request, DataModel $model) {
77		$this->beforeHandleRequest($request, $model);
78
79		// If we had a redirection or something, halt processing.
80		if($this->getResponse()->isFinished()) {
81		$this->popCurrent();
82		return $this->getResponse();
83		}
84
85		// If the database has not yet been created, redirect to the build page.
86		/** @skipUpgrade */
87	View Code Duplication	if(!DB::is_active() \|\| !ClassInfo::hasTable('SiteTree')) {
		0 ignored issues – show Duplication introduced 2016-08-08 06:08 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
88		$this->getResponse()->redirect(Director::absoluteBaseURL() . 'dev/build?returnURL=' . (isset($_GET['url']) ? urlencode($_GET['url']) : null));
89		$this->popCurrent();
90
91		return $this->getResponse();
92		}
93
94		try {
95		$result = $this->getNestedController();
96
97		if($result instanceof RequestHandler) {
		0 ignored issues – show Bug introduced 2016-09-07 05:20 UTC by Report Bug Copy Issue Report The class `SilverStripe\Control\RequestHandler` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
98		$result = $result->handleRequest($this->getRequest(), $model);
99		} else if(!($result instanceof HTTPResponse)) {
		0 ignored issues – show Bug introduced 2016-09-09 01:46 UTC by Report Bug Copy Issue Report The class `SilverStripe\Control\HTTPResponse` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
100		user_error("ModelAsController::getNestedController() returned bad object type '" .
101		get_class($result)."'", E_USER_WARNING);
102		}
103		} catch(HTTPResponse_Exception $responseException) {
		0 ignored issues – show Bug introduced 2016-09-09 01:46 UTC by Report Bug Copy Issue Report The class `SilverStripe\Control\HTTPResponse_Exception` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
104		$result = $responseException->getResponse();
105		}
106
107		$this->popCurrent();
108		return $result;
109		}
110
111		/**
112		* @return ContentController
113		* @throws Exception If URLSegment not passed in as a request parameter.
114		*/
115		public function getNestedController() {
116		$request = $this->getRequest();
117
118		if(!$URLSegment = $request->param('URLSegment')) {
119		throw new Exception('ModelAsController->getNestedController(): was not passed a URLSegment value.');
120		}
121
122		// Find page by link, regardless of current locale settings
123		if(class_exists('Translatable')) Translatable::disable_locale_filter();
124
125		// Select child page
126		$conditions = array('"SiteTree"."URLSegment"' => rawurlencode($URLSegment));
127		if(SiteTree::config()->nested_urls) {
128		$conditions[] = array('"SiteTree"."ParentID"' => 0);
129		}
130		/** @var SiteTree $sitetree */
131		$sitetree = DataObject::get_one('SilverStripe\\CMS\\Model\\SiteTree', $conditions);
132
133		// Check translation module
134		// @todo Refactor out module specific code
135		if(class_exists('Translatable')) Translatable::enable_locale_filter();
136
137		if(!$sitetree) {
138		$this->httpError(404, 'The requested page could not be found.');
139		}
140
141		// Enforce current locale setting to the loaded SiteTree object
142		if(class_exists('Translatable') && $sitetree->Locale) Translatable::set_current_locale($sitetree->Locale);
143
144		if(isset($_REQUEST['debug'])) {
145		Debug::message("Using record #$sitetree->ID of type $sitetree->class with link {$sitetree->Link()}");
146		}
147
148		return self::controller_for($sitetree, $this->getRequest()->param('Action'));
149		}
150
151		/**
152		* @deprecated 4.0 Use OldPageRedirector::find_old_page instead
153		*
154		* @param string $URLSegment A subset of the url. i.e in /home/contact/ home and contact are URLSegment.
155		* @param int $parent The ID of the parent of the page the URLSegment belongs to.
156		* @param bool $ignoreNestedURLs
157		* @return SiteTree
158		*/
159		static public function find_old_page($URLSegment, $parent = null, $ignoreNestedURLs = false) {
160		Deprecation::notice('4.0', 'Use OldPageRedirector::find_old_page instead');
161		if ($parent) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 02:50 UTC by Report Bug Copy Issue Report The expression `$parent` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
162		$parent = SiteTree::get()->byID($parent);
163		}
164		$url = OldPageRedirector::find_old_page(array($URLSegment), $parent);
165		return SiteTree::get_by_link($url);
166		}
167		}
168

silverstripe / silverstripe-cms

Pull Request — master (#1605)

ModelAsController::controller_for() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like