Listener options

package Default
inherited_from \Zend\Stdlib\AbstractOptions

 Methods

Constructor

__construct(array|\Traversable|null $options = null
Inherited

Parameters

$options

array\Traversablenull

Get a configuration property

__get(string $key) : mixed
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__get()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Returns

mixed

Test if a configuration property is null

__isset(string $key) : boolean
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__isset()

Parameters

$key

string

Returns

boolean

Set a configuration property

__set(string $key, mixed $value) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__set()

Parameters

$key

string

$value

mixed

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Set a configuration property to NULL

__unset(string $key) : void
Inherited
see
inherited_from \Zend\Stdlib\ParameterObjectInterface::__unset()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Get the path where cache file(s) are stored

getCacheDir() : string

Returns

string

Set whether to check dependencies during module loading or not

getCheckDependencies() : string

Returns

string

Check if the config cache is enabled

getConfigCacheEnabled() : boolean

Returns

boolean

Get the path to the config cache

getConfigCacheFile() : string

Should this be an option, or should the dir option include the filename, or should it simply remain hard-coded? Thoughts?

Returns

string

Get key used to create the cache file name

getConfigCacheKey() : string

Returns

string

Get the glob patterns to load additional config files

getConfigGlobPaths() : array

Returns

array

Get the static paths to load additional config files

getConfigStaticPaths() : array

Returns

array

Get any extra config to merge in.

getExtraConfig() : array | \Traversable

Returns

array\Traversable

Check if the module class map cache is enabled

getModuleMapCacheEnabled() : boolean

Returns

boolean

Get the path to the module class map cache

getModuleMapCacheFile() : string

Returns

string

Get key used to create the cache file name

getModuleMapCacheKey() : string

Returns

string

Get an array of paths where modules reside

getModulePaths() : array

Returns

array

Normalize a path for insertion in the stack

normalizePath(string $path) : string
Static

Parameters

$path

string

Returns

string

Set the path where cache files can be stored

setCacheDir(string $cacheDir) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$cacheDir

string

the value to be set

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set whether to check dependencies during module loading or not

setCheckDependencies(boolean $checkDependencies) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$checkDependencies

boolean

the value to be set

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set if the config cache should be enabled or not

setConfigCacheEnabled(boolean $enabled) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$enabled

boolean

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set key used to create the cache file name

setConfigCacheKey(string $configCacheKey) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$configCacheKey

string

the value to be set

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set the glob patterns to use for loading additional config files

setConfigGlobPaths(array|\Traversable $configGlobPaths) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$configGlobPaths

array\Traversable

Exceptions

\Zend\ModuleManager\Listener\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\Listener\ListenerOptionsProvides fluent interface

Set the static paths to use for loading additional config files

setConfigStaticPaths(array|\Traversable $configStaticPaths) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$configStaticPaths

array\Traversable

Exceptions

\Zend\ModuleManager\Listener\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\Listener\ListenerOptionsProvides fluent interface

Add some extra config array to the main config. This is mainly useful for unit testing purposes.

setExtraConfig(array|\Traversable $extraConfig) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$extraConfig

array\Traversable

Exceptions

\Zend\ModuleManager\Listener\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\Listener\ListenerOptionsProvides fluent interface

Set one or more configuration properties

setFromArray(array|\Traversable|\Zend\Stdlib\AbstractOptions $options) : \Zend\Stdlib\AbstractOptions
Inherited

Parameters

$options

array\Traversable\Zend\Stdlib\AbstractOptions

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

\Zend\Stdlib\AbstractOptionsProvides fluent interface

Set if the module class map cache should be enabled or not

setModuleMapCacheEnabled(boolean $enabled) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$enabled

boolean

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set key used to create the cache file name

setModuleMapCacheKey(string $moduleMapCacheKey) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$moduleMapCacheKey

string

the value to be set

Returns

\Zend\ModuleManager\Listener\ListenerOptions

Set an array of paths where modules reside

setModulePaths(array|\Traversable $modulePaths) : \Zend\ModuleManager\Listener\ListenerOptions

Parameters

$modulePaths

array\Traversable

Exceptions

\Zend\ModuleManager\Listener\Exception\InvalidArgumentException

Returns

\Zend\ModuleManager\Listener\ListenerOptionsProvides fluent interface

Cast to array

toArray() : array
Inherited

Returns

array

 Properties

 

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : boolean

Default

true
 

$cacheDir

$cacheDir : string

Default

 

$checkDependencies

$checkDependencies : boolean

Default

true
 

$configCacheEnabled

$configCacheEnabled : boolean

Default

false
 

$configCacheKey

$configCacheKey : string

Default

 

$configGlobPaths

$configGlobPaths : array

Default

array()
 

$configStaticPaths

$configStaticPaths : array

Default

array()
 

$extraConfig

$extraConfig : array

Default

array()
 

$moduleMapCacheEnabled

$moduleMapCacheEnabled : string

Default

false
 

$moduleMapCacheKey

$moduleMapCacheKey : string

Default

 

$modulePaths

$modulePaths : array

Default

array()