php cookie
v2.0.7
Переводы : Испанский
PHP-библиотека для обработки файлов cookie.
Операционная система: Линукс.
Версии PHP: 8.1 | 8.2 | 8.3.
Предпочтительный способ установки этого расширения — через Composer.
Чтобы установить библиотеку php cookie , просто:
composer require josantonius/cookieПредыдущая команда установит только необходимые файлы, если вы предпочитаете загрузить весь исходный код, вы можете использовать:
composer require josantonius/cookie --prefer-sourceВы также можете клонировать весь репозиторий с помощью Git:
git clone https://github.com/josantonius/php-cookie.git JosantoniusCookieCookie
Устанавливает параметры cookie:
/**
* Cookie options:
*
* domain: Domain for which the cookie is available.
* expires: The time the cookie will expire.
* httpOnly: If cookie will only be available through the HTTP protocol.
* path: Path for which the cookie is available.
* raw: If cookie will be sent as a raw string.
* sameSite: Enforces the use of a Lax or Strict SameSite policy.
* secure: If cookie will only be available through the HTTPS protocol.
*
* These settings will be used to create and delete cookies.
*
* @throws CookieException if $sameSite value is wrong.
*
* @see https://www.php.net/manual/en/datetime.formats.php for date formats.
* @see https://www.php.net/manual/en/function.setcookie.php for more information.
*/
public function __construct(
private string $ domain = '' ,
private int | string | DateTime $ expires = 0 ,
private bool $ httpOnly = false ,
private string $ path = ' / ' ,
private bool $ raw = false ,
private null | string $ sameSite = null ,
private bool $ secure = false
);Устанавливает файл cookie по имени:
/**
* @throws CookieException if headers already sent.
* @throws CookieException if failure in date/time string analysis.
*/
public function set(
string $ name ,
mixed $ value ,
null | int | string | DateTime $ expires = null
): void ;Устанавливает сразу несколько файлов cookie:
/**
* If cookies exist they are replaced, if they do not exist they are created.
*
* @throws CookieException if headers already sent.
*/
public function replace(
array $ data ,
null | int | string | DateTime $ expires = null
): void ;Получает файл cookie по имени:
/**
* Optionally defines a default value when the cookie does not exist.
*/
public function get( string $ name , mixed $ default = null ): mixed ;Получает все файлы cookie:
public function all(): array ;Проверьте, существует ли файл cookie:
public function has( string $ name ): bool ;Удаляет файл cookie по имени и возвращает его значение:
/**
* Optionally defines a default value when the cookie does not exist.
*
* @throws CookieException if headers already sent.
*/
public function pull( string $ name , mixed $ default = null ): mixed ;Удаляет файл cookie по имени:
/**
* @throws CookieException if headers already sent.
* @throws CookieException if failure in date/time string analysis.
*/
public function remove( string $ name ): void ; JosantoniusCookieFacadesCookie
Устанавливает параметры cookie:
/**
* Cookie options:
*
* domain: Domain for which the cookie is available.
* expires: The time the cookie will expire.
* httpOnly: If cookie will only be available through the HTTP protocol.
* path: Path for which the cookie is available.
* raw: If cookie will be sent as a raw string.
* sameSite: Enforces the use of a Lax or Strict SameSite policy.
* secure: If cookie will only be available through the HTTPS protocol.
*
* These settings will be used to create and delete cookies.
*
* @throws CookieException if $sameSite value is wrong.
*
* @see https://www.php.net/manual/en/datetime.formats.php for date formats.
* @see https://www.php.net/manual/en/function.setcookie.php for more information.
*/
public static function options(
string $ domain = '' ,
int | string | DateTime $ expires = 0 ,
bool $ httpOnly = false ,
string $ path = ' / ' ,
bool $ raw = false ,
null | string $ sameSite = null ,
bool $ secure = false
): void ;Устанавливает файл cookie по имени:
/**
* @throws CookieException if headers already sent.
* @throws CookieException if failure in date/time string analysis.
*/
public static function set(
string $ name ,
mixed $ value ,
null | int | string | DateTime $ expires = null
): void ;Устанавливает сразу несколько файлов cookie:
/**
* If cookies exist they are replaced, if they do not exist they are created.
*
* @throws CookieException if headers already sent.
*/
public static function replace(
array $ data ,
null | int | string | DateTime $ expires = null
): void ;Получает файл cookie по имени:
/**
* Optionally defines a default value when the cookie does not exist.
*/
public static function get( string $ name , mixed $ default = null ): mixed ;Получает все файлы cookie:
public static function all(): array ;Проверьте, существует ли файл cookie:
public static function has( string $ name ): bool ;Удаляет файл cookie по имени и возвращает его значение:
/**
* Optionally defines a default value when the cookie does not exist.
*
* @throws CookieException if headers already sent.
*/
public static function pull( string $ name , mixed $ default = null ): mixed ;Удаляет файл cookie по имени:
/**
* @throws CookieException if headers already sent.
* @throws CookieException if failure in date/time string analysis.
*/
public static function remove( string $ name ): void ; use Josantonius Cookie Exceptions CookieException ;Пример использования этой библиотеки:
use Josantonius Cookie Cookie ;
$ cookie = new Cookie (); use Josantonius Cookie Facades Cookie ;
Cookie:: options (); use Josantonius Cookie Cookie ;
$ cookie = new Cookie (
domain: ' example.com ' ,
expires: time () + 3600 ,
httpOnly: true ,
path: ' /foo ' ,
raw: true ,
sameSite: ' Strict ' ,
secure: true ,
); use Josantonius Cookie Facades Cookie ;
Cookie:: options (
expires: ' now +1 hour ' ,
httpOnly: true ,
); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> set ( ' foo ' , ' bar ' ); use Josantonius Cookie Facades Cookie ;
Cookie:: set ( ' foo ' , ' bar ' ); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> set ( ' foo ' , ' bar ' , time () + 3600 ); use Josantonius Cookie Facades Cookie ;
Cookie:: set ( ' foo ' , ' bar ' , new DateTime ( ' now +1 hour ' )); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> replace ([
' foo ' => ' bar ' ,
' bar ' => ' foo '
]); use Josantonius Cookie Facades Cookie ;
Cookie:: replace ([
' foo ' => ' bar ' ,
' bar ' => ' foo '
], time () + 3600 ); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> replace ([
' foo ' => ' bar ' ,
' bar ' => ' foo '
], time () + 3600 ); use Josantonius Cookie Facades Cookie ;
Cookie:: replace ([
' foo ' => ' bar ' ,
' bar ' => ' foo '
], time () + 3600 ); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> get ( ' foo ' ); // null if the cookie does not exist use Josantonius Cookie Facades Cookie ;
Cookie:: get ( ' foo ' ); // null if the cookie does not exist use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> get ( ' foo ' , false ); // false if cookie does not exist use Josantonius Cookie Facades Cookie ;
Cookie:: get ( ' foo ' , false ); // false if cookie does not exist use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> all (); use Josantonius Cookie Facades Cookie ;
Cookie:: all (); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> has ( ' foo ' ); use Josantonius Cookie Facades Cookie ;
Cookie:: has ( ' foo ' ); use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> pull ( ' foo ' ); // null if attribute does not exist use Josantonius Cookie Facades Cookie ;
Cookie:: pull ( ' foo ' ); // null if attribute does not exist use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> pull ( ' foo ' , false ); // false if attribute does not exist use Josantonius Cookie Facades Cookie ;
Cookie:: pull ( ' foo ' , false ); // false if attribute does not exist use Josantonius Cookie Cookie ;
$ cookie = new Cookie ();
$ cookie -> remove ( ' foo ' ); use Josantonius Cookie Facades Cookie ;
Cookie:: remove ( ' foo ' ); Параметр expires , используемый в нескольких методах этой библиотеки, принимает следующие типы: int|string|DateTime .
Integers будут обрабатываться как время unix, кроме нуля.
Strings будут обрабатываться как форматы даты и времени. Дополнительную информацию см. в разделе «Поддерживаемые форматы даты и времени».
$ cookie = new Cookie (
expires: ' 2016-12-15 +1 day '
);Это было бы похоже на:
$ cookie = new Cookie (
expires: new DateTime ( ' 2016-12-15 +1 day ' )
); Объекты DateTime будут использоваться для получения времени Unix.
Если параметр expires используется в методах set или replace , он будет использован вместо значения expires , установленного в параметрах cookie.
$ cookie = new Cookie (
expires: ' now +1 minute '
);
$ cookie -> set ( ' foo ' , ' bar ' ); // Expires in 1 minute
$ cookie -> set ( ' bar ' , ' foo ' , ' now +8 days ' ); // Expires in 8 days
$ cookie -> replace ([ ' foo ' => ' bar ' ]); // Expires in 1 minute
$ cookie -> replace ([ ' foo ' => ' bar ' ], time () + 3600 ); // Expires in 1 hour Если параметр expires, переданный в параметрах, представляет собой строку даты и времени, он форматируется при использовании метода set или replace , а не при настройке параметров.
$ cookie = new Cookie (
expires: ' now +1 minute ' , // It will not be formatted as unix time yet
);
$ cookie -> set ( ' foo ' , ' bar ' ); // It is will formatted now and expires in 1 minute Для запуска тестов вам просто нужен композитор и выполните следующее:
git clone https://github.com/josantonius/php-cookie.git cd php-cookie composer installЗапустите модульные тесты с помощью PHPUnit:
composer phpunitЗапустите стандартные тесты кода с помощью PHPCS:
composer phpcsЗапустите тесты PHP Mess Detector, чтобы обнаружить несоответствия в стиле кода:
composer phpmdЗапустите все предыдущие тесты:
composer tests Подробные изменения для каждого выпуска описаны в примечаниях к выпуску.
Обязательно прочтите Руководство для участников, прежде чем делать запрос на включение, начинать обсуждение или сообщать о проблеме.
Спасибо всем участникам! ❤️
Если этот проект поможет вам сократить время разработки, вы можете спонсировать меня для поддержки моей работы с открытым исходным кодом?
Этот репозиторий лицензируется по лицензии MIT.
Copyright © 2016-настоящее время, Джосантониус
