How to include a library to a Zend Framework 2 application using namespace based autoloading?

Question

I created a subfolder MyNamespace in /vendor/ (is it the correct place for own libraries?) and want to use classes like MyNamespace\Mvc\Router\MyCustomRouter in my application. How can I include this library to my namespace based autoloading?

Answer 1

Edit init_autoloader.php and change the if ($zf2Path) { section to be:

if ($zf2Path) {
    if (isset($loader)) {
        $loader->add('Zend', $zf2Path);
    } else {
        include $zf2Path . '/Zend/Loader/AutoloaderFactory.php';
        Zend\Loader\AutoloaderFactory::factory(array(
            'Zend\Loader\StandardAutoloader' => array(
                'autoregister_zf' => true,
                'namespaces' => array(
                    'MyNamespace' => __DIR__ . '/vendor/MyNamespace',
                ),                    
            )
        ));
    }
}

Note the addition of the MyNamespace key within the Zend\Loader\StandardAutoloader section.

Answer 2

In addition to Rob's answer, some other ways to autoload a custom library

First, make sure your folder structure is psr0 compliant

A typical structure for the mythical psr0 compliant MyNamespace library used in the examples

vendor/
    MyNamespace/
        lib/
            MyNamespace/
                FooClass.php
                BarClass.php

Include from a Module.php file using getAutoloaderConfig

public function getAutoloaderConfig()
{
    return array(
        'Zend\Loader\StandardAutoloader' => array(
            'namespaces' => array(
                'MyNamespace' => __DIR__ . '/../../vendor/MyNamespace/lib/MyNamespace',
            ),
        ),
    );
}

Directly in index.php using the AutoloaderFactory to configure the StandardAutoloader

// Setup autoloading
require 'init_autoloader.php';

Zend\Loader\AutoloaderFactory::factory(array(
    'Zend\Loader\StandardAutoloader' => array(
        'namespaces' => array(
            'MyNamespace' => __DIR__ . '/../vendor/MyNamespace/lib/MyNamespace',
        ),
    )
));

You could even do the same in a ./config/autoload/ file

<?php    
// file ./config/autoload/namespaces.local.php

Zend\Loader\AutoloaderFactory::factory(array(
     'Zend\Loader\StandardAutoloader' => array(
         'namespaces' => array(
             'MyNamespace' => __DIR__ . '/../../vendor/MyNamespace/lib/MyNamespace',
         ),
     )
));

A further alternative to include your lib is to edit vendor/composer/autoload_namespaces.php

<?php

// autoload_namespaces.php generated by Composer

$vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);

return array(
    'Zend\\' => $vendorDir . '/zendframework/zendframework/library/',
    'MyNamespace\\' => $vendorDir . '/MyNamespace/lib/',
);

Answer 3

Also you can use the composer autoloading

{
"autoload": {
    "psr-0": {"MyNamespace\\": "vendor/MyNamespace/"}
}}