Autoloader Class Reference

Public Member Functions
	__construct ()
	load ($class)
	register ()
	unregister ()

Static Public Member Functions
static	clearCache ()
static	getCacheSize ()
static	getStats ()

Private Member Functions
	resolveClassPath ($class, $rootPath)

Static Private Attributes
static	$classMap = []
static	$failedLookups = []
static	$stats

Detailed Description

Class Autoloader

This class handles the autoloading of classes within the Bearsampp application. It registers itself with the SPL autoload stack and loads classes based on naming conventions.

Performance optimizations:

• Implements class path caching to avoid repeated file_exists() calls
• Caches both successful and failed lookups to prevent redundant checks
• Uses static cache that persists for the entire request lifecycle

Definition at line 21 of file class.autoloader.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Autoloader constructor.

Initializes the Autoloader object.

Definition at line 50 of file class.autoloader.php.

    {
    }

Member Function Documentation

clearCache()

clearCache ( )

static

Clears the autoloader cache. Useful for testing or when class files are modified during runtime.

Returns

void

Definition at line 150 of file class.autoloader.php.

    {
        self::$classMap = [];
        self::$failedLookups = [];
        self::$stats = [
            'hits' => 0,
            'misses' => 0,
            'failed_hits' => 0
        ];
    }

getCacheSize()

getCacheSize ( )

static

Gets the size of the class map cache.

Returns

int Number of cached class paths

Definition at line 166 of file class.autoloader.php.

    {
        return count(self::$classMap);
    }

getStats()

getStats ( )

static

Gets the current cache statistics. Useful for monitoring and debugging cache effectiveness.

Returns

array Array containing hits, misses, and failed_hits counts

Definition at line 139 of file class.autoloader.php.

    {
        return self::$stats;
    }

load()

load

(

$class

)

Loads the specified class file based on the class name. Implements caching to improve performance on repeated class loads.

Parameters

string

$class

The name of the class to load.

Returns

bool True if the class file was successfully loaded, false otherwise.

Definition at line 61 of file class.autoloader.php.

    {
        global $bearsamppRoot;
 
        $originalClass = $class;
        $class = strtolower($class);
 
        // Check if we've already successfully loaded this class
        if (isset(self::$classMap[$class])) {
            self::$stats['hits']++;
            require_once self::$classMap[$class];
            return true;
        }
 
        // Check if we've already determined this class doesn't exist
        if (isset(self::$failedLookups[$class])) {
            self::$stats['failed_hits']++;
            return false;
        }
 
        self::$stats['misses']++;
 
        $rootPath = $bearsamppRoot->getCorePath();
        $file = $this->resolveClassPath($class, $rootPath);
 
        if (!file_exists($file)) {
            // Cache the failed lookup
            self::$failedLookups[$class] = true;
            return false;
        }
 
        // Cache the successful path resolution
        self::$classMap[$class] = $file;
        require_once $file;
        return true;
    }

References $bearsamppRoot, and resolveClassPath().

register()

register

(

)

Registers the autoloader with the SPL autoload stack.

Returns

bool True on success, false on failure.

Definition at line 176 of file class.autoloader.php.

    {
        return spl_autoload_register(array($this, 'load'));
    }

resolveClassPath()

resolveClassPath ( $class, $rootPath )

private

Resolves the file path for a given class name based on naming conventions. Extracted into separate method for better maintainability and testability.

Parameters

string	$class	The lowercase class name
string	$rootPath	The root path to the classes directory

Returns

string The resolved file path

Definition at line 106 of file class.autoloader.php.

    {
        $file = $rootPath . '/classes/class.' . $class . '.php';
 
        if (Util::startWith($class, 'bin')) {
            $class = $class != 'bins' ? substr_replace($class, '.', 3, 0) : $class;
            $file = $rootPath . '/classes/bins/class.' . $class . '.php';
        } elseif (Util::startWith($class, 'tool')) {
            $class = $class != 'tools' ? substr_replace($class, '.', 4, 0) : $class;
            $file = $rootPath . '/classes/tools/class.' . $class . '.php';
        } elseif (Util::startWith($class, 'app')) {
            $class = $class != 'apps' ? substr_replace($class, '.', 3, 0) : $class;
            $file = $rootPath . '/classes/apps/class.' . $class . '.php';
        } elseif (Util::startWith($class, 'action')) {
            $class = $class != 'action' ? substr_replace($class, '.', 6, 0) : $class;
            $file = $rootPath . '/classes/actions/class.' . $class . '.php';
        } elseif (Util::startWith($class, 'tplapp') && $class != 'tplapp') {
            $class = substr_replace(substr_replace($class, '.', 3, 0), '.', 7, 0);
            $file = $rootPath . '/classes/tpls/app/class.' . $class . '.php';
        } elseif (Util::startWith($class, 'tpl')) {
            $class = $class != 'tpls' ? substr_replace($class, '.', 3, 0) : $class;
            $file = $rootPath . '/classes/tpls/class.' . $class . '.php';
        }
 
        return $file;
    }

References Util\startWith().

Referenced by load().

unregister()

unregister

(

)

Unregisters the autoloader from the SPL autoload stack.

Returns

bool True on success, false on failure.

Definition at line 186 of file class.autoloader.php.

    {
        return spl_autoload_unregister(array($this, 'load'));
    }

Field Documentation

$classMap

$classMap = []

staticprivate

Definition at line 27 of file class.autoloader.php.

$failedLookups

$failedLookups = []

staticprivate

Definition at line 33 of file class.autoloader.php.

$stats

$stats

staticprivate

Initial value:

                      = [
    'hits' => 0,
    'misses' => 0,
    'failed_hits' => 0
]

Definition at line 39 of file class.autoloader.php.

---

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

• E:/Bearsampp-development/sandbox/core/classes/class.autoloader.php