How to lnstall and Use Composer in PHP Project?
Ghulam Mujtaba
Posted on July 18, 2024
Composer Introduction
Composer is a dependency manager for PHP that helps manage libraries and dependencies in your web development projects. It installs and updates dependencies declared in your project's composer.json file, autloads classes from installed dependencies, simplifies project setup and collaboration, and enhances security and performance.
Composer Installation
To install Composer, follow these steps:
- Open a browser and navigate to (https://getcomposer.org/)
- Click on the "Download" button it moves you to next page where you see a code snippet/block.
- Copy the code snippet provided on that page and paste it into your terminal/command prompt
- Run the command to download and install Composer (note: this method only works on Linux and macOS)
- For Windows, download the executable file (.exe) and follow the installation prompts
- Once installed, open a terminal/command prompt and type
composer
to verify the installation
Composer Initialization
To initialize a new Composer project, run the command composer init
in your terminal/command prompt. This will create a composer.json
file and prompt you to provide information about your project, such as:
- Name
- Description
- Author
- License
- Dependencies (require and require-dev)
Here's an example of the prompts you'll see when running composer init
:
Package name (<vendor>/<name>) []: Ghulam Mujtaba <mujtabaofficial247@gmail.com>
Description []:
Author [n to skip]:
License []:
Minimum Stability []:
Package type (library, project, metapackage, custom) []:
Define your dependencies:
Would you like to define your dependencies (require) interactively [yes]? no
Would you like to define your dev dependencies (require-dev) interactively [yes]? no
Autoloading
To autoload classes and functions, we have to add the following code to our composer.json
file:
{
"name": "admin/demo",
"authors": [
{
"name": "Ghulam Mujtaba",
"email": "mujtabaofficial247@gmail.com"
}
],
"autoload": {
"psr-4": {
"Core\\": "Core/",
"Http\\": "Http/"
}
}
}
The double backslash (\\
) is used to escape the namespace separator, which is a single backslash (\
).
Add path
Open Public/Index.php
file as entry point for project and add the BASE_PATH at top, after classes import statements, to autoload classes in project:
require BASE_PATH . 'vendor/autoload.php';
And remove any existing spl_autoload code statements from the file and run the project it shows error as Core/Container is missing.
Updating Autoload
To fix container missing issue we have to update the autoload configuration by running the command composer dump-autoload
in terminal. This will update the autoload_psr4.php
file in the vendor directory. In psr-4 the namespace must end with namespace separator. The updated autoload_psr4.php
file is:
<?php
// autoload_psr4.php @generated by Composer
$vendorDir = dirname(__DIR__);
$baseDir = dirname($vendorDir);
return array(
'Core\\' => array($baseDir . '/Core'),
'Http\\' => array($baseDir . '/Http'),
);
Running the Project
After completing these steps, refresh your browser to see the output. Composer should now autoload the classes and run the project successfully.
I hope that you have clearly understood it.
Posted on July 18, 2024
Join Our Newsletter. No Spam, Only the good stuff.
Sign up to receive the latest update from our blog.