Secciones

Abstract Class Phalcon\Session\Adapter\AbstractAdapter

Código fuente en GitHub

Namespace Phalcon\Session\Adapter   Uses Phalcon\Storage\Adapter\AdapterInterface, SessionHandlerInterface   Implements SessionHandlerInterface

Propiedades

/**
 * @var AdapterInterface
 */
protected adapter;

Métodos

public function close(): bool;

Cerrar

public function destroy( mixed $sessionId ): bool;

Destruir

public function gc( int $maxlifetime ): int | bool;

Recolección de basura (GC)

public function open( mixed $savePath, mixed $sessionName ): bool;

Abrir

public function read( mixed $sessionId ): string;

Leer

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

Escribir

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

@todo Remove this when we get traits

Class Phalcon\Session\Adapter\Libmemcached

Código fuente en GitHub

Namespace Phalcon\Session\Adapter   Uses Phalcon\Storage\AdapterFactory   Extends AbstractAdapter

Phalcon\Session\Adapter\Libmemcached

Métodos

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

Constructor Libmemcached.

Class Phalcon\Session\Adapter\Noop

Código fuente en GitHub

Namespace Phalcon\Session\Adapter   Uses SessionHandlerInterface   Implements SessionHandlerInterface

Phalcon\Session\Adapter\Noop

Este es un adaptador “vacío” o nulo. 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());

Propiedades

/**
 * The connection of some adapters
 *
 * @var null
 */
protected connection;

/**
 * Session options
 *
 * @var array
 */
protected options;

/**
 * Session prefix
 *
 * @var string
 */
protected prefix = ;

/**
 * Time To Live
 *
 * @var int
 */
protected ttl = 8600;

Métodos

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

Constructor

public function close(): bool;

Cerrar

public function destroy( mixed $sessionId ): bool;

Destruir

public function gc( int $maxlifetime ): int | bool;

Recolección de basura (GC)

public function open( mixed $savePath, mixed $sessionName ): bool;

Abrir

public function read( mixed $sessionId ): string;

Leer

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

Escribir

protected function getPrefixedName( mixed $name ): string;

Método auxiliar para obtener el prefijo del nombre

Class Phalcon\Session\Adapter\Redis

Código fuente en GitHub

Namespace Phalcon\Session\Adapter   Uses Phalcon\Storage\AdapterFactory   Extends AbstractAdapter

Phalcon\Session\Adapter\Redis

Métodos

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

Constructor

Class Phalcon\Session\Adapter\Stream

Código fuente en GitHub

Namespace Phalcon\Session\Adapter   Uses Phalcon\Session\Exception   Extends Noop

Phalcon\Session\Adapter\Stream

Este es el adaptador basado en ficheros. Almacena sesiones en un sistema basado en ficheros

<?php

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

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

Propiedades

/**
 * @var string
 */
private path = ;

Métodos

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

Constructor

public function destroy( mixed $sessionId ): bool;
public function gc( int $maxlifetime ): int | bool;

Recolección de basura (GC)

public function open( mixed $savePath, mixed $sessionName ): bool;

Ignora savePath y usa la ruta local definida

public function read( mixed $sessionId ): string;

Lee datos desde el adaptador

public function write( mixed $sessionId, mixed $data ): bool;
protected function getArrVal( array $collection, mixed $index, mixed $defaultValue = null, string $cast = null ): mixed;

@todo Remove this when we get traits

protected function phpFileExists( string $filename );
protected function phpFileGetContents( string $filename );
protected function phpFilePutContents( string $filename, mixed $data, int $flags = int, mixed $context = null );
protected function phpFopen( string $filename, string $mode );
protected function phpIniGet( string $varname ): string;

Gets the value of a configuration option

protected function phpIsWritable( string $filename ): bool;

Tells whether the filename is writable

Class Phalcon\Session\Bag

Código fuente en GitHub

Namespace Phalcon\Session   Uses Phalcon\Di\Di, Phalcon\Di\DiInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\Session\ManagerInterface, Phalcon\Support\Collection   Extends Collection   Implements BagInterface, InjectionAwareInterface

Phalcon\Session\Bag

Este componente ayuda a separar los datos de sesión en “namespaces”. Trabajando de esta forma puede crear fácilmente grupos de variables de sesión en la aplicación

$user = new \Phalcon\Session\Bag("user");

$user->name = "Kimbra Johnson";
$user->age  = 22;

Propiedades

/**
 * @var DiInterface|null
 */
private container;

/**
 * Session Bag name
 *
 * @var string
 */
private name;

/**
 * @var ManagerInterface
 */
private session;

Métodos

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

Destruye la bolsa de la sesión

public function getDI(): DiInterface;

Devuelve el contenedor DependencyInjector

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

Inicializa el vector interno

public function remove( string $element ): void;

Elimina una propiedad de la bolsa interna

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

Establece un valor en la bolsa de sesión

public function setDI( DiInterface $container ): void;

Configura el contenedor DependencyInjector

Interface Phalcon\Session\BagInterface

Código fuente en GitHub

Namespace Phalcon\Session

Phalcon\Session\BagInterface

Interface for Phalcon\Session\Bag

Métodos

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

Class Phalcon\Session\Exception

Código fuente en GitHub

Namespace Phalcon\Session   Extends \Exception

Phalcon\Session\Exception

Las excepciones lanzadas en Phalcon\Session usarán esta clase

Class Phalcon\Session\Manager

Código fuente en GitHub

Namespace Phalcon\Session   Uses InvalidArgumentException, RuntimeException, SessionHandlerInterface, Phalcon\Di\AbstractInjectionAware, Phalcon\Di\DiInterface, Phalcon\Support\Helper\Arr\Get   Extends AbstractInjectionAware   Implements ManagerInterface

Phalcon\Session\Manager

Clase gestor de sesiones

Propiedades

/**
 * @var SessionHandlerInterface|null
 */
private adapter;

/**
 * @var string
 */
private name = ;

/**
 * @var array
 */
private options;

/**
 * @var string
 */
private uniqueId = ;

Métodos

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

Constructor del gestor.

public function __get( string $key ): mixed;

Alias: obtiene una variable de sesión de un contexto de aplicación

public function __isset( string $key ): bool;

Alias: comprueba si una variable de sesión se ha establecido en un contexto de aplicación

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

Alias: establece una variable de sesión en un contexto de aplicación

public function __unset( string $key ): void;

Alias: elimina una variable de sesión de un contexto de aplicación

public function destroy(): void;

Destruir/finalizar una sesión

public function exists(): bool;

Comprueba si la sesión ha sido iniciada

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

Obtiene una variable de sesión de un contexto de aplicación

public function getAdapter(): SessionHandlerInterface;

Devuelve el adaptador de sesión almacenado

public function getId(): string;

Devuelve el id de sesión

public function getName(): string;

Devuelve el nombre de la sesión

public function getOptions(): array;

Obtiene opciones internas

public function has( string $key ): bool;

Comprueba si una variable de sesión se ha establecido en un contexto de aplicación

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

Regenera el identificador de sesión usando el adaptador.

public function remove( string $key ): void;

Elimina una variable de sesión de un contexto de aplicación

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

Establece una variable de sesión en un contexto de aplicación

public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;

Establece el adaptador para la sesión

public function setId( string $sessionId ): ManagerInterface;

Establece el Id de la sesión

public function setName( string $name ): ManagerInterface;

Establece el nombre de la sesión. Lanzar una excepción si la sesión ha iniciado y no permite nombres malos

public function setOptions( array $options ): void;

Establece las opciones de la sesión

public function start(): bool;

Inicia la sesión (si las cabeceras ya se enviaron, la sesión no iniciará)

public function status(): int;

Devuelve el estado de la sesión actual.

protected function phpHeadersSent(): bool;

Checks if or where headers have been sent

Interface Phalcon\Session\ManagerInterface

Código fuente en GitHub

Namespace Phalcon\Session   Uses InvalidArgumentException, RuntimeException, SessionHandlerInterface

Phalcon\Session

Interfaz para Phalcon\Session\Manager

Constantes

const SESSION_ACTIVE = 2;
const SESSION_DISABLED = 0;
const SESSION_NONE = 1;

Métodos

public function __get( string $key ): mixed;

Alias: obtiene una variable de sesión de un contexto de aplicación

public function __isset( string $key ): bool;

Alias: comprueba si una variable de sesión se ha establecido en un contexto de aplicación

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

Alias: establece una variable de sesión en un contexto de aplicación

public function __unset( string $key ): void;

Alias: elimina una variable de sesión de un contexto de aplicación

public function destroy(): void;

Destruir/finalizar una sesión

public function exists(): bool;

Comprueba si la sesión ha sido iniciada

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

Obtiene una variable de sesión de un contexto de aplicación

public function getAdapter(): SessionHandlerInterface;

Devuelve el adaptador de sesión almacenado

public function getId(): string;

Devuelve el id de sesión

public function getName(): string;

Devuelve el nombre de la sesión

public function getOptions(): array;

Obtiene opciones internas

public function has( string $key ): bool;

Comprueba si una variable de sesión se ha establecido en un contexto de aplicación

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

Regenera el identificador de sesión usando el adaptador.

public function remove( string $key ): void;

Elimina una variable de sesión de un contexto de aplicación

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

Establece una variable de sesión en un contexto de aplicación

public function setAdapter( SessionHandlerInterface $adapter ): ManagerInterface;

Establece el adaptador para la sesión

public function setId( string $sessionId ): ManagerInterface;

Establece el Id de la sesión

public function setName( string $name ): ManagerInterface;

Establece el nombre de la sesión. Lanzar una excepción si la sesión ha iniciado y no permite nombres malos

@throws InvalidArgumentException

public function setOptions( array $options ): void;

Establece las opciones de la sesión

public function start(): bool;

Inicia la sesión (si las cabeceras ya se enviaron, la sesión no iniciará)

public function status(): int;

Devuelve el estado de la sesión actual.