CodeIgniter v3.0.0 API
\

\CI_Session_files_driver

CodeIgniter Session Files Driver

Summary

Methods
Properties
Constants
__construct()
open()
read()
write()
close()
destroy()
gc()
No public properties found
No constants found
_cookie_destroy()
_get_lock()
_release_lock()
_fail()
strlen()
$_config
$_fingerprint
$_lock
$_session_id
$_success
$_failure
$_save_path
$_file_handle
$_file_path
$_file_new
$_sid_regexp
$func_overload
N/A
No private methods found
No private properties found
N/A

Properties

$_config

$_config :

Type

$_fingerprint

$_fingerprint : boolean

Data fingerprint

Type

boolean

$_lock

$_lock : mixed

Lock placeholder

Type

mixed

$_session_id

$_session_id : string

Read session ID

Used to detect session_regenerate_id() calls because PHP only calls write() after regenerating the ID.

Type

string

$_success

$_success : mixed

Success and failure return values

Necessary due to a bug in all PHP 5 versions where return values from userspace handlers are not handled properly. PHP 7 fixes the bug, so we need to return different values depending on the version.

Type

mixed

$_failure

$_failure : mixed

Success and failure return values

Necessary due to a bug in all PHP 5 versions where return values from userspace handlers are not handled properly. PHP 7 fixes the bug, so we need to return different values depending on the version.

Type

mixed

$_save_path

$_save_path : string

Save path

Type

string

$_file_handle

$_file_handle : resource

File handle

Type

resource

$_file_path

$_file_path : resource

File name

Type

resource

$_file_new

$_file_new : boolean

File new flag

Type

boolean

$_sid_regexp

$_sid_regexp : string

Validate SID regular expression

Type

string

$func_overload

$func_overload : boolean

mbstring.func_overload flag

Type

boolean

Methods

__construct()

__construct(array  $params) : void

Class constructor

Parameters

array $params

Configuration parameters

open()

open(string  $save_path, string  $name) : boolean

Open

Sanitizes the save_path directory.

Parameters

string $save_path

Path to session files' directory
string $name

Session cookie name

Returns

boolean

read()

read(string  $session_id) : string

Read

Reads session data and acquires a lock

Parameters

string $session_id

Session ID

Returns

string —

Serialized session data

write()

write(string  $session_id, string  $session_data) : boolean

Write

Writes (create / update) session data

Parameters

string $session_id

Session ID
string $session_data

Serialized session data

Returns

boolean

close()

close() : boolean

Close

Releases locks and closes file descriptor.

Returns

boolean

destroy()

destroy(string  $session_id) : boolean

Destroy

Destroys the current session.

Parameters

string $session_id

Session ID

Returns

boolean

gc()

gc(integer  $maxlifetime) : boolean

Garbage Collector

Deletes expired sessions

Parameters

integer $maxlifetime

Maximum lifetime of sessions

Returns

boolean

_cookie_destroy()

_cookie_destroy() : boolean

Cookie destroy

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

Returns

boolean

_get_lock()

_get_lock(string  $session_id) : boolean

Get lock

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 $session_id

Returns

boolean

_release_lock()

_release_lock() : boolean

Release lock

Returns

boolean

_fail()

_fail() : mixed

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

mixed

strlen()

strlen(string  $str) : integer

Byte-safe strlen()

Parameters

string $str

Returns

integer