Zend\Session\Config\SessionConfig
Session configuration proxying to session INI options
Synopsis
class SessionConfig
extends StandardConfig
{
- // members
- protected int $phpErrorCode;
- protected string $phpErrorMessage;
- protected integer $rememberMeSeconds;
- protected string $serializeHandler;
- protected array $validCacheLimiters;
- protected array $validHashBitsPerCharacters;
- protected array $validHashFunctions;
- // Inherited members from StandardConfig
- protected string $name;
- protected string $savePath;
- protected int $cookieLifetime;
- protected string $cookiePath;
- protected string $cookieDomain;
- protected bool $cookieSecure;
- protected bool $cookieHttpOnly;
- protected int $rememberMeSeconds;
- protected bool $useCookies;
- protected array $options;
- // methods
- public SessionConfig setStorageOption()
- public mixed getStorageOption()
- public SessionConfig setPhpSaveHandler()
- public SessionConfig setSavePath()
- public SessionConfig setSerializeHandler()
- public SessionConfig setCacheLimiter()
- public SessionConfig setHashFunction()
- public SessionConfig setHashBitsPerCharacter()
- protected array getHashFunctions()
- protected void handleError()
- // Inherited methods from StandardConfig
- public StandardConfig setOptions()
- public array getOptions()
- public StandardConfig setOption()
- public mixed getOption()
- public bool hasOption()
- public StandardConfig setStorageOption()
- public mixed getStorageOption()
- public StandardConfig setSavePath()
- public string|null getSavePath()
- public StandardConfig setName()
- public null|string getName()
- public StandardConfig setGcProbability()
- public int getGcProbability()
- public StandardConfig setGcDivisor()
- public int getGcDivisor()
- public StandardConfig setGcMaxlifetime()
- public int getGcMaxlifetime()
- public StandardConfig setCookieLifetime()
- public int getCookieLifetime()
- public StandardConfig setCookiePath()
- public string getCookiePath()
- public StandardConfig setCookieDomain()
- public string getCookieDomain()
- public StandardConfig setCookieSecure()
- public bool getCookieSecure()
- public StandardConfig setCookieHttpOnly()
- public bool getCookieHttpOnly()
- public StandardConfig setUseCookies()
- public bool getUseCookies()
- public StandardConfig setEntropyFile()
- public string getEntropyFile()
- public StandardConfig setEntropyLength()
- public string getEntropyLength()
- public StandardConfig setCacheExpire()
- public string getCacheExpire()
- public StandardConfig setHashBitsPerCharacter()
- public string getHashBitsPerCharacter()
- public StandardConfig setRememberMeSeconds()
- public int getRememberMeSeconds()
- public array toArray()
- public mixed __call()
Hierarchy
Members
protected
- $name
—
string
session.name - $options
—
array
All options - $phpErrorCode
—
int
Used with {@link handleError()}; stores PHP error code - $phpErrorMessage
—
string
Used with {@link handleError()}; stores PHP error message - $rememberMeSeconds — int
- $rememberMeSeconds
—
int
remember_me_seconds - $savePath
—
string
session.save_path - $serializeHandler — string
- $useCookies
—
Zend\Session\Config\bool
session.use_cookies - $validCacheLimiters — array
- $validHashBitsPerCharacters — array
- $validHashFunctions — array
Methods
protected
- getHashFunctions() — Retrieve list of valid hash functions
- handleError() — Handle PHP errors
public
- getStorageOption() — Retrieve a storage option from a backend configuration store
- setCacheLimiter() — Set cache limiter
- setHashBitsPerCharacter() — Set session.hash_bits_per_character
- setHashFunction() — Set session.hash_function
- setPhpSaveHandler() — Set session.save_handler
- setSavePath() — Set session.save_path
- setSerializeHandler() — Set session.serialize_handler
- setStorageOption() — Set storage option in backend configuration store
Inherited from Zend\Session\Config\StandardConfig
public
- __call() — Intercept get*() and set*() methods
- getCacheExpire() — Get session.cache_expire
- getCookieDomain() — Get session.cookie_domain
- getCookieHttpOnly() — Get session.cookie_httponly
- getCookieLifetime() — Get session.cookie_lifetime
- getCookiePath() — Get session.cookie_path
- getCookieSecure() — Get session.cookie_secure
- getEntropyFile() — Get session.entropy_file
- getEntropyLength() — Get session.entropy_length
- getGcDivisor() — Get session.gc_divisor
- getGcMaxlifetime() — Get session.gc_maxlifetime
- getGcProbability() — Get session.gc_probability
- getHashBitsPerCharacter() — Get session.hash_bits_per_character
- getName() — Get session.name
- getOption() — Get an individual option
- getOptions() — Get all options set
- getRememberMeSeconds() — Get remember_me_seconds
- getSavePath() — Set session.save_path
- getStorageOption() — Retrieve a storage option from a backend configuration store
- getUseCookies() — Get session.use_cookies
- hasOption() — Check to see if an internal option has been set for the key provided.
- setCacheExpire() — Set session.cache_expire
- setCookieDomain() — Set session.cookie_domain
- setCookieHttpOnly() — Set session.cookie_httponly
- setCookieLifetime() — Set session.cookie_lifetime
- setCookiePath() — Set session.cookie_path
- setCookieSecure() — Set session.cookie_secure
- setEntropyFile() — Set session.entropy_file
- setEntropyLength() — set session.entropy_length
- setGcDivisor() — Set session.gc_divisor
- setGcMaxlifetime() — Set gc_maxlifetime
- setGcProbability() — Set session.gc_probability
- setHashBitsPerCharacter() — Set session.hash_bits_per_character
- setName() — Set session.name
- setOption() — Set an individual option
- setOptions() — Set many options at once
- setRememberMeSeconds() — Set remember_me_seconds
- setSavePath() — Set session.save_path
- setStorageOption() — Set storage option in backend configuration store
- setUseCookies() — Set session.use_cookies
- toArray() — Cast configuration to an array