CodeIgniter v3.0.0 API
\

\CI_Session

CodeIgniter Session Class

Summary

Methods
Properties
Constants
__construct()
mark_as_flash()
get_flash_keys()
unmark_flash()
mark_as_temp()
get_temp_keys()
unmark_temp()
__get()
__isset()
__set()
sess_destroy()
sess_regenerate()
get_userdata()
userdata()
set_userdata()
unset_userdata()
all_userdata()
has_userdata()
flashdata()
set_flashdata()
keep_flashdata()
tempdata()
set_tempdata()
unset_tempdata()
$userdata
No constants found
_ci_load_classes()
_configure()
_configure_sid_length()
_ci_init_vars()
$_driver
$_config
$_sid_regexp
N/A
No private methods found
No private properties found
N/A

Properties

$userdata

$userdata :

Userdata array

Just a reference to $_SESSION, for BC purposes.

Type

$_driver

$_driver :

Type

$_config

$_config :

Type

$_sid_regexp

$_sid_regexp :

Type

Methods

__construct()

__construct(array  $params = array()) : void

Class constructor

Parameters

array $params

Configuration parameters

mark_as_flash()

mark_as_flash(mixed  $key) : boolean

Mark as flash

Parameters

mixed $key

Session data key(s)

Returns

boolean

get_flash_keys()

get_flash_keys() : array

Get flash keys

Returns

array

unmark_flash()

unmark_flash(mixed  $key) : void

Unmark flash

Parameters

mixed $key

Session data key(s)

mark_as_temp()

mark_as_temp(mixed  $key, integer  $ttl = 300) : boolean

Mark as temp

Parameters

mixed $key

Session data key(s)
integer $ttl

Time-to-live in seconds

Returns

boolean

get_temp_keys()

get_temp_keys() : array

Get temp keys

Returns

array

unmark_temp()

unmark_temp(mixed  $key) : void

Unmark flash

Parameters

mixed $key

Session data key(s)

__get()

__get(string  $key) : mixed

__get()

Parameters

string $key

'session_id' or a session data key

Returns

mixed

__isset()

__isset(string  $key) : boolean

__isset()

Parameters

string $key

'session_id' or a session data key

Returns

boolean

__set()

__set(string  $key, mixed  $value) : void

__set()

Parameters

string $key

Session data key
mixed $value

Session data value

sess_destroy()

sess_destroy() : void

Session destroy

Legacy CI_Session compatibility method

sess_regenerate()

sess_regenerate(boolean  $destroy = FALSE) : void

Session regenerate

Legacy CI_Session compatibility method

Parameters

boolean $destroy

Destroy old session data flag

get_userdata()

get_userdata()

Get userdata reference

Legacy CI_Session compatibility method

userdata()

userdata(string  $key = NULL) : mixed

Userdata (fetch)

Legacy CI_Session compatibility method

Parameters

string $key

Session data key

Returns

mixed —

Session data value or NULL if not found

set_userdata()

set_userdata(mixed  $data, mixed  $value = NULL) : void

Set userdata

Legacy CI_Session compatibility method

Parameters

mixed $data

Session data key or an associative array
mixed $value

Value to store

unset_userdata()

unset_userdata(mixed  $key) : void

Unset userdata

Legacy CI_Session compatibility method

Parameters

mixed $key

Session data key(s)

all_userdata()

all_userdata() : array

All userdata (fetch)

Legacy CI_Session compatibility method

Returns

array —

$_SESSION, excluding flash data items

has_userdata()

has_userdata(string  $key) : boolean

Has userdata

Legacy CI_Session compatibility method

Parameters

string $key

Session data key

Returns

boolean

flashdata()

flashdata(string  $key = NULL) : mixed

Flashdata (fetch)

Legacy CI_Session compatibility method

Parameters

string $key

Session data key

Returns

mixed —

Session data value or NULL if not found

set_flashdata()

set_flashdata(mixed  $data, mixed  $value = NULL) : void

Set flashdata

Legacy CI_Session compatibility method

Parameters

mixed $data

Session data key or an associative array
mixed $value

Value to store

keep_flashdata()

keep_flashdata(mixed  $key) : void

Keep flashdata

Legacy CI_Session compatibility method

Parameters

mixed $key

Session data key(s)

tempdata()

tempdata(string  $key = NULL) : mixed

Temp data (fetch)

Legacy CI_Session compatibility method

Parameters

string $key

Session data key

Returns

mixed —

Session data value or NULL if not found

set_tempdata()

set_tempdata(mixed  $data, mixed  $value = NULL, integer  $ttl = 300) : void

Set tempdata

Legacy CI_Session compatibility method

Parameters

mixed $data

Session data key or an associative array of items
mixed $value

Value to store
integer $ttl

Time-to-live in seconds

unset_tempdata()

unset_tempdata(  $key) : void

Unset tempdata

Legacy CI_Session compatibility method

Parameters

$key

_ci_load_classes()

_ci_load_classes(string  $driver) : string

CI Load Classes

An internal method to load all possible dependency and extension classes. It kind of emulates the CI_Driver library, but is self-sufficient.

Parameters

string $driver

Driver name

Returns

string —

Driver class name

_configure()

_configure(  $params) : void

Configuration

Handle input parameters and configuration defaults

Parameters

$params

_configure_sid_length()

_configure_sid_length() : void

Configure session ID length

To make life easier, we used to force SHA-1 and 4 bits per character on everyone. And of course, someone was unhappy.

Then PHP 7.1 broke backwards-compatibility because ext/session is such a mess that nobody wants to touch it with a pole stick, and the one guy who does, nobody has the energy to argue with.

So we were forced to make changes, and OF COURSE something was going to break and now we have this pile of shit. -- Narf

_ci_init_vars()

_ci_init_vars() : void

Handle temporary variables

Clears old "flash" data, marks the new one for deletion and handles "temp" data deletion.