ModuleList Class Reference

Inheritance diagram for ModuleList:

Public Member Functions
	__construct (DeploymentConfig $config, ModuleList\Loader $loader)
	getAll ()
	getOne ($name)
	getNames ()
	has ($name)
	isModuleInfoAvailable ()

Detailed Description

A list of modules in the Magento application

Encapsulates information about whether modules are enabled or not. Represents only enabled modules through its interface

Definition at line 17 of file ModuleList.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DeploymentConfig	$config,
		ModuleList\Loader	$loader
	)

Constructor

Parameters

DeploymentConfig	$config
ModuleList\Loader	$loader

Definition at line 55 of file ModuleList.php.

    {
        $this->config = $config;
        $this->loader = $loader;
    }

Member Function Documentation

getAll()

getAll

(

)

{Get list of all modulesReturns an array where key is module name and value is an array with module meta-information

Returns

array

}

Note that this triggers loading definitions of all existing modules in the system. Use this method only when you actually need modules' declared meta-information.

See also

getNames()

Implements ModuleListInterface.

Definition at line 69 of file ModuleList.php.

    {
        if (null === $this->enabled) {
            $all = $this->loader->load();
            if (empty($all)) {
                return []; // don't record erroneous value into memory
            }
            $this->enabled = [];
            foreach ($all as $key => $value) {
                if ($this->has($key)) {
                    $this->enabled[$key] = $value;
                }
            }
        }
        return $this->enabled;
    }

getNames()

getNames

(

)

{Enumerates the list of names of modules

Returns

string[]

}

Implements ModuleListInterface.

Definition at line 99 of file ModuleList.php.

    {
        $this->loadConfigData();
        if (!$this->configData) {
            return [];
        }
        $result = array_keys(array_filter($this->configData));
        return $result;
    }

getOne()

getOne

(

$name

)

{Get module declaration dataReturns an array with meta-information about one module by specified name

Parameters

string

$name

Returns

array|null

}

See also

has()

Implements ModuleListInterface.

Definition at line 90 of file ModuleList.php.

    {
        $enabled = $this->getAll();
        return $enabled[$name] ?? null;
    }

has()

has

(

$name

)

{Checks whether the specified module is present in the list

Parameters

string

$name

Returns

bool

}

Implements ModuleListInterface.

Definition at line 112 of file ModuleList.php.

    {
        $this->loadConfigData();
        if (!$this->configData) {
            return false;
        }
        return !empty($this->configData[$name]);
    }

isModuleInfoAvailable()

isModuleInfoAvailable

(

)

Checks if module list information is available.

Returns

bool

Definition at line 126 of file ModuleList.php.

    {
        $this->loadConfigData();
        if ($this->configData) {
            return true;
        }
        return false;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Module/ModuleList.php