System:Bootstrap:moduleRegistry

From Aspen Documentation

Returns a specific registry object for a selected module. You may provide either the module name or it's GUID, but there is no need to provide both.

Since 1.0

Arguments

object moduleRegistry ([string $guid = false], [string $name = false], [string $interface = false])

guid
GUID of the module to load.
name
Class name of the module to load.
interface
The interface the module exists within. Only provided if different than current interface and if GUID not provided.

Returns

Returns simplexml object. Returns false if no matches found.


Examples

Calling the module registry for the Settings module:

$this->APP->moduleRegistry('f801e330-c7ba-11dc-95ff-0800200c9a66');

Returns:

SimpleXMLElement Object
(
    [type] => Module
    [guid] => f801e330-c7ba-11dc-95ff-0800200c9a66
    [classname] => Settings
    [name] => Settings
    [version] => 1.0
    [description] => Manages application settings.
    [vendor] => Trellis Development, LLC
    [pressUrl] => http://www.aspen-framework.org
    [updateUrl] => http://www.aspen-framework.org
    [folder] => Settings
)