suda\framework\http\Cookie

Complexity

Total Complexity

29

Size/Duplication

Total Lines	327
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	setSameSite()	0	3	1
A	jsonSerialize()	0	5	1
A	isSameSite()	0	3	1
A	isFullTime()	0	3	1
A	getName()	0	3	1
A	session()	0	4	1
A	__construct()	0	5	1
A	send()	0	3	1
A	isHttpOnly()	0	3	1
A	isSecure()	0	3	1
A	getPath()	0	3	1
A	full()	0	4	1
B	__toString()	0	30	8
A	secure()	0	4	1
A	expire()	0	4	1
A	path()	0	4	1
A	getValue()	0	3	1
A	httpOnly()	0	4	1
A	domain()	0	4	1
A	getExpire()	0	3	1
A	isSession()	0	3	1
A	getDomain()	0	3	1

<?php

namespace suda\framework\http;

use DateTime;
use DateTimeZone;
use JsonSerializable;

/**
 * Class Cookie
 * @package suda\framework\http
 */
class Cookie implements JsonSerializable
{
    /**
     * 名称
     *
     * @var string
     */
    protected $name;

    /**
     * 值
     *
     * @var string
     */
    protected $value;

    /**
     * 设置 HttpOnly
     *
     * @var boolean
     */
    protected $httpOnly = false;

    /**
     * Cookie Path
     *
     * @var string
     */
    protected $path = '/';

    /**
     * 设置域
     *
     * @var string|null
     */
    protected $domain = null;

    /**
     * 设置过期时间
     *
     * @var int
     */
    protected $expire = 0;

    /**
     * 是否使用HTTPS
     *
     * @var boolean
     */
    protected $secure = false;

    /**
     * 会话过期时间
     *
     * @var boolean
     */
    protected $session = false;

    /**
     * @var bool
     */
    private $fullTime = true;


    /**
     * @var bool
     */
    private $sameSite = false;

    /**
     * Cookie constructor.
     * @param string $name
     * @param string $value
     * @param int $expire
     */
    public function __construct(string $name, string $value, int $expire = 0)
    {
        $this->name = $name;
        $this->value = $value;
        $this->expire = $expire;
    }

    /**
     * 设置 HTTP Only
     *
     * @param boolean $set
     * @return $this
     */
    public function httpOnly(bool $set = true)
    {
        $this->httpOnly = $set;
        return $this;
    }

    /**
     * 时长全部
     *
     * @param boolean $set
     * @return $this
     */
    public function full(bool $set = true)
    {
        $this->fullTime = $set;
        return $this;
    }

    /**
     * 设置安全模式
     *
     * @param boolean $set
     * @return $this
     */
    public function secure(bool $set = true)
    {
        $this->secure = $set;
        return $this;
    }

    /**
     * 设置路径
     *
     * @param string $set
     * @return $this
     */
    public function path(string $set = '/')
    {
        $this->path = $set;
        return $this;
    }

    /**
     * 设置过期时间
     *
     * @param integer $time
     * @return $this
     */
    public function expire(int $time = 1440)
    {
        $this->expire = $time;
        return $this;
    }

    /**
     * 设置cookie域
     *
     * @param string $set
     * @return $this
     *
     */
    public function domain(string $set)
    {
        $this->domain = $set;
        return $this;
    }

    /**
     * 获取值
     *
     * @return mixed
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the value of name
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get 设置 HttpOnly
     *
     * @return  boolean
     */
    public function isHttpOnly(): bool
    {
        return $this->httpOnly;
    }

    /**
     * Get 设置域
     *
     * @return  string|null
     */
    public function getDomain()
    {
        return $this->domain;
    }

    /**
     * Get cookie Path
     *
     * @return  string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Get 设置过期时间
     *
     * @return  int
     */
    public function getExpire()
    {
        return $this->expire;
    }

    /**
     * Get 是否使用HTTPS
     *
     * @return  boolean
     */
    public function isSecure(): bool
    {
        return $this->secure;
    }

    /**
     * Get 会话过期时间
     *
     * @return  boolean
     */
    public function isSession(): bool
    {
        return $this->session;
    }

    /**
     * Get the value of fulltime
     */
    public function isFullTime(): bool
    {
        return $this->fullTime;
    }

    /**
     * 设置Session
     *
     * @param boolean $session
     * @return $this
     */
    public function session(bool $session = true)
    {
        $this->session = $session;
        return $this;
    }

    /**
     * 发送COOKIE
     *
     * @param Response $response
     * @return void
     */
    public function send(Response $response)
    {
        $response->header('Set-Cookie', $this);
    }

    /**
     * @return bool
     */
    public function isSameSite(): bool
    {
        return $this->sameSite;
    }

    /**
     * @param bool $sameSite
     */
    public function setSameSite(bool $sameSite): void
    {
        $this->sameSite = $sameSite;
    }


    /**
     * 发送文本
     *
     * @return string
     */

    public function __toString()
    {
        $cookie = sprintf('%s=%s', $this->name, $this->value);

        if ($this->expire !== 0) {
            $time = $this->fullTime ? $this->expire : time() + $this->expire;
            $dateTime = DateTime::createFromFormat('U', $time, new DateTimeZone('GMT'));
            $cookie .= '; Expires=' . str_replace('+0000', '', $dateTime->format('D, d M Y H:i:s T'));
        }

        if ($this->domain !== null) {
            $cookie .= '; Domain=' . $this->domain;
        }

        if ($this->path) {
            $cookie .= '; Path=' . $this->path;
        }

        if ($this->secure) {
            $cookie .= '; Secure';
        }

        if ($this->httpOnly) {
            $cookie .= '; HttpOnly';
        }

        if ($this->sameSite) {
            $cookie .= '; SameSite=Strict';
        }
        return $cookie;
    }

    /**
     * @return array|mixed
     */
    public function jsonSerialize()
    {
        return [
            'name' => $this->name,
            'value' => $this->value,
        ];
    }
}