Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A simple recursive PHP autoloader using the RecursiveDirectoryIterator.
<?php
class A
{
public function __construct()
{
echo get_class($this);
}
}
// EOF
<?php
/*
* The MIT License (MIT)
*
* Copyright (c) 2014 Rob Dunham
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* Simple Recursive Autoloader
*
* A simple autoloader that loads class files recursively starting in the directory
* where this class resides. Additional options can be provided to control the naming
* convention of the class files.
*
* @package Autoloader
* @license http://opensource.org/licenses/MIT MIT License
* @author Rob Dunham <contact@robunham.info>
*/
class Autoloader
{
/**
* File extension as a string. Defaults to ".php".
*/
protected static $fileExt = '.php';
/**
* The top level directory where recursion will begin. Defaults to the current
* directory.
*/
protected static $pathTop = __DIR__;
/**
* A placeholder to hold the file iterator so that directory traversal is only
* performed once.
*/
protected static $fileIterator = null;
/**
* Autoload function for registration with spl_autoload_register
*
* Looks recursively through project directory and loads class files based on
* filename match.
*
* @param string $className
*/
public static function loader($className)
{
$directory = new RecursiveDirectoryIterator(static::$pathTop, RecursiveDirectoryIterator::SKIP_DOTS);
if (is_null(static::$fileIterator)) {
static::$fileIterator = new RecursiveIteratorIterator($directory, RecursiveIteratorIterator::LEAVES_ONLY);
}
$filename = $className . static::$fileExt;
foreach (static::$fileIterator as $file) {
if (strtolower($file->getFilename()) === strtolower($filename)) {
if ($file->isReadable()) {
include_once $file->getPathname();
}
break;
}
}
}
/**
* Sets the $fileExt property
*
* @param string $fileExt The file extension used for class files. Default is "php".
*/
public static function setFileExt($fileExt)
{
static::$fileExt = $fileExt;
}
/**
* Sets the $path property
*
* @param string $path The path representing the top level where recursion should
* begin. Defaults to the current directory.
*/
public static function setPath($path)
{
static::$pathTop = $path;
}
}
Autoloader::setFileExt('.php');
spl_autoload_register('Autoloader::loader');
// EOF
<?php
class B
{
public function __construct()
{
echo __CLASS__;
}
}
// EOF
<?php
class C extends A
{
public function __construct()
{
parent::__construct();
}
}
// EOF
<?php
include 'Autoloader.php';
$a = new A;
$b = new B;
$c = new C;
// EOF
@matthew798

This comment has been minimized.

Copy link

@matthew798 matthew798 commented Jan 13, 2016

Does this autoloader overcome the lower case problem with the default autoloader?

EDIT
To answer my own question, yes!

@emresaracoglu

This comment has been minimized.

Copy link

@emresaracoglu emresaracoglu commented May 8, 2017

Script work thank you but how can I run this script with Namespace?

@Firestorm-Graphics

This comment has been minimized.

Copy link

@Firestorm-Graphics Firestorm-Graphics commented Jul 16, 2017

you can iterate through child directories too, just replace the loader function with this:

/** * Autoload function for registration with spl_autoload_register * * Looks recursively through project directory and loads class files based on * filename match. * * @param string $className */ public static function loader($className) { if (is_null(static::$fileIterator)) { static::$fileIterator = new RecursiveIteratorIterator( new RecursiveDirectoryIterator(static::$pathTop, RecursiveDirectoryIterator::SKIP_DOTS), RecursiveIteratorIterator::SELF_FIRST, RecursiveIteratorIterator::CATCH_GET_CHILD // Ignore "Permission denied" ); } $filename = $className . static::$fileExt; foreach (static::$fileIterator as $file) { if (strtolower($file->getFilename()) === strtolower($filename)) { if ($file->isReadable()) { include_once $file->getPathname(); } break; } } }

@Raserad

This comment has been minimized.

Copy link

@Raserad Raserad commented Jun 21, 2018

You can use static map for save previous founded class, for a better performance))

@nkmwambs

This comment has been minimized.

Copy link

@nkmwambs nkmwambs commented Nov 11, 2019

Thanks this script works fine

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.