LDAPGroup - Code Metrics - Inspection of "Switch from_dn to new LDAPGroup() call" - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 68b6aa...23a9a3 )

by Patrick

created 2016-06-10 18:46 UTC

LDAPGroup B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	259
Duplicated Lines	5.41 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	13
Bugs	3	Features	3

Metric	Value
c	13
b	3
f	3
dl	14
loc	259
rs	7.4757
wmc	53
lcom	1
cbo	5

14 Methods

Rating	Name	Duplication	Size	Complexity
C	getNonMemebers()	0	39	7
A	clearMembers()	0	15	4
C	addMember()	0	46	8
A	__construct()	0	5	1
A	getGroupName()	0	4	1
A	getDescription()	0	4	1
A	setDescription()	0	4	1
A	getMembersField()	0	20	4
A	getIDFromDN()	0	9	2
B	getMemberUids()	0	26	6
A	getObjectFromDN()	0	17	4
A	getMemberDetail()	0	10	2
C	members()	0	25	8
A	from_name()	14	14	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like LDAPGroup often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use LDAPGroup, and based on these observations, apply Extract Interface, too.

<?php
namespace Auth;

class LDAPGroup extends Group
{
    use LDAPCachableObject;

    private $ldapObj;
    private $server;

    public function __construct($data)
    {
        $this->server = \LDAP\LDAPServer::getInstance();
        $this->initialize($data);
    }

    public function getGroupName()
    {
        return $this->getFieldSingleValue('cn');
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function getDescription()
    {
        return $this->getFieldSingleValue('description');
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function setDescription($name)
    {
        return $this->setField('description', $name);
    }

    private function getMembersField(&$fieldName = false)
    {
        $rawMembers = $this->getField('member');
        $fieldName  = 'member';
        if($rawMembers === false)
        {
            $rawMembers = $this->getField('uniqueMember');
            $fieldName  = 'uniqueMember';
        }
        if($rawMembers === false)
        {
            $rawMembers = $this->getField('memberUid');
            $fieldName  = 'memberUid';
        }
        if(!isset($rawMembers['count']))
        {
            $rawMembers['count'] = count($rawMembers);
        }
        return $rawMembers;
    }

    private function getIDFromDN($dn)
    {
        $split = explode(',', $dn);
        if(strncmp('cn=', $split[0], 3) === 0)
        {
            return substr($split[0], 3);
        }
        return substr($split[0], 4);
    }

    public function getMemberUids($recursive = true)
    {
        $members = array();
        $rawMembers = $this->getMembersField();
        for($i = 0; $i < $rawMembers['count']; $i++)
        {
            if($recursive && strncmp($rawMembers[$i], 'cn=', 3) === 0)
            {
                $child = new LDAPGroup($rawMembers[$i]);
                if($child !== false)
                {
                    $members = array_merge($members, $child->members());
                }
            }
            else
            {
                array_push($members, $rawMembers[$i]);
            }
        }
        $count = count($members);
        for($i = 0; $i < $count; $i++)
        {
            $members[$i] = $this->getIDFromDN($members[$i]);
        }
        return $members;
    }

    private function getObjectFromDN($dn)
    {
        $split = explode(',', $dn);
        if(strncmp('cn=', $dn, 3) === 0)
        {
            if(count($split) === 1)
            {
                return LDAPGroup::from_name($dn, $this->server);
            }
            return LDAPGroup::from_name(substr($split[0], 3), $this->server);
        }
        if(count($split) === 1)
        {
            return LDAPUser::from_name($dn, $this->server);
        }
        return LDAPUser::from_name(substr($split[0], 4), $this->server);
    }

    private function getMemberDetail($members)
    {
        $details = array();
        $count = count($members);
        for($i = 0; $i < $count; $i++)
        {
            $details[$i] = $this->getObjectFromDN($members[$i]);
        }
        return $details;
    }

    public function members($details = false, $recursive = true, $includeGroups = true)
    {
        $members = array();
        $rawMembers = $this->getMembersField();
        for($i = 0; $i < $rawMembers['count']; $i++)
        {
            if($recursive && strncmp($rawMembers[$i], 'cn=', 3) === 0)
            {
                $child = new LDAPGroup($rawMembers[$i]);
                if($child !== false)
                {
                    $members = array_merge($members, $child->members());
                }
            }
            else if($includeGroups !== false || strncmp($rawMembers[$i], 'cn=', 3) !== 0)
            {
                array_push($members, $rawMembers[$i]);
            }
        }
        if($details === true)
        {
            $members = $this->getMemberDetail($members);
        }
        return $members;
    }

    public function getNonMemebers($select = false)
    {
        $data = array();
        $groupFilter = '(&(cn=*)(!(cn='.$this->getGroupName().'))';
        $userFilter = '(&(cn=*)';
        $members = $this->members();
        $count = count($members);
        for($i = 0; $i < $count; $i++)
        {
            $dnComps = explode(',', $members[$i]);
            if(strncmp($members[$i], "uid=", 4) == 0)
            {
                $userFilter .= '(!('.$dnComps[0].'))';
            }
            else
            {
                $groupFilter .= '(!('.$dnComps[0].'))';
            }
        }
        $userFilter .= ')';
        $groupFilter .= ')';
        $groups = $this->server->read($this->server->group_base, $groupFilter);
        $count = count($groups);
        for($i = 0; $i < $count; $i++)
        {
            if($groups[$i] === false || $groups[$i] === null)
            {
                continue;
            }
            array_push($data, new LDAPGroup($groups[$i]));
        }
        $users = $this->server->read($this->server->user_base, $userFilter, false, $select);
        $count = count($users);
        for($i = 0; $i < $count; $i++)
        {
            array_push($data, new LDAPUser($users[$i]));
        } 
        return $data;
    }

    public function clearMembers()
    {
        if(isset($this->ldapObj['member']))
        {
            $this->ldapObj['member'] = array();
        }
        else if(isset($this->ldapObj['uniquemember']))
        {
            $this->ldapObj['uniquemember'] = array();
        }
        else if(isset($this->ldapObj['memberuid']))
        {
            $this->ldapObj['memberuid'] = array();
        }
    }

    public function addMember($name, $isGroup = false, $flush = true)
    {
        $dn = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if($isGroup)
        {
            $dn = 'cn='.$name.','.$this->server->group_base;
        }
        else
        {
            $dn = 'uid='.$name.','.$this->server->user_base;
        }
        $propName   = false;
        $rawMembers = $this->getMembersField($propName);
        if(isset($rawMembers['count']))
        {
            unset($rawMembers['count']);
        }
        if(in_array($dn, $rawMembers) || in_array($name, $rawMembers))
        {
            return true;
        }
        if($propName === 'memberUid')
        {
            if($isGroup)
            {
                throw new \Exception('Unable to add a group as a child of this group type');
            }
            array_push($rawMembers, $name);
        }
        else
        {
            array_push($rawMembers, $dn);
        }
        $tmp = strtolower($propName);
        $this->ldapObj->$tmp = $rawMembers;
        if($flush === true)
        {
            $obj = array('dn'=>$this->ldapObj->dn);
            $obj[$propName] = $rawMembers;
            return $this->server->update($obj);
        }
        else
        {
            return true;
        }
    }

    public static function from_name($name, $data = false)

    {
        if($data === false)
        {
            throw new \Exception('data must be set for LDAPGroup');
        }
        $filter = new \Data\Filter("cn eq $name");
        $group = $data->read($data->group_base, $filter);

        if($group === false || !isset($group[0]))
        {
            return false;
        }
        return new static($group[0]);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}
/* vim: set tabstop=4 shiftwidth=4 expandtab: */


1		<?php
2		namespace Auth;
3
4		class LDAPGroup extends Group
5		{
6		use LDAPCachableObject;
7
8		private $ldapObj;
9		private $server;
10
11		public function __construct($data)
12		{
13		$this->server = \LDAP\LDAPServer::getInstance();
14		$this->initialize($data);
15		}
16
17		public function getGroupName()
18		{
19		return $this->getFieldSingleValue('cn');
		0 ignored issues – show Bug Best Practice introduced 2016-06-07 04:26 UTC by Report Bug Copy Issue Report The return type of `return $this->getFieldSingleValue('cn');` (`string`) is incompatible with the return type of the parent method `Auth\Group::getGroupName` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
20		}
21
22		public function getDescription()
23		{
24		return $this->getFieldSingleValue('description');
		0 ignored issues – show Bug Best Practice introduced 2016-06-07 04:26 UTC by Report Bug Copy Issue Report The return type of `return $this->getFieldSingleValue('description');` (`string`) is incompatible with the return type of the parent method `Auth\Group::getDescription` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
25		}
26
27		public function setDescription($name)
28		{
29		return $this->setField('description', $name);
30		}
31
32		private function getMembersField(&$fieldName = false)
33		{
34		$rawMembers = $this->getField('member');
35		$fieldName = 'member';
36		if($rawMembers === false)
37		{
38		$rawMembers = $this->getField('uniqueMember');
39		$fieldName = 'uniqueMember';
40		}
41		if($rawMembers === false)
42		{
43		$rawMembers = $this->getField('memberUid');
44		$fieldName = 'memberUid';
45		}
46		if(!isset($rawMembers['count']))
47		{
48		$rawMembers['count'] = count($rawMembers);
49		}
50		return $rawMembers;
51		}
52
53		private function getIDFromDN($dn)
54		{
55		$split = explode(',', $dn);
56		if(strncmp('cn=', $split[0], 3) === 0)
57		{
58		return substr($split[0], 3);
59		}
60		return substr($split[0], 4);
61		}
62
63		public function getMemberUids($recursive = true)
64		{
65		$members = array();
66		$rawMembers = $this->getMembersField();
67		for($i = 0; $i < $rawMembers['count']; $i++)
68		{
69		if($recursive && strncmp($rawMembers[$i], 'cn=', 3) === 0)
70		{
71		$child = new LDAPGroup($rawMembers[$i]);
72		if($child !== false)
73		{
74		$members = array_merge($members, $child->members());
75		}
76		}
77		else
78		{
79		array_push($members, $rawMembers[$i]);
80		}
81		}
82		$count = count($members);
83		for($i = 0; $i < $count; $i++)
84		{
85		$members[$i] = $this->getIDFromDN($members[$i]);
86		}
87		return $members;
88		}
89
90		private function getObjectFromDN($dn)
91		{
92		$split = explode(',', $dn);
93		if(strncmp('cn=', $dn, 3) === 0)
94		{
95		if(count($split) === 1)
96		{
97		return LDAPGroup::from_name($dn, $this->server);
98		}
99		return LDAPGroup::from_name(substr($split[0], 3), $this->server);
100		}
101		if(count($split) === 1)
102		{
103		return LDAPUser::from_name($dn, $this->server);
104		}
105		return LDAPUser::from_name(substr($split[0], 4), $this->server);
106		}
107
108		private function getMemberDetail($members)
109		{
110		$details = array();
111		$count = count($members);
112		for($i = 0; $i < $count; $i++)
113		{
114		$details[$i] = $this->getObjectFromDN($members[$i]);
115		}
116		return $details;
117		}
118
119		public function members($details = false, $recursive = true, $includeGroups = true)
120		{
121		$members = array();
122		$rawMembers = $this->getMembersField();
123		for($i = 0; $i < $rawMembers['count']; $i++)
124		{
125		if($recursive && strncmp($rawMembers[$i], 'cn=', 3) === 0)
126		{
127		$child = new LDAPGroup($rawMembers[$i]);
128		if($child !== false)
129		{
130		$members = array_merge($members, $child->members());
131		}
132		}
133		else if($includeGroups !== false \|\| strncmp($rawMembers[$i], 'cn=', 3) !== 0)
134		{
135		array_push($members, $rawMembers[$i]);
136		}
137		}
138		if($details === true)
139		{
140		$members = $this->getMemberDetail($members);
141		}
142		return $members;
143		}
144
145		public function getNonMemebers($select = false)
146		{
147		$data = array();
148		$groupFilter = '(&(cn=*)(!(cn='.$this->getGroupName().'))';
149		$userFilter = '(&(cn=*)';
150		$members = $this->members();
151		$count = count($members);
152		for($i = 0; $i < $count; $i++)
153		{
154		$dnComps = explode(',', $members[$i]);
155		if(strncmp($members[$i], "uid=", 4) == 0)
156		{
157		$userFilter .= '(!('.$dnComps[0].'))';
158		}
159		else
160		{
161		$groupFilter .= '(!('.$dnComps[0].'))';
162		}
163		}
164		$userFilter .= ')';
165		$groupFilter .= ')';
166		$groups = $this->server->read($this->server->group_base, $groupFilter);
167		$count = count($groups);
168		for($i = 0; $i < $count; $i++)
169		{
170		if($groups[$i] === false \|\| $groups[$i] === null)
171		{
172		continue;
173		}
174		array_push($data, new LDAPGroup($groups[$i]));
175		}
176		$users = $this->server->read($this->server->user_base, $userFilter, false, $select);
177		$count = count($users);
178		for($i = 0; $i < $count; $i++)
179		{
180		array_push($data, new LDAPUser($users[$i]));
181		}
182		return $data;
183		}
184
185		public function clearMembers()
186		{
187		if(isset($this->ldapObj['member']))
188		{
189		$this->ldapObj['member'] = array();
190		}
191		else if(isset($this->ldapObj['uniquemember']))
192		{
193		$this->ldapObj['uniquemember'] = array();
194		}
195		else if(isset($this->ldapObj['memberuid']))
196		{
197		$this->ldapObj['memberuid'] = array();
198		}
199		}
200
201		public function addMember($name, $isGroup = false, $flush = true)
202		{
203		$dn = false;
		0 ignored issues – show Unused Code introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report `$dn` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
204		if($isGroup)
205		{
206		$dn = 'cn='.$name.','.$this->server->group_base;
207		}
208		else
209		{
210		$dn = 'uid='.$name.','.$this->server->user_base;
211		}
212		$propName = false;
213		$rawMembers = $this->getMembersField($propName);
214		if(isset($rawMembers['count']))
215		{
216		unset($rawMembers['count']);
217		}
218		if(in_array($dn, $rawMembers) \|\| in_array($name, $rawMembers))
219		{
220		return true;
221		}
222		if($propName === 'memberUid')
223		{
224		if($isGroup)
225		{
226		throw new \Exception('Unable to add a group as a child of this group type');
227		}
228		array_push($rawMembers, $name);
229		}
230		else
231		{
232		array_push($rawMembers, $dn);
233		}
234		$tmp = strtolower($propName);
235		$this->ldapObj->$tmp = $rawMembers;
236		if($flush === true)
237		{
238		$obj = array('dn'=>$this->ldapObj->dn);
239		$obj[$propName] = $rawMembers;
240		return $this->server->update($obj);
241		}
242		else
243		{
244		return true;
245		}
246		}
247
248	View Code Duplication	public static function from_name($name, $data = false)
		0 ignored issues – show Duplication introduced 2016-05-13 18:20 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...
249		{
250		if($data === false)
251		{
252		throw new \Exception('data must be set for LDAPGroup');
253		}
254		$filter = new \Data\Filter("cn eq $name");
255		$group = $data->read($data->group_base, $filter);
		0 ignored issues – show Bug introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report The method `read` cannot be called on `$data` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
256		if($group === false \|\| !isset($group[0]))
257		{
258		return false;
259		}
260		return new static($group[0]);
		0 ignored issues – show Bug Best Practice introduced 2016-05-13 18:20 UTC by Report Bug Copy Issue Report The return type of `return new static($group[0]);` (`Auth\LDAPGroup`) is incompatible with the return type of the parent method `Auth\Group::from_name` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
261		}
262		}
263		/* vim: set tabstop=4 shiftwidth=4 expandtab: */
264

BurningFlipside / CommonCode