W3cubDocs

/Phalcon 3

Abstract class Phalcon\Session\Adapter

implements Phalcon\Session\AdapterInterface

Source on GitHub

Base class for Phalcon\Session adapters

Constants

integer SESSION_ACTIVE

integer SESSION_NONE

integer SESSION_DISABLED

Methods

public __construct ([array $options])

Phalcon\Session\Adapter constructor

public start ()

Starts the session (if headers are already sent the session will not be started)

public setOptions (array $options)

Sets session’s options

$session->setOptions(
    [
        "uniqueId" => "my-private-app",
    ]
);

public getOptions ()

Get internal options

public setName (mixed $name)

Set session name

public getName ()

Get session name

public regenerateId ([mixed $deleteOldSession])

public get (mixed $index, [mixed $defaultValue], [mixed $remove])

Gets a session variable from an application context

$session->get("auth", "yes");

public set (mixed $index, mixed $value)

Sets a session variable in an application context

$session->set("auth", "yes");

public has (mixed $index)

Check whether a session variable is set in an application context

var_dump(
    $session->has("auth")
);

public remove (mixed $index)

Removes a session variable from an application context

$session->remove("auth");

public getId ()

Returns active session id

echo $session->getId();

public setId (mixed $id)

Set the current session id

$session->setId($id);

public isStarted ()

Check whether the session has been started

var_dump(
    $session->isStarted()
);

public destroy ([mixed $removeData])

Destroys the active session

var_dump(
    $session->destroy()
);

var_dump(
    $session->destroy(true)
);

public status ()

Returns the status of the current session.

var_dump(
    $session->status()
);

if ($session->status() !== $session::SESSION_ACTIVE) {
    $session->start();
}

public __get (mixed $index)

Alias: Gets a session variable from an application context

public __set (mixed $index, mixed $value)

Alias: Sets a session variable in an application context

public __isset (mixed $index)

Alias: Check whether a session variable is set in an application context

public __unset (mixed $index)

Alias: Removes a session variable from an application context

public __destruct ()

...

© 2011–2017 Phalcon Framework Team
Licensed under the Creative Commons Attribution License 3.0.
https://docs.phalconphp.com/en/latest/api/Phalcon_Session_Adapter.html