Alpha ZealPHP is early-stage and under active development. APIs may change between minor versions until v1.0. Feedback and bug reports welcome on GitHub.
Esc
API Index — Namespaces, Packages, Reports, Indices

utils.php

Table of Contents

Functions

php_session_encode_from_array()  : string
Encode an array into PHP's native 'php' session serialize format (key|serialized_value for each key). This matches the format produced by session.serialize_handler = php (the default in mod_php / phpredis).
php_session_decode_to_array()  : array<string, mixed>
zeal_session_start()  : bool
Start a new session or resume existing one
zeal_session_id()  : string|false
Get or set the session ID
zeal_session_status()  : int
zeal_session_name()  : string
Get or set the session name
zeal_session_write_close()  : bool
Write session data and close the session
zeal_session_destroy()  : bool
Destroy the session
zeal_session_unset()  : void
Unset all session variables
zeal_session_regenerate_id()  : bool
Regenerate session ID
zeal_session_get_cookie_params()  : array{lifetime: int, path: string, domain: string, secure: bool, httponly: bool, samesite?: string}
Get session cookie parameters
zeal_session_set_cookie_params()  : void
Set session cookie parameters. Accepts either positional args (PHP < 8.0) or an options array (PHP 8.0+).
zeal_session_cache_limiter()  : string
zeal_session_commit()  : bool
zeal_session_cache_expire()  : int
zeal_session_abort()  : bool
zeal_session_encode()  : string
zeal_session_decode()  : bool
zeal_session_create_id()  : string|false
zeal_session_save_path()  : string
zeal_session_module_name()  : string

Functions

php_session_encode_from_array()

Encode an array into PHP's native 'php' session serialize format (key|serialized_value for each key). This matches the format produced by session.serialize_handler = php (the default in mod_php / phpredis).

php_session_encode_from_array(array<string, mixed> $data) : string
Parameters
$data : array<string, mixed>
Return values
string

php_session_decode_to_array()

php_session_decode_to_array(string $data) : array<string, mixed>
Parameters
$data : string
Return values
array<string, mixed>

zeal_session_start()

Start a new session or resume existing one

zeal_session_start() : bool
Return values
bool

zeal_session_id()

Get or set the session ID

zeal_session_id([string|null $id = null ]) : string|false
Parameters
$id : string|null = null
Return values
string|false

zeal_session_status()

zeal_session_status() : int
Return values
int

zeal_session_name()

Get or set the session name

zeal_session_name([string|null $name = null ]) : string
Parameters
$name : string|null = null
Return values
string

zeal_session_write_close()

Write session data and close the session

zeal_session_write_close() : bool
Return values
bool

zeal_session_destroy()

Destroy the session

zeal_session_destroy() : bool
Return values
bool

zeal_session_unset()

Unset all session variables

zeal_session_unset() : void

zeal_session_regenerate_id()

Regenerate session ID

zeal_session_regenerate_id([bool $delete_old_session = false ]) : bool
Parameters
$delete_old_session : bool = false
Return values
bool

zeal_session_get_cookie_params()

Get session cookie parameters

zeal_session_get_cookie_params() : array{lifetime: int, path: string, domain: string, secure: bool, httponly: bool, samesite?: string}
Return values
array{lifetime: int, path: string, domain: string, secure: bool, httponly: bool, samesite?: string}

zeal_session_set_cookie_params()

Set session cookie parameters. Accepts either positional args (PHP < 8.0) or an options array (PHP 8.0+).

zeal_session_set_cookie_params(int|array<string, mixed> $lifetime_or_options[, string $path = '/' ][, string $domain = '' ][, bool $secure = false ][, bool $httponly = false ]) : void
Parameters
$lifetime_or_options : int|array<string, mixed>
$path : string = '/'
$domain : string = ''
$secure : bool = false
$httponly : bool = false

zeal_session_cache_limiter()

zeal_session_cache_limiter([string|null $cache_limiter = null ]) : string
Parameters
$cache_limiter : string|null = null
Return values
string

zeal_session_commit()

zeal_session_commit() : bool
Return values
bool

zeal_session_cache_expire()

zeal_session_cache_expire([int|null $cache_expire = null ]) : int
Parameters
$cache_expire : int|null = null
Return values
int

zeal_session_abort()

zeal_session_abort() : bool
Return values
bool

zeal_session_encode()

zeal_session_encode() : string
Return values
string

zeal_session_decode()

zeal_session_decode(string $data) : bool
Parameters
$data : string
Return values
bool

zeal_session_create_id()

zeal_session_create_id([string $prefix = '' ]) : string|false
Parameters
$prefix : string = ''
Return values
string|false

zeal_session_save_path()

zeal_session_save_path([string|null $path = null ]) : string
Parameters
$path : string|null = null
Return values
string

zeal_session_module_name()

zeal_session_module_name([string|null $module = null ]) : string
Parameters
$module : string|null = null
Return values
string
On this page