RichanFongdasen\Varnishable\Concerns\ManageEtagHeader

Complexity

Total Complexity

5

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addEtagHeader()	0	9	3
A	disableEtag()	0	4	1
A	enableEtag()	0	4	1
	getConfig()	0	1	?
	setConfig()	0	1	?

<?php

namespace RichanFongdasen\Varnishable\Concerns;

use Symfony\Component\HttpFoundation\Response;

trait ManageEtagHeader
{
    /**
     * Add an ETag header to the current response.
     *
     * @param \Symfony\Component\HttpFoundation\Response $response
     *
     * @return void
     */
    protected function addEtagHeader(Response $response): void
    {
        $useEtag = (bool) $this->getConfig('use_etag');
        $content = $response->getContent();

        if (($content !== false) && $useEtag) {
            $response->setEtag(md5($content));
        }
    }

    /**
     * Disable Etag for current request.
     *
     * @return void
     */
    public function disableEtag(): void
    {
        $this->setConfig('use_etag', false);
    }

    /**
     * Enable Etag for current request.
     *
     * @return void
     */
    public function enableEtag(): void
    {
        $this->setConfig('use_etag', true);
    }

    /**
     * Get configuration value for a specific key.
     *
     * @param string $key
     *
     * @return mixed
     */
    abstract public function getConfig($key);

    /**
     * Set configuration value for a specific key.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @return void
     */
    abstract public function setConfig($key, $value): void;
}