Moodle PHP Documentation 4.1
Moodle 4.1.19+ (Build: 20250711) (5f47dc23ffc)
Box\Spout\Autoloader\Psr4Autoloader Class Reference

Public Member Functions

 addNamespace ($prefix, $baseDir, $prepend=false)
 Adds a base directory for a namespace prefix.
 
 loadClass ($class)
 Loads the class file for a given class name.
 
 register ()
 Register loader with SPL autoloader stack.
 

Protected Member Functions

 loadMappedFile ($prefix, $relativeClass)
 Load the mapped file for a namespace prefix and relative class.
 
 requireFile ($file)
 If a file exists, require it from the file system.
 

Protected Attributes

array $prefixes = []
 An associative array where the key is a namespace prefix and the value is an array of base directories for classes in that namespace.
 

Member Function Documentation

◆ addNamespace()

Box\Spout\Autoloader\Psr4Autoloader::addNamespace ( $prefix,
$baseDir,
$prepend = false )

Adds a base directory for a namespace prefix.

Parameters
string$prefixThe namespace prefix.
string$baseDirA base directory for class files in the namespace.
bool$prependIf true, prepend the base directory to the stack instead of appending it; this causes it to be searched first rather than last.
Return values
void

◆ loadClass()

Box\Spout\Autoloader\Psr4Autoloader::loadClass ( $class)

Loads the class file for a given class name.

Parameters
string$classThe fully-qualified class name.
Return values
mixedThe mapped file name on success, or boolean false on failure.

◆ loadMappedFile()

Box\Spout\Autoloader\Psr4Autoloader::loadMappedFile ( $prefix,
$relativeClass )
protected

Load the mapped file for a namespace prefix and relative class.

Parameters
string$prefixThe namespace prefix.
string$relativeClassThe relative class name.
Return values
mixedBoolean false if no mapped file can be loaded, or the name of the mapped file that was loaded.

◆ register()

Box\Spout\Autoloader\Psr4Autoloader::register ( )

Register loader with SPL autoloader stack.

Return values
void

◆ requireFile()

Box\Spout\Autoloader\Psr4Autoloader::requireFile ( $file)
protected

If a file exists, require it from the file system.

Parameters
string$fileThe file to require.
Return values
boolTrue if the file exists, false if not.

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