php cookie下载 - php cookie源代码下载

php cookie库

翻译：西班牙语

用于处理 cookie 的 PHP 库。

要求
安装
可选课程
- 饼干类
- Cookie 外观
使用的例外情况
用法
关于 Cookie 过期
测试
待办事项
变更日志
贡献
赞助
执照

要求

操作系统：Linux。
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 ;

Cookie 外观

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 ;

用法

该库的使用示例：

使用默认选项创建 Cookie 实例

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: options ();

使用自定义选项创建 Cookie 实例

 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 ,
);

按名称设置 cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> set ( ' foo ' , ' bar ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: set ( ' foo ' , ' bar ' );

按名称设置 cookie 并修改过期时间

 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 ' ));

一次设置多个cookie

 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 );

一次设置多个 cookie 并修改过期时间

 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 );

按名称获取 cookie

 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

如果 cookie 不存在，则按名称获取具有默认值的 cookie

 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

获取所有cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> all ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: all ();

检查cookie是否存在

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> has ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: has ( ' foo ' );

按名称删除 cookie 并返回其值

 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

删除 cookie 并返回其值或默认值（如果不存在）

 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

按名称删除 cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> remove ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: remove ( ' foo ' );

关于cookie过期

该库的多个方法中使用的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 时间。

如果set或replace方法中使用了expires参数，则将采用该参数来代替cookie选项中设置的expires值。

 $ 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

测试

要运行测试，您只需要 Composer 并执行以下命令：

 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

待办事项

添加新功能
改进测试
改进文档
改进 README 文件中的英文翻译
重构代码以禁用代码样式规则（请参阅 phpmd.xml 和 phpcs.xml）

变更日志

每个版本的详细更改都记录在发行说明中。

贡献

在发出拉取请求、开始讨论或报告问题之前，请务必阅读贡献指南。

感谢所有贡献者！ ❤️

赞助

如果这个项目可以帮助您减少开发时间，您可以资助我支持我的开源工作吗？

执照

该存储库已根据 MIT 许可证获得许可。

展开