session_set_save_handler

Parámetros

Esta función tiene dos prototipos.

sessionhandler

Una instancia de una clase que implementa una o más de las siguientes interfaces: SessionHandlerInterface, y opcionalmente SessionIdInterface, y/o SessionUpdateTimestampHandlerInterface, como la clase SessionHandler, para el registro como manejador de sesión.

register_shutdown

Registra la función session_write_close() como función register_shutdown_function().

open

Una función de retorno con la siguiente firma:

open(string $savePath, string $sessionName): bool

La función de retorno open funciona como un constructor en una clase, y se ejecuta cuando la sesión se abre. Es la primera función de retorno ejecutada cuando la sesión comienza automáticamente o manualmente con la función session_start(). El valor devuelto es true en caso de éxito o false si ocurre un error.

close

Una función de retorno con la siguiente firma:

close(): bool

La función de retorno close funciona como un destructor en una clase, y se ejecuta una vez que la función de retorno write de la sesión ha terminado de ejecutarse. También es llamada cuando la función session_write_close() es llamada. El valor devuelto es true en caso de éxito, o false si ocurre un error.

read

Una función de retorno con la siguiente firma:

read(string $sessionId): string

La función de retorno read debe siempre devolver un string serializado que contenga los datos de sesión codificados o un string vacío si no hay datos que leer.

Esta función de retorno es llamada internamente por PHP cuando la sesión comienza o cuando la función session_start() es llamada. Antes de que esta función de retorno sea invocada, PHP invocará la función de retorno open.

El valor devuelto por esta función de retorno debe ser exactamente del mismo formato de serialización que el pasado para el almacenamiento a la función de retorno write. El valor devuelto será deserializado automáticamente por PHP y utilizado para poblar la variable superglobal $_SESSION. Aunque los datos se asemejen fuertemente a los emitidos por la función serialize(), note que es un formato diferente, que es especificado mediante la opción de configuración session.serialize_handler.

write

Una función de retorno con la siguiente firma:

write(string $sessionId, string $data): bool

La función de retorno write es llamada cuando la sesión debe ser guardada y cerrada. Esta función de retorno recibe el identificador de la sesión actual así como una versión serializada del contenido de la variable superglobal $_SESSION. El método de serialización utilizado internamente por PHP es especificado mediante la opción de configuración session.serialize_handler.

Los datos de sesión serializados pasados a esta función de retorno deben ser almacenados utilizando el identificador de sesión proporcionado. Al recuperar estos datos, la función de retorno read debe devolver el valor exacto, originalmente pasado a la función de retorno write.

Esta función de retorno es invocada cuando PHP se detiene o explícitamente cuando la función session_write_close() es llamada. Note que después de la ejecución de esta función, PHP ejecutará internamente la función de retorno close.

Nota:

El manejador de escritura no se ejecuta hasta que el flujo de salida no haya sido cerrado. Por lo tanto, la salida de las peticiones de depuración del manejador "write" nunca será mostrada en el navegador. Si la salida de depuración es necesaria, se sugiere que sea dirigida a un archivo.

destroy

Una función de retorno con la siguiente firma:

destroy(string $sessionId): bool

Esta función de retorno es ejecutada cuando una sesión es destruida con la función session_destroy() o con session_regenerate_id() con el parámetro de destrucción definido a true. El valor devuelto debe ser true en caso de éxito, o false si ocurre un error.

gc

Una función de retorno con la siguiente firma:

gc(int $lifetime): bool

La función de retorno del recolector de basura es invocada internamente por PHP periódicamente para purgar los datos de sesión antiguos. La frecuencia es controlada por las opciones de configuración session.gc_probability y session.gc_divisor. El valor de la duración de vida pasado a esta función de retorno puede ser definido mediante la opción de configuración session.gc_maxlifetime. El valor devuelto debe ser true en caso de éxito, o false si ocurre un error.

create_sid

Una función de retorno con la siguiente firma:

create_sid(): string

Esta función de retorno es ejecutada cuando se necesita un nuevo ID de sesión. No se proporcionan parámetros, y el valor devuelto debe ser un string que es un ID de sesión válido para su manejador.

validate_sid

Una función de retorno con la siguiente firma:

validate_sid(string $key): bool

Esta función de retorno es ejecutada cuando una sesión va a comenzar, un ID de sesión es proporcionado y session.use_strict_mode está activado. key es el ID de sesión a validar. Un ID de sesión es válido, si una sesión con este ID ya existe. El valor de retorno debe ser true en caso de éxito, false en caso de fallo.

update_timestamp

Una función de retorno con la siguiente firma:

update_timestamp(string $key, string $val): bool

Esta función de retorno es ejecutada cuando una sesión es actualizada. key es el ID de sesión, val son los datos de sesión. El valor de retorno debe ser true en caso de éxito, false en caso de fallo.