Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webiny/classloader
[READ-ONLY] PHP class loader (autoloader) that supports PEAR, PSR-0 and PSR-4 standards. (master at Webiny/Framework)
https://github.com/webiny/classloader
Last synced: 2 months ago
JSON representation
[READ-ONLY] PHP class loader (autoloader) that supports PEAR, PSR-0 and PSR-4 standards. (master at Webiny/Framework)
- Host: GitHub
- URL: https://github.com/webiny/classloader
- Owner: webiny
- License: mit
- Created: 2014-08-29T19:20:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-26T21:24:24.000Z (about 7 years ago)
- Last Synced: 2024-08-09T23:47:09.554Z (5 months ago)
- Language: PHP
- Homepage: http://www.webiny.com/
- Size: 25.4 KB
- Stars: 3
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
ClassLoader Component
=====================
Class loader component loads your PHP files automatically as long as they follow some standard naming convention.
The following standards are supported:
- PEAR
- [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
- [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
Install the component
---------------------
The best way to install the component is using Composer.
```bash
composer require webiny/class-loader
```
For additional versions of the package, visit the [Packagist page](https://packagist.org/packages/webiny/class-loader).
## Usage
To use the ClassLoader, get its instance by calling ClassLoader::getInstance() method.
```php
require_once 'Webiny/Component/ClassLoader/ClassLoader.php'
use Webiny\Component\ClassLoader;
ClassLoader::getInstance();
```
Once you have the ClassLoader instance, you can register map rules. The ClassLoader automatically detects if you are
registering a namespace or a PEAR rule. PEAR rules are identified by having a underline '_' at the end of the prefix.
If PSR is not defined, the component will use **PSR-4** standard. All paths should be absolute.
```php
ClassLoader::getInstance()->registerMap([
// a namespace rule (PSR-4 - default)
'Webiny' => realpath(dirname(__FILE__)).'/library/Webiny',
// a namespace rule (PSR-0)
'Symfony' => [
'Path' => '/var/vendors/Symfony',
'Psr' => 0
],
// a PEAR rule
'Swift_' => realpath(dirname(__FILE__)).'/library/Swift',
]);
```
As you can see the registerMap method takes an array of multiple rules. Each rule consists of a prefix and a location.
For better performance you can provide a Cache component to ClassLoader. Doing so, ClassLoader will cache the paths and
files resulting in a faster performance.
```php
ClassLoader::getLoader()->registerCacheDriver($instanceOfCacheInterface);
```
## Non-standardized libraries
If you have a library that is not following neither the PSR naming convention nor the PEAR naming convention, you'll
have to manually define some of the settings.
Let's take a look at this example:
```php
ClassLoader::getInstance()->registerMap([
'Smarty_' => [
'Path' => '/var/www/Vendors/Smarty/libs/sysplugins',
'Normalize' => false,
'Case' => lower
]
]);
```
You can see that the `Smarty_` library is defined as an array that has `Path`, `Normalize` and `Case` parameter.
### `Path`
Defines the path to the library.
### `Normalize`
The `Normalize` parameter tells the autoloader if he should to change the `_`, on the class name, into directory separators.
For example if you have a class names`Smarty_Internal_Compile` the normalized path would be `Smarty/Internal/Compiler`.
If you set the `Normalize` parameter to `false`, the original class name will be used.
### `Case`
By default the autoloader transfers all the class names to CamelCase, you can set the `Case` parameter to `lower` if
you wish that the class names are used in lower case inside the class path.
Resources
---------
To run unit tests, you need to use the following command:
$ cd path/to/Webiny/Component/ClassLoader/
$ composer.phar install
$ phpunit