summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Authentication/UserGroup/UserGroupBackendInterface.php
blob: cc9438fa4cb6d19ec6ea7912faedda0a557d0410 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Authentication\UserGroup;

use Icinga\User;

/**
 * Interface for user group backends
 */
interface UserGroupBackendInterface
{
    /**
     * Set this backend's name
     *
     * @param   string  $name
     *
     * @return  $this
     */
    public function setName($name);

    /**
     * Return this backend's name
     *
     * @return  string
     */
    public function getName();

    /**
     * Return the groups the given user is a member of
     *
     * @param   User    $user
     *
     * @return  array
     */
    public function getMemberships(User $user);

    /**
     * Return the name of the backend that is providing the given user
     *
     * @param   string  $username
     *
     * @return  null|string     The name of the backend or null in case this information is not available
     */
    public function getUserBackendName($username);

    /**
     * Return this backend's configuration form class path
     *
     * This is not part of the interface to not break existing implementations.
     * If you need a custom backend form, implement this method.
     *
     * @return string
     */
    //public static function getConfigurationFormClass();
}