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 許可證獲得許可。

展開