19992775795

Committed 06 Dec 2025 06:45PM UTC coverage: 72.97% (-0.009%) from 72.979%

Build # 19992775795

Build Type

push

github

Committed by

avoutic

Commit Message

Use modern find() variants

Run Details

27 of 29 new or added lines in 6 files covered. (93.1%)

31 existing lines in 4 files now uncovered.

1995 of 2734 relevant lines covered (72.97%)

2.76 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.0

/src/Security/UserRightService.php

<?php

/*
 * This file is part of WebFramework.
 *
 * (c) Avoutic <avoutic@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WebFramework\Security;

use Psr\Log\LoggerInterface;
use WebFramework\Database\Database;
use WebFramework\Entity\User;
use WebFramework\Repository\RightRepository;
use WebFramework\Repository\UserRightRepository;

/**
 * Manages user rights and permissions.
 */
class UserRightService
{
    /**
     * UserRightService constructor.
     *
     * @param Database            $database            The database service
     * @param LoggerInterface     $logger              The logger service
     * @param RightRepository     $rightRepository     The right repository
     * @param UserRightRepository $userRightRepository The user right repository
     */
    public function __construct(
        private Database $database,
        private LoggerInterface $logger,
        private RightRepository $rightRepository,
        private UserRightRepository $userRightRepository,
    ) {}

    /**
     * Add a right to a user.
     *
     * @param User   $user      The user to add the right to
     * @param string $shortName The short name of the right to add
     *
     * @throws \InvalidArgumentException If the right is unknown
     */
    public function addRight(User $user, string $shortName): void
    {
        $this->logger->info('Adding right to user', ['user_id' => $user->getId(), 'short_name' => $shortName]);

        $right = $this->rightRepository->getRightByShortName($shortName);

        if ($right === null)
        {
            $this->logger->error('Cannot add unknown right to user', ['user_id' => $user->getId(), 'short_name' => $shortName]);

            throw new \InvalidArgumentException('Right unknown');
        }

        $userRight = $this->userRightRepository
            ->findOneBy([
                'user_id' => $user->getId(),
                'right_id' => $right->getId(),
            ])
        ;

        if ($userRight === null)
        {
            $this->userRightRepository->create([
                'user_id' => $user->getId(),
                'right_id' => $right->getId(),
            ]);
        }
    }

    /**
     * Delete a right from a user.
     *
     * @param User   $user      The user to remove the right from
     * @param string $shortName The short name of the right to remove
     *
     * @throws \InvalidArgumentException If the right is unknown
     */
    public function deleteRight(User $user, string $shortName): void
    {
        $this->logger->info('Deleting right from user', ['user_id' => $user->getId(), 'short_name' => $shortName]);

        $right = $this->rightRepository->getRightByShortName($shortName);

        if ($right === null)
        {
            $this->logger->error('Cannot delete unknown right from user', ['user_id' => $user->getId(), 'short_name' => $shortName]);

            throw new \InvalidArgumentException('Right unknown');
        }

        $userRight = $this->userRightRepository->findOneBy([
            'user_id' => $user->getId(),
            'right_id' => $right->getId(),
        ]);

        if ($userRight === null)
        {
            return;
        }

        $this->userRightRepository->delete($userRight);
    }

    /**
     * Check if a user has a specific right.
     *
     * @param User   $user      The user to check
     * @param string $shortName The short name of the right to check for
     *
     * @return bool True if the user has the right, false otherwise
     */
    public function hasRight(User $user, string $shortName): bool
    {
        $right = $this->rightRepository->getRightByShortName($shortName);

        if ($right === null)
        {
            return false;
        }

        $userRight = $this->userRightRepository->findOneBy([
            'user_id' => $user->getId(),
            'right_id' => $right->getId(),
        ]);

        return ($userRight !== null);
    }

    /**
     * Get all rights for a user.
     *
     * @param User $user The user to get rights for
     *
     * @return array<string> An array of right short names
     */
    public function getRights(User $user): array
    {
        $query = <<<'SQL'
        SELECT short_name
        FROM rights AS r,
             user_rights AS ur
        WHERE ur.user_id = ? AND
              ur.right_id = r.id
        ORDER BY r.short_name
SQL;

        $params = [$user->getId()];

        $result = $this->database->query($query, $params, 'Failed to retrieve rights');

        $data = [];

        foreach ($result as $row)
        {
            $data[] = $row['short_name'];
        }

        return $data;
    }
}

1	<?php
2
3	/*
4	* This file is part of WebFramework.
5	*
6	* (c) Avoutic <avoutic@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	namespace WebFramework\Security;
13
14	use Psr\Log\LoggerInterface;
15	use WebFramework\Database\Database;
16	use WebFramework\Entity\User;
17	use WebFramework\Repository\RightRepository;
18	use WebFramework\Repository\UserRightRepository;
19
20	/**
21	* Manages user rights and permissions.
22	*/
23	class UserRightService
24	{
25	/**
26	* UserRightService constructor.
27	*
28	* @param Database $database The database service
29	* @param LoggerInterface $logger The logger service
30	* @param RightRepository $rightRepository The right repository
31	* @param UserRightRepository $userRightRepository The user right repository
32	*/
33	public function __construct(	×
34	private Database $database,
35	private LoggerInterface $logger,
36	private RightRepository $rightRepository,
37	private UserRightRepository $userRightRepository,
38	) {}	×
39
40	/**
41	* Add a right to a user.
42	*
43	* @param User $user The user to add the right to
44	* @param string $shortName The short name of the right to add
45	*
46	* @throws \InvalidArgumentException If the right is unknown
47	*/
48	public function addRight(User $user, string $shortName): void	3✔
49	{
50	$this->logger->info('Adding right to user', ['user_id' => $user->getId(), 'short_name' => $shortName]);	3✔
51
52	$right = $this->rightRepository->getRightByShortName($shortName);	3✔
53
54	if ($right === null)	3✔
55	{
56	$this->logger->error('Cannot add unknown right to user', ['user_id' => $user->getId(), 'short_name' => $shortName]);	1✔
57
58	throw new \InvalidArgumentException('Right unknown');	1✔
59	}
60
61	$userRight = $this->userRightRepository	2✔
62	->findOneBy([	2✔
63	'user_id' => $user->getId(),	2✔
64	'right_id' => $right->getId(),	2✔
65	])	2✔
66	;	2✔
67
68	if ($userRight === null)	2✔
69	{
70	$this->userRightRepository->create([	1✔
71	'user_id' => $user->getId(),	1✔
72	'right_id' => $right->getId(),	1✔
73	]);	1✔
74	}
75	}
76
77	/**
78	* Delete a right from a user.
79	*
80	* @param User $user The user to remove the right from
81	* @param string $shortName The short name of the right to remove
82	*
83	* @throws \InvalidArgumentException If the right is unknown
84	*/
85	public function deleteRight(User $user, string $shortName): void	3✔
86	{
87	$this->logger->info('Deleting right from user', ['user_id' => $user->getId(), 'short_name' => $shortName]);	3✔
88
89	$right = $this->rightRepository->getRightByShortName($shortName);	3✔
90
91	if ($right === null)	3✔
92	{
93	$this->logger->error('Cannot delete unknown right from user', ['user_id' => $user->getId(), 'short_name' => $shortName]);	1✔
94
95	throw new \InvalidArgumentException('Right unknown');	1✔
96	}
97
98	$userRight = $this->userRightRepository->findOneBy([	2✔
99	'user_id' => $user->getId(),	2✔
100	'right_id' => $right->getId(),	2✔
101	]);	2✔
102
103	if ($userRight === null)	2✔
104	{
105	return;	1✔
106	}
107
108	$this->userRightRepository->delete($userRight);	1✔
109	}
110
111	/**
112	* Check if a user has a specific right.
113	*
114	* @param User $user The user to check
115	* @param string $shortName The short name of the right to check for
116	*
117	* @return bool True if the user has the right, false otherwise
118	*/
119	public function hasRight(User $user, string $shortName): bool	3✔
120	{
121	$right = $this->rightRepository->getRightByShortName($shortName);	3✔
122
123	if ($right === null)	3✔
124	{
125	return false;	1✔
126	}
127
128	$userRight = $this->userRightRepository->findOneBy([	2✔
129	'user_id' => $user->getId(),	2✔
130	'right_id' => $right->getId(),	2✔
131	]);	2✔
132
133	return ($userRight !== null);	2✔
134	}
135
136	/**
137	* Get all rights for a user.
138	*
139	* @param User $user The user to get rights for
140	*
141	* @return array<string> An array of right short names
142	*/
UNCOV 143	public function getRights(User $user): array	×
144	{
145	$query = <<<'SQL'	×
146	SELECT short_name
147	FROM rights AS r,
148	user_rights AS ur
149	WHERE ur.user_id = ? AND
150	ur.right_id = r.id
151	ORDER BY r.short_name
UNCOV 152	SQL;	×
153
UNCOV 154	$params = [$user->getId()];	×
155
UNCOV 156	$result = $this->database->query($query, $params, 'Failed to retrieve rights');	×
157
158	$data = [];	×
159
UNCOV 160	foreach ($result as $row)	×
161	{
UNCOV 162	$data[] = $row['short_name'];	×
163	}
164
UNCOV 165	return $data;	×
166	}
167	}

avoutic / web-framework / 19992775795

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous