ModuleManifest
class ModuleManifest (View source)
A utility class which builds a manifest of configuration items
Traits
Provides extensions to this object to integrate it with standard config API methods.
Constants
| PROJECT_KEY |
|
Config options
| module_priority | array | List of modules sorted by priority |
|
| project | string | Project name |
Properties
| protected | string | $base | The base path used when building the manifest |
|
| protected | string | $cacheKey | A string to prepend to all cache keys to ensure all keys are unique to just this $base |
|
| protected | CacheFactory | $cacheFactory | Factory to use to build cache |
|
| protected | CacheInterface | $cache | ||
| protected | Module[] | $modules | List of all modules. |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Constructs and initialises a new configuration object, either loading from the cache or re-scanning for classes.
Completely regenerates the manifest file. Scans through finding all php _config.php and yaml _config/*.ya?ml files,parses the yaml files into fragments, sorts them and figures out what values need to be checked to pick the correct variant.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
__construct(string $base, CacheFactory $cacheFactory = null)
Constructs and initialises a new configuration object, either loading from the cache or re-scanning for classes.
addModule(string $path)
Adds a path as a module
bool
moduleExists(string $name)
Returns true if the passed module exists
init(bool $includeTests = false, bool $forceRegen = false)
No description
activateConfig()
Includes all of the php _config.php files found by this manifest.
regenerate(bool $includeTests = false)
Completely regenerates the manifest file. Scans through finding all php _config.php and yaml _config/*.ya?ml files,parses the yaml files into fragments, sorts them and figures out what values need to be checked to pick the correct variant.
Does not build the actual variant
Module
getModule(string $name)
Get module by name
Module[]
getModules()
Get modules found
sort()
Sort modules sorted by priority
Module
getModuleByPath(string $path)
Get module that contains the given path