varunsridharan/php-autoloader

Lightweight PSR-4 PHP Autoloader Class.

2.6 2019-10-04 09:42 UTC

GPL-3.0-or-later

• Varun

README

Lightweight PSR-4 PHP Autoloader Class.

Installation

The preferred way to install this extension is through Composer.

To install PHP_Autoloader library, simply:

$ composer require varunsridharan/php-autoloader

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require varunsridharan/php-autoloader --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/varunsridharan/php-autoloader.git

Or install it manually:

Download autoloader.php:

$ wget https://raw.githubusercontent.com/varunsridharan/php-autoloader/master/src/autoloader.php

Usage

Arguments

• $namespace : PHP Namspace To Handle Autoload For
• $classmap : https://github.com/varunsridharan/php-classmap-generator Generated Classmap File.
• $path : Full Path to lookup for php files
• $options : An Array of useful Arguments.
• $prepend : Option to prepend / append current autoloader with exists autoloaders.

$options Arguments

  array(
      /**
       * An Array of Class Namespace to Exclude While Checking for current namespace.
       * Eg
       * Main Namespace \Testing\Core
       * Exclude \Testing\Core\Abstracts
       */
      'exclude' => false,
      
      /**
       * Custom Option To Quickly Remap A Class File. 
       * If any class added then it will not search.
       * instead it gets the location from here and loads it.
       * An Array of class and its file location
       */
      'mapping' => array(),
      
      /**
       * Set To True / False.
       */
      'debug'   => false,
  );

Example Folder Stucture

  | - src\
  | -- class1\
  | --- class1.php
  | -- class2\
  | --- class2.php
  | --- class3\
  | ---- class3.php
  | - loader.php
  | - index.php

loader.php SourceCode

  $autoloader = new \Varunsridharan\PHP\Autoloader('varun',__DIR__.'/src/',array(
      'mapping' => array(
          'varun\class2\class3\class3' => 'src/class2/class3/class3.php',
      )
  ))

index.php SoruceCode

  require __DIR__.'loader.php';
  
  $class1 = new \varun\class1\class1(); // This file is autoloaded based on the namespace 
  $class2 = new \varun\class1\class2(); // This file is autoloaded based on the namespace 
  $class3 = new \varun\class1\class3(); // This file is loaded using the data from remap array

📝 Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

• GNU General Public License v3.0 © Varun Sridharan
• Code of Conduct

📣 Feedback

• ⭐ This repository if this project helped you! 😉
• Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. If you, or your company, use any of my projects or like what I’m doing, kindly consider backing me. I'm in this for the long run.

• ☕ How about we get to know each other over coffee? Buy me a cup for just $9.99
• ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
• 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
• 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

• Follow me on 👨‍💻 Github and stay updated on free and open-source software
• Follow me on 🐦 Twitter to get updates on my latest open source projects
• Message me on 📠 Telegram
• Follow my pet on Instagram for some dog-tastic updates!

Built With ♥ By Varun Sridharan