ClassMap Class Reference

Public Member Functions
	__construct ($baseDir)
	getFile ($class)
	addMap (array $map)
	load ($class)

Protected Attributes
	$_baseDir
	$_map = []

Detailed Description

Definition at line 10 of file ClassMap.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$baseDir

)

Set base directory absolute path

Parameters

string

$baseDir

Exceptions

Definition at line 36 of file ClassMap.php.

    {
        $this->_baseDir = realpath($baseDir);
        if (!$this->_baseDir || !is_dir($this->_baseDir)) {
            throw new \InvalidArgumentException("Specified path is not a valid directory: '{$baseDir}'");
        }
    }

Member Function Documentation

addMap()

addMap

(

array

$map

)

Add classes files declaration to the map. New map will override existing values if such was defined before.

Parameters

array

$map

Returns

$this

Definition at line 64 of file ClassMap.php.

    {
        $this->_map = array_merge($this->_map, $map);
        return $this;
    }

getFile()

getFile

(

$class

)

Find an absolute path to a file to be included

Parameters

string

$class

Returns

string|bool

Definition at line 50 of file ClassMap.php.

    {
        if (isset($this->_map[$class])) {
            return $this->_baseDir . '/' . $this->_map[$class];
        }
        return false;
    }

load()

load

(

$class

)

Resolve a class file and include it

Parameters

string

$class

Returns

void

Definition at line 76 of file ClassMap.php.

    {
        $file = $this->getFile($class);
        if (file_exists($file)) {
            include $file;
        }
    }

Field Documentation

$_baseDir

$_baseDir

protected

Definition at line 17 of file ClassMap.php.

$_map

$_map = []

protected

Definition at line 28 of file ClassMap.php.

---

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

• vendor/magento/framework/Autoload/ClassMap.php