Unduh php cookie - unduh kode sumber php cookie

perpustakaan php cookie

Terjemahan : Spanyol

Pustaka PHP untuk menangani cookie.

Persyaratan
Instalasi
Kelas yang Tersedia
- Kelas Kue
- Fasad Kue
Pengecualian Digunakan
Penggunaan
Tentang Cookie Kedaluwarsa
Tes
TODO
log perubahan
Kontribusi
Sponsor
Lisensi

Persyaratan

Sistem Operasi: Linux.
Versi PHP: 8.1 | 8.2 | 8.3.

Instalasi

Cara yang lebih disukai untuk memasang ekstensi ini adalah melalui Komposer.

Untuk menginstal perpustakaan php cookie , cukup:

 composer require josantonius/cookie

Perintah sebelumnya hanya akan menginstal file yang diperlukan, jika Anda lebih suka mengunduh seluruh kode sumber, Anda dapat menggunakan:

 composer require josantonius/cookie --prefer-source

Anda juga dapat mengkloning repositori lengkap dengan Git:

 git clone https://github.com/josantonius/php-cookie.git

Kelas yang Tersedia

Kelas Kue

JosantoniusCookieCookie

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

Menetapkan cookie berdasarkan nama:

 /**
 * @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 ;

Menetapkan beberapa cookie sekaligus:

 /**
 * 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 ;

Mendapatkan cookie berdasarkan nama:

 /**
 * Optionally defines a default value when the cookie does not exist.
 */
public function get( string $ name , mixed $ default = null ): mixed ;

Mendapatkan semua cookie:

 public function all(): array ;

Periksa apakah cookie ada:

 public function has( string $ name ): bool ;

Menghapus cookie berdasarkan nama dan mengembalikan nilainya:

 /**
 * 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 ;

Menghapus cookie berdasarkan nama:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public function remove( string $ name ): void ;

Fasad Kue

JosantoniusCookieFacadesCookie

Menetapkan opsi 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 ;

Menetapkan cookie berdasarkan nama:

 /**
 * @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 ;

Menetapkan beberapa cookie sekaligus:

 /**
 * 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 ;

Mendapatkan cookie berdasarkan nama:

 /**
 * Optionally defines a default value when the cookie does not exist.
 */
public static function get( string $ name , mixed $ default = null ): mixed ;

Mendapatkan semua cookie:

 public static function all(): array ;

Periksa apakah cookie ada:

 public static function has( string $ name ): bool ;

Menghapus cookie berdasarkan nama dan mengembalikan nilainya:

 /**
 * 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 ;

Menghapus cookie berdasarkan nama:

 /**
 * @throws CookieException if headers already sent.
 * @throws CookieException if failure in date/time string analysis.
 */
public static function remove( string $ name ): void ;

Pengecualian Digunakan

 use Josantonius  Cookie  Exceptions  CookieException ;

Penggunaan

Contoh penggunaan perpustakaan ini:

Buat instance Cookie dengan opsi default

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: options ();

Buat instance Cookie dengan opsi khusus

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

Menetapkan cookie berdasarkan nama

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

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

 use Josantonius  Cookie  Facades  Cookie ;

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

Menetapkan cookie berdasarkan nama dan mengubah waktu kedaluwarsa

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

Menetapkan beberapa cookie sekaligus

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

Menetapkan beberapa cookie sekaligus mengubah waktu kedaluwarsa

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

Mendapat cookie berdasarkan nama

 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

Mendapatkan cookie berdasarkan nama dengan nilai default jika cookie tidak ada

 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

Mendapatkan semua cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> all ();

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: all ();

Periksa apakah ada cookie

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> has ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: has ( ' foo ' );

Menghapus cookie berdasarkan nama dan mengembalikan nilainya

 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

Menghapus cookie dan mengembalikan nilainya atau nilai default jika tidak ada

 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

Menghapus cookie berdasarkan nama

 use Josantonius  Cookie  Cookie ;

$ cookie = new Cookie ();

$ cookie -> remove ( ' foo ' );

 use Josantonius  Cookie  Facades  Cookie ;

Cookie:: remove ( ' foo ' );

Tentang cookie kedaluwarsa

Parameter expired yang digunakan dalam beberapa metode perpustakaan ini menerima tipe berikut: int|string|DateTime .
- Integers akan ditangani sebagai waktu unix kecuali nol.
- Strings akan ditangani sebagai format tanggal/waktu. Lihat Format Tanggal dan Waktu yang didukung untuk informasi lebih lanjut.
```
 $ cookie = new Cookie (
    expires: ' 2016-12-15 +1 day '
);
```
  Ini akan serupa dengan:
```
 $ cookie = new Cookie (
    expires: new DateTime ( ' 2016-12-15 +1 day ' )
);
```
- Objek DateTime akan digunakan untuk mendapatkan waktu unix.

Jika parameter expired digunakan dalam metode set atau replace , maka parameter tersebut akan diambil alih-alih nilai expired yang ditetapkan dalam opsi 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

Jika parameter kedaluwarsa yang diteruskan dalam opsi adalah string tanggal/waktu, parameter tersebut akan diformat saat menggunakan metode set atau replace dan bukan saat menyetel opsi.

 $ 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

Tes

Untuk menjalankan tes, Anda hanya perlu composer dan menjalankan perintah berikut:

 git clone https://github.com/josantonius/php-cookie.git

 cd php-cookie

 composer install

Jalankan pengujian unit dengan PHPUnit:

 composer phpunit

Jalankan tes standar kode dengan PHPCS:

 composer phpcs

Jalankan tes PHP Mess Detector untuk mendeteksi ketidakkonsistenan dalam gaya kode:

 composer phpmd

Jalankan semua tes sebelumnya:

 composer tests

TODO

Tambahkan fitur baru
Tingkatkan tes
Tingkatkan dokumentasi
Tingkatkan terjemahan bahasa Inggris di file README
Memfaktorkan ulang kode untuk aturan gaya kode yang dinonaktifkan (lihat phpmd.xml dan phpcs.xml)

log perubahan

Perubahan terperinci untuk setiap rilis didokumentasikan dalam catatan rilis.

Kontribusi

Pastikan untuk membaca Panduan Berkontribusi, sebelum membuat permintaan penarikan, memulai diskusi, atau melaporkan masalah.

Terima kasih kepada semua kontributor! ❤️

Sponsor

Jika proyek ini membantu Anda mengurangi waktu pengembangan, Anda dapat mensponsori saya untuk mendukung pekerjaan open source saya?

Lisensi

Repositori ini dilisensikan di bawah Lisensi MIT.

Memperluas