korstiaan/nsautoload

Namespace Autoloader for Drupal 7.x.

Nsautoload for Drupal 7.x

Drupal 7.x module which autoloads your modules namespaced classes., _(*1)

, _(*2)

Requirements

• Drupal 7.x
• PHP 5.3.3+

Installation

Download the module

The recommended way to install Nsautoload is with Composer. Just add the following to your composer.json:, _(*3)

   {
       "minimum-stability": "dev",
       "require": {
           "korstiaan/nsautoload": "dev-master"
       }
   }

Now update Composer and install the newly added requirement and its dependencies:, _(*4)

``` bash $ php composer.phar update korstiaan/nsautoload, <sub>(*5)</sub>

If all went well and `composer/installers` did its job, Nsautoload was installed to `modules/nsautoload`. 
If you don't want it there, or it's not part of your Drupal rootdir, symlink it to your folder of choice.   

### Using Composer

Using `Composer` means including its autoloader. Add the following to your Drupals settings.php:

```php
// /path/to/sites/default/settings.php

require '/path/to/vendor/autoload.php';

2. Use composer_loader

Just follow its readme., <sub>(*6)</sub>

Enable Nsautoload

There are 2 ways to enable Nsautoload:, <sub>(*7)</sub>

1. Add a few lines to _settings.php_ (recommended)

Add the following to your project's settings.php:, <sub>(*8)</sub>

<?php
// /path/to/sites/default/settings.php

use Nsautoload\Nsautoload;

$loader = new Nsautoload();
$loader->register();

2. Enable it as a Drupal module.

Go to site/all/modules and enable it on http://yourdomain.com/admin/modules/list. (If you're using voiture just add nsautoload to cnf/shared/modules.php), <sub>(*9)</sub>

Usage

In order for Nsautoload to be able to find your classes some conventions have to be followed:, <sub>(*10)</sub>

Naming your namespace

Your namespace must be the name of your module with an under_score to CamelCase conversion. For example:, <sub>(*11)</sub>

• my_module has namespace MyModule
• my_foo_module has namespace MyFooModule
• mymodule has namespace Mymodule

Location of your classes

Two conventions can be used for this, one following the PSR-0 standard, and a more Drupal'ish convention:, <sub>(*12)</sub>

1. PSR-0

This one completely follows the PSR-0 standard, for example:, <sub>(*13)</sub>

• MyModule\Foo is located at /path/to/my_module/MyModule/Foo.php
• Mymodule\Foo\Bar is located at /path/to/mymodule/Mymodule/Foo/Bar.php
• Mymodule\Foo\Bar_Crux is located at /path/to/mymodule/Mymodule/Foo/Bar/Crux.php

2. Drupal-style (deprecated)

When this convention is followed, a class is located at module_name/class/_class_.class.inc. Only a 2 level namespace can be used. Examples:, <sub>(*14)</sub>

• MyModule\Foo is located at /path/to/my_module/class/foo.class.inc
• MyModule\Foo_Bar is located at /path/to/my_module/class/foo_bar.class.inc
• MyModule\Foo\Bar can't be mapped with this convention.

This convention also adds another namespace naming strategy for BC purposes. Next to a under_score to CamelCase conversion, it also allows you to randomly add capitals in your namespace. This allows the following mapping:, <sub>(*15)</sub>

• MyOldModule\Foo to /path/to/myoldmodule/class/foo.class.inc

APC caching

In order to cache Nsautoload's autoload map you can wrap it into Symfony's ApcClassLoader., <sub>(*16)</sub>

First add Symfony's ClassLoader component to your composer.json:, <sub>(*17)</sub>

   {
       "require": {
           "symfony/class-loader": "dev-master"
       }
   }

Install it:, <sub>(*18)</sub>

$ php composer.phar update symfony/class-loader

Then change your project's settings.php Nsautoload lines to look like this:, <sub>(*19)</sub>

<?php
// /path/to/sites/default/settings.php

use Nsautoload\Nsautoload;

$loader    = new Nsautoload();
$apcLoader = new Symfony\Component\ClassLoader\ApcClassLoader(md5(__DIR__), $loader);
$apcLoader->register(true);

And you're done!, <sub>(*20)</sub>

License

Nsautoload is licensed under the MIT license., <sub>(*21)</sub>