Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
Username
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 2
20
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getPermissions
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
1<?php
2
3/**
4 * Username permission provider for VuFind.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2007.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Authorization
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org Main Page
28 */
29
30namespace VuFind\Role\PermissionProvider;
31
32use LmcRbacMvc\Service\AuthorizationService;
33
34use function in_array;
35
36/**
37 * Username permission provider for VuFind.
38 *
39 * @category VuFind
40 * @package  Authorization
41 * @author   Demian Katz <demian.katz@villanova.edu>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org Main Page
44 */
45class Username implements PermissionProviderInterface
46{
47    /**
48     * Authorization object
49     *
50     * @var AuthorizationService
51     */
52    protected $auth;
53
54    /**
55     * Constructor
56     *
57     * @param AuthorizationService $authorization Authorization service
58     */
59    public function __construct(AuthorizationService $authorization)
60    {
61        $this->auth = $authorization;
62    }
63
64    /**
65     * Return an array of roles which may be granted the permission based on
66     * the options.
67     *
68     * @param mixed $options Options provided from configuration.
69     *
70     * @return array
71     */
72    public function getPermissions($options)
73    {
74        // If no user is logged in, or the user doesn't match the passed-in
75        // filter, we can't grant the permission to any roles.
76        $user = $this->auth->getIdentity();
77        if (!$user || !in_array($user->username, (array)$options)) {
78            return [];
79        }
80
81        // If we got this far, we can grant the permission to the loggedin role.
82        return ['loggedin'];
83    }
84}