Skip to content

Commit

Permalink
1.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@refkinscallv
refkinscallv committed Nov 20, 2024
1 parent 3b9b1a1 commit aa83f34
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 135 deletions.
6 changes: 2 additions & 4 deletions composer.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "refkinscallv/cookie",
"description": "Cookies Library for PHP",
"version": "1.0.5",
"type": "library",
"license": "MIT",
"autoload": {
Expand All @@ -14,8 +15,5 @@
"email": "[email protected]"
}
],
"minimum-stability": "stable",
"require": {
"refkinscallv/crypto": "^1.0"
}
"minimum-stability": "stable"
}
8 changes: 0 additions & 8 deletions path/to/encrypt.txt
View file

This file was deleted.

220 changes: 132 additions & 88 deletions src/Cookie.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,172 +2,216 @@

namespace RF\Cookie;

use RF\Crypto\Crypto;
use Exception;

class Cookie {

/**
* Class to handle encrypted cookies with enhanced functionality.
*/
class Cookie
{

/**
* @var string $cookieName
* @var string Cookie name.
*/
protected string $cookieName;

/**
* @var int $cookieExpire
* @var int Cookie expiration time in hours.
*/
protected int $cookieExpire;

/**
* @var string $cookiePath
* @var string Cookie path.
*/
protected string $cookiePath;

/**
* @var string $cookieDomain
* @var string|null Cookie domain.
*/
protected string $cookieDomain;
protected ?string $cookieDomain;

/**
* @var bool $cookieSecure
* @var bool Cookie secure flag.
*/
protected bool $cookieSecure;

/**
* @var bool $cookieHttpOnly
* @var mixed|null Encryption handler or null if encryption is disabled.
*/
protected bool $cookieHttpOnly;
protected mixed $crypto;

/**
* @var Crypto|null $crypto
* @var bool Whether encryption is enabled.
*/
protected ?Crypto $crypto;
protected bool $cookieEncrypt;

/**
* @var callable|null $cookieEncrypt
* Cookie constructor.
*
* @param mixed|null $db Encryption handler or null to disable encryption.
*/
protected $cookieEncrypt;

public function __construct(array $args = []) {
$this->validateArgs($args);

if ($this->cookieEncrypt) {
$this->crypto = new Crypto($this->cookieEncrypt);
} else {
$this->crypto = null;
}
}

private function validateArgs(array $args): void {
if (!isset($args["cookieName"])) {
throw new Exception("Invalid Cookie Config. Array index 'cookieName' not found.");
}

$this->cookieName = $args["cookieName"];
$this->cookieExpire = $args["cookieExpires"] ?? 24;
$this->cookiePath = $args["cookiePath"] ?? "/";
$this->cookieDomain = $args["cookieDomain"] ?? $_SERVER["SERVER_NAME"];
$this->cookieSecure = $args["cookieSecure"] ?? false;
$this->cookieHttpOnly = $args["cookieHttpOnly"] ?? true;
$this->cookieEncrypt = $args["cookieEncrypt"] ?? [];
public function __construct(mixed $db = null)
{
$this->cookieName = $_SERVER['COOKIE_NAME'] ?? 'web_cookie';
$this->cookieExpire = (int)($_SERVER['COOKIE_EXPIRES'] ?? 24);
$this->cookiePath = $_SERVER['COOKIE_PATH'] ?? '/';
$this->cookieDomain = $_SERVER['SERVER_NAME'] ?? null;
$this->cookieSecure = filter_var($_SERVER['COOKIE_SECURE'] ?? false, FILTER_VALIDATE_BOOLEAN);
$this->crypto = $db;
$this->cookieEncrypt = $db !== null;
}

/**
* Retrieve all encrypted cookie data.
* Retrieve all cookies.
*
* @return array
* @return array Parsed cookie data or an empty array.
* @throws Exception If cookie data cannot be decrypted or unserialized.
*/
public function all(): array {
public function all(): array
{
if (!isset($_COOKIE[$this->cookieName])) {
return [];
}

$cookieData = $_COOKIE[$this->cookieName];

if ($this->crypto) {
$decryptedData = $this->crypto->decrypt($cookieData, "array");
return $decryptedData;
try {
if ($this->cookieEncrypt) {
return $this->crypto->decrypt($cookieData, 'array');
}
$unserializedData = @unserialize($cookieData);
if ($unserializedData === false && $cookieData !== 'b:0;') {
throw new Exception('Failed to unserialize cookie data.');
}
return $unserializedData ?: [];
} catch (Exception $e) {
throw new Exception('Failed to retrieve cookies: ' . $e->getMessage(), 0, $e);
}

return $cookieData ? @unserialize($cookieData) : [];
}

/**
* Get specific value from decrypted cookie data.
* Get a specific cookie value by key.
*
* @param string $value
* @return mixed|null
* @param string $key The key of the cookie to retrieve.
* @return mixed|null The value of the cookie or null if not found.
*/
public function get(string $value) {
$getCookie = $this->all();
public function get(string $key): mixed
{
$allCookies = $this->all();
return $allCookies[$key] ?? null;
}

return $getCookie[$value] ?? null;
/**
* Check if a specific cookie key exists.
*
* @param string $key The key to check.
* @return bool True if the key exists, false otherwise.
*/
public function has(string $key): bool
{
return $this->get($key) !== null;
}

/**
* Set encrypted cookie data.
* Set a cookie value or values.
*
* @param mixed $key
* @param mixed $value
* @return bool
* @param string|array $key The key or an array of key-value pairs to set.
* @param mixed|null $value The value to set if $key is a string.
* @return bool True on success.
* @throws Exception If the headers are already sent or setting the cookie fails.
*/
public function set($key, $value = null): bool {
$getCookie = $this->all();
public function set(string|array $key, mixed $value = null): bool
{
$allCookies = $this->all();

if (is_array($key)) {
foreach ($key as $index => $val) {
$getCookie[$index] = $val;
foreach ($key as $idx => $val) {
$allCookies[$idx] = $val;
}
} else {
$getCookie[$key] = $value;
$allCookies[$key] = $value;
}

$setCookie = $this->crypto ? $this->crypto->encrypt($getCookie, "array") : serialize($getCookie);
$setCookie = $this->cookieEncrypt
? $this->crypto->encrypt($allCookies, 'array')
: serialize($allCookies);

return setcookie(
if (headers_sent()) {
throw new Exception('Cannot set cookie; headers already sent.');
}

if (!setcookie(
$this->cookieName,
$setCookie,
time() + ($this->cookieExpire * 3600),
$this->cookiePath,
$this->cookieDomain,
$this->cookieSecure,
$this->cookieHttpOnly
);
[
'expires' => time() + ($this->cookieExpire * 3600),
'path' => $this->cookiePath,
'secure' => $this->cookieSecure,
'httponly' => true
]
)) {
throw new Exception('Failed to set cookie: ' . $this->cookieName);
}

return true;
}

/**
* Unset encrypted cookie data.
* Unset a cookie by key.
*
* @param mixed $key
* @return bool
* @param string|array $key The key or an array of keys to unset.
* @return bool True on success.
* @throws Exception If setting the cookie fails.
*/
public function unset($key = null): bool {
$getCookie = $this->all();
public function unset(string|array $key): bool
{
$allCookies = $this->all();

if (is_array($key)) {
foreach ($key as $index) {
unset($getCookie[$index]);
foreach ($key as $idx) {
unset($allCookies[$idx]);
}
} else {
unset($getCookie[$key]);
unset($allCookies[$key]);
}

$setCookie = $this->crypto ? $this->crypto->encrypt($getCookie, "array") : serialize($getCookie);
$setCookie = $this->cookieEncrypt
? $this->crypto->encrypt($allCookies, 'array')
: serialize($allCookies);

return setcookie(
if (!setcookie(
$this->cookieName,
$setCookie,
time() + ($this->cookieExpire * 3600),
$this->cookiePath,
$this->cookieDomain,
$this->cookieSecure,
$this->cookieHttpOnly
);
[
'expires' => time() + ($this->cookieExpire * 3600),
'path' => $this->cookiePath,
'secure' => $this->cookieSecure,
'httponly' => true
]
)) {
throw new Exception('Failed to unset cookie: ' . $this->cookieName);
}

return true;
}

/**
* Destroy cookie data.
* Destroy all cookies.
*
* @return bool True on success.
*/
public function destroy() {
return setcookie($this->cookieName, "", time() - 3600, "/");
public function destroy(): bool
{
return setcookie(
$this->cookieName,
'',
[
'expires' => time() - 3600,
'path' => $this->cookiePath,
'secure' => $this->cookieSecure,
'httponly' => true
]
);
}

}
35 changes: 0 additions & 35 deletions test/index.php
View file

This file was deleted.

0 comments on commit aa83f34

Please sign in to comment.