AuthController::__construct() - Code Metrics - Inspection of "Add AuthController baseClass" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b19c96...9aea22 )

by Jean-Christophe

created 2018-05-26 01:52 UTC

AuthController::__construct() A

↳ Parent: AuthController

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	0

<?php
namespace Ubiquity\controllers\auth;

use Ubiquity\utils\http\USession;
use Ubiquity\utils\http\URequest;
use Ubiquity\utils\flash\FlashMessage;
use Ubiquity\controllers\ControllerBase;
use Ubiquity\controllers\Auth\AuthFiles;
use Ubiquity\cache\ClassUtils;
use Ubiquity\utils\http\UResponse;
use Ubiquity\utils\base\UString;
use Ubiquity\controllers\Startup;

 /**
 * Controller Auth
 * @property \Ajax\php\ubiquity\JsUtils $jquery
 **/
abstract class AuthController extends ControllerBase{
	/**
	 * @var AuthFiles
	 */
	protected $authFiles;
	protected $_controller;
	protected $_action;
	protected $_actionParams;
	protected $_noAccessMsg;
	protected $_loginCaption;
	
	public function __construct(){
		parent::__construct();
		$this->_controller=Startup::getController();
		$this->_action=Startup::getAction();
		$this->_actionParams=Startup::getActionParams();
		$this->_noAccessMsg=new FlashMessage("You are not authorized to access the page <b>{url}</b> !","Forbidden access","error","warning circle");
		$this->_loginCaption="Log in";
	}
	
	public function index(){
		$this->authLoadView($this->_getFiles()->getViewIndex(),["action"=>$this->_getBaseRoute()."/connect",
				"loginInputName"=>$this->_getLoginInputName(),"loginLabel"=>$this->loginLabel(),
				"passwordInputName"=>$this->_getPasswordInputName(),"passwordLabel"=>$this->passwordLabel()
		]);
	}
	
	/**
	 * To override
	 * Return the base route for this Auth controller
	 * @return string
	 */
	public function _getBaseRoute(){
		return ClassUtils::getClassSimpleName(get_class($this));
	}
	/**
	 * {@inheritDoc}
	 * @see \controllers\ControllerBase::isValid()
	 */
	public final function isValid($action) {

		return true;
	}
	
	/**
	 * Action called when the user does not have access rights to a requested resource
	 * @param array|string $urlParts
	 */
	public function noAccess($urlParts){
		if(!is_array($urlParts)){
			$urlParts=explode(".", $urlParts);
		}
		USession::set("urlParts", $urlParts);
		$fMessage=$this->_noAccessMsg->parseContent(["url"=>implode("/",$urlParts)]);
		$this->noAccessMessage($fMessage);
		$message=$this->fMessage($fMessage);		
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	
	/**
	 * Override for modifying the noAccess message
	 * @param FlashMessage $fMessage
	 */
	protected function noAccessMessage(FlashMessage $fMessage){
		
	}
	
	/**
	 * Override to implement the complete connection procedure 
	 */
	public function connect(){
		if(URequest::isPost()){
			if($connected=$this->_connect()){
				$this->onConnect($connected);
			}else{
				$this->onBadCreditentials();
			}
		}
	}
	
	/**
	 * Processes the data posted by the login form
	 * Have to return the connected user instance
	 */
	abstract protected function _connect();
	
	/**
	 * @param object $connected
	 */
	abstract protected function onConnect($connected);
	
	/**
	 * To override for defining a new action when creditentials are invalid
	 */
	protected function onBadCreditentials(){
		$this->badLogin();
	}
	
	/**
	 * Default Action for invalid creditentials
	 */
	public function badLogin(){

		$fMessage=new FlashMessage("Invalid creditentials!","Connection problem","warning","warning circle");
		$this->badLoginMessage($fMessage);
		$message=$this->fMessage($fMessage);
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	
	/**
	 * To override for modifying the bad login message
	 * @param FlashMessage $fMessage
	 */
	protected function badLoginMessage(FlashMessage $fMessage){
		
	}
	
	private function authLoadView($viewName,$vars=[]){
		$files=$this->_getFiles();
		$mainTemplate=$files->getBaseTemplate();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		if(isset($mainTemplate)){
			$vars["_viewname"]=$viewName;
			$vars["_base"]=$mainTemplate;
			$this->loadView($files->getViewBaseTemplate(),$vars);
		}else{
			$this->loadView($viewName,$vars);
		}
	}
	
	/**
	 * Logout action
	 * Terminate the session and display a logout message
	 */
	public function terminate(){

		USession::terminate();
		$fMessage=new FlashMessage("You have been properly disconnected!","Logout","success","checkmark");
		$this->terminateMessage($fMessage);
		$message=$this->fMessage($fMessage);
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	
	public function _disConnected(){
		$fMessage=new FlashMessage("You have been disconnected from the application!","Logout","","sign out");
		$this->disconnectedMessage($fMessage);
		$message=$this->fMessage($fMessage);
		$this->jquery->getOnClick("._signin", $this->_getBaseRoute(),$this->_getBodySelector(),["stopPropagation"=>false,"preventDefault"=>false]);
		$this->jquery->execOn("click", "._close", "window.open(window.location,'_self').close();");
		$this->jquery->renderView($this->_getFiles()->getViewDisconnected(),["_title"=>"Session ended","_message"=>$message]);
	}
	
	/**
	 * To override for modifying the logout message
	 * @param FlashMessage $fMessage
	 */
	protected function terminateMessage(FlashMessage $fMessage){
		
	}
	
	/**
	 * To override for modifying the disconnect message
	 * @param FlashMessage $fMessage
	 */
	protected function disconnectedMessage(FlashMessage $fMessage){
		
	}
	
	/**
	 * Action displaying the logged user information 
	 * if _displayInfoAsString returns true, use _infoUser var in views to display user info
	 * @return string|null
	 */
	public function info(){
		return $this->loadView($this->_getFiles()->getViewInfo(),["connected"=>USession::get($this->_getUserSessionKey()),"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector()],$this->_displayInfoAsString());
	}
	
	protected function fMessage(FlashMessage $fMessage){
		return $this->message($fMessage->getType(), $fMessage->getTitle(), $fMessage->getContent(),$fMessage->getIcon());
	}
	
	public function message($type,$header,$body,$icon="info"){
		return $this->loadView($this->_getFiles()->getViewMessage(),get_defined_vars(),true);
	}
	
	protected function getOriginalURL(){
		return USession::get("urlParts");
	}
	
	/**
	 * To override for defining user session key, default : "activeUser"
	 * @return string
	 */
	public function _getUserSessionKey(){
		return "activeUser";
	}
	
	public function _checkConnection(){
		UResponse::asJSON();
		echo "{\"valid\":".UString::getBooleanStr($this->_isValidUser())."}";
	}
	
	/**
	 * return boolean true if activeUser is valid
	 */
	abstract public function _isValidUser();
	
	/**
	 * To override for changing view files
	 * @return AuthFiles
	 */
	protected function getFiles ():AuthFiles{
		return new AuthFiles();
	}
	
	/**
	 * Override to define if info is displayed as string
	 * if set to true, use _infoUser var in views to display user info
	 */
	public function _displayInfoAsString(){
		return false;
	}
	
	public function _checkConnectionTimeout(){
		return;
	}
	
	private function _getFiles():AuthFiles{
		if(!isset($this->authFiles)){
			$this->authFiles=$this->getFiles();
		}
		return $this->authFiles;
	}
	
	public function _getLoginInputName(){
		return "email";
	}

	protected function loginLabel(){
		return ucfirst($this->_getLoginInputName());
	}
	
	public function _getPasswordInputName(){
		return "password";
	}
	
	protected function passwordLabel(){
		return ucfirst($this->_getPasswordInputName());
	}
	
	public function _getBodySelector(){
		return "body";
	}
	
	/**
	 * Sets the default noAccess message
	 * Default : "You are not authorized to access the page <b>{url}</b> !"
	 * @param string $content
	 * @param string $title
	 * @param string $type
	 * @param string $icon
	 */
	public function _setNoAccessMsg($content,$title=NULL,$type=NULL,$icon=null) {
		$this->_noAccessMsg->setValues($content,$title,$type,$icon);
	}
	/**
	 * @param string $_loginCaption
	 */
	public function _setLoginCaption($_loginCaption) {
		$this->_loginCaption = $_loginCaption;
	}


}


1		<?php
2		namespace Ubiquity\controllers\auth;
3
4		use Ubiquity\utils\http\USession;
5		use Ubiquity\utils\http\URequest;
6		use Ubiquity\utils\flash\FlashMessage;
7		use Ubiquity\controllers\ControllerBase;
8		use Ubiquity\controllers\Auth\AuthFiles;
9		use Ubiquity\cache\ClassUtils;
10		use Ubiquity\utils\http\UResponse;
11		use Ubiquity\utils\base\UString;
12		use Ubiquity\controllers\Startup;
13
14		/**
15		* Controller Auth
16		* @property \Ajax\php\ubiquity\JsUtils $jquery
17		**/
18		abstract class AuthController extends ControllerBase{
19		/**
20		* @var AuthFiles
21		*/
22		protected $authFiles;
23		protected $_controller;
24		protected $_action;
25		protected $_actionParams;
26		protected $_noAccessMsg;
27		protected $_loginCaption;
28
29		public function __construct(){
30		parent::__construct();
31		$this->_controller=Startup::getController();
32		$this->_action=Startup::getAction();
33		$this->_actionParams=Startup::getActionParams();
34		$this->_noAccessMsg=new FlashMessage("You are not authorized to access the page <b>{url}</b> !","Forbidden access","error","warning circle");
35		$this->_loginCaption="Log in";
36		}
37
38		public function index(){
39		$this->authLoadView($this->_getFiles()->getViewIndex(),["action"=>$this->_getBaseRoute()."/connect",
40		"loginInputName"=>$this->_getLoginInputName(),"loginLabel"=>$this->loginLabel(),
41		"passwordInputName"=>$this->_getPasswordInputName(),"passwordLabel"=>$this->passwordLabel()
42		]);
43		}
44
45		/**
46		* To override
47		* Return the base route for this Auth controller
48		* @return string
49		*/
50		public function _getBaseRoute(){
51		return ClassUtils::getClassSimpleName(get_class($this));
52		}
53		/**
54		* {@inheritDoc}
55		* @see \controllers\ControllerBase::isValid()
56		*/
57		public final function isValid($action) {
		0 ignored issues – show Coding Style introduced 2018-05-25 01:12 UTC by Report Bug Copy Issue Report As per PSR2, `final` should precede the visibility keyword. Loading history...
58		return true;
59		}
60
61		/**
62		* Action called when the user does not have access rights to a requested resource
63		* @param array\|string $urlParts
64		*/
65		public function noAccess($urlParts){
66		if(!is_array($urlParts)){
67		$urlParts=explode(".", $urlParts);
68		}
69		USession::set("urlParts", $urlParts);
70		$fMessage=$this->_noAccessMsg->parseContent(["url"=>implode("/",$urlParts)]);
71		$this->noAccessMessage($fMessage);
72		$message=$this->fMessage($fMessage);
73		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
74		}
75
76		/**
77		* Override for modifying the noAccess message
78		* @param FlashMessage $fMessage
79		*/
80		protected function noAccessMessage(FlashMessage $fMessage){
81
82		}
83
84		/**
85		* Override to implement the complete connection procedure
86		*/
87		public function connect(){
88		if(URequest::isPost()){
89		if($connected=$this->_connect()){
90		$this->onConnect($connected);
91		}else{
92		$this->onBadCreditentials();
93		}
94		}
95		}
96
97		/**
98		* Processes the data posted by the login form
99		* Have to return the connected user instance
100		*/
101		abstract protected function _connect();
102
103		/**
104		* @param object $connected
105		*/
106		abstract protected function onConnect($connected);
107
108		/**
109		* To override for defining a new action when creditentials are invalid
110		*/
111		protected function onBadCreditentials(){
112		$this->badLogin();
113		}
114
115		/**
116		* Default Action for invalid creditentials
117		*/
118	View Code Duplication	public function badLogin(){
		0 ignored issues – show Duplication introduced 2018-05-17 01:02 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...
119		$fMessage=new FlashMessage("Invalid creditentials!","Connection problem","warning","warning circle");
120		$this->badLoginMessage($fMessage);
121		$message=$this->fMessage($fMessage);
122		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
123		}
124
125		/**
126		* To override for modifying the bad login message
127		* @param FlashMessage $fMessage
128		*/
129		protected function badLoginMessage(FlashMessage $fMessage){
130
131		}
132
133		private function authLoadView($viewName,$vars=[]){
134		$files=$this->_getFiles();
135		$mainTemplate=$files->getBaseTemplate();
		1 ignored issue – show Bug introduced 2018-05-17 01:02 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$mainTemplate` is correct as `$files->getBaseTemplate()` (which targets `Ubiquity\controllers\Aut...iles::getBaseTemplate()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
136		if(isset($mainTemplate)){
137		$vars["_viewname"]=$viewName;
138		$vars["_base"]=$mainTemplate;
139		$this->loadView($files->getViewBaseTemplate(),$vars);
140		}else{
141		$this->loadView($viewName,$vars);
142		}
143		}
144
145		/**
146		* Logout action
147		* Terminate the session and display a logout message
148		*/
149	View Code Duplication	public function terminate(){
		0 ignored issues – show Duplication introduced 2018-05-17 01:02 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...
150		USession::terminate();
151		$fMessage=new FlashMessage("You have been properly disconnected!","Logout","success","checkmark");
152		$this->terminateMessage($fMessage);
153		$message=$this->fMessage($fMessage);
154		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
155		}
156
157		public function _disConnected(){
158		$fMessage=new FlashMessage("You have been disconnected from the application!","Logout","","sign out");
159		$this->disconnectedMessage($fMessage);
160		$message=$this->fMessage($fMessage);
161		$this->jquery->getOnClick("._signin", $this->_getBaseRoute(),$this->_getBodySelector(),["stopPropagation"=>false,"preventDefault"=>false]);
162		$this->jquery->execOn("click", "._close", "window.open(window.location,'_self').close();");
163		$this->jquery->renderView($this->_getFiles()->getViewDisconnected(),["_title"=>"Session ended","_message"=>$message]);
164		}
165
166		/**
167		* To override for modifying the logout message
168		* @param FlashMessage $fMessage
169		*/
170		protected function terminateMessage(FlashMessage $fMessage){
171
172		}
173
174		/**
175		* To override for modifying the disconnect message
176		* @param FlashMessage $fMessage
177		*/
178		protected function disconnectedMessage(FlashMessage $fMessage){
179
180		}
181
182		/**
183		* Action displaying the logged user information
184		* if _displayInfoAsString returns true, use _infoUser var in views to display user info
185		* @return string\|null
186		*/
187		public function info(){
188		return $this->loadView($this->_getFiles()->getViewInfo(),["connected"=>USession::get($this->_getUserSessionKey()),"authURL"=>$this->_getBaseRoute(),"bodySelector"=>$this->_getBodySelector()],$this->_displayInfoAsString());
189		}
190
191		protected function fMessage(FlashMessage $fMessage){
192		return $this->message($fMessage->getType(), $fMessage->getTitle(), $fMessage->getContent(),$fMessage->getIcon());
193		}
194
195		public function message($type,$header,$body,$icon="info"){
196		return $this->loadView($this->_getFiles()->getViewMessage(),get_defined_vars(),true);
197		}
198
199		protected function getOriginalURL(){
200		return USession::get("urlParts");
201		}
202
203		/**
204		* To override for defining user session key, default : "activeUser"
205		* @return string
206		*/
207		public function _getUserSessionKey(){
208		return "activeUser";
209		}
210
211		public function _checkConnection(){
212		UResponse::asJSON();
213		echo "{\"valid\":".UString::getBooleanStr($this->_isValidUser())."}";
214		}
215
216		/**
217		* return boolean true if activeUser is valid
218		*/
219		abstract public function _isValidUser();
220
221		/**
222		* To override for changing view files
223		* @return AuthFiles
224		*/
225		protected function getFiles ():AuthFiles{
226		return new AuthFiles();
227		}
228
229		/**
230		* Override to define if info is displayed as string
231		* if set to true, use _infoUser var in views to display user info
232		*/
233		public function _displayInfoAsString(){
234		return false;
235		}
236
237		public function _checkConnectionTimeout(){
238		return;
239		}
240
241		private function _getFiles():AuthFiles{
242		if(!isset($this->authFiles)){
243		$this->authFiles=$this->getFiles();
244		}
245		return $this->authFiles;
246		}
247
248		public function _getLoginInputName(){
249		return "email";
250		}
251
252		protected function loginLabel(){
253		return ucfirst($this->_getLoginInputName());
254		}
255
256		public function _getPasswordInputName(){
257		return "password";
258		}
259
260		protected function passwordLabel(){
261		return ucfirst($this->_getPasswordInputName());
262		}
263
264		public function _getBodySelector(){
265		return "body";
266		}
267
268		/**
269		* Sets the default noAccess message
270		* Default : "You are not authorized to access the page <b>{url}</b> !"
271		* @param string $content
272		* @param string $title
273		* @param string $type
274		* @param string $icon
275		*/
276		public function _setNoAccessMsg($content,$title=NULL,$type=NULL,$icon=null) {
277		$this->_noAccessMsg->setValues($content,$title,$type,$icon);
278		}
279		/**
280		* @param string $_loginCaption
281		*/
282		public function _setLoginCaption($_loginCaption) {
283		$this->_loginCaption = $_loginCaption;
284		}
285
286
287		}
288

phpMv / ubiquity

Push — master ( b19c96...9aea22 )

AuthController::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like