\core\autoloaderPsr4Autoloader

An example of a general-purpose implementation that includes the optional functionality of allowing multiple base directories for a single namespace prefix.

Given a foo-bar package of classes in the file system at the following paths ...

/path/to/packages/foo-bar/
    src/
        Baz.php             # Foo\Bar\Baz
        Qux/
            Quux.php        # Foo\Bar\Qux\Quux
    tests/
        BazTest.php         # Foo\Bar\BazTest
        Qux/
            QuuxTest.php    # Foo\Bar\Qux\QuuxTest

... add the path to the class files for the \Foo\Bar\ namespace prefix as follows:

 <?php
 // instantiate the loader
 $loader = new \Example\Psr4AutoloaderClass;

 // register the autoloader
 $loader->register();

 // register the base directories for the namespace prefix
 $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/src');
 $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/tests');

The following line would cause the autoloader to attempt to load the \Foo\Bar\Qux\Quux class from /path/to/packages/foo-bar/src/Qux/Quux.php:

 <?php
 new \Foo\Bar\Qux\Quux;

The following line would cause the autoloader to attempt to load the \Foo\Bar\Qux\QuuxTest class from /path/to/packages/foo-bar/tests/Qux/QuuxTest.php:

 <?php
 new \Foo\Bar\Qux\QuuxTest;

Summary

Methods
Properties
Constants
register()
addNamespace()
loadClass()
No public properties found
No constants found
loadMappedFile()
requireFile()
$prefixes
N/A
No private methods found
No private properties found
N/A

Properties

$prefixes

$prefixes : mixed|string|int

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

Type

mixed|string|int —

Methods

register()

register() : 

Register loader with SPL autoloader stack.

Returns

addNamespace()

addNamespace(  prefix,   base_dir,   prepend = false) : 

Adds a base directory for a namespace prefix.

Parameters

prefix

The namespace prefix.

base_dir

A base directory for class files in the namespace.

prepend

If true, prepend the base directory to the stack instead of appending it; this causes it to be searched first rather than last.

Returns

loadClass()

loadClass(  class) : string|bool

Loads the class file for a given class name.

Parameters

class

The fully-qualified class name.

Returns

string|bool —

The mapped file name on success, or boolean false on failure.

loadMappedFile()

loadMappedFile(  prefix,   relative_class) : 

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

Parameters

prefix

The namespace prefix.

relative_class

The relative class name.

Returns

Boolean false if no mapped file can be loaded, or the name of the mapped file that was loaded.

requireFile()

requireFile(  file) : 

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

Parameters

file

The file to require.

Returns

True if the file exists, false if not.