Recommend this page to a friend! |
Classes of Josantonius | PHP Cookie | README.md | Download |
|
DownloadPHP Cookie libraryPHP library for handling cookies.
RequirementsThis library is supported by PHP versions 5.6 or higher. InstallationThe preferred way to install this extension is through Composer. To install PHP Cookie library, simply:
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
You can also clone the complete repository with Git:
Or install it manually:
Available MethodsAvailable methods in this library: - Set cookie:
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $key | Cookie name. | string | Yes | | | $value | The data to save. | string | Yes | | | $time | Expiration time in days. | string | No | 365 | # Return (boolean) - Get item from cookie:
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $key | Cookie name. | string | No | '' | # Return (mixed|false) ? returns cookie value, cookies array or false - Extract item from cookie and delete cookie:
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $key | Cookie name. | string | Yes | | # Return (string|false) ? item or false when key does not exists - Extract item from cookie and delete cookie:
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $key | Cookie name to destroy. Not set to delete all. | string | No | '' | # Return (boolean) - Set cookie prefix:
| Attribute | Description | Type | Required | Default | --- | --- | --- | --- | --- | | $prefix | Cookie prefix. | string | Yes | | # Return (boolean) - Get cookie prefix:
# Return (string) ? cookie prefix Quick StartTo use this class with Composer:
Or If you installed it manually, use it:
UsageExample of use for this library: - Set cookie:
- Get cookie:
- Get all cookies:
- Pull cookie:
- Destroy one cookie:
- Destroy all cookies:
- Set cookie prefix:
- Get cookie prefix:
TestsTo run tests you just need composer and to execute the following:
Run unit tests with PHPUnit:
Run PSR2 code standard tests with PHPCS:
Run PHP Mess Detector tests to detect inconsistencies in code style:
Run all previous tests:
? TODO
ContributeIf you would like to help, please take a look at the list of issues or the To Do checklist. Pull requests
RepositoryThe file structure from this repository was created with PHP-Skeleton. LicenseThis project is licensed under MIT license. See the LICENSE file for more info. Copyright2016 - 2018 Josantonius, josantonius.com If you find it useful, let me know :wink: |