1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file has been automatically generated by TDBM. |
5
|
|
|
* DO NOT edit this file, as it might be overwritten. |
6
|
|
|
* If you need to perform changes, edit the UserDao class instead! |
7
|
|
|
*/ |
8
|
|
|
|
9
|
|
|
namespace Mouf\Security\DAO; |
10
|
|
|
|
11
|
|
|
use Kls\Model\Bean\RolesRightBean; |
12
|
|
|
use Mouf\Database\TDBM\TDBMService; |
13
|
|
|
use Mouf\Database\TDBM\ResultIterator; |
14
|
|
|
use Mouf\Security\Model\Role; |
15
|
|
|
use Mouf\Security\Rights\RightsRegistry; |
16
|
|
|
use Mouf\Security\RightsService\RightInterface; |
17
|
|
|
use Mouf\Security\RightsService\RightsDaoInterface; |
18
|
|
|
use Mouf\Security\UserManagement\Api\RoleDao; |
19
|
|
|
use Mouf\Security\UserManagement\Api\RoleInterface; |
20
|
|
|
use Mouf\Security\UserService\UserDaoInterface; |
21
|
|
|
use Mouf\Security\UserService\UserInterface; |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* This class provides a TDBM implementation of the RoleDao interface. |
25
|
|
|
*/ |
26
|
|
|
class SecurityRoleDao implements RoleDao |
27
|
|
|
{ |
28
|
|
|
/** |
29
|
|
|
* @var TDBMService |
30
|
|
|
*/ |
31
|
|
|
protected $tdbmService; |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* @param TDBMService $tdbmService Sets the TDBM service used by this DAO. |
35
|
|
|
*/ |
36
|
|
|
public function __construct(TDBMService $tdbmService) |
37
|
|
|
{ |
38
|
|
|
$this->tdbmService = $tdbmService; |
39
|
|
|
} |
40
|
|
|
|
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Returns the list of all roles known by the application. |
44
|
|
|
* |
45
|
|
|
* @return RoleInterface[] |
46
|
|
|
*/ |
47
|
|
|
public function getAllRoles() |
48
|
|
|
{ |
49
|
|
|
return $this->find(); |
|
|
|
|
50
|
|
|
} |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* @param UserInterface $user |
54
|
|
|
* @param RoleInterface[] $roles |
55
|
|
|
* @return void |
56
|
|
|
*/ |
57
|
|
|
public function setRoles(UserInterface $user, array $roles) |
58
|
|
|
{ |
59
|
|
|
$user = $this->tdbmService->findObjectByPk('users', [ |
60
|
|
|
'id' => $user->getId() |
61
|
|
|
]); |
62
|
|
|
// FIXME: throw exception is $user is null |
63
|
|
|
|
64
|
|
|
$roleBeans = []; |
65
|
|
|
|
66
|
|
|
foreach ($roles as $role) { |
67
|
|
|
$roleBeans[] = $this->findRoleById($role->getId()); |
68
|
|
|
} |
69
|
|
|
|
70
|
|
|
$user->setRoles($roleBeans); |
71
|
|
|
$this->tdbmService->save($user); |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* @param UserInterface $user |
76
|
|
|
* @return RoleInterface[] |
77
|
|
|
*/ |
78
|
|
|
public function getRoles(UserInterface $user) |
79
|
|
|
{ |
80
|
|
|
if ($user->getId() === null) { |
81
|
|
|
return []; |
82
|
|
|
} |
83
|
|
|
return $this->find([ |
|
|
|
|
84
|
|
|
'users_roles.user_id' => $user->getId() |
85
|
|
|
]); |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
/** |
89
|
|
|
* Get a list of RolesBean specified by its filters. |
90
|
|
|
* |
91
|
|
|
* @param mixed $filter The filter bag (see TDBMService::findObjects for complete description) |
92
|
|
|
* @param array $parameters The parameters associated with the filter |
93
|
|
|
* @param mixed $orderBy The order string |
94
|
|
|
* @param array $additionalTablesFetch A list of additional tables to fetch (for performance improvement) |
95
|
|
|
* @param int $mode Either TDBMService::MODE_ARRAY or TDBMService::MODE_CURSOR (for large datasets). Defaults to TDBMService::MODE_ARRAY. |
96
|
|
|
* |
97
|
|
|
* @return RolesRightBean[]|ResultIterator|ResultArray |
98
|
|
|
*/ |
99
|
|
|
private function find($filter = null, array $parameters = [], $orderBy = null, array $additionalTablesFetch = [], $mode = null) |
100
|
|
|
{ |
101
|
|
|
return $this->tdbmService->findObjects('roles', $filter, $parameters, $orderBy, $additionalTablesFetch, $mode); |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
private function findRoleById($roleId) { |
105
|
|
|
return $this->tdbmService->findObjectByPk('roles', [ |
106
|
|
|
'id' => $roleId |
107
|
|
|
]); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* Fetches a role by ID. |
112
|
|
|
* |
113
|
|
|
* @param $roleId |
114
|
|
|
* @return RoleInterface |
115
|
|
|
*/ |
116
|
|
|
public function getRoleById($roleId) : RoleInterface |
117
|
|
|
{ |
118
|
|
|
return self::castToRole($this->findRoleById($roleId)); |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
public static function castToRole($roleBean) : RoleInterface |
122
|
|
|
{ |
123
|
|
|
return new Role($roleBean->getId(), $roleBean->getLabel()); |
124
|
|
|
} |
125
|
|
|
} |
126
|
|
|
|
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:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.