Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/vendor/cakephp/cakephp/src/Http/Cookie/ |
Upload File : |
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.5.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Cookie;
/**
* Cookie Interface
*/
interface CookieInterface
{
/**
* Expires attribute format.
*
* @var string
*/
const EXPIRES_FORMAT = 'D, d-M-Y H:i:s T';
/**
* Sets the cookie name
*
* @param string $name Name of the cookie
* @return static
*/
public function withName($name);
/**
* Gets the cookie name
*
* @return string
*/
public function getName();
/**
* Gets the cookie value
*
* @return string|array
*/
public function getValue();
/**
* Gets the cookie value as a string.
*
* This will collapse any complex data in the cookie with json_encode()
*
* @return string
*/
public function getStringValue();
/**
* Create a cookie with an updated value.
*
* @param string|array $value Value of the cookie to set
* @return static
*/
public function withValue($value);
/**
* Get the id for a cookie
*
* Cookies are unique across name, domain, path tuples.
*
* @return string
*/
public function getId();
/**
* Get the path attribute.
*
* @return string
*/
public function getPath();
/**
* Create a new cookie with an updated path
*
* @param string $path Sets the path
* @return static
*/
public function withPath($path);
/**
* Get the domain attribute.
*
* @return string
*/
public function getDomain();
/**
* Create a cookie with an updated domain
*
* @param string $domain Domain to set
* @return static
*/
public function withDomain($domain);
/**
* Get the current expiry time
*
* @return \DateTime|\DateTimeImmutable|null Timestamp of expiry or null
*/
public function getExpiry();
/**
* Get the timestamp from the expiration time
*
* Timestamps are strings as large timestamps can overflow MAX_INT
* in 32bit systems.
*
* @return string|null The expiry time as a string timestamp.
*/
public function getExpiresTimestamp();
/**
* Builds the expiration value part of the header string
*
* @return string
*/
public function getFormattedExpires();
/**
* Create a cookie with an updated expiration date
*
* @param \DateTime|\DateTimeImmutable $dateTime Date time object
* @return static
*/
public function withExpiry($dateTime);
/**
* Create a new cookie that will virtually never expire.
*
* @return static
*/
public function withNeverExpire();
/**
* Create a new cookie that will expire/delete the cookie from the browser.
*
* This is done by setting the expiration time to 1 year ago
*
* @return static
*/
public function withExpired();
/**
* Check if a cookie is expired when compared to $time
*
* Cookies without an expiration date always return false.
*
* @param \DateTime|\DateTimeImmutable $time The time to test against. Defaults to 'now' in UTC.
* @return bool
*/
public function isExpired($time = null);
/**
* Check if the cookie is HTTP only
*
* @return bool
*/
public function isHttpOnly();
/**
* Create a cookie with HTTP Only updated
*
* @param bool $httpOnly HTTP Only
* @return static
*/
public function withHttpOnly($httpOnly);
/**
* Check if the cookie is secure
*
* @return bool
*/
public function isSecure();
/**
* Create a cookie with Secure updated
*
* @param bool $secure Secure attribute value
* @return static
*/
public function withSecure($secure);
/**
* Returns the cookie as header value
*
* @return string
*/
public function toHeaderValue();
}