Dir Class Reference

Public Member Functions
	__construct (ComponentRegistrarInterface $componentRegistrar)
	getDir ($moduleName, $type='')

Data Fields
const	MODULE_ETC_DIR = 'etc'
const	MODULE_I18N_DIR = 'i18n'
const	MODULE_VIEW_DIR = 'view'
const	MODULE_CONTROLLER_DIR = 'Controller'
const	MODULE_SETUP_DIR = 'Setup'

Detailed Description

Definition at line 13 of file Dir.php.

Constructor & Destructor Documentation

__construct()

__construct

(

ComponentRegistrarInterface

$componentRegistrar

)

Parameters

ComponentRegistrarInterface

$componentRegistrar

Definition at line 31 of file Dir.php.

    {
        $this->componentRegistrar = $componentRegistrar;
    }

Member Function Documentation

getDir()

getDir	(		$moduleName,
			$type = ''
	)

Retrieve full path to a directory of certain type within a module

Parameters

string	$moduleName	Fully-qualified module name
string	$type	Type of module's directory to retrieve

Returns

string

Exceptions

Definition at line 44 of file Dir.php.

    {
        $path = $this->componentRegistrar->getPath(ComponentRegistrar::MODULE, $moduleName);

        // An empty $type means it's getting the directory of the module itself.
        if (empty($type) && !isset($path)) {
            // Note: do not throw \LogicException, as it would break backwards-compatibility.
            throw new \InvalidArgumentException("Module '$moduleName' is not correctly registered.");
        }

        if ($type) {
            if (!in_array($type, [
                self::MODULE_ETC_DIR,
                self::MODULE_I18N_DIR,
                self::MODULE_VIEW_DIR,
                self::MODULE_CONTROLLER_DIR,
                self::MODULE_SETUP_DIR
            ])) {
                throw new \InvalidArgumentException("Directory type '{$type}' is not recognized.");
            }
            $path .= '/' . $type;
        }

        return $path;
    }

Field Documentation

MODULE_CONTROLLER_DIR

const MODULE_CONTROLLER_DIR = 'Controller'

Definition at line 21 of file Dir.php.

MODULE_ETC_DIR

const MODULE_ETC_DIR = 'etc'

#+ Directories within modules

Definition at line 18 of file Dir.php.

MODULE_I18N_DIR

const MODULE_I18N_DIR = 'i18n'

Definition at line 19 of file Dir.php.

MODULE_SETUP_DIR

const MODULE_SETUP_DIR = 'Setup'

Definition at line 22 of file Dir.php.

MODULE_VIEW_DIR

const MODULE_VIEW_DIR = 'view'

Definition at line 20 of file Dir.php.

---

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

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