1. class
  2. Illuminate
  3. \
  4. Session
  5. \
  6. CookieSessionHandler

CookieSessionHandler

class CookieSessionHandler implements SessionHandlerInterface (View source)

Traits

InteractsWithTime

Properties

protected Factory

The cookie jar instance.
protected Request $request

The request instance.
protected int $minutes

The number of minutes the session should be valid.
protected bool $expireOnClose

Indicates whether the session should be expired when the browser closes.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
__construct(QueueingFactory $cookie, int $minutes, bool $expireOnClose = false)

Create a new cookie driven handler instance.

bool
open($savePath, $sessionName)

{@inheritdoc}

bool
close()

{@inheritdoc}

string|false
read($sessionId)

{@inheritdoc}

bool
write($sessionId, $data)

{@inheritdoc}

bool
destroy($sessionId)

{@inheritdoc}

int
gc($lifetime)

{@inheritdoc}

void
setRequest(Request $request)

Set the request instance.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

at line 49
__construct(QueueingFactory $cookie, int $minutes, bool $expireOnClose = false)

Create a new cookie driven handler instance.

Parameters

QueueingFactory $cookie
int $minutes
bool $expireOnClose

at line 61
bool open($savePath, $sessionName)

{@inheritdoc}

Parameters

$savePath
$sessionName

Return Value

bool

at line 71
bool close()

{@inheritdoc}

Return Value

bool

at line 81
string|false read($sessionId)

{@inheritdoc}

Parameters

$sessionId

Return Value

string|false

at line 98
bool write($sessionId, $data)

{@inheritdoc}

Parameters

$sessionId
$data

Return Value

bool

at line 113
bool destroy($sessionId)

{@inheritdoc}

Parameters

$sessionId

Return Value

bool

at line 125
int gc($lifetime)

{@inheritdoc}

Parameters

$lifetime

Return Value

int

at line 136
void setRequest(Request $request)

Set the request instance.

Parameters

Request $request

Return Value

void