Role
5 years ago
CapabilitiesProvider.php
5 years ago
Capability.php
5 years ago
Role.php
5 years ago
RolesProvider.php
5 years ago
RolesProvider.php
67 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | * |
| 8 | */ |
| 9 | namespace Piwik\Access; |
| 10 | |
| 11 | use Piwik\Access\Role\Admin; |
| 12 | use Piwik\Access\Role\View; |
| 13 | use Piwik\Access\Role\Write; |
| 14 | use Piwik\Piwik; |
| 15 | use Exception; |
| 16 | |
| 17 | class RolesProvider |
| 18 | { |
| 19 | /** |
| 20 | * @return Role[] |
| 21 | */ |
| 22 | public function getAllRoles(): array |
| 23 | { |
| 24 | return array( |
| 25 | new View(), |
| 26 | new Write(), |
| 27 | new Admin() |
| 28 | ); |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * Returns the list of the existing Access level. |
| 33 | * Useful when a given API method requests a given access Level. |
| 34 | * We first check that the required access level exists. |
| 35 | * |
| 36 | * @return string[] |
| 37 | */ |
| 38 | public function getAllRoleIds(): array |
| 39 | { |
| 40 | $ids = array(); |
| 41 | foreach ($this->getAllRoles() as $role) { |
| 42 | $ids[] = $role->getId(); |
| 43 | } |
| 44 | return $ids; |
| 45 | } |
| 46 | |
| 47 | public function isValidRole(string $roleId): bool |
| 48 | { |
| 49 | $roles = $this->getAllRoleIds(); |
| 50 | |
| 51 | return \in_array($roleId, $roles, true); |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * @param $roleId |
| 56 | * @throws Exception |
| 57 | */ |
| 58 | public function checkValidRole(string $roleId): void |
| 59 | { |
| 60 | if (!$this->isValidRole($roleId)) { |
| 61 | $roles = $this->getAllRoleIds(); |
| 62 | throw new Exception(Piwik::translate("UsersManager_ExceptionAccessValues", implode(", ", $roles))); |
| 63 | } |
| 64 | } |
| 65 | |
| 66 | } |
| 67 |