pixxel/cookie

处理cookie的PHP库。

2.0 2022-07-08 14:55 UTC

This package is auto-updated.

Last update: 2024-09-08 19:43:27 UTC


README

基于Josantonius的优秀库: https://github.com/josantonius/PHP-Cookie 开发的PHP库,用于处理cookie。

基本上,这是一个针对PHP 8以上版本(联合类型等)进行修改的分支,将静态方法转换为普通方法,并实时更新$_COOKIE数组。

需求

此库支持PHP版本8.0或更高。

安装

安装此扩展的首选方法是使用Composer

要安装 PHP Cookie库,只需

$ composer require pixxel/cookie

上述命令只会安装必要的文件,如果您希望 下载整个源代码,可以使用

$ composer require pixxel/cookie --prefer-source 您也可以使用Git 克隆完整仓库

$ git clone https://github.com/pixxelfactory/cookie.git 或者 手动安装

下载Cookie.php:

$ wget https://raw.githubusercontent.com/pixxelfactory/cookie/master/src/Cookie.php

可用方法

此库中的可用方法

- 设置cookie

$cookie->set($key, $value, $time);

返回 (布尔值)

- 从cookie获取项

$cookie->get($key);

返回 (混合|false) → 返回cookie值,cookies数组或false

- 从cookie提取项并删除cookie

$cookie->pull($key);

返回 (字符串|false) → 项或当键不存在时返回false

- 从cookie提取项并删除cookie

$cookie->destroy($key);

返回 (布尔值)

- 设置cookie前缀

$cookie->setPrefix($prefix);

返回 (布尔值)

- 获取cookie前缀

$cookie->getPrefix();

返回 (字符串) → cookie前缀

快速开始

使用Composer使用此类

require __DIR__ . '/vendor/autoload.php';

use Pixxel\Cookie;

如果您已手动安装,请使用它

require_once __DIR__ . '/Cookie.php';

use Pixxel\Cookie;

用法

此库的使用示例

- 设置cookie

$cookie->set('cookie_name', 'value', 365);

- 获取cookie

$cookie->get('cookie_name');

- 获取所有cookie

$cookie->get();

- 拉取cookie

$cookie->pull('cookie_name');

- 销毁一个cookie

$cookie->destroy('cookie_name');

- 销毁所有cookie

$cookie->destroy();

- 设置cookie前缀

$cookie->setPrefix('prefix_');

- 获取cookie前缀

$cookie->getPrefix();

测试

要运行测试,您只需要Composer并执行以下操作

$ git clone https://github.com/pixxelfactory/cookie.git

$ cd PHP-Cookie

$ composer install 使用PHPUnit运行单元测试

$ composer phpunit 使用PSR2代码标准测试PHPCS

$ composer phpcs 使用PHP Mess Detector测试以检测代码风格的不一致性

$ composer phpmd 运行所有之前的测试

$ composer tests

☑ 待办事项

  • 添加新功能。
  • 改进测试。
  • 改进文档。
  • 重构代码以禁用代码风格规则。请参阅phpmd.xml.php_cs.dist

许可

本项目采用 MIT 许可协议 许可。更多信息请参阅LICENSE 文件。

版权

原始版权:2016 - 2018 Josantonius,josantonius.com