--- name: PHP Composer and Autoloading user-invocable: false description: Use when composer package management and PSR-4 autoloading including dependency management, autoload strategies, package creation, version constraints, and patterns for modern PHP project organization and distribution. allowed-tools: [] --- # PHP Composer and Autoloading ## Introduction Composer is PHP's de facto dependency manager, handling package installation, autoloading, and version management. PSR-4 autoloading eliminates manual require statements by automatically loading classes based on namespace and file structure conventions. Composer revolutionized PHP development by providing standardized dependency management similar to npm, pip, or Maven. Combined with PSR-4 autoloading, Composer enables modern PHP projects to organize code cleanly, share packages easily, and manage dependencies reliably. This skill covers Composer basics, dependency management, autoloading strategies, package creation, semantic versioning, and best practices for maintainable PHP projects. ## Composer Basics Composer manages project dependencies through composer.json configuration and installs packages into the vendor directory. ```json { "name": "company/project", "description": "Project description", "type": "project", "require": { "php": ">=8.1", "symfony/console": "^6.0", "guzzlehttp/guzzle": "^7.5", "monolog/monolog": "^3.0" }, "require-dev": { "phpunit/phpunit": "^10.0", "phpstan/phpstan": "^1.10", "squizlabs/php_codesniffer": "^3.7" }, "autoload": { "psr-4": { "App\\": "src/" } }, "autoload-dev": { "psr-4": { "Tests\\": "tests/" } }, "scripts": { "test": "phpunit", "lint": "phpcs", "analyse": "phpstan analyse" }, "config": { "optimize-autoloader": true, "sort-packages": true } } ``` ```bash # Install dependencies composer install # Install specific package composer require symfony/http-foundation # Install development dependency composer require --dev symfony/var-dumper # Update dependencies composer update # Update specific package composer update monolog/monolog # Remove package composer remove guzzlehttp/guzzle # Show installed packages composer show # Show outdated packages composer outdated # Validate composer.json composer validate # Run script composer test ``` Composer creates composer.lock to lock exact dependency versions, ensuring consistent installations across environments. ## PSR-4 Autoloading PSR-4 autoloading maps namespaces to directories, automatically loading classes without manual require statements. ```php find($id); } } // src/Models/UserModel.php namespace App\Models; use App\User; class UserModel { public function find(int $id): User { return new User("Alice", "alice@example.com"); } } // index.php - Composer autoloader require __DIR__ . '/vendor/autoload.php'; use App\Controllers\UserController; $controller = new UserController(); $user = $controller->show(1); echo $user->name; // "Alice" ``` ```php =5.0 <6.0", "vendor/latest": "dev-master", "vendor/branch": "dev-feature-x", "vendor/stability": "1.0@beta" } } ``` Version constraint patterns: - `1.2.3` - Exact version - `^1.2.3` - Caret: >=1.2.3 <2.0.0 (compatible) - `~1.2.3` - Tilde: >=1.2.3 <1.3.0 (similar) - `1.*` - Wildcard: >=1.0.0 <2.0.0 - `>=1.0 <2.0` - Range: explicit min/max - `dev-master` - Development branch - `1.0@beta` - Specific stability ```json { "require": { "symfony/console": "^6.0", "monolog/monolog": "^3.0", "guzzlehttp/guzzle": "^7.5" }, "minimum-stability": "stable", "prefer-stable": true } ``` ```bash # Show why package installed composer why vendor/package # Show what depends on package composer depends vendor/package # Show what package provides composer show --all vendor/package # Check for security vulnerabilities composer audit # Show platform requirements composer check-platform-reqs # Diagnose issues composer diagnose ``` Semantic versioning (MAJOR.MINOR.PATCH) communicates breaking changes, features, and fixes in version numbers. ## Creating Packages Creating reusable Composer packages enables code sharing across projects and with the community. ```json { "name": "company/http-client", "description": "HTTP client wrapper", "type": "library", "keywords": ["http", "client", "api"], "license": "MIT", "authors": [ { "name": "Developer Name", "email": "dev@example.com" } ], "require": { "php": ">=8.1", "guzzlehttp/guzzle": "^7.5" }, "require-dev": { "phpunit/phpunit": "^10.0" }, "autoload": { "psr-4": { "Company\\HttpClient\\": "src/" } }, "autoload-dev": { "psr-4": { "Tests\\": "tests/" } } } ``` ```php client = new GuzzleClient(['base_uri' => $baseUrl]); } public function get(string $path): array { $response = $this->client->get($path); return json_decode($response->getBody(), true); } public function post(string $path, array $data): array { $response = $this->client->post($path, ['json' => $data]); return json_decode($response->getBody(), true); } } // tests/ClientTest.php namespace Tests; use Company\HttpClient\Client; use PHPUnit\Framework\TestCase; class ClientTest extends TestCase { public function testCanCreateClient(): void { $client = new Client('https://api.example.com'); $this->assertInstanceOf(Client::class, $client); } } ``` ```bash # Validate package composer validate # Initialize new package composer init # Publish to Packagist # 1. Create GitHub repository # 2. Push code with composer.json # 3. Submit to packagist.org # Private packages # Add to composer.json: { "repositories": [ { "type": "vcs", "url": "https://github.com/company/private-package" } ] } ``` Well-designed packages follow PSR standards, include tests, and provide clear documentation. ## Autoload Optimization Optimizing autoloading improves production performance by reducing file system lookups. ```bash # Generate optimized autoloader composer dump-autoload --optimize # Classmap authoritative (no file system checks) composer dump-autoload --classmap-authoritative # APCu cache (requires apcu extension) composer dump-autoload --apcu ``` ```json { "config": { "optimize-autoloader": true, "classmap-authoritative": true, "apcu-autoloader": true } } ``` ```php ) - [PSR-4 Autoloading Standard]() - [Packagist - PHP Package Repository]() - [Semantic Versioning]() - [Composer Best Practices]()