MAGETWO-71257: Need to disable module output by configuration

Author: Eric Bohanon

lib/internal/Magento/Framework/Module/Manager.php

@@ -4,6 +4,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * Module statuses manager
+ */
 namespace Magento\Framework\Module;
 
 /**
@@ -17,84 +20,82 @@
 class Manager
 {
     /**
-     * The checker of output modules.
-     *
-     * @var Output\ConfigInterface the config checker of output modules.
+     * @var Output\ConfigInterface
      * @deprecated 100.2.0 Magento does not support custom disabling/enabling module output since 2.2.0 version.
      * The property can be removed in a future major release
      */
-    private $outputConfig;
+    private $_outputConfig;
 
     /**
-     * The list of all modules.
-     *
-     * @var ModuleListInterface the list of all modules.
+     * @var ModuleListInterface
      */
-    private $moduleList;
+    private $_moduleList;
 
     /**
-     * The list of config paths to ignore.
-     *
-     * @var array the list of config paths to ignore.
+     * @var array
      * @deprecated 100.2.0 Magento does not support custom disabling/enabling module output since 2.2.0 version.
      * The property can be removed in a future major release
      */
-    private $outputConfigPaths;
+    private $_outputConfigPaths;
 
     /**
-     * Constructor.
-     *
-     * @param Output\ConfigInterface $outputConfig the checker of output modules
-     * @param ModuleListInterface $moduleList the list of all modules
-     * @param array $outputConfigPaths the list of config paths to ignore
+     * @param Output\ConfigInterface $outputConfig
+     * @param ModuleListInterface $moduleList
+     * @param array $outputConfigPaths
      */
     public function __construct(
         Output\ConfigInterface $outputConfig,
         ModuleListInterface $moduleList,
         array $outputConfigPaths = []
     ) {
-        $this->outputConfig = $outputConfig;
-        $this->moduleList = $moduleList;
-        $this->outputConfigPaths = $outputConfigPaths;
+        $this->_outputConfig = $outputConfig;
+        $this->_moduleList = $moduleList;
+        $this->_outputConfigPaths = $outputConfigPaths;
     }
 
     /**
-     * Checks whether a module is enabled in the configuration or not.
+     * Whether a module is enabled in the configuration or not
      *
-     * @param string $moduleName the fully-qualified module name
-     *
-     * @return boolean true if module is enabled, false otherwise
+     * @param string $moduleName Fully-qualified module name
+     * @return boolean
      */
     public function isEnabled($moduleName)
     {
-        return $this->moduleList->has($moduleName);
+        return $this->_moduleList->has($moduleName);
     }
 
     /**
-     * Checks whether a module output is permitted by the configuration or not.
-     *
-     * @param string $moduleName the fully-qualified module name.
+     * Whether a module output is permitted by the configuration or not
      *
+     * @param string $moduleName Fully-qualified module name
      * @return boolean
      * @deprecated 100.2.0 Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     public function isOutputEnabled($moduleName)
     {
-        return $this->isEnabled($moduleName);
+        if (!$this->isEnabled($moduleName)) {
+            return false;
+        }
+
+        return true;
     }
 
     /**
-     * Checks whether a configuration switch for a module output permits output.
+     * Whether a configuration switch for a module output permits output or not
      *
      * @param string $moduleName Fully-qualified module name
-     *
      * @return boolean
-     * @deprecated 100.2.0 Magento does not support custom disabling/enabling module output since 2.2.0 version.
-     * The method can be removed in a future major release
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @deprecated
      */
     protected function _isCustomOutputConfigEnabled($moduleName)
     {
+        if (isset($this->_outputConfigPaths[$moduleName])) {
+            $configPath = $this->_outputConfigPaths[$moduleName];
+            if (defined($configPath)) {
+                $configPath = constant($configPath);
+            }
+            return $this->_outputConfig->isSetFlag($configPath);
+        }
         return true;
     }
 }

lib/internal/Magento/Framework/Module/Output/ConfigInterface.php

@@ -5,11 +5,6 @@
  */
 namespace Magento\Framework\Module\Output;
 
-/**
- * Checks whether the module is enabled in the configuration.
- *
- * @deprecated 100.2.0 Magento does not support custom disabling/enabling module output since 2.2.0 version
- */
 interface ConfigInterface
 {
     /**

lib/internal/Magento/Framework/Module/Test/Unit/ManagerTest.php

@@ -5,63 +5,60 @@
  */
 namespace Magento\Framework\Module\Test\Unit;
 
-use Magento\Framework\Module\Manager;
-use Magento\Framework\Module\ModuleListInterface;
-use Magento\Framework\Module\Output\ConfigInterface;
-use \PHPUnit_Framework_MockObject_MockObject as Mock;
+use Magento\Framework\Module\Plugin\DbStatusValidator;
 
 class ManagerTest extends \PHPUnit\Framework\TestCase
 {
     /**
      * XPath in the configuration of a module output flag
-     * @deprecated
      */
     const XML_PATH_OUTPUT_ENABLED = 'custom/is_module_output_enabled';
 
     /**
-     * @var Manager
+     * @var \Magento\Framework\Module\Manager
      */
-    private $model;
+    private $_model;
 
     /**
-     * @var ModuleListInterface|Mock
+     * @var \PHPUnit_Framework_MockObject_MockObject
      */
-    private $moduleList;
+    private $_moduleList;
 
     /**
-     * @var ConfigInterface|Mock
-     * @deprecated
+     * @var \PHPUnit_Framework_MockObject_MockObject
      */
-    private $outputConfig;
+    private $_outputConfig;
 
     /**
      * @inheritdoc
      */
     protected function setUp()
     {
-        $this->moduleList = $this->getMockBuilder(ModuleListInterface::class)
-            ->getMockForAbstractClass();
-        $this->outputConfig = $this->getMockBuilder(ConfigInterface::class)
-            ->getMockForAbstractClass();
-
-        $this->model = new Manager(
-            $this->outputConfig,
-            $this->moduleList
+        $this->_moduleList = $this->getMockForAbstractClass(\Magento\Framework\Module\ModuleListInterface::class);
+        $this->_moduleList->expects($this->any())
+            ->method('getOne')
+            ->will($this->returnValueMap([
+                ['Module_One', ['name' => 'One_Module', 'setup_version' => '1']],
+                ['Module_Two', ['name' => 'Two_Module', 'setup_version' => '2']],
+                ['Module_Three', ['name' => 'Two_Three']],
+            ]));
+        $this->_outputConfig = $this->getMockForAbstractClass(\Magento\Framework\Module\Output\ConfigInterface::class);
+        $this->_model = new \Magento\Framework\Module\Manager(
+            $this->_outputConfig,
+            $this->_moduleList,
+            [
+                'Module_Two' => self::XML_PATH_OUTPUT_ENABLED,
+            ]
         );
     }
 
     public function testIsEnabled()
     {
-        $this->moduleList->expects($this->exactly(2))
-            ->method('has')
-            ->willReturnMap(
-                [
-                    ['Module_Exists', true],
-                    ['Module_NotExists', false],
-                ]
-            );
-
-        $this->assertTrue($this->model->isEnabled('Module_Exists'));
-        $this->assertFalse($this->model->isEnabled('Module_NotExists'));
+        $this->_moduleList->expects($this->exactly(2))->method('has')->will($this->returnValueMap([
+            ['Module_Exists', true],
+            ['Module_NotExists', false],
+        ]));
+        $this->assertTrue($this->_model->isEnabled('Module_Exists'));
+        $this->assertFalse($this->_model->isEnabled('Module_NotExists'));
     }
 }