AbstractDeployment::__construct() - Code Metrics - Inspection of "glue stuff together so that it works web-wise" - GEANT/CAT - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 5d347f...d6f93a )

by Stefan

created 2019-03-06 13:42 UTC

AbstractDeployment::__construct() A

↳ Parent: AbstractDeployment

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	16
dl	0
loc	19
rs	9.7333
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php
/*
 * *****************************************************************************
 * Contributions to this work were made on behalf of the GÉANT project, a 
 * project that has received funding from the European Union’s Framework 
 * Programme 7 under Grant Agreements No. 238875 (GN3) and No. 605243 (GN3plus),
 * Horizon 2020 research and innovation programme under Grant Agreements No. 
 * 691567 (GN4-1) and No. 731122 (GN4-2).
 * On behalf of the aforementioned projects, GEANT Association is the sole owner
 * of the copyright in all material which was developed by a member of the GÉANT
 * project. GÉANT Vereniging (Association) is registered with the Chamber of 
 * Commerce in Amsterdam with registration number 40535155 and operates in the 
 * UK as a branch of GÉANT Vereniging.
 * 
 * Registered office: Hoekenrode 3, 1102BR Amsterdam, The Netherlands. 
 * UK branch address: City House, 126-130 Hills Road, Cambridge CB2 1PQ, UK
 *
 * License: see the web/copyright.inc.php file in the file structure or
 *          <base_url>/copyright.php after deploying the software
 */

/**
 * This file contains the AbstractProfile class. It contains common methods for
 * both RADIUS/EAP profiles and SilverBullet profiles
 *
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 *
 * @package Developer
 *
 */

namespace core;

use \Exception;

/**
 * This class represents an EAP Profile.
 * Profiles can inherit attributes from their IdP, if the IdP has some. Otherwise,
 * one can set attribute in the Profile directly. If there is a conflict between
 * IdP-wide and Profile-wide attributes, the more specific ones (i.e. Profile) win.
 * 
 * @author Stefan Winter <[email protected]>
 * @author Tomasz Wolniewicz <[email protected]>
 *
 * @license see LICENSE file in root directory
 *
 * @package Developer
 */
abstract class AbstractDeployment extends EntityWithDBProperties {

    const INACTIVE = 0;
    const ACTIVE = 1;

    const DEPLOYMENTTYPE_CLASSIC = "RADIUS-SP";
    const DEPLOYMENTTYPE_MANAGED = "MANAGED-SP";
    
    /**
     * status of this deployment. Defaults to INACTIVE.
     * 
     * @var int
     */
    public $status = AbstractDeployment::INACTIVE;
    
    /**
     * which type of deployment is this. Not initialised, done by sub-classes.
     * 
     * @var string
     */
    public $type;
    
    /**
     * DB identifier of the parent institution of this profile
     * @var int
     */
    public $institution;

    /**
     * name of the parent institution of this profile in the current language
     * @var string
     */
    public $instName;

    /**
     * number of deployments the IdP this profile is attached to has
     * 
     * @var int
     */
    protected $idpNumberOfDeployments;

    /**
     * IdP-wide attributes of the IdP this profile is attached to
     * 
     * @var array
     */
    protected $idpAttributes;

    /**
     * Federation level attributes that this profile is attached to via its IdP
     * 
     * @var array
     */
    protected $fedAttributes;

    /**
     * This class also needs to handle frontend operations, so needs its own
     * access to the FRONTEND datbase. This member stores the corresponding 
     * handle.
     * 
     * @var DBConnection
     */
    protected $frontendHandle;

    /**
     * Class constructor for existing deployments (use 
     * IdP::newDeployment() to actually create one). Retrieves all 
     * attributes from the DB and stores them in the priv_ arrays.
     * 
     * @param IdP $idpObject       optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.

     * @param string|int $deploymentIdRaw identifier of the deployment in the DB, or 
     */
    public function __construct($idpObject,$deploymentIdRaw = NULL) {
        $this->databaseType = "INST";
        parent::__construct(); // we now have access to our INST database handle and logging
        $this->frontendHandle = DBConnection::handle("FRONTEND");
            if (!($idpObject instanceof IdP)) {

                throw new Exception("Always provide an IdP object when constructing Deployment.");
            } else {
            $idp = $idpObject;
            $this->institution = $idp->identifier;
        }
        if ($deploymentIdRaw !== NULL) {
            $this->identifier = $deploymentIdRaw;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }
        $this->instName = $idp->name;
        $this->idpNumberOfDeployments = $idp->deploymentCount();
        $this->idpAttributes = $idp->getAttributes();
        $fedObject = new Federation($idp->federation);
        $this->fedAttributes = $fedObject->getAttributes();
        $this->loggerInstance->debug(3, "--- END Constructing new AbstractDeployment object ... ---\n");
    }

    /**
     * update the last_changed timestamp for this deployment
     * 
     * @return void
     */
    abstract public function updateFreshness();

    /**
     * gets the last-modified timestamp (useful for caching "dirty" check)
     * 
     * @return string the date in string form, as returned by SQL
     */
    abstract public function getFreshness();

    /**
     * Deletes the deployment from database
     * 
     * @return void
     */
    abstract public function destroy();
}


1			<?php
2			/*
3			* *****************************************************************************
4			* Contributions to this work were made on behalf of the GÉANT project, a
5			* project that has received funding from the European Union’s Framework
6			* Programme 7 under Grant Agreements No. 238875 (GN3) and No. 605243 (GN3plus),
7			* Horizon 2020 research and innovation programme under Grant Agreements No.
8			* 691567 (GN4-1) and No. 731122 (GN4-2).
9			* On behalf of the aforementioned projects, GEANT Association is the sole owner
10			* of the copyright in all material which was developed by a member of the GÉANT
11			* project. GÉANT Vereniging (Association) is registered with the Chamber of
12			* Commerce in Amsterdam with registration number 40535155 and operates in the
13			* UK as a branch of GÉANT Vereniging.
14			*
15			* Registered office: Hoekenrode 3, 1102BR Amsterdam, The Netherlands.
16			* UK branch address: City House, 126-130 Hills Road, Cambridge CB2 1PQ, UK
17			*
18			* License: see the web/copyright.inc.php file in the file structure or
19			* <base_url>/copyright.php after deploying the software
20			*/
21
22			/**
23			* This file contains the AbstractProfile class. It contains common methods for
24			* both RADIUS/EAP profiles and SilverBullet profiles
25			*
26			* @author Stefan Winter <[email protected]>
27			* @author Tomasz Wolniewicz <[email protected]>
28			*
29			* @package Developer
30			*
31			*/
32
33			namespace core;
34
35			use \Exception;
36
37			/**
38			* This class represents an EAP Profile.
39			* Profiles can inherit attributes from their IdP, if the IdP has some. Otherwise,
40			* one can set attribute in the Profile directly. If there is a conflict between
41			* IdP-wide and Profile-wide attributes, the more specific ones (i.e. Profile) win.
42			*
43			* @author Stefan Winter <[email protected]>
44			* @author Tomasz Wolniewicz <[email protected]>
45			*
46			* @license see LICENSE file in root directory
47			*
48			* @package Developer
49			*/
50			abstract class AbstractDeployment extends EntityWithDBProperties {
51
52			const INACTIVE = 0;
53			const ACTIVE = 1;
54
55			const DEPLOYMENTTYPE_CLASSIC = "RADIUS-SP";
56			const DEPLOYMENTTYPE_MANAGED = "MANAGED-SP";
57
58			/**
59			* status of this deployment. Defaults to INACTIVE.
60			*
61			* @var int
62			*/
63			public $status = AbstractDeployment::INACTIVE;
64
65			/**
66			* which type of deployment is this. Not initialised, done by sub-classes.
67			*
68			* @var string
69			*/
70			public $type;
71
72			/**
73			* DB identifier of the parent institution of this profile
74			* @var int
75			*/
76			public $institution;
77
78			/**
79			* name of the parent institution of this profile in the current language
80			* @var string
81			*/
82			public $instName;
83
84			/**
85			* number of deployments the IdP this profile is attached to has
86			*
87			* @var int
88			*/
89			protected $idpNumberOfDeployments;
90
91			/**
92			* IdP-wide attributes of the IdP this profile is attached to
93			*
94			* @var array
95			*/
96			protected $idpAttributes;
97
98			/**
99			* Federation level attributes that this profile is attached to via its IdP
100			*
101			* @var array
102			*/
103			protected $fedAttributes;
104
105			/**
106			* This class also needs to handle frontend operations, so needs its own
107			* access to the FRONTEND datbase. This member stores the corresponding
108			* handle.
109			*
110			* @var DBConnection
111			*/
112			protected $frontendHandle;
113
114			/**
115			* Class constructor for existing deployments (use
116			* IdP::newDeployment() to actually create one). Retrieves all
117			* attributes from the DB and stores them in the priv_ arrays.
118			*
119			* @param IdP $idpObject optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.
			0 ignored issues – show Coding Style introduced 2019-03-06 13:48 UTC by Report Bug Copy Issue Report Expected 8 spaces after parameter type; 1 found Loading history...
120			* @param string\|int $deploymentIdRaw identifier of the deployment in the DB, or
121			*/
122			public function __construct($idpObject,$deploymentIdRaw = NULL) {
123			$this->databaseType = "INST";
124			parent::__construct(); // we now have access to our INST database handle and logging
125			$this->frontendHandle = DBConnection::handle("FRONTEND");
126			if (!($idpObject instanceof IdP)) {
			0 ignored issues – show introduced 2019-03-06 13:49 UTC by Report Bug Copy Issue Report `$idpObject` is always a sub-type of `core\IdP`. Loading history...
127			throw new Exception("Always provide an IdP object when constructing Deployment.");
128			} else {
129			$idp = $idpObject;
130			$this->institution = $idp->identifier;
131			}
132			if ($deploymentIdRaw !== NULL) {
133			$this->identifier = $deploymentIdRaw;
			0 ignored issues – show Documentation Bug introduced 2019-03-06 13:49 UTC by Report Bug Copy Issue Report It seems like `$deploymentIdRaw` can also be of type `string`. However, the property `$identifier` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
134			}
135			$this->instName = $idp->name;
136			$this->idpNumberOfDeployments = $idp->deploymentCount();
137			$this->idpAttributes = $idp->getAttributes();
138			$fedObject = new Federation($idp->federation);
139			$this->fedAttributes = $fedObject->getAttributes();
140			$this->loggerInstance->debug(3, "--- END Constructing new AbstractDeployment object ... ---\n");
141			}
142
143			/**
144			* update the last_changed timestamp for this deployment
145			*
146			* @return void
147			*/
148			abstract public function updateFreshness();
149
150			/**
151			* gets the last-modified timestamp (useful for caching "dirty" check)
152			*
153			* @return string the date in string form, as returned by SQL
154			*/
155			abstract public function getFreshness();
156
157			/**
158			* Deletes the deployment from database
159			*
160			* @return void
161			*/
162			abstract public function destroy();
163			}
164

GEANT / CAT

Push — master ( 5d347f...d6f93a )

AbstractDeployment::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like