Lines 96.83% 214 / 221
Methods 88.46% 23 / 26
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readRoleById 100.00% 8 / 8 100.00% 1 / 1 2
 readRoleByName 100.00% 8 / 8 100.00% 1 / 1 2
 readAllRoles 100.00% 11 / 11 100.00% 1 / 1 3
 addRole 100.00% 21 / 21 100.00% 1 / 1 2
 updateRole 100.00% 28 / 28 100.00% 1 / 1 4
 fetchPermissionsByNamesOrFail 93.75% 15 / 16 0.00% 0 / 1 4.00
 deleteRole 91.66% 11 / 12 0.00% 0 / 1 6.02
 [BO\Zmsbackend\Base] __construct 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] init 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] getWriter 100.00% 4 / 4 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] getReader 100.00% 5 / 5 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] fetchPreparedStatement 100.00% 9 / 9 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] startExecute 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] pdoExceptionHandler 100.00% 13 / 13 100.00% 1 / 1 4
 [BO\Zmsbackend\Base] fetchStatement 100.00% 3 / 3 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchOne 100.00% 7 / 7 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] fetchRow 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchValue 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAll 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchHandle 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchList 100.00% 8 / 8 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] writeItem 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] deleteItem 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] perform 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAffected 100.00% 8 / 8 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] readResolvedReferences n/a 0 / 0 n/a 0 / 0 1
 [BO\Zmsbackend\Base] hashStringValue 50.00% 5 / 10 0.00% 0 / 1 8.12
9class Role extends \BO\Zmsbackend\Base
10{
11    public function readRoleById(int $roleId, int $resolveReferences = 1): ?Entity
12    {
13        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::SELECT);
14        $query->addEntityMapping()
15            ->addResolvedReferences($resolveReferences)
16            ->addConditionRoleId($roleId);
17        $role = $this->fetchOne($query, new Entity());
18
19        if (! $role->hasId()) {
20            return null;
21        }
22
23        return $role;
24    }
25
26    public function readRoleByName(string $name, int $resolveReferences = 1): ?Entity
27    {
28        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::SELECT);
29        $query->addEntityMapping()
30            ->addResolvedReferences($resolveReferences)
31            ->addConditionName($name);
32
33        $role = $this->fetchOne($query, new Entity());
34        if (! $role->hasId()) {
35            return null;
36        }
37
38        return $role;
39    }
40
41    public function readAllRoles(string $order = 'ASC', int $resolveReferences = 1): Collection
42    {
43        $roleList = new Collection();
44        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::SELECT);
45        $query->addEntityMapping()
46            ->addResolvedReferences($resolveReferences)
47            ->addOrderBy('id', $order);
48        $result = $this->fetchList($query, new Entity());
49        if (count($result)) {
50            foreach ($result as $entity) {
51                $entity = $this->readResolvedReferences($entity, $resolveReferences);
52                $roleList->addEntity($entity);
53            }
54        }
55        return $roleList;
56    }
57
58    public function addRole(Entity $role, int $resolveReferences = 1): ?Entity
59    {
60        $permissionNames = array_values(array_unique($role['permissions'] ?? []));
61        $permissions = $this->fetchPermissionsByNamesOrFail($permissionNames);
62
63        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::INSERT);
64        $query->addValues(
65            [
66                'name' => $role['name'],
67                'description' => $role['description'],
68            ]
69        );
70        $this->writeItem($query);
71        $newId = (int) $this->getWriter()->lastInsertId();
72
73        foreach ($permissions as $permission) {
74            $link = new \BO\Zmsbackend\Role\Repository\RolePermission(\BO\Zmsbackend\Query\Base::INSERT);
75            $link->addValues(
76                [
77                    'role_id' => $newId,
78                    'permission_id' => $permission['id'],
79                ]
80            );
81            $this->writeItem($link);
82        }
83
84        return $this->readRoleById($newId, $resolveReferences);
85    }
86
87    public function updateRole(int $roleId, Entity $role, int $resolveReferences = 1): ?Entity
88    {
89        $existing = $this->readRoleById($roleId);
90        if (!$existing || !$existing->hasId()) {
91            return null;
92        }
93
94        $permissionNames = array_values(array_unique($role['permissions'] ?? []));
95        $permissions = $this->fetchPermissionsByNamesOrFail($permissionNames);
96
97        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::UPDATE);
98        $query->addConditionRoleId($roleId);
99        $query->addValues(
100            [
101                'name' => $role['name'],
102                'description' => $role['description'],
103            ]
104        );
105        $this->writeItem($query);
106
107        $delLinks = new \BO\Zmsbackend\Role\Repository\RolePermission(\BO\Zmsbackend\Query\Base::DELETE);
108        $delLinks->addConditionRoleId($roleId);
109        $this->deleteItem($delLinks);
110
111        foreach ($permissions as $permission) {
112            $link = new \BO\Zmsbackend\Role\Repository\RolePermission(\BO\Zmsbackend\Query\Base::INSERT);
113            $link->addValues(
114                [
115                    'role_id' => $roleId,
116                    'permission_id' => $permission['id'],
117                ]
118            );
119            $this->writeItem($link);
120        }
121
122        (new \BO\Zmsbackend\Useraccount\Service\Useraccount())->invalidateAllCaches();
123
124        return $this->readRoleById($roleId, $resolveReferences);
125    }
126
127    private function fetchPermissionsByNamesOrFail(array $permissionNames): array
128    {
129        if ($permissionNames === []) {
130            return [];
131        }
132        $permQuery = new \BO\Zmsbackend\Permission\Repository\Permission(\BO\Zmsbackend\Query\Base::SELECT);
133        $permQuery->addEntityMapping()
134            ->addResolvedReferences(0)
135            ->addConditionNames($permissionNames);
136        $permissions = $this->fetchList($permQuery, new PermissionEntity());
137        if (count($permissions) !== count($permissionNames)) {
138            $found = [];
139            foreach ($permissions as $p) {
140                $found[$p['name']] = true;
141            }
142            $missing = array_values(array_filter($permissionNames, static fn($n) => !isset($found[$n])));
143            throw new \InvalidArgumentException(
144                'Unknown permission name(s): ' . implode(', ', $missing)
145            );
146        }
147        return $permissions;
148    }
149
150    public function deleteRole(int $roleId): ?Entity
151    {
152        $entity = $this->readRoleById($roleId);
153        if (! $entity || ! $entity->hasId()) {
154            return null;
155        }
156
157        $assignedUserCount = (int) ($entity['assignedUserCount'] ?? 0);
158        if ($assignedUserCount > 0) {
159            throw new \BO\Zmsbackend\Role\Exception\AssignedUserListNotEmpty();
160        }
161
162        $query = new \BO\Zmsbackend\Role\Repository\Role(\BO\Zmsbackend\Query\Base::DELETE);
163
164        $query->addConditionRoleId($roleId);
165        $deleted = ($this->deleteItem($query)) ? $entity : null;
166
167        if ($deleted) {
168            (new \BO\Zmsbackend\Useraccount\Service\Useraccount())->invalidateAllCaches();
169        }
170        return $deleted;
171    }
172}

Inherited from BO\Zmsbackend\Base

38    public function __construct(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null)
39    {
40        $this->writeDb = $writeConnection;
41        $this->readDb = $readConnection;
42    }
44    public static function init(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null): static
45    {
46        $instance = new static($writeConnection, $readConnection);
47        return $instance;
48    }
50    public function getWriter(): Connection\Pdo
51    {
52        if (null === $this->writeDb) {
53            $this->writeDb = Connection\Select::getWriteConnection();
54            $this->readDb = $this->writeDb;
55        }
56        return $this->writeDb;
57    }
59    public function getReader(): Connection\Pdo
60    {
61        if (null !== $this->writeDb) {
62            // if readDB gets a reset, still use writeDB
63            return $this->writeDb;
64        }
65        if (null === $this->readDb) {
66            $this->readDb = Connection\Select::getReadConnection();
67        }
68        return $this->readDb;
69    }
71    public function fetchPreparedStatement(Query\Base|string $query)
72    {
73        $sql = "$query";
74        $reader = $this->getReader();
75        if (spl_object_hash($reader) != static::$preparedConnectionId) {
76            // do not use prepared statements on a different connection
77            static::$preparedCache = [];
78            static::$preparedConnectionId = spl_object_hash($reader);
79        }
80        if (!isset(static::$preparedCache[$sql])) {
81            $prepared = $this->getReader()->prepare($sql);
82            static::$preparedCache[$sql] = $prepared;
83        }
84        return static::$preparedCache[$sql];
85    }
87    public function startExecute($statement, array $parameters)
88    {
89        $statement = static::pdoExceptionHandler(function () use ($statement, $parameters) {
90            $statement->execute($parameters);
91            return $statement;
92        });
93        return $statement;
94    }
96    protected static function pdoExceptionHandler(\Closure $pdoFunction, $parameters = [])
97    {
98        try {
99            $statement = $pdoFunction($parameters);
100        } catch (\PDOException $pdoException) {
101            if (stripos($pdoException->getMessage(), 'Lock wait timeout') !== false) {
102                throw new \BO\Zmsbackend\Exception\Pdo\LockTimeout();
103            }
104            //@codeCoverageIgnoreStart
105            if (stripos($pdoException->getMessage(), 'Deadlock found') !== false) {
106                throw new \BO\Zmsbackend\Exception\Pdo\DeadLockFound();
107            }
108            //@codeCoverageIgnoreEnd
109            $message = "SQL: "
110                . " Err: "
111                . $pdoException->getMessage()
112                //. " || Statement: "
113                //.$statement->queryString
114                //." || Parameters=". var_export($parameters, true)
115                ;
116            throw new \BO\Zmsbackend\Exception\Pdo\PDOFailed($message, 0, $pdoException);
117        }
118        return $statement;
119    }
121    public function fetchStatement(Query\Base $query)
122    {
123        $parameters = $query->getParameters();
124        $statement = $this->startExecute($this->fetchPreparedStatement($query), $parameters);
125        return $statement;
126    }
133    public function fetchOne(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity)
134    {
135        $statement = $this->fetchStatement($query);
136        $data = $statement->fetch(\PDO::FETCH_ASSOC);
137        if ($data) {
138            $entity->exchangeArray($query->postProcessJoins($data));
139            $entity->setResolveLevel($query->getResolveLevel());
140        }
141        $statement->closeCursor();
142        return $entity;
143    }
145    public function fetchRow(Query\Base|string $query, array|null $parameters = null)
146    {
147        return static::pdoExceptionHandler(function () use ($query, $parameters) {
148            $prepared = $this->fetchPreparedStatement($query);
149            $prepared->execute($parameters);
150            $row = $prepared->fetch(\PDO::FETCH_ASSOC);
151            $prepared->closeCursor();
152            return $row;
153        });
154    }
156    public function fetchValue(Query\Base|string $query, array|null $parameters = null)
157    {
158        return static::pdoExceptionHandler(function () use ($query, $parameters) {
159            $prepared = $this->fetchPreparedStatement($query);
160            $prepared->execute($parameters);
161            $value = $prepared->fetchColumn();
162            $prepared->closeCursor();
163            return $value;
164        });
165    }
167    public function fetchAll(Query\Base|string $query, array|null $parameters = null)
168    {
169        return static::pdoExceptionHandler(function () use ($query, $parameters) {
170            $prepared = $this->fetchPreparedStatement($query);
171            $prepared->execute($parameters);
172            $list = $prepared->fetchAll(\PDO::FETCH_ASSOC);
173            $prepared->closeCursor();
174            return $list;
175        });
176    }
178    public function fetchHandle(Query\Base|string $query, array|null $parameters = null)
179    {
180        return static::pdoExceptionHandler(function () use ($query, $parameters) {
181            $prepared = $this->fetchPreparedStatement($query);
182            $prepared->execute($parameters);
183            return $prepared;
184        });
185    }
187    public function fetchList(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity, array|\ArrayAccess $resultList = [])
188    {
189        $statement = $this->fetchStatement($query);
190        while ($data = $statement->fetch(\PDO::FETCH_ASSOC)) {
191            $dataEntity = clone $entity;
192            $dataEntity->exchangeArray($query->postProcessJoins($data));
193            $dataEntity->setResolveLevel($query->getResolveLevel());
194            $resultList[] = $dataEntity;
195        }
196        $statement->closeCursor();
197        return $resultList;
198    }
206    public function writeItem(Query\Base $query)
207    {
208        return static::pdoExceptionHandler(function () use ($query) {
209            $this->getWriter(); //Switch to writer for write/delete
210            $statement = $this->fetchPreparedStatement($query);
211            $status = $statement->execute($query->getParameters());
212            $statement->closeCursor();
213            return $status;
214        });
215    }
221    public function deleteItem(Query\Base $query)
222    {
223        return $this->writeItem($query);
224    }
226    public function perform(string $sql, array|null $parameters = null)
227    {
228        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
229            $this->getWriter(); //Switch to writer for perform
230            $prepared = $this->fetchPreparedStatement($sql);
231            $status = $prepared->execute($parameters);
232            $prepared->closeCursor();
233            return $status;
234        });
235    }
237    public function fetchAffected(string $sql, array|null $parameters = null)
238    {
239        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
240            $this->getWriter(); //Switch to writer for perform
241            $prepared = $this->fetchPreparedStatement($sql);
242            $prepared->execute($parameters);
243            $count = $prepared->rowCount();
244            $prepared->closeCursor();
245            return $count;
246        });
247    }
256    public function readResolvedReferences(\BO\Zmsentities\Schema\Entity $entity, int $resolveReferences)
257    {
258        return $entity;
259    }
268    public function hashStringValue(string $value, ?callable $callable = null): string
269    {
270        if ($callable === null) {
271            $callable = 'sha1';
272        }
273
274        if (is_callable($callable)) {
275            $hash = $callable($value);
276
277            if (is_string($callable)) {
278                return $callable . ':' . $hash;
279            }
280            if ($callable instanceof \Closure) {
281                return 'closure:' . $hash;
282            }
283            // else
284            return 'custom:' . $hash;
285        }
286
287        throw new \InvalidArgumentException('hashStringValue() should be called with a callable as second parameter.');
288    }