\CodeIgniter\Session\HandlersBaseHandler

Base class for session handling

Summary

Methods
Properties
Constants
setLogger()
__construct()
No public properties found
No constants found
destroyCookie()
lockSession()
releaseLock()
fail()
$logger
$fingerprint
$lock
$cookiePrefix
$cookieDomain
$cookiePath
$cookieSecure
$cookieName
$matchIP
$sessionID
$savePath
$ipAddress
N/A
No private methods found
No private properties found
N/A

Properties

$fingerprint

$fingerprint : boolean

The Data fingerprint.

Type

boolean

$lock

$lock : mixed

Lock placeholder.

Type

mixed

$cookiePrefix

$cookiePrefix : string

Cookie prefix

Type

string

$cookieDomain

$cookieDomain : string

Cookie domain

Type

string

$cookiePath

$cookiePath : string

Cookie path

Type

string

$cookieSecure

$cookieSecure : boolean

Cookie secure?

Type

boolean

$cookieName

$cookieName : string

Cookie name to use

Type

string

$matchIP

$matchIP : boolean

Match IP addresses for cookies?

Type

boolean

$sessionID

$sessionID : string

Current session ID

Type

string

$savePath

$savePath : string

The 'save path' for the session varies between

Type

string

$ipAddress

$ipAddress : string

User's IP address.

Type

string

Methods

__construct()

__construct(\CodeIgniter\Config\BaseConfig  $config, string  $ipAddress) 

Constructor

Parameters

\CodeIgniter\Config\BaseConfig $config
string $ipAddress

destroyCookie()

destroyCookie() : boolean

Internal method to force removal of a cookie by the client when session_destroy() is called.

Returns

boolean

lockSession()

lockSession(string  $sessionID) : boolean

A dummy method allowing drivers with no locking functionality (databases other than PostgreSQL and MySQL) to act as if they do acquire a lock.

Parameters

string $sessionID

Returns

boolean

releaseLock()

releaseLock() : boolean

Releases the lock, if any.

Returns

boolean

fail()

fail() : boolean

Fail

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.

Returns

boolean