Listener options

category Zend
package Zend_ModuleManager
subpackage Listener

 Methods

__construct()

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

inherited_from \Zend\Stdlib\AbstractOptions::__construct()

Parameters

$options

array\Traversablenull

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

__get()

__get(string $key) : mixed
Inherited

see \Zend\Stdlib\ParameterObject::__get()
inherited_from \Zend\Stdlib\AbstractOptions::__get()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Returns

mixed

__isset()

__isset(string $key) : bool
Inherited

see \Zend\Stdlib\ParameterObject::__isset()
inherited_from \Zend\Stdlib\AbstractOptions::__isset()

Parameters

$key

string

Returns

bool

__set()

__set(string $key, mixed $value) : void
Inherited

see \Zend\Stdlib\ParameterObject::__set()
inherited_from \Zend\Stdlib\AbstractOptions::__set()

Parameters

$key

string

$value

mixed

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

__unset()

__unset(string $key) : void
Inherited

see \Zend\Stdlib\ParameterObject::__unset()
inherited_from \Zend\Stdlib\AbstractOptions::__unset()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Get the path where cache file(s) are stored

getCacheDir() : string

Returns

string

Check if the config cache is enabled

getConfigCacheEnabled() : bool

Returns

bool

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

Get an array of paths where modules reside

getModulePaths() : array

Returns

array

Normalize a path for insertion in the stack

normalizePath(string $path) : string

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

Set if the config cache should be enabled or not

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

Parameters

$enabled

bool

Returns

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

Set the glob patterns to use for loading additional config files

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

Set the static paths to use for loading additional config files

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

Add some extra config array to the main config.

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

This is mainly useful for unit testing purposes.

Parameters

$extraConfig

array\Traversable

Exceptions

\Zend\ModuleManager\Listener\Exception\InvalidArgumentException

Returns

setFromArray()

setFromArray(array | \Traversable $options) : void
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::setFromArray()

Parameters

$options

array\Traversable

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Set an array of paths where modules reside

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

Cast to array

toArray() : array
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::toArray()

Returns

array

 Properties

 

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

$__strictMode__ : bool
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::$$__strictMode__
 

$cacheDir

$cacheDir : string

 

$configCacheEnabled

$configCacheEnabled : bool

 

$configCacheKey

$configCacheKey : string

 

$configGlobPaths

$configGlobPaths : array

 

$configStaticPaths

$configStaticPaths : array

 

$extraConfig

$extraConfig : array

 

$modulePaths

$modulePaths : array