eZ\Publish\Core\MVC\Symfony\Security\User\HashGenerator

Complexity

Total Complexity

7

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setIdentityDefiner()	0	4	1
A	getIdentityDefiners()	0	4	1
A	setIdentity()	0	4	1
A	getIdentity()	0	4	1
A	generate()	0	8	2
A	updateUserContext()	0	4	1

<?php

/**
 * File containing the user HashGenerator 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\User;

use eZ\Publish\SPI\HashGenerator as HashGeneratorInterface;
use eZ\Publish\SPI\User\Identity as IdentityInterface;
use eZ\Publish\SPI\User\IdentityAware;
use FOS\HttpCache\UserContext\ContextProviderInterface;
use FOS\HttpCache\UserContext\UserContext;

/**
 * User hash generator.
 *
 * @deprecated since 5.4. Will be removed in 6.0. Use FOSHttpCacheBundle user context feature instead.
 */
class HashGenerator implements HashGeneratorInterface, IdentityAware, ContextProviderInterface
{
    /**
     * @var IdentityInterface
     */
    protected $userIdentity;

    /**
     * @var IdentityAware[]
     */
    protected $identityDefiners = [];

    /**
     * @param IdentityAware $identityDefiner
     */
    public function setIdentityDefiner(IdentityAware $identityDefiner)
    {
        $this->identityDefiners[] = $identityDefiner;
    }

    /**
     * @return IdentityAware[]
     */
    public function getIdentityDefiners()
    {
        return $this->identityDefiners;
    }

    /**
     * @param IdentityInterface $identity
     */
    public function setIdentity(IdentityInterface $identity)
    {
        $this->userIdentity = $identity;
    }

    /**
     * @return IdentityInterface
     */
    public function getIdentity()
    {
        return $this->userIdentity;
    }

    /**
     * Generates the user hash.
     *
     * @return string
     */
    public function generate()
    {
        foreach ($this->getIdentityDefiners() as $identityDefiner) {
            $identityDefiner->setIdentity($this->userIdentity);
        }

        return $this->userIdentity->getHash();
    }

    public function updateUserContext(UserContext $context)
    {
        $context->addParameter('ezpublish_identity', $this->generate());
    }
}