FileResolver Class Reference

Public Member Functions
	getFile ($class)
	getFilePath ($class)

Static Public Member Functions
static	addIncludePath ($path, $prepend=true)

Detailed Description

Contains logic for finding class filepaths based on include_path configuration.

Definition at line 11 of file FileResolver.php.

Member Function Documentation

addIncludePath()

static addIncludePath (   $path,   $prepend = true  )

static

Add specified path(s) to the current include_path

Parameters

string | array	$path
bool	$prepend	Whether to prepend paths or to append them

Returns

void

Definition at line 43 of file FileResolver.php.

    {
        $includePathExtra = implode(PATH_SEPARATOR, (array)$path);
        $includePath = get_include_path();
        $pathSeparator = $includePath && $includePathExtra ? PATH_SEPARATOR : '';
        if ($prepend) {
            $includePath = $includePathExtra . $pathSeparator . $includePath;
        } else {
            $includePath = $includePath . $pathSeparator . $includePathExtra;
        }
        set_include_path($includePath);
    }

getFile()

getFile

(

$class

)

Find a file in include path. Include path is set in composer.json or with set_include_path()

Parameters

string

$class

Returns

string|bool

Definition at line 19 of file FileResolver.php.

    {
        $relativePath = $this->getFilePath($class);
        return stream_resolve_include_path($relativePath);
    }

getFilePath()

getFilePath

(

$class

)

Get relative file path for specified class

Parameters

string

$class

Returns

string

Definition at line 31 of file FileResolver.php.

    {
        return ltrim(str_replace(['_', '\\'], '/', $class), '/') . '.php';
    }

---

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

• vendor/magento/framework/Filesystem/FileResolver.php