aaronholbrook/autoload

Automatically and recursively require_once all files in a directory.

1.2 2015-06-04 19:49 UTC

This package is not auto-updated.

Last update: 2024-11-06 14:59:06 UTC


README

Purpose

Automatically load all PHP files in the specified directory. Recursively.

Benefits

  • Rename files with no fear of breaking includes or require calls
  • Encourages using more files to more cleanly organize code into smaller logical chunks
  • Reduce git merge conflicts with other developers

Usage

Install via composer by adding the package to your composer file. "aaronholbrook/autoload": "1.*", does the trick.

Be sure to include the regular composer load file via require( __DIR__ . '/vendor/autoload.php' );.

Please note that although similarly named, this Autoload library is meant for loading all PHP files in a given directory. This does NOT function in the manner of the built-in PSR-4 PHP Autoloader.

Simply load your desired includes or whatever directory by calling:

\AaronHolbrook\Autoload\autoload( __DIR__ . 'includes' );

Caveats

Since this is a recursive loader, you should be conscious of what you're placing in your autoloaded directory.

Things I wouldn't recommend doing:

  • Placing a big (or any) PHP library in the autoloaded directory (this should/could be handled better with composer anyways!)
  • Being lax with permissions on a server. Obviously this is never a good idea, but I would be sure that your folder / file permissions are up to snuff (or strange files may be loaded)

Disclaimer

Be aware that this may not be the right choice for your project. Please be fully aware of what this plugin does and how it works.

References