Phalcon session

NOTE

All classes are prefixed with Phalcon

Session\Adapter\AbstractAdapter¶

Phalcon\Session\Adapter\AbstractAdapter — implements SessionHandlerInterface, SessionUpdateTimestampHandlerInterface
- Phalcon\Session\Adapter\Libmemcached
- Phalcon\Session\Adapter\Redis

Uses Phalcon\Storage\Adapter\AdapterInterface · SessionHandlerInterface · SessionUpdateTimestampHandlerInterface

Method Summary¶

public bool close() Close public bool destroy( mixed $id ) Destroy public int|false gc( int $max_lifetime ) Garbage Collector public bool open(mixed $path,mixed $name) Open public string read( mixed $id ) Read public bool updateTimestamp(mixed $id,mixed $data) Refresh the session lifetime without changing the session data public bool validateId( mixed $id ) Validate the session id (used when strict mode is enabled) public bool write(mixed $id,mixed $data) Write protected mixed getArrVal(array $collection,mixed $index,mixed $defaultValue = null) @todo Remove this when we get traits

Properties¶

protected AdapterInterface $adapter

Methods¶

Public · 8

`close()`¶

public function close(): bool;

Close

`destroy()`¶

public function destroy( mixed $id ): bool;

Destroy

`gc()`¶

public function gc( int $max_lifetime ): int|false;

Garbage Collector

`open()`¶

public function open(
    mixed $path,
    mixed $name
): bool;

Open

`read()`¶

public function read( mixed $id ): string;

Read

`updateTimestamp()`¶

public function updateTimestamp(
    mixed $id,
    mixed $data
): bool;

Refresh the session lifetime without changing the session data

`validateId()`¶

public function validateId( mixed $id ): bool;

Validate the session id (used when strict mode is enabled)

`write()`¶

public function write(
    mixed $id,
    mixed $data
): bool;

Write

Protected · 1

`getArrVal()`¶

protected function getArrVal(
    array $collection,
    mixed $index,
    mixed $defaultValue = null
): mixed;

@todo Remove this when we get traits

Session\Adapter\Exceptions\AdapterRuntimeError¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError

Uses Phalcon\Session\Exception

Session\Adapter\Exceptions\InvalidSavePath¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Adapter\Exceptions\InvalidSavePath

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Session\Adapter\Exceptions\SavePathUnavailable¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Adapter\Exceptions\SavePathUnavailable

Uses Phalcon\Session\Exception

Method Summary¶

public __construct( string $path )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $path );

Session\Adapter\Libmemcached¶

Class Source on GitHub

Phalcon\Session\Adapter\Libmemcached

Phalcon\Session\Adapter\AbstractAdapter
- Phalcon\Session\Adapter\Libmemcached

Uses Phalcon\Storage\AdapterFactory

Method Summary¶

public __construct(AdapterFactory $factory,array $options = []) Libmemcached constructor.

Methods¶

Public · 1

`__construct()`¶

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

use Phalcon\Session\Manager;
use Phalcon\Session\Adapter\Noop;

$session = new Manager();
$session->setAdapter(new Noop());

Phalcon\Session\Adapter\Noop — implements SessionHandlerInterface, SessionUpdateTimestampHandlerInterface
- Phalcon\Session\Adapter\Stream

Uses SessionHandlerInterface · SessionUpdateTimestampHandlerInterface

Method Summary¶

public bool close() Close public bool destroy( mixed $id ) Destroy public int|false gc( int $max_lifetime ) Garbage Collector public bool open(mixed $path,mixed $name) Open public string read( mixed $id ) Read public bool updateTimestamp(mixed $id,mixed $data) Refresh the session lifetime without changing the session data public bool validateId( mixed $id ) Validate the session id (used when strict mode is enabled) public bool write(mixed $id,mixed $data) Write

Methods¶

Public · 8

`close()`¶

public function close(): bool;

Close

`destroy()`¶

public function destroy( mixed $id ): bool;

Destroy

`gc()`¶

public function gc( int $max_lifetime ): int|false;

Garbage Collector

`open()`¶

public function open(
    mixed $path,
    mixed $name
): bool;

Open

`read()`¶

public function read( mixed $id ): string;

Read

`updateTimestamp()`¶

public function updateTimestamp(
    mixed $id,
    mixed $data
): bool;

Refresh the session lifetime without changing the session data

`validateId()`¶

public function validateId( mixed $id ): bool;

Validate the session id (used when strict mode is enabled)

`write()`¶

public function write(
    mixed $id,
    mixed $data
): bool;

Write

Session\Adapter\Redis¶

Class Source on GitHub

Phalcon\Session\Adapter\Redis

Phalcon\Session\Adapter\AbstractAdapter
- Phalcon\Session\Adapter\Redis

Uses Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError · Phalcon\Storage\AdapterFactory

Method Summary¶

public __construct(AdapterFactory $factory,array $options = []) Constructor public bool close() Close - releases the session lock if one is held public bool destroy( mixed $id ) Destroy public string read( mixed $id ) Read protected bool acquireLock( mixed $id ) Tries to acquire the session lock, pausing lockWaitTime microseconds protected void releaseLock() Releases the session lock - only when this instance still owns it

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()`¶

public function __construct(
    AdapterFactory $factory,
    array $options = []
);

Constructor

`close()`¶

public function close(): bool;

Close - releases the session lock if one is held

`destroy()`¶

public function destroy( mixed $id ): bool;

Destroy

`read()`¶

public function read( mixed $id ): string;

Read

Protected · 2

`acquireLock()`¶

protected function acquireLock( mixed $id ): bool;

Tries to acquire the session lock, pausing lockWaitTime microseconds between attempts, up to lockRetries times

`releaseLock()`¶

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

use Phalcon\Session\Manager;
use Phalcon\Session\Adapter\Stream;

$session = new Manager();
$files = new Stream(
    [
        'savePath' => '/tmp',
    ]
);
$session->setAdapter($files);

@property array $options @property string $prefix @property string $path

Phalcon\Session\Adapter\Noop
- Phalcon\Session\Adapter\Stream

Uses Phalcon\Session\Adapter\Exceptions\AdapterRuntimeError · Phalcon\Session\Adapter\Exceptions\InvalidSavePath · Phalcon\Session\Adapter\Exceptions\SavePathUnavailable

Method Summary¶

public __construct( array $options = [] ) Constructor public bool destroy( mixed $id ) public int|false gc( int $max_lifetime ) Garbage Collector public bool open(mixed $path,mixed $name) Ignore the savePath and use local defined path public string read( mixed $id ) Reads data from the adapter public bool updateTimestamp(mixed $id,mixed $data) Refresh the session file modification time without changing its data public bool validateId( mixed $id ) Validate the session id (used when strict mode is enabled) public bool write(mixed $id,mixed $data) protected mixed getArrVal(array $collection,mixed $index,mixed $defaultValue = null,string $cast = null) @todo Remove this when we get traits protected array|false getGlobFiles( string $pattern ) Gets the glob array or returns false on failure protected string getPrefixedName( mixed $name ) Helper method to get the name prefixed protected phpFileExists( string $filename ) @link https://php.net/manual/en/function.file-exists.php protected phpFileGetContents( string $filename ) @link https://php.net/manual/en/function.file-get-contents.php protected phpFilePutContents(string $filename,mixed $data,int $flags = 0,mixed $context = null) @link https://php.net/manual/en/function.file-put-contents.php protected phpFopen(string $filename,string $mode) @link https://php.net/manual/en/function.fopen.php protected string phpIniGet( string $varname ) Gets the value of a configuration option protected bool phpIsWritable( string $filename ) Tells whether the filename is writable

Properties¶

protected array $options = [] Session options

protected string $prefix = "" Session prefix

Methods¶

Public · 8

`__construct()`¶

public function __construct( array $options = [] );

Constructor

`destroy()`¶

public function destroy( mixed $id ): bool;

`gc()`¶

public function gc( int $max_lifetime ): int|false;

Garbage Collector

`open()`¶

public function open(
    mixed $path,
    mixed $name
): bool;

Ignore the savePath and use local defined path

`read()`¶

public function read( mixed $id ): string;

Reads data from the adapter

`updateTimestamp()`¶

public function updateTimestamp(
    mixed $id,
    mixed $data
): bool;

Refresh the session file modification time without changing its data

`validateId()`¶

public function validateId( mixed $id ): bool;

Validate the session id (used when strict mode is enabled)

`write()`¶

public function write(
    mixed $id,
    mixed $data
): bool;

Protected · 9

`getArrVal()`¶

protected function getArrVal(
    array $collection,
    mixed $index,
    mixed $defaultValue = null,
    string $cast = null
): mixed;

@todo Remove this when we get traits

`getGlobFiles()`¶

protected function getGlobFiles( string $pattern ): array|false;

Gets the glob array or returns false on failure

`getPrefixedName()`¶

protected function getPrefixedName( mixed $name ): string;

Helper method to get the name prefixed

`phpFileExists()`¶

protected function phpFileExists( string $filename );

@link https://php.net/manual/en/function.file-exists.php

`phpFileGetContents()`¶

protected function phpFileGetContents( string $filename );

@link https://php.net/manual/en/function.file-get-contents.php

`phpFilePutContents()`¶

protected function phpFilePutContents(
    string $filename,
    mixed $data,
    int $flags = 0,
    mixed $context = null
);

@link https://php.net/manual/en/function.file-put-contents.php

`phpFopen()`¶

protected function phpFopen(
    string $filename,
    string $mode
);

@link https://php.net/manual/en/function.fopen.php

`phpIniGet()`¶

protected function phpIniGet( string $varname ): string;

Gets the value of a configuration option

@link https://php.net/manual/en/function.ini-get.php @link https://php.net/manual/en/ini.list.php

`phpIsWritable()`¶

protected function phpIsWritable( string $filename ): bool;

Tells whether the filename is writable

@link https://php.net/manual/en/function.is-writable.php

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

$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
- Phalcon\Session\Bag — implements Phalcon\Session\BagInterface, Phalcon\Di\InjectionAwareInterface

Uses Phalcon\Di\Di · Phalcon\Di\DiInterface · Phalcon\Di\InjectionAwareInterface · Phalcon\Session\ManagerInterface · Phalcon\Support\Collection

Method Summary¶

public __construct(ManagerInterface $session,string $name) public void clear() Destroys the session bag public DiInterface getDI() Returns the DependencyInjector container public void init( array $data = [] ) Initialize internal array public void remove( string $element ) Removes a property from the internal bag public void set(string $element,mixed $value) Sets a value in the session bag public void setDI( DiInterface $container ) Sets the DependencyInjector container

Methods¶

Public · 7

`__construct()`¶

public function __construct(
    ManagerInterface $session,
    string $name
);

`clear()`¶

public function clear(): void;

Destroys the session bag

`getDI()`¶

public function getDI(): DiInterface;

Returns the DependencyInjector container

`init()`¶

public function init( array $data = [] ): void;

Initialize internal array

`remove()`¶

public function remove( string $element ): void;

Removes a property from the internal bag

`set()`¶

public function set(
    string $element,
    mixed $value
): void;

Sets a value in the session bag

`setDI()`¶

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¶

public mixed __get( string $element ) public bool __isset( string $element ) public void __set(string $element,mixed $value) public void __unset( string $element ) public void clear() public mixed get(string $element,mixed $defaultValue = null,string $cast = null) public bool has( string $element ) public void init( array $data = [] ) public void remove( string $element ) public void set(string $element,mixed $value)

Methods¶

Public · 10

`__get()`¶

public function __get( string $element ): mixed;

`__isset()`¶

public function __isset( string $element ): bool;

`__set()`¶

public function __set(
    string $element,
    mixed $value
): void;

`__unset()`¶

public function __unset( string $element ): void;

`clear()`¶

public function clear(): void;

`get()`¶

public function get(
    string $element,
    mixed $defaultValue = null,
    string $cast = null
): mixed;

`has()`¶

public function has( string $element ): bool;

`init()`¶

public function init( array $data = [] ): void;

`remove()`¶

public function remove( string $element ): void;

`set()`¶

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

Session\Exceptions\InvalidSessionAdapter¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Exceptions\InvalidSessionAdapter

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Session\Exceptions\InvalidSessionId¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Exceptions\InvalidSessionId

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Session\Exceptions\InvalidSessionName¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Exceptions\InvalidSessionName

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Session\Exceptions\SessionAlreadyStarted¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Exceptions\SessionAlreadyStarted

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Session\Exceptions\SessionModificationDenied¶

Class Source on GitHub

\Exception
- Phalcon\Session\Exception
  - Phalcon\Session\Exceptions\SessionModificationDenied

Uses Phalcon\Session\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

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
  - Phalcon\Session\Manager — implements Phalcon\Session\ManagerInterface

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 · SessionHandlerInterface

Method Summary¶

Methods¶

Public · 22

`__construct()`¶

public function __construct( array $options = [] );

Manager constructor.

`__get()`¶

public function __get( string $key ): mixed;

Alias: Gets a session variable from an application context

`__isset()`¶

public function __isset( string $key ): bool;

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

`__set()`¶

public function __set(
    string $key,
    mixed $value
): void;

Alias: Sets a session variable in an application context

`__unset()`¶

public function __unset( string $key ): void;

Alias: Removes a session variable from an application context

`destroy()`¶

public function destroy(): void;

Destroy/end a session

`exists()`¶

public function exists(): bool;

Check whether the session has been started

`get()`¶

public function get(
    string $key,
    mixed $defaultValue = null,
    bool $remove = false
): mixed;

Gets a session variable from an application context

`getAdapter()`¶

public function getAdapter(): SessionHandlerInterface|null;

Returns the stored session adapter

`getId()`¶

public function getId(): string;

Returns the session id

`getName()`¶

public function getName(): string;

Returns the name of the session

`getOptions()`¶

public function getOptions(): array;

Get internal options

`has()`¶

public function has( string $key ): bool;

Check whether a session variable is set in an application context

`regenerateId()`¶

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()`¶

public function remove( string $key ): void;

Removes a session variable from an application context

`set()`¶

public function set(
    string $key,
    mixed $value
): void;

Sets a session variable in an application context

`setAdapter()`¶

public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;

Set the adapter for the session

`setId()`¶

public function setId( string $sessionId ): ManagerInterface;

Set session Id

`setName()`¶

public function setName( string $name ): ManagerInterface;

Set the session name. Throw exception if the session has started and do not allow poop names

`setOptions()`¶

public function setOptions( array $options ): void;

Sets session's options

`start()`¶

public function start(): bool;

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

`status()`¶

public function status(): int;

Returns the status of the current session.

Protected · 1

`phpHeadersSent()`¶

protected function phpHeadersSent(): bool;

Checks if or where headers have been sent

@link https://php.net/manual/en/function.headers-sent.php

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()`¶

public function __get( string $key ): mixed;

Alias: Gets a session variable from an application context

`__isset()`¶

public function __isset( string $key ): bool;

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

`__set()`¶

public function __set(
    string $key,
    mixed $value
): void;

Alias: Sets a session variable in an application context

`__unset()`¶

public function __unset( string $key ): void;

Alias: Removes a session variable from an application context

`destroy()`¶

public function destroy(): void;

Destroy/end a session

`exists()`¶

public function exists(): bool;

Check whether the session has been started

`get()`¶

public function get(
    string $key,
    mixed $defaultValue = null,
    bool $remove = false
): mixed;

Gets a session variable from an application context

`getAdapter()`¶

public function getAdapter(): SessionHandlerInterface|null;

Returns the stored session adapter

`getId()`¶

public function getId(): string;

Returns the session id

`getName()`¶

public function getName(): string;

Returns the name of the session

`getOptions()`¶

public function getOptions(): array;

Get internal options

`has()`¶

public function has( string $key ): bool;

Check whether a session variable is set in an application context

`regenerateId()`¶

public function regenerateId( bool $deleteOldSession = true ): ManagerInterface;

Regenerates the session id using the adapter.

`remove()`¶

public function remove( string $key ): void;

Removes a session variable from an application context

`set()`¶

public function set(
    string $key,
    mixed $value
): void;

Sets a session variable in an application context

`setAdapter()`¶

public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;

Set the adapter for the session

`setId()`¶

public function setId( string $sessionId ): ManagerInterface;

Set session Id

`setName()`¶

public function setName( string $name ): ManagerInterface;

Set the session name. Throw exception if the session has started and do not allow poop names

`setOptions()`¶

public function setOptions( array $options ): void;

Sets session's options

`start()`¶

public function start(): bool;

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

`status()`¶

public function status(): int;

Returns the status of the current session.

Phalcon session

Session\Adapter\AbstractAdapter¶

Method Summary¶

Properties¶

Methods¶

close()¶

destroy()¶

gc()¶

open()¶

read()¶

updateTimestamp()¶

validateId()¶

write()¶

getArrVal()¶

Session\Adapter\Exceptions\AdapterRuntimeError¶

Session\Adapter\Exceptions\InvalidSavePath¶

Method Summary¶

Methods¶

__construct()¶

Session\Adapter\Exceptions\SavePathUnavailable¶

Method Summary¶

Methods¶

__construct()¶

Session\Adapter\Libmemcached¶

Method Summary¶

Methods¶

__construct()¶

Session\Adapter\Noop¶

Method Summary¶

Methods¶

close()¶

destroy()¶

gc()¶

open()¶

read()¶

updateTimestamp()¶

validateId()¶

write()¶

Session\Adapter\Redis¶

Method Summary¶

Properties¶

Methods¶

__construct()¶

close()¶

destroy()¶

read()¶

acquireLock()¶

releaseLock()¶

Session\Adapter\Stream¶

Method Summary¶

Properties¶

Methods¶

__construct()¶

destroy()¶

gc()¶

open()¶

read()¶

updateTimestamp()¶

validateId()¶

write()¶

getArrVal()¶

getGlobFiles()¶

getPrefixedName()¶

phpFileExists()¶

phpFileGetContents()¶

phpFilePutContents()¶

phpFopen()¶

phpIniGet()¶

phpIsWritable()¶

Session\Bag¶

Method Summary¶

Methods¶

__construct()¶

clear()¶

getDI()¶

init()¶

remove()¶

set()¶

setDI()¶

Session\BagInterface¶

`close()`¶

`destroy()`¶

`gc()`¶

`open()`¶

`read()`¶

`updateTimestamp()`¶

`validateId()`¶

`write()`¶

`getArrVal()`¶

`__construct()`¶

`__construct()`¶

`__construct()`¶

`close()`¶

`destroy()`¶

`gc()`¶

`open()`¶

`read()`¶

`updateTimestamp()`¶

`validateId()`¶

`write()`¶

`__construct()`¶

`close()`¶

`destroy()`¶

`read()`¶

`acquireLock()`¶

`releaseLock()`¶

`__construct()`¶

`destroy()`¶

`gc()`¶

`open()`¶

`read()`¶

`updateTimestamp()`¶

`validateId()`¶

`write()`¶

`getArrVal()`¶

`getGlobFiles()`¶

`getPrefixedName()`¶

`phpFileExists()`¶

`phpFileGetContents()`¶

`phpFilePutContents()`¶

`phpFopen()`¶

`phpIniGet()`¶

`phpIsWritable()`¶

`__construct()`¶

`clear()`¶

`getDI()`¶

`init()`¶

`remove()`¶

`set()`¶

`setDI()`¶

`__get()`¶

`__isset()`¶

`__set()`¶

`__unset()`¶

`clear()`¶

`get()`¶

`has()`¶

`init()`¶

`remove()`¶

`set()`¶

`__construct()`¶

`__construct()`¶

`__construct()`¶

`__construct()`¶

`__construct()`¶

`__construct()`¶

`__get()`¶

`__isset()`¶

`__set()`¶

`__unset()`¶

`destroy()`¶

`exists()`¶

`get()`¶

`getAdapter()`¶

`getId()`¶

`getName()`¶

`getOptions()`¶

`has()`¶

`regenerateId()`¶

`remove()`¶