marm/yamm

YAMM :: Yet Another Meta Module

English

This meta module provides generally desired functionality, like:, _(*1)

• A reusable Dependency Injection Container, _(*2)

• Sensible logging facilities, _(*3)

DIC Usage

The DIC is an extension of Pimple which allows service tagging and is integrated with Oxid eSales., _(*4)

To use the DIC just put a dic.php in the root of yourproject and register all your services in there. A variable $dic will be available in this fileyou can operate with:, _(*5)

/** @var \Marm\Yamm\DIC $dic */
$dic['acme_module_service'] = function (\Marm\Yamm\DIC $dic) {
    return new Acme\Module\Service(/* ... */);
};

On top of that we allow tagging of services and receiving of all services which are tagged with a defined tag when constructing services:, _(*6)

/** @var \Marm\Yamm\DIC $dic */
$dic->tag('acme_module_service', 'acme:tag');
$dic['acme_module_service'] = function (\Marm\Yamm\DIC $dic) {
    return new Acme\Module\Service(/* ... */);
};

// Somewhere else or later
$dic['acme_module_aggregator'] = function (\Marm\Yamm\DIC $dic) {
    return new Acme\Module\Aggregator(
        // Array of all services tagged with "acme:tag"
        $dic->getTagged('acme:tag')
    );
};

To get the DIC anywhere else in your project, just fetch it from oxRegistry:, _(*7)

/** @var \Marm\Yamm\DIC $dic */
$dic = oxRegistry::get('yamm_dic');

Licence Terms

YAMM is released under MIT., _(*8)

Use this module in your project but keep the author notice. Thank you!, _(*9)

Authors

• Kore Nordmann
• Joscha Krug