Session configuration proxying to session INI options

 Methods

Intercept get*() and set*() methods

__call(string $method, array $args) : mixed
Inherited

Intercepts getters and setters and passes them to getOption() and setOption(), respectively.

inherited_from \Zend\Session\Config\StandardConfig::__call()

Parameters

$method

string

$args

array

Exceptions

\Zend\Session\Exception\BadMethodCallException on non-getter/setter method

Returns

mixed

Get session.cache_expire

getCacheExpire() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCacheExpire()

Returns

string

Get session.cookie_domain

getCookieDomain() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCookieDomain()

Returns

string

Get session.cookie_httponly

getCookieHttpOnly() : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCookieHttpOnly()

Returns

bool

Get session.cookie_lifetime

getCookieLifetime() : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCookieLifetime()

Returns

int

Get session.cookie_path

getCookiePath() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCookiePath()

Returns

string

Get session.cookie_secure

getCookieSecure() : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getCookieSecure()

Returns

bool

Get session.entropy_file

getEntropyFile() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getEntropyFile()

Returns

string

Get session.entropy_length

getEntropyLength() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getEntropyLength()

Returns

string

Get session.gc_divisor

getGcDivisor() : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getGcDivisor()

Returns

int

Get session.gc_maxlifetime

getGcMaxlifetime() : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getGcMaxlifetime()

Returns

int

Get session.gc_probability

getGcProbability() : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getGcProbability()

Returns

int

Get session.hash_bits_per_character

getHashBitsPerCharacter() : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getHashBitsPerCharacter()

Returns

string

Get session.name

getName() : null | string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getName()

Returns

nullstring

Get an individual option

getOption(string $option) : mixed
Inherited

Keys are normalized to lowercase. If the option is not found, attempts to retrieve it via getStorageOption(); if a value is returned from that method, it will be set as the internal value and returned.

Returns null for unfound options

inherited_from \Zend\Session\Config\StandardConfig::getOption()

Parameters

$option

string

Returns

mixed

Get all options set

getOptions() : array
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getOptions()

Returns

array

Get remember_me_seconds

getRememberMeSeconds() : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getRememberMeSeconds()

Returns

int

Set session.save_path

getSavePath() : string | null
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getSavePath()

Returns

stringnull

Retrieve a storage option from a backend configuration store

getStorageOption(string $storageOption) : mixed

Used to retrieve default values from a backend configuration store.

Parameters

$storageOption

string

Returns

mixed

Get session.use_cookies

getUseCookies() : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::getUseCookies()

Returns

bool

Check to see if an internal option has been set for the key provided.

hasOption(string $option) : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::hasOption()

Parameters

$option

string

Returns

bool

Set session.cache_expire

setCacheExpire(int $cacheExpire) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setCacheExpire()

Parameters

$cacheExpire

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set cache limiter

setCacheLimiter($cacheLimiter) : \Zend\Session\Config\SessionConfig

Set session.cookie_domain

setCookieDomain(string $cookieDomain) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setCookieDomain()

Parameters

$cookieDomain

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.cookie_httponly

setCookieHttpOnly(bool $cookieHttpOnly) : \Zend\Session\Config\StandardConfig
Inherited

case sensitive method lookups in setOptions means this method has an unusual casing

inherited_from \Zend\Session\Config\StandardConfig::setCookieHttpOnly()

Parameters

$cookieHttpOnly

bool

Returns

Set session.cookie_lifetime

setCookieLifetime(int $cookieLifetime) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setCookieLifetime()

Parameters

$cookieLifetime

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.cookie_path

setCookiePath(string $cookiePath) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setCookiePath()

Parameters

$cookiePath

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.cookie_secure

setCookieSecure(bool $cookieSecure) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setCookieSecure()

Parameters

$cookieSecure

bool

Returns

Set session.entropy_file

setEntropyFile(string $entropyFile) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setEntropyFile()

Parameters

$entropyFile

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

set session.entropy_length

setEntropyLength(int $entropyLength) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setEntropyLength()

Parameters

$entropyLength

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.gc_divisor

setGcDivisor(int $gcDivisor) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setGcDivisor()

Parameters

$gcDivisor

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set gc_maxlifetime

setGcMaxlifetime(int $gcMaxlifetime) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setGcMaxlifetime()

Parameters

$gcMaxlifetime

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.gc_probability

setGcProbability(int $gcProbability) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setGcProbability()

Parameters

$gcProbability

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.hash_bits_per_character

setHashBitsPerCharacter(int $hashBitsPerCharacter) : \Zend\Session\Config\SessionConfig

Parameters

$hashBitsPerCharacter

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.hash_function

setHashFunction(string | int $hashFunction) : \Zend\Session\Config\SessionConfig

Parameters

$hashFunction

stringint

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.name

setName(string $name) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setName()

Parameters

$name

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set an individual option

setOption(string $option, mixed $value) : \Zend\Session\Config\StandardConfig
Inherited

Keys are normalized to lowercase. After setting internally, calls setStorageOption() to allow further processing.

inherited_from \Zend\Session\Config\StandardConfig::setOption()

Parameters

$option

string

$value

mixed

Returns

Set many options at once

setOptions(array | \Traversable $options) : \Zend\Session\Config\StandardConfig
Inherited

If a setter method exists for the key, that method will be called; otherwise, a standard option will be set with the value provided via setOption().

inherited_from \Zend\Session\Config\StandardConfig::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.save_handler

setPhpSaveHandler(string $phpSaveHandler) : \Zend\Session\Config\SessionConfig

Parameters

$phpSaveHandler

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set remember_me_seconds

setRememberMeSeconds(int $rememberMeSeconds) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setRememberMeSeconds()

Parameters

$rememberMeSeconds

int

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set session.save_path

setSavePath(string $savePath) : \Zend\Session\Config\SessionConfig

Parameters

$savePath

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException on invalid path

Returns

Set session.serialize_handler

setSerializeHandler(string $serializeHandler) : \Zend\Session\Config\SessionConfig

Parameters

$serializeHandler

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

Set storage option in backend configuration store

setStorageOption(string $storageName, mixed $storageValue) : \Zend\Session\Config\SessionConfig

Does nothing in this implementation; others might use it to set things such as INI settings.

Parameters

$storageName

string

$storageValue

mixed

Exceptions

\InvalidArgumentException

Returns

Set session.use_cookies

setUseCookies(bool $useCookies) : \Zend\Session\Config\StandardConfig
Inherited

inherited_from \Zend\Session\Config\StandardConfig::setUseCookies()

Parameters

$useCookies

bool

Returns

Cast configuration to an array

toArray() : array
Inherited

inherited_from \Zend\Session\Config\StandardConfig::toArray()

Returns

array

Retrieve list of valid hash functions

getHashFunctions() : array

Returns

array

Handle PHP errors

handleError(int $code, string $message) : void

Parameters

$code

int

$message

string

 Properties

 

session.cookie_domain

$cookieDomain : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$cookieDomain
 

session.cookie_httponly

$cookieHttpOnly : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$cookieHttpOnly
 

session.cookie_lifetime

$cookieLifetime : int
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$cookieLifetime
 

session.cookie_path

$cookiePath : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$cookiePath
 

session.cookie_secure

$cookieSecure : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$cookieSecure
 

session.name

$name : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$name
 

All options

$options : array
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$options
 

Used with {@link handleError()}; stores PHP error code

$phpErrorCode : int

 

Used with {@link handleError()}; stores PHP error message

$phpErrorMessage : string

 

remember_me_seconds

$rememberMeSeconds : int

 

session.save_path

$savePath : string
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$savePath
 

<p>session.serialize_handler</p>

$serializeHandler : string

 

session.use_cookies

$useCookies : bool
Inherited

inherited_from \Zend\Session\Config\StandardConfig::$$useCookies
 

<p>Valid cache limiters (per session.cache_limiter)</p>

$validCacheLimiters : array

 

<p>Valid hash bits per character (per session.hash_bits_per_character)</p>

$validHashBitsPerCharacters : array

 

<p>Valid hash functions (per session.hash_function)</p>

$validHashFunctions : array