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

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	addInformation()	0	5	1
A	setInformation()	0	5	1
A	replaceInformation()	0	5	1
A	getInformation()	0	4	1
A	resetHash()	0	4	1
A	getHash()	0	13	3

<?php

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

/**
 * Represents a user "identity", or footprint.
 * Instance can be transformed to a hash and used as an identity token.
 *
 * @deprecated since 5.4. Will be removed in 6.0. Use FOSHttpCacheBundle user context feature instead.
 */
class Identity implements IdentityInterface

The interface eZ\Publish\SPI\User\Identity has been deprecated with message: since 5.4. Will be removed in 6.0. Use FOSHttpCacheBundle user context feature instead.

{
    /**
     * @var array
     */
    protected $identityInfo;

    /**
     * @var string
     */
    protected $hash;

    public function __construct()
    {
        $this->identityInfo = [];
    }

    /**
     * Registers several pieces of information in the identity.
     *
     * @param array $information Hash where key is the information type and value is a scalar.
     */
    public function addInformation(array $information)
    {
        $this->identityInfo += $information;
        $this->resetHash();
    }

    /**
     * Registers an information in the identity.
     *
     * @param string $informationName
     * @param scalar $informationValue
     */
    public function setInformation($informationName, $informationValue)
    {
        $this->identityInfo[$informationName] = $informationValue;
        $this->resetHash();
    }

    /**
     * Replaces the information already registered in the identity.
     *
     * @param array $information Hash where key is the information type and value is a scalar.
     */
    public function replaceInformation(array $information)
    {
        $this->identityInfo = $information;
        $this->resetHash();
    }

    /**
     * Returns registered information.
     *
     * @return array
     */
    public function getInformation()
    {
        return $this->identityInfo;
    }

    /**
     * Resets current hash.
     */
    protected function resetHash()
    {
        $this->hash = null;
    }

    /**
     * Returns the hash of the current identity (e.g. md5, sha1...).
     *
     * @return string
     */
    public function getHash()
    {
        if (!isset($this->hash)) {
            $hashArray = [];
            foreach ($this->identityInfo as $infoType => $infoValue) {
                $hashArray[] = "$infoType=$infoValue";
            }

            $this->hash = sha1(implode('-', $hashArray));
        }

        return $this->hash;
    }
}