Standard session configuration

package Default

 Methods

Intercept get*() and set*() methods

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

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

Parameters

$method

string

$args

array

Exceptions

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

Returns

mixed

Get session.cache_expire

getCacheExpire() : string

Returns

string

Get session.cookie_domain

getCookieDomain() : string
inherited_from \Zend\Session\Config\ConfigInterface::getCookieDomain()

Returns

string

Get session.cookie_httponly

getCookieHttpOnly() : boolean
inherited_from \Zend\Session\Config\ConfigInterface::getCookieHttpOnly()

Returns

boolean

Get session.cookie_lifetime

getCookieLifetime() : integer
inherited_from \Zend\Session\Config\ConfigInterface::getCookieLifetime()

Returns

integer

Get session.cookie_path

getCookiePath() : string
inherited_from \Zend\Session\Config\ConfigInterface::getCookiePath()

Returns

string

Get session.cookie_secure

getCookieSecure() : boolean
inherited_from \Zend\Session\Config\ConfigInterface::getCookieSecure()

Returns

boolean

Get session.entropy_file

getEntropyFile() : string

Returns

string

Get session.entropy_length

getEntropyLength() : string

Returns

string

Get session.gc_divisor

getGcDivisor() : integer

Returns

integer

Get session.gc_maxlifetime

getGcMaxlifetime() : integer

Returns

integer

Get session.gc_probability

getGcProbability() : integer

Returns

integer

Get session.hash_bits_per_character

getHashBitsPerCharacter() : string

Returns

string

Get session.name

getName() : null | string
inherited_from \Zend\Session\Config\ConfigInterface::getName()

Returns

nullstring

Get an individual option

getOption(string $option) : mixed

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\ConfigInterface::getOption()

Parameters

$option

string

Returns

mixed

Get all options set

getOptions() : array
inherited_from \Zend\Session\Config\ConfigInterface::getOptions()

Returns

array

Get remember_me_seconds

getRememberMeSeconds() : integer
inherited_from \Zend\Session\Config\ConfigInterface::getRememberMeSeconds()

Returns

integer

Set session.save_path

getSavePath() : string | null
inherited_from \Zend\Session\Config\ConfigInterface::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() : boolean
inherited_from \Zend\Session\Config\ConfigInterface::getUseCookies()

Returns

boolean

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

hasOption(string $option) : boolean
inherited_from \Zend\Session\Config\ConfigInterface::hasOption()

Parameters

$option

string

Returns

boolean

Set session.cache_expire

setCacheExpire(integer $cacheExpire) : \Zend\Session\Config\StandardConfig

Parameters

$cacheExpire

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.cookie_domain

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

Parameters

$cookieDomain

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.cookie_httponly

setCookieHttpOnly(boolean $cookieHttpOnly) : \Zend\Session\Config\StandardConfig

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

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

Parameters

$cookieHttpOnly

boolean

Returns

\Zend\Session\Config\StandardConfig

Set session.cookie_lifetime

setCookieLifetime(integer $cookieLifetime) : \Zend\Session\Config\StandardConfig
inherited_from \Zend\Session\Config\ConfigInterface::setCookieLifetime()

Parameters

$cookieLifetime

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.cookie_path

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

Parameters

$cookiePath

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.cookie_secure

setCookieSecure(boolean $cookieSecure) : \Zend\Session\Config\StandardConfig
inherited_from \Zend\Session\Config\ConfigInterface::setCookieSecure()

Parameters

$cookieSecure

boolean

Returns

\Zend\Session\Config\StandardConfig

Set session.entropy_file

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

Parameters

$entropyFile

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

set session.entropy_length

setEntropyLength(integer $entropyLength) : \Zend\Session\Config\StandardConfig

Parameters

$entropyLength

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.gc_divisor

setGcDivisor(integer $gcDivisor) : \Zend\Session\Config\StandardConfig

Parameters

$gcDivisor

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set gc_maxlifetime

setGcMaxlifetime(integer $gcMaxlifetime) : \Zend\Session\Config\StandardConfig

Parameters

$gcMaxlifetime

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.gc_probability

setGcProbability(integer $gcProbability) : \Zend\Session\Config\StandardConfig

Parameters

$gcProbability

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.hash_bits_per_character

setHashBitsPerCharacter(integer $hashBitsPerCharacter) : \Zend\Session\Config\StandardConfig

Parameters

$hashBitsPerCharacter

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.name

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

Parameters

$name

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set an individual option

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

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

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

Parameters

$option

string

$value

mixed

Returns

\Zend\Session\Config\StandardConfig

Set many options at once

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

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\ConfigInterface::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set remember_me_seconds

setRememberMeSeconds(integer $rememberMeSeconds) : \Zend\Session\Config\StandardConfig
inherited_from \Zend\Session\Config\ConfigInterface::setRememberMeSeconds()

Parameters

$rememberMeSeconds

integer

Exceptions

\Zend\Session\Exception\InvalidArgumentException

Returns

\Zend\Session\Config\StandardConfig

Set session.save_path

setSavePath(string $savePath) : \Zend\Session\Config\StandardConfig
inherited_from \Zend\Session\Config\ConfigInterface::setSavePath()

Parameters

$savePath

string

Exceptions

\Zend\Session\Exception\InvalidArgumentException on invalid path

Returns

\Zend\Session\Config\StandardConfig

Set storage option in backend configuration store

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

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

Parameters

$storageName

string

$storageValue

mixed

Returns

\Zend\Session\Config\StandardConfig

Set session.use_cookies

setUseCookies(boolean $useCookies) : \Zend\Session\Config\StandardConfig
inherited_from \Zend\Session\Config\ConfigInterface::setUseCookies()

Parameters

$useCookies

boolean

Returns

\Zend\Session\Config\StandardConfig

Cast configuration to an array

toArray() : array
inherited_from \Zend\Session\Config\ConfigInterface::toArray()

Returns

array

 Properties

 

session.cookie_domain

$cookieDomain : string

Default

 

session.cookie_httponly

$cookieHttpOnly : boolean

Default

 

session.cookie_lifetime

$cookieLifetime : integer

Default

 

session.cookie_path

$cookiePath : string

Default

 

session.cookie_secure

$cookieSecure : boolean

Default

 

session.name

$name : string

Default

 

All options

$options : array

Default

array()
 

remember_me_seconds

$rememberMeSeconds : integer

Default

 

session.save_path

$savePath : string

Default

 

session.use_cookies

$useCookies : boolean

Default