PHP Composer Full Tutorial: A Beginner's Guide to Dependency Management
Introduction to PHP Composer
PHP Composer is like a smart shopping assistant for your PHP projects. It helps you:
- Download and manage third-party libraries/packages
- Keep track of exact versions used
- Automatically load classes
- Share your own code with others
Why use Composer?
Imagine baking a cake:
- Without Composer: You grow wheat, milk cows, make flour/butter from scratch
- With Composer: You buy pre-made ingredients and focus on baking
Table of Contents
- Installation Guide
- Basic Concepts
- Starting a Project
- Managing Dependencies
- Autoloading Magic
- Updating Packages
- Version Constraints
- Common Commands
- Troubleshooting
- Advanced Features
1. Installation Guide {#installation}
Windows
- Download Composer-Setup.exe
- Run installer (check "Add to PATH")
- Verify in Command Prompt:
composer --version
Linux/macOS
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php composer-setup.php
php -r "unlink('composer-setup.php');"
# Move to global location
sudo mv composer.phar /usr/local/bin/composer
Verify installation:
composer --version
2. Basic Concepts {#basic-concepts}
- Dependency: A package your project needs to work
- Packagist: Official package repository (like an app store)
- composer.json: Shopping list of required packages
- composer.lock: Exact versions used (never edit manually)
- vendor directory: Where downloaded packages live
3. Starting a Project {#starting-a-project}
Create a new folder and initialize:
mkdir my-project
cd my-project
composer init
You'll be asked:
- Package name (vendor/name format, e.g.,
john/my-project) - Description
- Author
- Minimum stability (usually
stable) - Package type (usually
project) - License
- Dependencies (press Enter to skip)
Example generated composer.json:
{
"name": "john/my-project",
"description": "My awesome project",
"type": "project",
"require": {}
}
4. Managing Dependencies {#managing-dependencies}
Adding a Package
To add the popular Monolog logging library:
composer require monolog/monolog
This:
- Adds monolog to
composer.json - Downloads it to
vendor/ - Creates
composer.lock
Your composer.json now looks like:
{
"require": {
"monolog/monolog": "^2.0"
}
}
Development Dependencies
Packages only needed for development (like testing tools):
composer require phpunit/phpunit --dev
5. Autoloading Magic {#autoloading}
Composer can automatically load your classes. Create this structure:
my-project/
├── composer.json
└── src/
└── MyClass.php
src/MyClass.php:
<?php
namespace John\MyProject;
class MyClass
{
public function hello()
{
return "Hello from Composer!";
}
}
Update composer.json:
{
"autoload": {
"psr-4": {
"John\\MyProject\\": "src/"
}
}
}
Generate autoloader:
composer dump-autoload
Now use your class:
require 'vendor/autoload.php';
$obj = new John\MyProject\MyClass();
echo $obj->hello();
6. Updating Packages {#updating-packages}
Install from lock file (team members should do this):
composer installUpdate all packages:
composer updateUpdate specific package:
composer update monolog/monolog
7. Version Constraints {#version-constraints}
| Constraint | Meaning | Example |
|---|---|---|
^1.2.3 |
1.2.3 <= version < 2.0.0 | Safe updates |
~1.2.3 |
1.2.3 <= version < 1.3.0 | Patch updates |
1.2.* |
Any 1.2 version | Wildcard |
>=1.2 |
1.2 or higher | Minimum version |
1.2 - 1.5 |
Between 1.2 and 1.5 | Range |
dev-main |
Latest commit from Git branch | Development |
8. Common Commands {#common-commands}
| Command | Description |
|---|---|
composer init |
Create new composer.json |
composer require [package] |
Add a package |
composer remove [package] |
Remove a package |
composer install |
Install all dependencies |
composer update |
Update all packages |
composer show |
List installed packages |
composer search [term] |
Search Packagist |
composer outdated |
Show outdated packages |
composer validate |
Check composer.json for errors |
composer dump-autoload |
Refresh autoloader |
9. Troubleshooting {#troubleshooting}
Common Issues
Memory Limit Errors
COMPOSER_MEMORY_LIMIT=-1 composer updateVersion Conflicts
- Remove conflicting packages
- Update version constraints
- Use
composer why [package]to find conflicts
Missing Extensions
- Install required PHP extensions (e.g., mbstring, openssl)
Slow Downloads
Use China mirror (if needed):composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
10. Advanced Features {#advanced-features}
1. Scripts
Automate tasks in composer.json:
{
"scripts": {
"test": "phpunit",
"deploy": [
"composer install --no-dev",
"php artisan migrate"
]
}
}
Run with:
composer run test
2. Private Repositories
Add in composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "git@github.com:yourcompany/private-package.git"
}
]
}
3. Creating Your Own Package
- Create
composer.json - Set up PSR-4 autoloading
- Host on GitHub/Packagist
- Share with others!
Conclusion: Why Composer Matters
PHP Composer has revolutionized PHP development by:
- Saving time - No manual dependency management
- Ensuring consistency - Same versions across environments
- Encouraging sharing - Vast ecosystem of packages
- Modernizing PHP - Brings PHP up-to-date with other languages
Best Practices Checklist:
- ✔️ Always commit
composer.lock - ✔️ Use version constraints wisely
- ✔️ Keep
vendor/in.gitignore - ✔️ Update dependencies regularly
- ✔️ Use meaningful package names
Now you're ready to manage PHP dependencies like a pro! Start by adding Composer to your next project and explore the vast world of PHP packages available.
Projects to explore next
Source-code projects from the KritiMyantra catalogue. Check each project's details before buying.
Flask Authentication System (Free Version) - Kritim Yantra
🛠 Features✔ Google & GitHub Authentication✔ User Registration & Login✔ Profile/Dashboard Access✔ Secure & Mi...
Flask Blog CMS with Admin Dashboard — Python Source Code
A Flask-based blogging website with a built-in admin dashboard. Manage articles, images, categories, tags and featured p...
Laravel 12 + ReactJS Starter Kit: Add Multi-Language Support (Arabic, English, Spanish) with Blog CRUD
🚀 Installation & Setup Download & Extract Get the ZIP from kritimyantra.com and extract it. Includes preconfigu...
Comments
No comments yet. Be the first to comment.
Sign in to join the discussion.