Zend\ModuleManager\Listener\ListenerOptions
Listener options
Synopsis
class ListenerOptions
extends AbstractOptions
{
- // members
- protected array $modulePaths;
- protected array $configGlobPaths;
- protected array $configStaticPaths;
- protected array $extraConfig;
- protected bool $configCacheEnabled;
- protected string $configCacheKey;
- protected string $cacheDir;
- protected bool $checkDependencies;
- protected string $moduleMapCacheEnabled;
- protected string $moduleMapCacheKey;
- // Inherited members from AbstractOptions
- protected bool $__strictMode__;
- // methods
- public array getModulePaths()
- public ListenerOptions setModulePaths()
- public array getConfigGlobPaths()
- public array getConfigStaticPaths()
- public ListenerOptions setConfigGlobPaths()
- public ListenerOptions setConfigStaticPaths()
- public array|Traversable getExtraConfig()
- public ListenerOptions setExtraConfig()
- public bool getConfigCacheEnabled()
- public ListenerOptions setConfigCacheEnabled()
- public string getConfigCacheKey()
- public ListenerOptions setConfigCacheKey()
- public string getConfigCacheFile()
- public string getCacheDir()
- public ListenerOptions setCacheDir()
- public bool getModuleMapCacheEnabled()
- public ListenerOptions setModuleMapCacheEnabled()
- public string getModuleMapCacheKey()
- public ListenerOptions setModuleMapCacheKey()
- public string getModuleMapCacheFile()
- public string getCheckDependencies()
- public ListenerOptions setCheckDependencies()
- public static string normalizePath()
- // Inherited methods from AbstractOptions
- public void __construct()
- public AbstractOptions setFromArray()
- public array toArray()
- public void __set()
- public mixed __get()
- public bool __isset()
- public void __unset()
Hierarchy
Extends
Members
protected
- $__strictMode__
—
Zend\Stdlib\bool
We use the __ prefix to avoid collisions with properties in user-implementations. - $cacheDir — string
- $checkDependencies — Zend\ModuleManager\Listener\bool
- $configCacheEnabled — Zend\ModuleManager\Listener\bool
- $configCacheKey — string
- $configGlobPaths — array
- $configStaticPaths — array
- $extraConfig — array
- $moduleMapCacheEnabled — string
- $moduleMapCacheKey — string
- $modulePaths — array
Methods
public
- getCacheDir() — Get the path where cache file(s) are stored
- getCheckDependencies() — Set whether to check dependencies during module loading or not
- getConfigCacheEnabled() — Check if the config cache is enabled
- getConfigCacheFile() — Get the path to the config cache
- getConfigCacheKey() — Get key used to create the cache file name
- getConfigGlobPaths() — Get the glob patterns to load additional config files
- getConfigStaticPaths() — Get the static paths to load additional config files
- getExtraConfig() — Get any extra config to merge in.
- getModuleMapCacheEnabled() — Check if the module class map cache is enabled
- getModuleMapCacheFile() — Get the path to the module class map cache
- getModuleMapCacheKey() — Get key used to create the cache file name
- getModulePaths() — Get an array of paths where modules reside
- normalizePath() — Normalize a path for insertion in the stack
- setCacheDir() — Set the path where cache files can be stored
- setCheckDependencies() — Set whether to check dependencies during module loading or not
- setConfigCacheEnabled() — Set if the config cache should be enabled or not
- setConfigCacheKey() — Set key used to create the cache file name
- setConfigGlobPaths() — Set the glob patterns to use for loading additional config files
- setConfigStaticPaths() — Set the static paths to use for loading additional config files
- setExtraConfig() — Add some extra config array to the main config. This is mainly useful for unit testing purposes.
- setModuleMapCacheEnabled() — Set if the module class map cache should be enabled or not
- setModuleMapCacheKey() — Set key used to create the cache file name
- setModulePaths() — Set an array of paths where modules reside