Failed Conditions
Branch newinternal (104de7)
by Simon
09:33
created

SecurityConfigurationFactory   A

Complexity

Total Complexity 6

Size/Duplication

Total Lines 113
Duplicated Lines 23.01 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 6
c 1
b 0
f 0
lcom 1
cbo 1
dl 26
loc 113
rs 10

6 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A asInternalPage() 0 10 1
A asAdminPage() 0 9 1
A asPublicPage() 0 17 1
A asAllLoggedInUsersPage() 13 13 1
A asCheckUserData() 13 13 1

How to fix   Duplicated Code   

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:

1
<?php
2
/**
3
 * Created by PhpStorm.
4
 * User: stwalkerster
5
 * Date: 24/03/2016
6
 * Time: 23:52
7
 */
8
9
namespace Waca\Security;
10
11
12
final class SecurityConfigurationFactory
13
{
14
	/**
15
	 * @var bool
16
	 */
17
	private $forceIdentified;
18
19
	/**
20
	 * Security constructor.
21
	 *
22
	 * @param bool $forceIdentified
23
	 */
24
	public function __construct($forceIdentified)
25
	{
26
		$this->forceIdentified = $forceIdentified;
27
	}
28
29
	/**
30
	 * Returns a pre-built security configuration for an internal page.
31
	 *
32
	 * @category Security-Critical
33
	 * @return SecurityConfiguration
34
	 */
35
	public function asInternalPage()
36
	{
37
		$config = new SecurityConfiguration();
38
		$config->setAdmin(SecurityConfiguration::ALLOW)
39
			->setUser(SecurityConfiguration::ALLOW);
40
41
		$config->setRequireIdentified($this->forceIdentified);
42
43
		return $config;
44
	}
45
46
	/**
47
	 * Returns a pre-built security configuration for a tool admin only page.
48
	 *
49
	 * @category Security-Critical
50
	 * @return SecurityConfiguration
51
	 */
52
	public function asAdminPage()
53
	{
54
		$config = new SecurityConfiguration();
55
		$config->setAdmin(SecurityConfiguration::ALLOW);
56
57
		$config->setRequireIdentified($this->forceIdentified);
58
59
		return $config;
60
	}
61
62
	/**
63
	 * Returns a pre-built security configuration for a page accessible to *ALL* logged in users, including suspended
64
	 * and new users. This probably isn't the setting you want.
65
	 *
66
	 * @category Security-Critical
67
	 * @return SecurityConfiguration
68
	 */
69 View Code Duplication
	public function asAllLoggedInUsersPage()
0 ignored issues
show
Duplication introduced by
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...
70
	{
71
		$config = new SecurityConfiguration();
72
		$config->setAdmin(SecurityConfiguration::ALLOW)
73
			->setUser(SecurityConfiguration::ALLOW)
74
			->setDeclined(SecurityConfiguration::ALLOW)
75
			->setNew(SecurityConfiguration::ALLOW)
76
			->setSuspended(SecurityConfiguration::ALLOW);
77
78
		$config->setRequireIdentified($this->forceIdentified);
79
80
		return $config;
81
	}
82
83
	/**
84
	 * @return SecurityConfiguration
85
	 * @category Security-Critical
86
	 */
87 View Code Duplication
	public function asCheckUserData()
0 ignored issues
show
Duplication introduced by
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...
88
	{
89
		$config = new SecurityConfiguration();
90
		$config->setCheckuser(SecurityConfiguration::ALLOW)
91
			->setCommunity(SecurityConfiguration::DENY)
92
			->setSuspended(SecurityConfiguration::DENY)
93
			->setDeclined(SecurityConfiguration::DENY)
94
			->setNew(SecurityConfiguration::DENY);
95
96
		$config->setRequireIdentified($this->forceIdentified);
97
98
		return $config;
99
	}
100
101
	/**
102
	 * Returns a pre-built security configuration for a public page.
103
	 *
104
	 * @category Security-Critical
105
	 * @return SecurityConfiguration
106
	 */
107
	public function asPublicPage()
108
	{
109
		$config = new SecurityConfiguration();
110
		$config->setAdmin(SecurityConfiguration::ALLOW)
111
			->setUser(SecurityConfiguration::ALLOW)
112
			->setCheckuser(SecurityConfiguration::ALLOW)
113
			->setCommunity(SecurityConfiguration::ALLOW)
114
			->setSuspended(SecurityConfiguration::ALLOW)
115
			->setDeclined(SecurityConfiguration::ALLOW)
116
			->setNew(SecurityConfiguration::ALLOW);
117
118
		// Public pages shouldn't be inaccessible to logged-in, unidentified users.
119
		// Otherwise, logged in but unidentified users can't even log out.
120
		$config->setRequireIdentified(false);
121
122
		return $config;
123
	}
124
}