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  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 141 142 143 144 145 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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 

<?php

/* --------------------------------------------------------------
    AdminAccessUser.inc.php 2018-01-22
    Gambio GmbH
    http://www.gambio.de
    Copyright (c) 2017 Gambio GmbH
    Released under the GNU General Public License (Version 2)
    [http://www.gnu.org/licenses/gpl-2.0.html]
    --------------------------------------------------------------
*/

/**
 * Class AdminAccessUser
 *
 * A User is a representation of an user with administration rights. Since all users are stored in
 * the customers table of the shop system, the term "customerId" is used to identify such an
 * user. Apart from the ID the user has a collection of roles.
 *
 * @category   System
 * @package    AdminAccess
 * @subpackage Entities
 */
class AdminAccessUser implements AdminAccessUserInterface
{
    /**
     * @var int
     */
    protected $customerId;
    
    /**
     * @var AdminAccessRoleCollection|AbstractCollection
     */
    protected $roles;
    
    /**
     * @var AdminAccessUserWriterInterface
     */
    protected $userWriter;
    
    /**
     * @var AdminAccessUserDeleterInterface
     */
    protected $userDeleter;
    
    /**
     * @var boolean
     */
    protected $readingUnknownGroupGranted;
    
    /**
     * @var boolean
     */
    protected $writingUnknownGroupGranted;
    
    /**
     * @var boolean
     */
    protected $deletingUnknownGroupGranted;
    
    
    /**
     * AdminAccessUser constructor.
     *
     * @param AdminAccessUserWriterInterface  $writer      User writer.
     * @param AdminAccessUserDeleterInterface $userDeleter User deleter.
     * @param IdType                          $customerId  User id.
     * @param AdminAccessRoleCollection       $roles       User roles collection.
     */
    public function __construct(AdminAccessUserWriterInterface $writer,
                                AdminAccessUserDeleterInterface $userDeleter,
                                IdType $customerId,
                                AdminAccessRoleCollection $roles)
    {
        $this->userWriter  = $writer;
        $this->userDeleter = $userDeleter;
        $this->customerId  = $customerId->asInt();
        $this->roles       = $roles;
    }
    
    
    /**
     * Returns the user id.
     *
     * @return int User ID.
     */
    public function getId()
    {
        return $this->customerId;
    }
    
    
    /**
     * Adds a role to this user.
     *
     * @param AdminAccessRoleInterface $role Role object.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     */
    public function addNewRole(AdminAccessRoleInterface $role)
    {
        $this->roles->add($role);
        
        return $this;
    }
    
    
    /**
     * Removes role from this user.
     *
     * @param AdminAccessRoleInterface $role Role object.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     *
     * @throws \RoleNotFoundInCollectionException
     */
    public function removeRole(AdminAccessRoleInterface $role)
    {
        $this->roles->remove($role);
        
        return $this;
    }
    
    
    /**
     * Checks deleting permission for a given group.
     *
     * @param AdminAccessGroupInterface $group Group object.
     *
     * @return bool True if deleting permission is granted, false otherwise.
     */
    public function checkDeletingPermission(AdminAccessGroupInterface $group)
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkDeletingPermission($group))
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Checks reading permission for a given group.
     *
     * @param AdminAccessGroupInterface $group Group object.
     *
     * @return bool True if reading permission is granted, false otherwise.
     */
    public function checkReadingPermission(AdminAccessGroupInterface $group)
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkReadingPermission($group))
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Checks writing permission for a given group.
     *
     * @param AdminAccessGroupInterface $group Group object.
     *
     * @return bool True if writing permission is granted, false otherwise.
     */
    public function checkWritingPermission(AdminAccessGroupInterface $group)
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkWritingPermission($group))
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Checks deleting permission for an unknown group.
     *
     * @return bool True if deleting permission for an unknown group is granted, false otherwise.
     */
    public function checkDeletingPermissionForUnknownGroup()
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkDeletingPermissionForUnknownGroup())
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Checks reading permission for an unknown group.
     *
     * @return bool True if reading permission for an unknown group is granted, false otherwise.
     */
    public function checkReadingPermissionForUnknownGroup()
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkReadingPermissionForUnknownGroup())
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Checks writing permission for an unknown group.
     *
     * @return bool True if writing permission for an unknown group is granted, false otherwise.
     */
    public function checkWritingPermissionForUnknownGroup()
    {
        /** @var AdminAccessRoleInterface $role */
        foreach($this->roles->getArray() as $role)
        {
            if($role->checkWritingPermissionForUnknownGroup())
            {
                return true;
            }
        }
        
        return false;
    }
    
    
    /**
     * Sets the customer ID.
     *
     * @param IdType $id Customer ID.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     */
    public function setCustomerId(IdType $id)
    {
        $this->customerId = $id->asInt();
        
        return $this;
    }
    
    
    /**
     * Sets the user roles.
     *
     * @param AdminAccessRoleCollection $roles Access roles collection.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     */
    public function setRoles(AdminAccessRoleCollection $roles)
    {
        $this->roles = $roles;
        
        return $this;
    }
    
    
    /**
     * Returns the user roles.
     *
     * @return AbstractCollection|AdminAccessRoleCollection Cloned roles collection.
     */
    public function getRoles()
    {
        return $this->roles->getClone();
    }
    
    
    /**
     * Stores/Updates an user into/from the database.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     */
    public function update()
    {
        $this->userWriter->store(new IdType($this->customerId), $this->roles);
        
        return $this;
    }
    
    
    /**
     * Deletes an user from the database.
     *
     * @return AdminAccessUserInterface Returns same instance for chained method calls.
     */
    public function delete()
    {
        $this->userDeleter->deleteById(new IdType($this->customerId));
        
        return $this;
    }
}