Borobudur\Http\Header\CacheControlHeader

Complexity

Total Complexity

45

Size/Duplication

Total Lines	425
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	3
A	setDirective()	0	15	2
A	setPublic()	0	8	2
A	isPrivate()	0	4	1
A	setAutoPrivilege()	0	12	3
A	isHasPrivileges()	0	4	2
A	hasDirective()	0	4	1
A	removeDirective()	0	6	1
A	set()	0	11	2
A	setPrivate()	0	8	2
A	isPublic()	0	4	1
A	setMaxAge()	0	4	1
A	setSharedMaxAge()	0	4	1
A	fromString()	0	20	3
A	setNoCache()	0	4	1
A	isNoCache()	0	4	1
A	setNoStore()	0	4	1
A	isNoStored()	0	4	1
A	setProxyReValidate()	0	4	1
A	isProxyReValidate()	0	4	1
A	setMustReValidate()	0	4	1
A	isMustReValidate()	0	4	1
A	setNoTransform()	0	4	1
A	isNoTransform()	0	4	1
A	getMaxAge()	0	4	1
A	getDirective()	0	4	2
A	getSharedMaxAge()	0	4	1
A	allDirectives()	0	4	1
A	__toString()	0	4	1
A	getFieldName()	0	4	1
A	getFieldValue()	0	13	2
A	setDeltaSeconds()	0	6	1

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http\Header;

use Borobudur\Http\Header\Exception\InvalidHeaderValueException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     7/19/15
 */
class CacheControlHeader implements HeaderInterface
{
    /**
     * @var array
     */
    private $directives = array();
    
    /**
     * Constructor.
     *
     * @param array $directives
     */
    public function __construct(array $directives = array())
    {
        foreach ($directives as $key => $value) {
            if (is_int($key)) {
                $key = $value;
                $value = null;
            }

            $this->setDirective($key, $value);
        }
    }
    
    /**
     * Add cache directive, some directive don't have any value.
     * Example: no-store, must-revalidate, etc.
     *
     * @param string      $key
     * @param string|null $value
     *
     * @return $this
     */
    public function setDirective($key, $value = null)
    {
        $maps = array(
            'public'   => 'setPublic',
            'private'  => 'setPrivate',
            'max-age'  => 'setMaxAge',
            's-maxage' => 'setSharedMaxAge',
        );

        if (isset($maps[$key])) {
            return $this->{$maps[$key]}($value);
        }

        return $this->set($key, $value);
    }
    
    /**
     * Set cache as public.
     *
     * @return $this
     */
    public function setPublic()
    {
        if ($this->isPrivate()) {
            $this->removeDirective('private');
        }
        
        return $this->set('public');
    }
    
    /**
     * Check if cache private.
     *
     * @return bool
     */
    public function isPrivate()
    {
        return $this->hasDirective('private');
    }

    /**
     * Set auto privilege.
     *
     * @return $this
     */
    public function setAutoPrivilege()
    {
        if ($this->isHasPrivileges()) {
            return $this;
        }

        if (null === $this->getSharedMaxAge()) {
            return $this->setPrivate();
        }

        return $this->setPublic();
    }

    /**
     * Check if cache has privileges directive.
     *
     * @return bool
     */
    public function isHasPrivileges()
    {
        return $this->isPublic() || $this->isPrivate();
    }
    
    /**
     * Check if directive exist.
     *
     * @param string $key
     *
     * @return bool Return true if directive exist, false otherwise
     */
    public function hasDirective($key)
    {
        return array_key_exists($key, $this->directives);
    }
    
    /**
     * Remove directive by key.
     *
     * @param string $key
     *
     * @return $this
     */
    public function removeDirective($key)
    {
        unset($this->directives[$key]);
        
        return $this;
    }
    
    /**
     * Set directive.
     *
     * @param string      $key
     * @param string|null $value
     *
     * @return $this
     *
     * @throws InvalidHeaderValueException
     */
    private function set($key, $value = null)
    {
        GenericHeader::assertHeaderValue($key);
        if (null !== $value) {
            GenericHeader::assertHeaderValue($value);
        }
        
        $this->directives[$key] = $value;
        
        return $this;
    }
    
    /**
     * Set cache as private.
     *
     * @param string|null $value
     *
     * @return $this
     */
    public function setPrivate($value = null)
    {
        if ($this->isPublic()) {
            $this->removeDirective('public');
        }
        
        return $this->set('private', $value);
    }
    
    /**
     * Check if cache is public.
     *
     * @return bool
     */
    public function isPublic()
    {
        return $this->hasDirective('public');
    }
    
    /**
     * Set cache max-age.
     *
     * @param int $deltaSeconds
     *
     * @return $this
     */
    public function setMaxAge($deltaSeconds)
    {
        return $this->setDeltaSeconds('max-age', $deltaSeconds);
    }
    
    /**
     * Set shared max age.
     *
     * @param int $deltaSeconds
     *
     * @return $this
     */
    public function setSharedMaxAge($deltaSeconds)
    {
        return $this->setDeltaSeconds('s-maxage', $deltaSeconds);
    }
    
    /**
     * Factory create CacheControlHeader from string representation.
     *
     * @param string $headerLine
     *
     * @return $this
     */
    public static function fromString($headerLine)
    {
        list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($headerLine);
        GenericHeader::assertHeaderFieldName('Cache-Control', $fieldName);
        preg_match_all('#((("[^"\']++")|(\'[^"\']++\'))|[^,"\'])+#', $fieldValue, $matches);
        $directives = array();

        foreach ($matches[0] as $item) {
            $pos = strpos($item, '=');

            if (false === $pos) {
                $directives[$item] = null;
                continue;
            }
            
            $directives[substr($item, 0, $pos)] = substr($item, $pos + 1);
        }
        
        return new static($directives);
    }
    
    /**
     * Add no-cache directive.
     *
     * @param string|null $value
     *
     * @return $this
     */
    public function setNoCache($value = null)
    {
        return $this->set('no-cache', $value);
    }
    
    /**
     * Check if no cached.
     *
     * @return bool
     */
    public function isNoCache()
    {
        return $this->hasDirective('no-cache');
    }
    
    /**
     * Add no-store directive.
     *
     * @return $this
     */
    public function setNoStore()
    {
        return $this->set('no-store');
    }
    
    /**
     * Check if no stored.
     *
     * @return bool
     */
    public function isNoStored()
    {
        return $this->hasDirective('no-store');
    }
    
    /**
     * Set proxy-revalidate.
     *
     * @return $this
     */
    public function setProxyReValidate()
    {
        return $this->set('proxy-revalidate');
    }
    
    /**
     * Check is proxy-revalidate.
     *
     * @return bool
     */
    public function isProxyReValidate()
    {
        return $this->hasDirective('proxy-revalidate');
    }
    
    /**
     * Cache should re-validate.
     *
     * @return $this
     */
    public function setMustReValidate()
    {
        return $this->set('must-revalidate');
    }
    
    /**
     * Check if cache must re-validate.
     *
     * @return bool
     */
    public function isMustReValidate()
    {
        return $this->hasDirective('must-revalidate');
    }
    
    /**
     * Set no-transform.
     *
     * @return $this
     */
    public function setNoTransform()
    {
        return $this->set('no-transform');
    }
    
    /**
     * Check if cache is no-transform.
     *
     * @return bool
     */
    public function isNoTransform()
    {
        return $this->hasDirective('no-transform');
    }
    
    /**
     * Get max-age.
     *
     * @return int|null
     */
    public function getMaxAge()
    {
        return $this->getDirective('max-age');
    }
    
    /**
     * Get directive by key.
     *
     * @param string $key
     *
     * @return string|null
     */
    public function getDirective($key)
    {
        return $this->hasDirective($key) ? $this->directives[$key] : null;
    }
    
    /**
     * Get shared max age.
     *
     * @return int|null
     */
    public function getSharedMaxAge()
    {
        return $this->getDirective('s-maxage');
    }
    
    /**
     * Get all directives.
     *
     * @return array
     */
    public function allDirectives()
    {
        return $this->directives;
    }
    
    /**
     * Cast header to string.
     *
     * @return string
     */
    public function __toString()
    {
        return sprintf('%s: %s', $this->getFieldName(), $this->getFieldValue());
    }
    
    /**
     * Get header field name.
     *
     * @return string
     */
    public function getFieldName()
    {
        return 'Cache-Control';
    }
    
    /**
     * Get header field value.
     *
     * @return mixed
     */
    public function getFieldValue()
    {
        ksort($this->directives);
        
        return implode(',', array_map(function ($key, $value = null) {
            
            if (null === $value) {
                return $key;
            }
            
            return $key . '=' . $value;
        }, array_keys($this->directives), $this->directives));
    }

    /**
     * Set delta second to specified key.
     *
     * @param string $key
     * @param int    $deltaSeconds
     *
     * @return $this
     */
    private function setDeltaSeconds($key, $deltaSeconds)
    {
        $this->set($key, GenericHeader::computeDeltaSeconds($deltaSeconds));

        return $this;
    }
}