AbstractRole.php 3.49 KB
Newer Older
Bertrand Gauthier's avatar
Bertrand Gauthier committed
1 2 3 4 5 6 7 8 9 10 11
<?php

namespace UnicaenAuth\Entity\Db;

use Doctrine\ORM\Mapping as ORM;

/**
 * Role entity abstract mother class.
 *
 * @ORM\MappedSuperclass
 */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
12
abstract class AbstractRole implements RoleInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
{
    /**
     * @var int
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @var string
     * @ORM\Column(name="role_id", type="string", length=255, unique=true, nullable=false)
     */
    protected $roleId;

    /**
     * @var boolean
     * @ORM\Column(name="is_default", type="boolean", nullable=true)
     */
    protected $isDefault = false;

    /**
     * @var Role
     * @ORM\ManyToOne(targetEntity="Role")
     */
    protected $parent;

    /**
     * @var string
     * @ORM\Column(name="ldap_filter", type="string", length=255, unique=true, nullable=true)
     */
    protected $ldapFilter;

    /**
     * @var \Doctrine\Common\Collections\Collection
     * @ORM\ManyToMany(targetEntity="UnicaenAuth\Entity\Db\User")
     * @ORM\JoinTable(name="user_role_linker",
     *      joinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="role_id", referencedColumnName="id")}
     * )
     */
    protected $users;

    /**
     * Get the id.
     *
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set the id.
     *
     * @param int $id
     *
     * @return self
     */
    public function setId($id)
    {
        $this->id = (int)$id;

        return $this;
    }

    /**
     * Get the role id.
     *
     * @return string
     */
    public function getRoleId()
    {
        return $this->roleId;
    }

    /**
     * Set the role id.
     *
     * @param string $roleId
     *
     * @return self
     */
    public function setRoleId($roleId)
    {
        $this->roleId = (string)$roleId;

        return $this;
    }

    /**
     * Is this role the default one ?
     *
     * @return boolean
     */
    public function getIsDefault()
    {
        return $this->isDefault;
    }

    /**
     * Set this role as the default one.
     *
     * @param boolean $isDefault
     *
     * @return self
     */
    public function setIsDefault($isDefault)
    {
        $this->isDefault = (boolean)$isDefault;

        return $this;
    }

    /**
     * Get the parent role
     *
     * @return Role
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Set the parent role.
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
141
     * @param RoleInterface $parent
Bertrand Gauthier's avatar
Bertrand Gauthier committed
142 143 144
     *
     * @return self
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
145
    public function setParent(RoleInterface $parent = null)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * @return string
     */
    public function getLdapFilter()
    {
        return $this->ldapFilter;
    }

    /**
     * @param string $ldapFilter
     *
     * @return Role
     */
    public function setLdapFilter($ldapFilter)
    {
        $this->ldapFilter = $ldapFilter;

        return $this;
    }

    /**
     * Get users.
     *
     * @return array
     */
    public function getUsers()
    {
        return $this->users->getValues();
    }

    /**
     * Add a user to the role.
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
185
     * @param UserInterface $user
Bertrand Gauthier's avatar
Bertrand Gauthier committed
186 187 188
     *
     * @return void
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
189
    public function addUser(UserInterface $user)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
190 191 192 193 194 195 196 197 198 199 200 201 202
    {
        $this->users[] = $user;
    }

    /**
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getRoleId();
    }
}