fyre/loader

An autoloader library.

v3.3.0 2024-11-15 10:08 UTC

Requires

• fyre/path: ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.59
• fyre/php-cs-fixer-config: ^1.0
• phpunit/phpunit: ^11

MIT

• elusivecodes

README

FyreLoader is a free, open-source autoloader library for PHP.

Table Of Contents

• Installation
• Basic Usage
• Methods

Installation

Using Composer

composer require fyre/loader

In PHP:

use Fyre\Loader\Loader;

Basic Usage

$loader = new Loader();

Autoloading

It is recommended to bind the Loader to the Container as a singleton.

$container->singleton(Loader::class);

Methods

Add Class Map

Add a class map.

• $classMap is an array containing the class map.

$loader->addClassMap($classMap);

Add Namespaces

Add namespaces.

• $namespaces is an array containing the namespaces where the key is the namespace prefix and the value is the path.

$loader->addNamespaces($namespaces);

Clear

Clear the auto loader.

$loader->clear();

Get Class Map

Get the class map.

$classMap = $loader->getClassMap();

Get Namespace

Get a namespace.

• $prefix is a string representing the namespace prefix.

$paths = $loader->getNamespace($prefix);

Get Namespace Paths

Get all paths for a namespace.

• $prefix is a string representing the namespace prefix.

$paths = $loader->getNamespacePaths($prefix);

Get Namespaces

Get the namespaces.

$namespaces = $loader->getNamespaces();

Has Namespace

Determine whether a namespace exists.

• $prefix is a string representing the namespace prefix.

$hasNamespace = $loader->hasNamespace($prefix);

Load Composer

Load composer.

• $composerPath is a string representing the composer autoload path.

$loader->loadComposer($composerPath);

Register

Register the autoloader.

$loader->register();

Remove Class

Remove a class.

• $className is a string representing the class name.

$loader->removeClass($className);

Remove Namespace

Remove a namespace.

• $prefix is a string representing the namespace prefix.

$loader->removeNamespace($prefix);

Unregister

Unregister the autoloader.

$loader->unregister();