1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 

<?php

/**
 * MvcCore
 *
 * This source file is subject to the BSD 3 License
 * For the full copyright and license information, please view
 * the LICENSE.md file that are distributed with this source code.
 *
 * @copyright   Copyright (c) 2016 Tom Flidr (https://github.com/mvccore)
 * @license  https://mvccore.github.io/docs/mvccore/5.0.0/LICENCE.md
 */

namespace MvcCore\Response;

trait Cookies {

    /**
     * @inheritDocs
     * @param string $name          Cookie name. Assuming the name is `cookiename`, this value is retrieved through `$_COOKIE['cookiename']`.
     * @param string $value         The value of the cookie. This value is stored on the clients computer; do not store sensitive information.
     * @param int    $lifetime      Life time in seconds to expire. 0 means "until the browser is closed".
     * @param string $path          The path on the server in which the cookie will be available on. If set to '/', the cookie will be available within the entire domain.
     * @param string $domain        If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->GetHostName();` .
     * @param bool   $secure        If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->IsSecure();`.
     * @param bool   $httpOnly      HTTP only cookie, `TRUE` by default.
     * @throws \RuntimeException    If HTTP headers have been sent.
     * @return bool                 True if cookie has been set.
     */
    public function SetCookie (
        $name, $value,
        $lifetime = 0, $path = '/',
        $domain = NULL, $secure = NULL, $httpOnly = TRUE
    ) {
        /** @var $this \MvcCore\Response */
        if ($this->IsSentHeaders())
            throw new \RuntimeException(
                "[".get_class()."] Cannot set cookie after HTTP headers have been sent."
            );
        $request = \MvcCore\Application::GetInstance()->GetRequest();
        $expires = $lifetime === 0 ? 0 : time() + $lifetime;
        $domain = ($domain === NULL ? $request->GetHostName() : (string) $domain);
        $secure = $secure === NULL ? $request->IsSecure() : $secure;
        if (PHP_VERSION_ID < 70300) {
            return \setcookie(
                $name, $value,
                $expires,
                $path,
                $domain . '; SameSite=Strict', // https://stackoverflow.com/questions/39750906/php-setcookie-samesite-strict
                $secure,
                $httpOnly
            );
        } else {
            return \setcookie(
                $name, $value, [
                    'expires'   => $expires,
                    'path'      => $path,
                    'domain'    => $domain,
                    'secure'    => $secure,
                    'httponly'  => $httpOnly,
                    'samesite'  => 'Strict',
                ]
            );
        }
    }

    /**
     * @inheritDocs
     * @param string $name          Cookie name. Assuming the name is `cookiename`, this value is retrieved through `$_COOKIE['cookiename']`.
     * @param string $path          The path on the server in which the cookie will be available on. If set to '/', the cookie will be available within the entire domain.
     * @param string $domain        If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->GetHostName();` .
     * @param bool   $secure        If not set, value is completed by `\MvcCore\Application::GetInstance()->GetRequest()->IsSecure();`.
     * @throws \RuntimeException    If HTTP headers have been sent.
     * @return bool                 True if cookie has been set.
     */
    public function DeleteCookie ($name, $path = '/', $domain = NULL, $secure = NULL) {
        /** @var $this \MvcCore\Response */
        return $this->SetCookie($name, '',  -3600, $path, $domain, $secure);
    }
}