---
title: "Phalcon Session"
version: "5.17"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Session
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Session\Adapter\AbstractAdapter
Abstract
Source on GitHub
- **`Phalcon\Session\Adapter\AbstractAdapter`** - implements `SessionHandlerInterface`, `SessionUpdateTimestampHandlerInterface`
- [`Phalcon\Session\Adapter\Libmemcached`](#sessionadapterlibmemcached)
- [`Phalcon\Session\Adapter\Redis`](#sessionadapterredis)
__Uses__ `Phalcon\Storage\Adapter\AdapterInterface` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `SessionHandlerInterface` · `SessionUpdateTimestampHandlerInterface`
### Method Summary
### Properties
protected
AdapterInterface
$adapter
### Methods
Public · 8
close()
```php
public function close(): bool;
```
Close
destroy()
```php
public function destroy( mixed $id ): bool;
```
Destroy
gc()
```php
public function gc( int $max_lifetime ): int|false;
```
Garbage Collector
open()
```php
public function open(
mixed $path,
mixed $name
): bool;
```
Open
read()
```php
public function read( mixed $id ): string;
```
Read
updateTimestamp()
```php
public function updateTimestamp(
mixed $id,
mixed $data
): bool;
```
Refresh the session lifetime without changing the session data
validateId()
```php
public function validateId( mixed $id ): bool;
```
Validate the session id (used when strict mode is enabled)
write()
```php
public function write(
mixed $id,
mixed $data
): bool;
```
Write
## Session\Adapter\Exceptions\AdapterRuntimeError
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError`**
__Uses__ `Phalcon\Session\Exception`
## Session\Adapter\Exceptions\InvalidSavePath
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Adapter\Exceptions\InvalidSavePath`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Adapter\Exceptions\SavePathUnavailable
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Adapter\Exceptions\SavePathUnavailable`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $path );
```
## Session\Adapter\Libmemcached
Class
Source on GitHub
Phalcon\Session\Adapter\Libmemcached
- [`Phalcon\Session\Adapter\AbstractAdapter`](#sessionadapterabstractadapter)
- **`Phalcon\Session\Adapter\Libmemcached`**
__Uses__ `Phalcon\Storage\AdapterFactory`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
AdapterFactory $factory,
array $options = []
);
```
Libmemcached constructor.
]
],
'defaultSerializer' => 'Php',
'lifetime' => 3600,
'serializer' => null,
'prefix' => 'sess-memc-',
'stripPrefix' => false
]
## Session\Adapter\Noop
Class
Source on GitHub
Phalcon\Session\Adapter\Noop
This is an "empty" or null adapter. It can be used for testing or any
other purpose that no session needs to be invoked
```php
setAdapter(new Noop());
```
- **`Phalcon\Session\Adapter\Noop`** - implements `SessionHandlerInterface`, `SessionUpdateTimestampHandlerInterface`
- [`Phalcon\Session\Adapter\Stream`](#sessionadapterstream)
__Uses__ `SessionHandlerInterface` · `SessionUpdateTimestampHandlerInterface`
### Method Summary
### Methods
Public · 8
close()
```php
public function close(): bool;
```
Close
destroy()
```php
public function destroy( mixed $id ): bool;
```
Destroy
gc()
```php
public function gc( int $max_lifetime ): int|false;
```
Garbage Collector
open()
```php
public function open(
mixed $path,
mixed $name
): bool;
```
Open
read()
```php
public function read( mixed $id ): string;
```
Read
updateTimestamp()
```php
public function updateTimestamp(
mixed $id,
mixed $data
): bool;
```
Refresh the session lifetime without changing the session data
validateId()
```php
public function validateId( mixed $id ): bool;
```
Validate the session id (used when strict mode is enabled)
write()
```php
public function write(
mixed $id,
mixed $data
): bool;
```
Write
## Session\Adapter\Redis
Class
Source on GitHub
Phalcon\Session\Adapter\Redis
- [`Phalcon\Session\Adapter\AbstractAdapter`](#sessionadapterabstractadapter)
- **`Phalcon\Session\Adapter\Redis`**
__Uses__ `Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError` · `Phalcon\Storage\AdapterFactory`
### Method Summary
### Properties
protected
bool
$lockAcquired = false
protected
int
$lockExpiry = 30
Lock time-to-live in seconds. The lock is not refreshed during the request: a request that runs longer than this expiry loses its lock silently and a concurrent request may then acquire it (the token-guarded release still avoids deleting the newer lock). Raise this above the longest expected request to retain the lock for the whole request.
protected
string
$lockKey = ""
protected
int
$lockRetries = 100
protected
string
$lockToken = ""
protected
int
$lockWaitTime = 50000
protected
bool
$lockingEnabled = false
protected
string
$prefix = ""
### Methods
Public · 4
__construct()
```php
public function __construct(
AdapterFactory $factory,
array $options = []
);
```
Constructor
close()
```php
public function close(): bool;
```
Close - releases the session lock if one is held
destroy()
```php
public function destroy( mixed $id ): bool;
```
Destroy
read()
```php
public function read( mixed $id ): string;
```
Read
Protected · 2
acquireLock()
```php
protected function acquireLock( mixed $id ): bool;
```
Tries to acquire the session lock, pausing `lockWaitTime` microseconds
between attempts, up to `lockRetries` times
releaseLock()
```php
protected function releaseLock(): void;
```
Releases the session lock - only when this instance still owns it
## Session\Adapter\Stream
Class
Source on GitHub
Phalcon\Session\Adapter\Stream
This is the file based adapter. It stores sessions in a file based system
```php
'/tmp',
]
);
$session->setAdapter($files);
```
@property array $options
@property string $prefix
@property string $path
- [`Phalcon\Session\Adapter\Noop`](#sessionadapternoop)
- **`Phalcon\Session\Adapter\Stream`**
__Uses__ `Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError` · `Phalcon\Session\Adapter\Exceptions\InvalidSavePath` · `Phalcon\Session\Adapter\Exceptions\SavePathUnavailable` · `Phalcon\Traits\Php\FileTrait` · `Phalcon\Traits\Php\IniTrait` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `Phalcon\Traits\Support\Helper\Str\DirSeparatorTrait`
### Method Summary
### Properties
protected
array
$options = []
Session options
protected
string
$prefix = ""
Session prefix
### Methods
Public · 8
__construct()
```php
public function __construct( array $options = [] );
```
Constructor
destroy()
```php
public function destroy( mixed $id ): bool;
```
gc()
```php
public function gc( int $max_lifetime ): int|false;
```
Garbage Collector
open()
```php
public function open(
mixed $path,
mixed $name
): bool;
```
Ignore the savePath and use local defined path
read()
```php
public function read( mixed $id ): string;
```
Reads data from the adapter
updateTimestamp()
```php
public function updateTimestamp(
mixed $id,
mixed $data
): bool;
```
Refresh the session file modification time without changing its data
validateId()
```php
public function validateId( mixed $id ): bool;
```
Validate the session id (used when strict mode is enabled)
write()
```php
public function write(
mixed $id,
mixed $data
): bool;
```
Protected · 2
getGlobFiles()
```php
protected function getGlobFiles( string $pattern ): array|false;
```
Gets the glob array or returns false on failure
getPrefixedName()
```php
protected function getPrefixedName( mixed $name ): string;
```
Helper method to get the name prefixed
## Session\Bag
Class
Source on GitHub
Phalcon\Session\Bag
This component helps to separate session data into "namespaces". Working by
this way you can easily create groups of session variables into the
application
```php
$user = new \Phalcon\Session\Bag("user");
$user->name = "Kimbra Johnson";
$user->age = 22;
```
@property DiInterface|null $container
@property string $name
@property ManagerInterface $session;
- [`Phalcon\Support\Collection`](/5.17/api/phalcon_support/#supportcollection)
- **`Phalcon\Session\Bag`** - implements [`Phalcon\Session\BagInterface`](#sessionbaginterface), [`Phalcon\Di\InjectionAwareInterface`](/5.17/api/phalcon_di/#diinjectionawareinterface)
__Uses__ `Phalcon\Di\Di` · `Phalcon\Di\DiInterface` · `Phalcon\Di\InjectionAwareInterface` · `Phalcon\Session\ManagerInterface` · `Phalcon\Support\Collection`
### Method Summary
### Methods
Public · 7
__construct()
```php
public function __construct(
ManagerInterface $session,
string $name
);
```
clear()
```php
public function clear(): void;
```
Destroys the session bag
getDI()
```php
public function getDI(): DiInterface;
```
Returns the DependencyInjector container
init()
```php
public function init( array $data = [] ): void;
```
Initialize internal array
remove()
```php
public function remove( string $element ): void;
```
Removes a property from the internal bag
set()
```php
public function set(
string $element,
mixed $value
): void;
```
Sets a value in the session bag
setDI()
```php
public function setDI( DiInterface $container ): void;
```
Sets the DependencyInjector container
## Session\BagInterface
Interface
Source on GitHub
Phalcon\Session\BagInterface
Interface for Phalcon\Session\Bag
- **`Phalcon\Session\BagInterface`**
### Method Summary
### Methods
Public · 10
__get()
```php
public function __get( string $element ): mixed;
```
__isset()
```php
public function __isset( string $element ): bool;
```
__set()
```php
public function __set(
string $element,
mixed $value
): void;
```
__unset()
```php
public function __unset( string $element ): void;
```
clear()
```php
public function clear(): void;
```
get()
```php
public function get(
string $element,
mixed $defaultValue = null,
string $cast = null
): mixed;
```
has()
```php
public function has( string $element ): bool;
```
init()
```php
public function init( array $data = [] ): void;
```
remove()
```php
public function remove( string $element ): void;
```
set()
```php
public function set(
string $element,
mixed $value
): void;
```
## Session\Exception
Class
Source on GitHub
Phalcon\Session\Exception
Exceptions thrown in Phalcon\Session will use this class
- `\Exception`
- **`Phalcon\Session\Exception`**
- [`Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError`](#sessionadapterexceptionsadapterruntimeerror)
- [`Phalcon\Session\Adapter\Exceptions\InvalidSavePath`](#sessionadapterexceptionsinvalidsavepath)
- [`Phalcon\Session\Adapter\Exceptions\SavePathUnavailable`](#sessionadapterexceptionssavepathunavailable)
- [`Phalcon\Session\Exceptions\InvalidSessionAdapter`](#sessionexceptionsinvalidsessionadapter)
- [`Phalcon\Session\Exceptions\InvalidSessionId`](#sessionexceptionsinvalidsessionid)
- [`Phalcon\Session\Exceptions\InvalidSessionName`](#sessionexceptionsinvalidsessionname)
- [`Phalcon\Session\Exceptions\SessionAlreadyStarted`](#sessionexceptionssessionalreadystarted)
- [`Phalcon\Session\Exceptions\SessionModificationDenied`](#sessionexceptionssessionmodificationdenied)
## Session\Exceptions\InvalidSessionAdapter
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Exceptions\InvalidSessionAdapter`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Exceptions\InvalidSessionId
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Exceptions\InvalidSessionId`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Exceptions\InvalidSessionName
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Exceptions\InvalidSessionName`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Exceptions\SessionAlreadyStarted
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Exceptions\SessionAlreadyStarted`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Exceptions\SessionModificationDenied
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Session\Exception`](#sessionexception)
- **`Phalcon\Session\Exceptions\SessionModificationDenied`**
__Uses__ `Phalcon\Session\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Session\Manager
Class
Source on GitHub
@property SessionHandlerInterface|null $adapter
@property string $name
@property array $options
@property string $uniqueId
- `stdClass`
- [`Phalcon\Di\AbstractInjectionAware`](/5.17/api/phalcon_di/#diabstractinjectionaware)
- **`Phalcon\Session\Manager`** - implements [`Phalcon\Session\ManagerInterface`](#sessionmanagerinterface)
__Uses__ `InvalidArgumentException` · `Phalcon\Di\AbstractInjectionAware` · `Phalcon\Di\DiInterface` · `Phalcon\Session\Exceptions\InvalidSessionAdapter` · `Phalcon\Session\Exceptions\InvalidSessionId` · `Phalcon\Session\Exceptions\InvalidSessionName` · `Phalcon\Session\Exceptions\SessionAlreadyStarted` · `Phalcon\Session\Exceptions\SessionModificationDenied` · `Phalcon\Traits\Php\HeaderTrait` · `Phalcon\Traits\Support\Helper\Arr\GetTrait` · `SessionHandlerInterface`
### Method Summary
### Methods
Public · 22
__construct()
```php
public function __construct( array $options = [] );
```
Manager constructor.
__get()
```php
public function __get( string $key ): mixed;
```
Alias: Gets a session variable from an application context
__isset()
```php
public function __isset( string $key ): bool;
```
Alias: Check whether a session variable is set in an application context
__set()
```php
public function __set(
string $key,
mixed $value
): void;
```
Alias: Sets a session variable in an application context
__unset()
```php
public function __unset( string $key ): void;
```
Alias: Removes a session variable from an application context
destroy()
```php
public function destroy(): void;
```
Destroy/end a session
exists()
```php
public function exists(): bool;
```
Check whether the session has been started
get()
```php
public function get(
string $key,
mixed $defaultValue = null,
bool $remove = false
): mixed;
```
Gets a session variable from an application context
getAdapter()
```php
public function getAdapter(): SessionHandlerInterface|null;
```
Returns the stored session adapter
getId()
```php
public function getId(): string;
```
Returns the session id
getName()
```php
public function getName(): string;
```
Returns the name of the session
getOptions()
```php
public function getOptions(): array;
```
Get internal options
has()
```php
public function has( string $key ): bool;
```
Check whether a session variable is set in an application context
regenerateId()
```php
public function regenerateId( bool $deleteOldSession = true ): ManagerInterface;
```
Regenerates the session id via `session_regenerate_id()` (when the
session is active). The registered save handler persists the data
under the new id.
remove()
```php
public function remove( string $key ): void;
```
Removes a session variable from an application context
set()
```php
public function set(
string $key,
mixed $value
): void;
```
Sets a session variable in an application context
setAdapter()
```php
public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;
```
Set the adapter for the session
setId()
```php
public function setId( string $sessionId ): ManagerInterface;
```
Set session Id
setName()
```php
public function setName( string $name ): ManagerInterface;
```
Set the session name. Throw exception if the session has started
and do not allow poop names
setOptions()
```php
public function setOptions( array $options ): void;
```
Sets session's options
start()
```php
public function start(): bool;
```
Starts the session (if headers are already sent the session will not be
started)
status()
```php
public function status(): int;
```
Returns the status of the current session.
## Session\ManagerInterface
Interface
Source on GitHub
Phalcon\Session
Interface for the Phalcon\Session\Manager
- **`Phalcon\Session\ManagerInterface`**
__Uses__ `InvalidArgumentException` · `SessionHandlerInterface`
### Method Summary
### Constants
int
SESSION_ACTIVE = 2
int
SESSION_DISABLED = 0
int
SESSION_NONE = 1
### Methods
Public · 21
__get()
```php
public function __get( string $key ): mixed;
```
Alias: Gets a session variable from an application context
__isset()
```php
public function __isset( string $key ): bool;
```
Alias: Check whether a session variable is set in an application context
__set()
```php
public function __set(
string $key,
mixed $value
): void;
```
Alias: Sets a session variable in an application context
__unset()
```php
public function __unset( string $key ): void;
```
Alias: Removes a session variable from an application context
destroy()
```php
public function destroy(): void;
```
Destroy/end a session
exists()
```php
public function exists(): bool;
```
Check whether the session has been started
get()
```php
public function get(
string $key,
mixed $defaultValue = null,
bool $remove = false
): mixed;
```
Gets a session variable from an application context
getAdapter()
```php
public function getAdapter(): SessionHandlerInterface|null;
```
Returns the stored session adapter
getId()
```php
public function getId(): string;
```
Returns the session id
getName()
```php
public function getName(): string;
```
Returns the name of the session
getOptions()
```php
public function getOptions(): array;
```
Get internal options
has()
```php
public function has( string $key ): bool;
```
Check whether a session variable is set in an application context
regenerateId()
```php
public function regenerateId( bool $deleteOldSession = true ): ManagerInterface;
```
Regenerates the session id using the adapter.
remove()
```php
public function remove( string $key ): void;
```
Removes a session variable from an application context
set()
```php
public function set(
string $key,
mixed $value
): void;
```
Sets a session variable in an application context
setAdapter()
```php
public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;
```
Set the adapter for the session
setId()
```php
public function setId( string $sessionId ): ManagerInterface;
```
Set session Id
setName()
```php
public function setName( string $name ): ManagerInterface;
```
Set the session name. Throw exception if the session has started
and do not allow poop names
setOptions()
```php
public function setOptions( array $options ): void;
```
Sets session's options
start()
```php
public function start(): bool;
```
Starts the session (if headers are already sent the session will not be
started)
status()
```php
public function status(): int;
```
Returns the status of the current session.
Source: https://docs.phalcon.io/5.17/api/phalcon_session/index.mdx