FileHandler
extends BaseHandler
in package
Session handler using file system for storage.
Table of Contents
Properties
- $cookieDomain : string
- Cookie domain.
- $cookieName : string
- Cookie name to use.
- $cookiePath : string
- Cookie path.
- $cookiePrefix : string
- Cookie prefix.
- $cookieSecure : bool
- Cookie secure?
- $fileHandle : resource|null
- The file handle.
- $fileNew : bool
- Whether this is a new file.
- $filePath : string
- File Name.
- $fingerprint : string
- The Data fingerprint.
- $ipAddress : string
- User's IP address.
- $lock : bool|string
- Lock placeholder.
- $matchIP : bool
- Whether IP addresses should be matched.
- $savePath : string
- Where to save the session files to.
- $sessionID : string|null
- Current session ID.
- $sessionIDRegex : string
- Regex of session ID.
Methods
- __construct() : mixed
- close() : bool
- Closes the current session.
- destroy() : bool
- Destroys a session.
- gc() : false|int
- Cleans up expired sessions.
- open() : bool
- Re-initialize existing session, or creates a new one.
- read() : false|string
- Reads the session data from the session storage, and returns the results.
- write() : bool
- Writes the session data to the session storage.
- configureSessionIDRegex() : void
- Configure Session ID regular expression.
- destroyCookie() : bool
- Internal method to force removal of a cookie by the client when session_destroy() is called.
- fail() : bool
- Drivers other than the 'files' one don't (need to) use the session.save_path INI setting, but that leads to confusing error messages emitted by PHP when open() or write() fail, as the message contains session.save_path ... To work around the problem, the drivers will call this method so that the INI is set just in time for the error message to be properly generated.
- lockSession() : bool
- A dummy method allowing drivers with no locking functionality (databases other than PostgreSQL and MySQL) to act as if they do acquire a lock.
- releaseLock() : bool
- Releases the lock, if any.
Properties
$cookieDomain
Cookie domain.
protected
string
$cookieDomain
= ''
$cookieName
Cookie name to use.
protected
string
$cookieName
$cookiePath
Cookie path.
protected
string
$cookiePath
= '/'
$cookiePrefix
Cookie prefix.
protected
string
$cookiePrefix
= ''
The Config\Cookie::$prefix setting is completely ignored. See https://codeigniter.com/user_guide/libraries/sessions.html#session-preferences
$cookieSecure
Cookie secure?
protected
bool
$cookieSecure
= false
$fileHandle
The file handle.
protected
resource|null
$fileHandle
$fileNew
Whether this is a new file.
protected
bool
$fileNew
$filePath
File Name.
protected
string
$filePath
$fingerprint
The Data fingerprint.
protected
string
$fingerprint
$ipAddress
User's IP address.
protected
string
$ipAddress
$lock
Lock placeholder.
protected
bool|string
$lock
= false
$matchIP
Whether IP addresses should be matched.
protected
bool
$matchIP
= false
$savePath
Where to save the session files to.
protected
string
$savePath
$sessionID
Current session ID.
protected
string|null
$sessionID
$sessionIDRegex
Regex of session ID.
protected
string
$sessionIDRegex
= ''
Methods
__construct()
public
__construct(Session $config, string $ipAddress) : mixed
Parameters
- $config : Session
- $ipAddress : string
close()
Closes the current session.
public
close() : bool
Return values
booldestroy()
Destroys a session.
public
destroy(string $id) : bool
Parameters
- $id : string
-
The session ID being destroyed.
Return values
boolgc()
Cleans up expired sessions.
public
gc(int $max_lifetime) : false|int
Parameters
- $max_lifetime : int
-
Sessions that have not updated for the last max_lifetime seconds will be removed.
Return values
false|intopen()
Re-initialize existing session, or creates a new one.
public
open(string $path, string $name) : bool
Parameters
- $path : string
-
The path where to store/retrieve the session.
- $name : string
-
The session name.
Tags
Return values
boolread()
Reads the session data from the session storage, and returns the results.
public
read(string $id) : false|string
Parameters
- $id : string
-
The session ID.
Return values
false|stringwrite()
Writes the session data to the session storage.
public
write(string $id, string $data) : bool
Parameters
- $id : string
-
The session ID.
- $data : string
-
The encoded session data.
Return values
boolconfigureSessionIDRegex()
Configure Session ID regular expression.
protected
configureSessionIDRegex() : void
To make life easier, we force the PHP defaults. Because PHP9 forces them.
Tags
destroyCookie()
Internal method to force removal of a cookie by the client when session_destroy() is called.
protected
destroyCookie() : bool
Return values
boolfail()
Drivers other than the 'files' one don't (need to) use the session.save_path INI setting, but that leads to confusing error messages emitted by PHP when open() or write() fail, as the message contains session.save_path ... To work around the problem, the drivers will call this method so that the INI is set just in time for the error message to be properly generated.
protected
fail() : bool
Return values
boollockSession()
A dummy method allowing drivers with no locking functionality (databases other than PostgreSQL and MySQL) to act as if they do acquire a lock.
protected
lockSession(string $sessionID) : bool
Parameters
- $sessionID : string
Return values
boolreleaseLock()
Releases the lock, if any.
protected
releaseLock() : bool