Ubiquity\utils\http\UCookie

Complexity

Total Complexity

18

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

45.16%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	exists()	0	2	1
A	setRaw()	0	5	3
A	setTransformer()	0	3	1
A	get()	0	6	3
A	deleteAll()	0	3	2
A	delete()	0	5	2
A	getTransformerClass()	0	5	2
A	set()	0	5	4

<?php

namespace Ubiquity\utils\http;

use Ubiquity\contents\transformation\TransformerInterface;

/**
 * Http Cookies utilities
 * Ubiquity\utils\http$UCookie
 * This class is part of Ubiquity
 *
 * @author jcheron <myaddressmail@gmail.com>
 * @version 1.1.1
 *
 */
class UCookie {

	/**
	 *
	 * @var TransformerInterface
	 */
	private static $transformer;
	public static $useTransformer = false;

	/**
	 * Sends a cookie
	 *
	 * @param string $name the name of the cookie
	 * @param string $value The value of the cookie.
	 * @param int $duration default : 1 day
	 * @param string $path default : / the cookie will be available within the entire domain
	 * @param boolean $secure Indicates that the cookie should only be transmitted over asecure HTTPS
	 * @param boolean $httpOnly When true the cookie will be made accessible only through the HTTPprotocol
	 * @return boolean
	 */
	public static function set($name, $value, $duration = 60 * 60 * 24, $path = '/', $secure = false, $httpOnly = false): bool {
		if (self::$useTransformer && isset ( self::$transformer )) {
			$value = self::$transformer->transform ( $value );
		}
		return \setcookie ( $name, $value, $duration ? (\time () + $duration) : null, $path, $secure, $httpOnly );
	}

	/**
	 * Returns the Cookie with the name $name
	 *
	 * @param string $name
	 * @param string $default
	 * @return string|array|null
	 */
	public static function get($name, $default = null) {
		$v = $_COOKIE [$name] ?? $default;
		if (self::$useTransformer && isset ( self::$transformer )) {
			return self::$transformer->reverse ( $v );
		}
		return $v;
	}

	/**
	 * Removes the cookie with the name $name
	 *
	 * @param string $name
	 * @param string $path
	 */
	public static function delete($name, $path = '/'): bool {
		if (isset ( $_COOKIE [$name] )) {
			unset ( $_COOKIE [$name] );
		}
		return \setcookie ( $name, '', \time () - 3600, $path );
	}

	/**
	 * Deletes all cookies
	 */
	public static function deleteAll($path = '/'): void {
		foreach ( $_COOKIE as $name => $_ ) {
			self::delete ( $name, $path );
		}
	}

	/**
	 * Tests the existence of a cookie
	 *
	 * @param string $name
	 * @return boolean
	 * @since Ubiquity 2.0.11
	 */
	public static function exists($name): bool {
		return isset ( $_COOKIE [$name] );
	}

	/**
	 * Sends a raw cookie without urlencoding the cookie value
	 *
	 * @param string $name the name of the cookie
	 * @param string $value The value of the cookie.
	 * @param int $duration default : 1 day
	 * @param string $path default : / the cookie will be available within the entire domain
	 * @param boolean $secure Indicates that the cookie should only be transmitted over asecure HTTPS
	 * @param boolean $httpOnly When true the cookie will be made accessible only through the HTTPprotocol
	 * @return boolean
	 * @since Ubiquity 2.0.11
	 */
	public static function setRaw($name, $value, $duration = 60 * 60 * 24, $path = '/', $secure = false, $httpOnly = false): bool {
		if (self::$useTransformer && isset ( self::$transformer )) {
			$value = self::$transformer->transform ( $value );
		}
		return \setrawcookie ( $name, $value, \time () + $duration, $path, $secure, $httpOnly );
	}

	public static function setTransformer(TransformerInterface $transformer) {
		self::$transformer = $transformer;
		self::$useTransformer = true;
	}

	public static function getTransformerClass(): ?string {
		if (isset ( self::$transformer )) {
			return \get_class ( self::$transformer );
		}
		return null;
	}
}