prod3v3loper/php-auto-autoloader

Need any more, no matter where you have a master in your root, the autoloader will find it.

v1.0.0 2019-03-05 18:18 UTC

This package is auto-updated.

Last update: 2024-04-19 09:55:46 UTC


README

Melabuai Logo

Language Codacy Badge Build Status Repo Size Code SIze Github Release date Packgist PHP Version MIT License Website

melabuai

🏗 PHP Auto Autoloader

With this autoloader, you do not need any more, no matter where you have a master in your root, the autoloader of MB tnado Ai will find it. The classes found can be indexed to retry without searching.

Usage

Instantiate your classes, interfaces, traits or even abstract classes, no matter where. The only thing you have to do is to integrate.

Packagist with Composer

This solution extends the vendor autoloader because it calls the files with certain criteria. The extension allows you to call classes wherever the Autoloader is involved.

Download Composer local or global. Check for more Tutorial - NetBeans with Composer and Packagist for this one.

You found the Autoloader package on Packagist - PHP Auto Autoloader.

Add the Autoloader dependencie to the composer.json and set the autoload.

{
    ...
    "autoload": {
        "psr-4": { "Aautoloder\\": "autoload/src" }
    },
    "require": {
        "prod3v3loper/php-auto-autoloader": ">=1.0"
    }
    ...
}

Now run the composer install command with php

php composer.phar install

This is the vendor autoloader invites our autoloader and now we do not need to specify any more class and can load all our classes.

index.php

<?php
define('MBT_DOCUMENT_ROOT', __DIR__);
require_once __DIR__ . '/vendor/autoload.php';
new \Aautoloder\Loader(array(MBT_DOCUMENT_ROOT));
?>
<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>MB tnado Ai - Autoload</title>
    </head>
    <body>
        <?php

        // METHOD 1: Fastest way, the namespace is foldername structure and filename is equal to filename
        $class_one = new testclasses\classOne();
        $class_one->method_from_class_one();

        // METHOD 2: The slower way, namespace is equal to folder structure but the classname is differnt to the filename
        $class_two = new testclasses\classes\class_two();
        $class_two->method_from_class_two();

        // METHOD 3: The slowest way, here ist nothing euqal
        $three_class = new name_space\namespace2\three_class();
        $three_class->method_from_three_class();
        
        ?>
    </body>
</html>

Git clone

Get per Git or download and use it.

git clone https://github.com/prod3v3loper/php-auto-autoloader.git /Users/username/projects/

So we use it without a vendor and can start a direct call.

index.php

<?php
define('MBT_DOCUMENT_ROOT', __DIR__);
require_once './autoload/src/Loader.php';
new \Aautoloder\Loader(array(MBT_DOCUMENT_ROOT));
?>
<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <title>MB tnado Ai - Autoload</title>
    </head>
    <body>
        <?php

        // METHOD 1: Fastest way, the namespace is foldername structure and filename is equal to filename
        $class_one = new testclasses\classOne();
        $class_one->method_from_class_one();

        // METHOD 2: The slower way, namespace is equal to folder structure but the classname is differnt to the filename
        $class_two = new testclasses\classes\class_two();
        $class_two->method_from_class_two();

        // METHOD 3: The slowest way, here ist nothing euqal
        $three_class = new name_space\namespace2\three_class();
        $three_class->method_from_three_class();
        
        ?>
    </body>
</html>

Core Settings & Debug

autoload/core.config.php

Indexing of the found classes, default is true.

define('MBT_CORE_AUTOLOAD_INDEX', true);

Maximum number of lines to read in a file, default is 49.

define('MBT_CORE_AUTOLOAD_READ_MAX_LINES', 49);

Set this to false so that you no longer see the debugging, default is true.

define('MBT_DEBUG_DISPLAY_AUTOLOAD', true);

Look at which classes where were found, default is true.

define('MBT_DEBUG_DISPLAY_AUTOLOAD_SEARCH', true);

Root

The complete path is the directory path, that the autoloader get by self.

DEFAULT: MBT_DOCUMENT_ROOT

The autoloader define get the web root by self after set MBT_DOCUMENT_ROOT

define('MBT_DOCUMENT_ROOT', __DIR__);

define('MBT_SERVER_ROOT', str_replace(MBT_DOCUMENT_ROOT, '', str_replace(filter_input(INPUT_SERVER, 'DOCUMENT_ROOT'), '', str_replace("\\", "/", MBT_DOCUMENT_ROOT))));
define('MBT_HTTP_ROOT', get_protocol() . get_host() . MBT_SERVER_ROOT);

Loader methods

The autoloader finds everything yourself you do not have to do anything except write your class and instance and use.

Method  Namespace (Instance) Path Load Time
1 testclasses\classOne php-auto-autoloader/testclasses/classOne.php 0.001 sec.
2 testclasses\classes\classTwo.php php-auto-autoloader/testclasses/classes/classTwo.php 0.002 sec.
3 name_space\namespace2\three_class php-auto-autoloader/testclasses/classThree.php  0.021 sec.

METHOD 1:

This is the fastest way

That means we take the website root path and namespace as a folder path and the classname we put together with these.

Example

The instance: new testclasses\classOne();

Type Sample Description
PATH /users/username/projects/sites/website/ MBT_DOCUMENT_ROOT
NAMESPACE testclasses Like the folder name
CLASS classOne Like the file name without extension
Then the result example /users/username/projects/sites/website/testclasses/classOne.php

METHOD 2:

This method is slightly slower than the first, so 0.03 - 0.05 seconds

This function namespace as folder path and force only this path for class class_two (Example) file. However, this only occurs when the file does not match the specified class name. This means every file found in this folder is opened and searched for the classname. As soon as the used class exists in a file, this is integrated and can use it.

Example

The instance: new testclasses\classes\class_two();

Type Sample Description
PATH /users/username/projects/sites/website/ MBT_DOCUMENT_ROOT
NAMESPACE testclasses\classes Like the folder name
Then the result example /users/username/projects/sites/website/testclasses/classes/classTwo.php

METHOD 3:

This method is the slowest, but found class anything where

This method is the slowest, because it scans all your folders. No matter how much files you have, all are opened, read and searched for the classname. This method intervenes only when none of the other methods was successful. So if the namespace was not just a folder name and the class name was not filename.

Example

The instance: new testclasses\classes\three_class();

Type Sample Description
PATH /users/username/projects/sites/website/ MBT_DOCUMENT_ROOT
Then the result example /users/username/projects/sites/website/testclasses/classThree.php

Information

tnado SEO & AMP CMS, this autoloader is one of parts from Framework.

Contribute

Please an issue if you think something could be improved. Please submit Pull Requests when ever possible.

Authors

Samet Tarim - All works

License

MIT - prod3v3loper