Download the PHP package webiik/login without Composer
On this page you can find all versions of the php package webiik/login. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package login
Short Description The Login manages the user login state.
License MIT
Homepage https://www.webiik.com
Informations about the package login
Login
The Login manages the user login state. It supports:
- permanent login
- automatic logout
- login namespaces
Note: This class is meant to be used after the successful user authentication and authorization.
Installation
Example
Summary
- Basic Login
- Permanent Login
- Login Check
- Logout
Basic Login
setSessionKey
setSessionKey() sets the key of login state stored in PHP session. This key holds the uid value. The default value of the key is logged.
setNamespace
setNamespace() sets login namespace. If you want to make the login valid only for the specific part of your app, use the login namespace. Imagine you have a multilingual app and you want to make a separate account for every language - this is the situation when the login namespace can help.
login
login() logs the user in. Login() writes login state to PHP session. If permanent login is not set, login is valid until the user closes the browser or the PHP session expires.
Parameters
- uid user unique identifier to be stored in PHP session
- permanent indicates if to use permanent login. Read more in permanent login section.
Permanent Login
setPermanentCookieName
setPermanentCookieName() sets the name of cookie where the permanent login information is stored at the users' computer. The default value is PC.
setPermanentLoginStorage
Note: To start using the permanent login, it's required to set permanent login storage.
setPermanentLoginStorage() sets the factory of permanent login storage and the time validity of permanent login data.
Parameters
- factory factory creates object implementing StorageInterface
- days how many days to keep permanent cookie and data in storage when user is not active
Permanent login saves the permanent login data to the user's computer (cookie) and to the server. Storage is here to solve the server part and to make storing data flexible. Out of the box, the Login class comes with the FileStorage, it saves login information to the disk at the server. However, you can write your own storage.
Example of using the file storage:
Write Custom Storage
You can write your custom storage. Only thing you have to do is to implement StorageInterface.
Login Check
isLogged
isLogged() checks if user is logged in.
Logout
logout
logout() logs the user out.
setAutoLogoutTime
setAutoLogoutTime() sets the time in seconds to auto logout the user on inactivity between two requests. The default value is 0 - no automatic logout. Automatic logout is ignored when user is logged permanently.
Warning: Update the time of last user activity with every http request to make auto logout feature working properly.
updateAutoLogoutTs
updateAutoLogoutTs() updates time of last users' activity stored in the session.
getLogoutReason
getLogoutReason() returns logout reason.
Resources
All versions of login with dependencies
webiik/token Version ^1
webiik/session Version ^1
webiik/cookie Version ^1