usmanakram/php-autoload-hello-world

My first Composer project.

v0.0.4 2019-09-29 06:15 UTC

Requires

• php: ^7.1.2

MIT

• Usman Akram

README

Create directory named php-autoload-hello-world

Files Structure We can put all files inside the main dir, but recommended way is to create another dir, as src to be easier to understand and maintain our code organized. The project structure will start with the follow: php-autoload-hello-world/src/HelloWorld/

We will create our classes inside "HelloWorld" directory.

Let's create a class named OurFirstClass.

/php-autoload-hello-world/src/HelloWorld/OurFirstClass.php

namespace HelloWorld;

class OurFirstClass
{
    public static function hello()
    {
        return 'Hello World, Composer!';
    }
}

Now we need to have composer.json file. For that we need to go inside our project's root directory using terminal. Then run $ composer init and answer simple questions. It will create composer.json

{
    "name": "usmanakram/php-autoload-hello-world",
    "description": "My first Composer project.",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Usman Akram",
            "email": "[e-mail]"
        }
    ],
    "minimum-stability": "dev",
    "require": {}
}

Add some configuration in composer.json

{
    "name": "usmanakram/php-autoload-hello-world",
    "description": "My first Composer project.",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Usman Akram",
            "email": "[e-mail]"
        }
    ],
    "minimum-stability": "dev",
    "require": {
        "php": "^7.1.2"
    },
    "autoload": {
        "psr-4": {
            "HelloWorld\\": "src/HelloWorld/"
        }
    }
}

Now, run $ composer install inside root directory. It will create vendor directory and composer.lock file inside root directory.

To test our working code, create tests/test.php file inside root directory and call any class method that we have created inside src/HelloWorld directory.

Uploading code at GitHub

Create file named .gitignore and put following line in it.

/vendor/
composer.lock

Create repository named php-autoload-hello-world at github. And run following commands inside our project root directory.

$ git init
$ git remote add origin [e-mail]:usmanakram/php-autoload-hello-world.git
$ git add --all
$ git commit -m "initial files"
$ git tag -a v1.0.0 -m "initial release"
$ git push -u origin master
$ git push --tags

Publish at Packagist

Now, we need to publish our project at Packagist. Login at github.com and go to our newly created repository page. Click Settings > Webhooks > Add Webhook. Here we need to put our Packagist detail.

Under

• Payload URL put https://packagist.org/api/github?username=usmanakram
• Content Type select application/json
• Secret put your Packagist API token (you will find API token at https://packagist.org/profile/)

Here is the reference link: https://packagist.org/about#how-to-update-packages

To use your library, simply run following commands

$ composer init
$ composer require usmanakram/php-autoload-hello-world

Then create an index.php file that will load the autoloader

require 'vendor/autoload.php';

use HelloWorld\OurFirstClass;

echo OurFirstClass::hello();

All the classes inside our library is now ready to use!