Cache isModuleOutputEnabled or isModuleEnabled status

[sreichel]

Description (*)

If isModuleOutputEnabled or isModuleEnabled is called multiple times for the same Module, get config once.

Related Pull Requests

1. see Fix Mage_Adminhtml_Block_Template::isOutputEnabled() for invalid module #4320

Manual testing scenarios (*)

1. add xdebug breapoints to isModuleOutputEnabled()
2. ...

    var_dump($test->isModuleOutputEnabled('Mage_Catalog'));
    var_dump($test->isModuleOutputEnabled('Mage_Catalog'));
    var_dump($test->isModuleOutputEnabled('Mage_Catalog'));
    var_dump($test->isModuleOutputEnabled('a'));
    var_dump($test->isModuleOutputEnabled('a'));
    var_dump($test->isModuleOutputEnabled('b'));

[justinbeaty]

XML / DB config is already cached, how much time is this actually saving?

[sreichel]

For the example above,

[justinbeaty]

I just tested and confirmed it's faster, although only on the order of microseconds per call. I suppose the SimpleXMLElement config cache just has that much overhead.

However, it is not caching per store even though the "Disable Modules Output" can be configured at the store scope. This may cause problems in the app emulation used for sales emails.

I enabled in app/etc/modules/Cm_RedisSession.xml, and disabled the module output for store id 2. Expected to get true / false but got true / true.

<?php

define('MAGENTO_ROOT', getcwd());
require MAGENTO_ROOT . '/app/bootstrap.php';
require_once MAGENTO_ROOT . '/app/Mage.php';

Mage::init();

$test = Mage::helper('core');

var_dump(
    $test->isModuleOutputEnabled('Cm_RedisSession')
);

Mage::app()->setCurrentStore(2);

var_dump(
    $test->isModuleOutputEnabled('Cm_RedisSession')
);

[sreichel]

even though the "Disable Modules Output" can be configured at the store scope

I did not see that and did not test it. Thanks.

Config is alerady cached, so it brings no benfits. Check if module is enabled still save some calls. (seems even faster ... numbers from ddev + xhprof + xhgui)

[sreichel]

#4320 (comment)

However, I only see two calls to this method

Updated:

• moved methods to parent abstract class ... so its also available for frontend block classes too
  • have access to these methods from everywhere
  • easier to mock in tests
• added trait to provide same funtionality to models, resource,-models, ... (instead of adding helper methods multiple times)