CodeIgniter v4.7 API

RedisHandler extends BaseHandler

in package

• Application

uses PersistsConnection

Session handler using Redis for persistence.

Table of Contents

Constants

DEFAULT_PORT  = 6379

DEFAULT_PROTOCOL  = 'tcp'

Properties

$connectionPool  : array<string, object>

Connection pool keyed by connection identifier.

$cookieDomain  : string

Cookie domain.

$cookieName  : string

Cookie name to use.

$cookiePath  : string

Cookie path.

$cookiePrefix  : string

Cookie prefix.

$cookieSecure  : bool

Cookie secure?

$fingerprint  : string

The Data fingerprint.

$ipAddress  : string

User's IP address.

$keyExists  : bool

Key exists flag.

$keyPrefix  : string

Key prefix.

$lock  : bool|string

Lock placeholder.

$lockKey  : string|null

Lock key.

$matchIP  : bool

Match IP addresses for cookies?

$redis  : Redis|null

phpRedis instance.

$savePath  : array<string, mixed>|string

The 'save path' for the session varies between.

$sessionExpiration  : int

Number of seconds until the session ends.

$sessionID  : string|null

Current session ID.

$lockMaxRetries  : int

Maximum number of lock acquisition attempts.

$lockRetryInterval  : int

Time (microseconds) to wait if lock cannot be acquired.

Methods

__construct()  : mixed

close()  : bool

Closes the current session.

destroy()  : bool

Destroys a session.

gc()  : 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.

resetPersistentConnections()  : void

Reset all persistent connections (useful for testing).

write()  : bool

Writes the session data to the session storage.

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.

getConnectionIdentifier()  : string

Get connection identifier based on configuration.

getPersistentConnection()  : object|null

Get the persistent connection for this configuration.

hasPersistentConnection()  : bool

Check if a persistent connection exists for this configuration.

lockSession()  : bool

Acquires an emulated lock.

releaseLock()  : bool

Releases a previously acquired lock.

setPersistentConnection()  : void

Store a connection for persistence.

setSavePath()  : void