Syscodes\Components\Http\ResponseHeaders

Complexity

Total Complexity

26

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	initDate()	0	3	1
A	all()	0	15	4
A	getCookies()	0	23	6
A	__construct()	0	10	3
A	allPreserveCaseWithoutCookies()	0	9	2
A	replace()	0	12	3
A	allPreserveCase()	0	9	2
A	setCookie()	0	6	1
A	set()	0	21	4

<?php

/**
 * Lenevor Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file license.md.
 * It is also available through the world-wide-web at this URL:
 * https://lenevor.com/license
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@Lenevor.com so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2023 Alexander Campo <jalexcam@gmail.com>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Components\Http;

use InvalidArgumentException;
use Syscodes\Components\Http\Loaders\Headers;

/**
 * ResponseHeaders is a container for Response HTTP headers.
 */
class ResponseHeaders extends Headers
{
	const COOKIE_FLAT = 'flat';
	const COOKIE_ARRAY = 'array';
	
	/**
	 * The list of cookies.
	 * 
	 * @var array $cookies
	 */
	protected $cookies = [];

    /**
     * The header names.
	 * 
	 * @var array $headerNames 
     */
	protected $headerNames = [];

	/**
	 * Constructor. Create a new ResponseHeaders class instance.
	 * 
	 * @param  array  $headers
	 * 
	 * @return void 
	 */
	public function __construct(array $headers = [])
	{
		parent::__construct($headers);
		
		if ( ! isset($this->headers['cache-control'])) {
			$this->set('Cache-Control', '');
		}

		if ( ! isset($this->headers['date'])) {
			$this->initDate();
		}
	}

	/**
	 * Returns the headers, without cookies.
	 * 
	 * @return mixed
	 */
	public function allPreserveCaseWithoutCookies()
	{
		$headers = $this->allPreserveCase();
		
		if (isset($this->headerNames['set-cookie'])) {
			unset($headers[$this->headerNames['set-cookie']]);
		}
		
		return $headers;
	}

    /**
	 * Returns the headers, with original capitalizations.
	 * 
	 * @return array An array of headers
	 */
	public function allPreserveCase(): array
	{
		$headers = [];
		
		foreach ($this->all() as $name => $value) {
			$headers[$this->headerNames[$name] ?? $name] = $value;
		}
		
		return $headers;
	}
	
	/**
	 * Returns all the headers.
	 * 
	 * @param  string|null  $key  The name of the headers
	 * 
	 * @return array
	 */
	public function all(string $key = null): array
	{
		$headers = parent::all();
		
		if (null !== $key) {
			$key = strtr($key, self::STRING_UPPER, self::STRING_LOWER);
			
			return 'set-cookie' !== $key ? $headers[$key] ?? [] : array_map('strval', $this->getCookies());
		}
		
		foreach ($this->getCookies() as $cookie) {
			$headers['set-cookie'][] = (string) $cookie;
		}
		
		return $headers;
	}

	/**
	 * Replaces the current HTTP headers by a new set.
	 * 
	 * @param  array  $headers
	 * 
	 * @return void
	 */
	public function replace(array $headers = []): void
	{
		$this->headerNames = [];

		parent::replace($headers);

		if ( ! isset($this->headers['cache-control'])) {
			$this->set('Cache-Control', '');
		}
		
		if ( ! isset($this->headers['date'])) {
			$this->initDate();
		}
	}

	/**
	 * Sets a header by name.
	 * 
	 * @param  string  $key  The header name
	 * @param  string|string[]|null  $values  The value or an array of values
	 * @param  bool  $replace  If you want to replace the value exists by the header, 
	 * 					       it is not overwritten / overwritten when it is false
	 *
	 * @return void
	 */
	public function set(string $key, $values, bool $replace = true): void
	{
		$unique = strtr($key, self::STRING_UPPER, self::STRING_LOWER); 
		
		if ('set-cookie' === $unique) {
			if ($replace) {
				$this->cookies = [];
			}
			
			foreach ((array) $values as $cookie) {
				$this->setCookie($cookie);

$cookie of type string is incompatible with the type Syscodes\Components\Http\Cookie expected by parameter $cookie of Syscodes\Components\Http\ResponseHeaders::setCookie().

			}
			
			$this->headerNames[$unique] = $key;

			return;
		}
		
		$this->headerNames[$unique] = $key;
		
		parent::set($key, $values, $replace);
	}
	
	/**
	 * Gets an array with all cookies.
	 * 
	 * @param  string  $format
	 * 
	 * @return Cookie[]
	 * 
	 * @throws \InvalidArgumentException
	 */
	public function getCookies(string $format = self::COOKIE_FLAT): array
	{
		if ( ! in_array($format, [self::COOKIE_FLAT, self::COOKIE_ARRAY])) {
			throw new InvalidArgumentException(
				sprintf('Format "%s" invalid (%s)', $format, implode(', ', [self::COOKIE_FLAT, self::COOKIE_ARRAY])
			));
		}
		
		if (self::COOKIE_ARRAY === $format) {
			return $this->cookies;
		}
		
		$stringCookies = [];

		foreach ($this->cookies as $path) {
			foreach ($path as $cookies) {
				foreach ($cookies as $cookie) {
					$stringCookies[] = $cookie;
				}
			}
		}
		
		return $stringCookies;
    }

	/**
	 * Sets the cookie.
	 * 
	 * @param  \Syscodes\Components\Http\Cookie  $cookie
	 * 
	 * @return static
	 */
	public function setCookie(Cookie $cookie): static
	{
		$this->cookies[$cookie->getDomain()][$cookie->getPath()][$cookie->getName()] = $cookie;
		$this->headerNames['set-cookie'] = 'Set-Cookie';

		return $this;
	}

	/**
	 * Initialize the date.
	 * 
	 * @return void
	 */
	private function initDate(): void
	{
		$this->set('Date', gmdate('D, d M Y H:i:s').' GMT');
	}
}