Download the PHP package josantonius/session without Composer
On this page you can find all versions of the php package josantonius/session. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/session
More information about josantonius/session
Files in josantonius/session
Informations about the package session
PHP Session library
Translations: Español
PHP library for handling sessions.
- Requirements
- Installation
- Available Classes
- Session Class
- Session Facade
- Exceptions Used
- Usage
- Tests
- TODO
- Changelog
- Contribution
- Sponsor
- License
Requirements
-
Operating System: Linux | Windows.
- PHP versions: 8.0 | 8.1 | 8.2 | 8.3.
Installation
The preferred way to install this extension is through Composer.
To install PHP Session 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:
Available Classes
Session Class
Josantonius\Session\Session
Starts the session:
Check if the session is started:
Sets an attribute by name:
Gets an attribute by name:
Gets all attributes:
Check if an attribute exists in the session:
Sets several attributes at once:
Deletes an attribute by name and returns its value:
Deletes an attribute by name:
Free all session variables:
Gets the session ID:
Sets the session ID:
Update the current session ID with a newly generated one:
Gets the session name:
Sets the session name:
Destroys the session:
Session Facade
Josantonius\Session\Facades\Session
Starts the session:
Check if the session is started:
Sets an attribute by name:
Gets an attribute by name:
Gets all attributes:
Check if an attribute exists in the session:
Sets several attributes at once:
Deletes an attribute by name and returns its value:
Deletes an attribute by name:
Free all session variables:
Gets the session ID:
Sets the session ID:
Update the current session ID with a newly generated one:
Gets the session name:
Sets the session name:
Destroys the session:
Exceptions Used
Usage
Example of use for this library:
Starts the session without setting options
Starts the session setting options
Check if the session is started
Sets an attribute by name
Gets an attribute by name without setting a default value
Gets an attribute by name setting a default value
Gets all attributes
Check if an attribute exists in the session
Sets several attributes at once
Deletes an attribute and returns its value or the default value if not exist
Deletes an attribute and returns its value or the custom value if not exist
Deletes an attribute by name
Free all session variables
Gets the session ID
Sets the session ID
Update the current session ID with a newly generated one
Update the current session ID with a newly generated one deleting the old session
Gets the session name
Sets the session name
Destroys the session
Tests
To run composer and to execute the following:
Run unit tests with PHPUnit:
Run code standard tests with PHPCS:
Run PHP Mess Detector tests to detect inconsistencies in code style:
Run all previous tests:
TODO
- [ ] Add new feature
- [ ] Improve tests
- [ ] Improve documentation
- [ ] Improve English translation in the README file
- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
- [ ] Show an example of renewing the session lifetime
- [ ] Feature to enable/disable exceptions?
- [ ] Feature to add prefixes in session attributes?
Changelog
Detailed changes for each release are documented in the release notes.
Contribution
Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.
Thanks to all contributors! :heart:
Sponsor
If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:
License
This repository is licensed under the MIT License.
Copyright © 2017-present, Josantonius