Class FileHandler

Summary

Fully Qualified Name: CodeIgniter\Session\Handlers\FileHandler
Extends: BaseHandler
Implements: SessionHandlerInterface

Description

Session handler using file system for storage

Methods

Name Description Defined By
__construct() Constructor FileHandler
close() Close FileHandler
destroy() Destroy FileHandler
gc() Garbage Collector FileHandler
open() Open FileHandler
read() Read FileHandler
write() Write FileHandler

Method Details

__construct()

Constructor

Parameter Name Type Description
$config \BaseConfig
$ipAddress string

Returns:

close()

Close

Releases locks and closes file descriptor.

Returns: bool

destroy()

Destroy

Destroys the current session.

Parameter Name Type Description
$session_id string Session

Returns: bool

gc()

Garbage Collector

Deletes expired sessions

Parameter Name Type Description
$maxlifetime int Maximum

Returns: bool

open()

Open

Sanitizes the save_path directory.

Parameter Name Type Description
$savePath string Path
$name string Session

Returns: bool

read()

Read

Reads session data and acquires a lock

Parameter Name Type Description
$sessionID string Session

Returns: string Serialized session data

write()

Write

Writes (create / update) session data

Parameter Name Type Description
$sessionID string Session
$sessionData string Serialized

Returns: bool

Top