How does PSR-4 autoloading work in composer for custom libraries?
Asked Answered
G

1

12

I use the following directory structure based on my understanding of how namespaces in PHP work:

project_root
    app/
    |    lib/
    |    |    MyCompany/
    |    |    |    Utility/
    |    |    |    |    Logger.php
    |    |    |    Core/
    |    |    |    |    User.php
vendor/
    composer/
    symfony/
    guzzle/
bootstrap.php
composer.json

According to the PSR-4 specification, a fully qualified class name has the following form:

\<NamespaceName>(\<SubNamespaceNames>)*\<ClassName>

Question 1:

From my directory structure above, is the assumption below correct?

  • NamespaceName = MyCompany
  • SubNamespaceNames = Utility | Core
  • ClassName = Logger | User

Question 2:

If my bootstrap.php file contains the following:

<?php
require 'vendor/autoload.php';

How would I configure the 'autoload' section of composer.json to autoload the classes in the MyCompany directory? Such that I would be able to create an instance of Logger in bootstrap.php

Garamond answered 6/1, 2015 at 15:48 Comment(0)
H
14

Taken from the documentation you linked:

{
    "autoload": {
        "psr-4": {
            "MyCompany\\": "app/lib/MyCompany/",
        }
    }
}

This is pretty self explanatory, it simply tells the autoloader that app/lib/MyCompany is the root for the MyCompany\ namespace.

You would then be able to use the class as \MyCompany\Utility\Logger.

Note that in PSR-4, unlike PSR-0, you'd normally omit MyCompany from the directory structure, and just use app/lib/.

Hecatomb answered 6/1, 2015 at 16:8 Comment(1)
You will also need to run composer dump-autoload once you've added this snippet in order for it to work.Moyers

© 2022 - 2024 — McMap. All rights reserved.