NamespaceResolver Class Reference

Public Member Functions
	__construct (\Magento\Framework\Module\ModuleListInterface $moduleList)
	determineOmittedNamespace ($name, $asFullModuleName=false)

Protected Member Functions
	prepareModuleNamespaces ()
	prepareName ($name)

Protected Attributes
	$moduleNamespaces
	$moduleList

Detailed Description

Definition at line 8 of file NamespaceResolver.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\Module\ModuleListInterface

$moduleList

)

Parameters

\Magento\Framework\Module\ModuleListInterface

$moduleList

Definition at line 25 of file NamespaceResolver.php.

    {
        $this->moduleList = $moduleList;
    }

Member Function Documentation

determineOmittedNamespace()

determineOmittedNamespace	(		$name,
			$asFullModuleName = false
	)

Determine whether provided name begins from any available modules, according to namespaces priority If matched, returns as the matched module "factory" name or a fully qualified module name

Parameters

string	$name
bool	$asFullModuleName

Returns

string

Definition at line 38 of file NamespaceResolver.php.

    {
        $this->prepareModuleNamespaces();
        $name = $this->prepareName($name);

        $partsNum = count($name);
        $defaultNamespaceFlag = false;
        foreach ($this->moduleNamespaces as $namespaceName => $namespace) {
            // assume the namespace is omitted (default namespace only, which comes first)
            if ($defaultNamespaceFlag === false) {
                $defaultNamespaceFlag = true;
                $defaultNS = $namespaceName . '_' . $name[0];
                if (isset($namespace[$defaultNS])) {
                    return $asFullModuleName ? $namespace[$defaultNS] : $name[0]; // return omitted as well
                }
            }
            // assume namespace is qualified
            if (isset($name[1])) {
                $fullNS = $name[0] . '_' . $name[1];
                if (2 <= $partsNum && isset($namespace[$fullNS])) {
                    return $asFullModuleName ? $namespace[$fullNS] : $fullNS;
                }
            }
        }
        return '';
    }

prepareModuleNamespaces()

prepareModuleNamespaces ( )

protected

Prepare module namespaces

Returns

void

Definition at line 70 of file NamespaceResolver.php.

    {
        if (null === $this->moduleNamespaces) {
            $this->moduleNamespaces = [];
            foreach ($this->moduleList->getNames() as $moduleName) {
                $module = strtolower($moduleName);
                $this->moduleNamespaces[substr($module, 0, strpos($module, '_'))][$module] = $moduleName;
            }
        }
    }

prepareName()

prepareName (   $name )

protected

Prepare name

Parameters

string

$name

Returns

array

Definition at line 87 of file NamespaceResolver.php.

    {
        $explodeString = strpos($name, '\\') === false ? '_' : '\\';
        return explode($explodeString, strtolower($name));
    }

Field Documentation

$moduleList

$moduleList

protected

Definition at line 20 of file NamespaceResolver.php.

$moduleNamespaces

$moduleNamespaces

protected

Definition at line 15 of file NamespaceResolver.php.

---

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

• vendor/magento/module-widget/Model/NamespaceResolver.php