eZ\Publish\Core\MVC\Symfony\Security\UserWrapped

Complexity

Total Complexity

15

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__toString()	0	4	1
A	setAPIUser()	0	4	1
A	getAPIUser()	0	4	1
A	setWrappedUser()	0	10	3
A	getWrappedUser()	0	4	1
A	getRoles()	0	4	1
A	getPassword()	0	4	1
A	getSalt()	0	4	1
A	getUsername()	0	4	1
A	eraseCredentials()	0	4	1
A	isEqualTo()	0	4	2

<?php

/**
 * File containing the UserWrapped class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\MVC\Symfony\Security;

use eZ\Publish\API\Repository\Values\User\User as APIUser;
use Symfony\Component\Security\Core\User\EquatableInterface;
use Symfony\Component\Security\Core\User\UserInterface as CoreUserInterface;
use InvalidArgumentException;

/**
 * This class represents a UserWrapped object.
 *
 * It's used when working with multiple user providers
 *
 * It has two properties:
 *     - wrappedUser: containing the originally matched user.
 *     - apiUser: containing the API User (the one from the eZ Repository )
 */
class UserWrapped implements UserInterface, EquatableInterface
{
    /** @var \Symfony\Component\Security\Core\User\UserInterface */
    private $wrappedUser;

    /** @var \eZ\Publish\API\Repository\Values\User\User */
    private $apiUser;

    public function __construct(CoreUserInterface $wrappedUser, APIUser $apiUser)
    {
        $this->setWrappedUser($wrappedUser);
        $this->apiUser = $apiUser;
    }

    public function __toString()
    {
        return $this->wrappedUser->getUsername();
    }

    /**
     * @param \eZ\Publish\API\Repository\Values\User\User $apiUser
     */
    public function setAPIUser(APIUser $apiUser)
    {
        $this->apiUser = $apiUser;
    }

    /**
     * @return \eZ\Publish\API\Repository\Values\User\User
     */
    public function getAPIUser()
    {
        return $this->apiUser;
    }

    /**
     * @throws InvalidArgumentException If $wrappedUser is instance of self or User to avoid duplicated APIUser in session.
     *
     * @param \Symfony\Component\Security\Core\User\UserInterface $wrappedUser
     */
    public function setWrappedUser(CoreUserInterface $wrappedUser)
    {
        if ($wrappedUser instanceof self) {
            throw new InvalidArgumentException('Injecting UserWrapped to itself is not allowed to avoid recursion');
        } elseif ($wrappedUser instanceof User) {
            throw new InvalidArgumentException('Injecting User into UserWrapped causes duplication of APIUser, not wanted for session serialization');
        }

        $this->wrappedUser = $wrappedUser;
    }

    /**
     * @return \Symfony\Component\Security\Core\User\UserInterface
     */
    public function getWrappedUser()
    {
        return $this->wrappedUser;
    }

    public function getRoles()
    {
        return $this->wrappedUser->getRoles();
    }

    public function getPassword()
    {
        return $this->wrappedUser->getPassword();
    }

    public function getSalt()
    {
        return $this->wrappedUser->getSalt();
    }

    public function getUsername()
    {
        return $this->wrappedUser->getUsername();
    }

    public function eraseCredentials()
    {
        $this->wrappedUser->eraseCredentials();
    }

    public function isEqualTo(CoreUserInterface $user)
    {
        return $this->wrappedUser instanceof EquatableInterface ? $this->wrappedUser->isEqualTo($user) : true;
    }
}