FOS\HttpCache\UserContext\DefaultHashGenerator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	registerProvider()	0	4	1
A	__construct()	0	10	3
A	generateHash()	0	15	2

<?php

/*
 * This file is part of the FOSHttpCache package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCache\UserContext;

use FOS\HttpCache\Exception\InvalidArgumentException;

/**
 * Generate a hash for a UserContext by getting all the parameters needed across all registered services.
 */
class DefaultHashGenerator
{
    /**
     * @var ContextProvider[]
     */
    private $providers = [];

    /**
     * Constructor.
     *
     * @param ContextProvider[] $providers
     *
     * @throws InvalidArgumentException If no providers are supplied
     */
    public function __construct(array $providers)
    {
        if (0 === count($providers)) {
            throw new InvalidArgumentException('You must supply at least one provider');
        }

        foreach ($providers as $provider) {
            $this->registerProvider($provider);
        }
    }

    /**
     * Collect UserContext parameters and generate a hash from that.
     *
     * @return string The hash generated
     */
    public function generateHash()
    {
        $userContext = new UserContext();

        foreach ($this->providers as $provider) {
            $provider->updateUserContext($userContext);
        }

        $parameters = $userContext->getParameters();

        // Sort by key (alphanumeric), as order should not make hash vary
        ksort($parameters);

        return hash('sha256', serialize($parameters));
    }

    /**
     * Register a provider to be called for updating a UserContext before generating the Hash.
     *
     * @param ContextProvider $provider A context provider to be called to get context information about the current request
     */
    private function registerProvider(ContextProvider $provider)
    {
        $this->providers[] = $provider;
    }
}