https://github.com/nadar/php-composer-reader
A PHP library to read and manipulate the composer.json file.
https://github.com/nadar/php-composer-reader
composer composer-library hacktoberfest php
Last synced: 4 months ago
JSON representation
A PHP library to read and manipulate the composer.json file.
- Host: GitHub
- URL: https://github.com/nadar/php-composer-reader
- Owner: nadar
- License: mit
- Created: 2018-01-03T07:12:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T08:29:05.000Z (over 1 year ago)
- Last Synced: 2025-09-07T13:21:48.110Z (10 months ago)
- Topics: composer, composer-library, hacktoberfest, php
- Language: PHP
- Homepage:
- Size: 124 KB
- Stars: 23
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Composer JSON Reader and Manipulator
[](https://packagist.org/packages/nadar/php-composer-reader)
[](https://packagist.org/packages/nadar/php-composer-reader)
[](https://packagist.org/packages/nadar/php-composer-reader)
[](https://codeclimate.com/github/nadar/php-composer-reader/test_coverage)
[](https://codeclimate.com/github/nadar/php-composer-reader/maintainability)
A small PHP library for manipulating and reading the **composer.json** file. It allows you to add new sections, check if it's writable/readable, or retrieve information from the composer schema such as description, title, and more.
## Installation
Install via Composer:
```sh
composer require nadar/php-composer-reader
```
## Usage
To load the composer.json file into ComposerReader:
```php
require 'vendor/autoload.php';
$reader = new ComposerReader('path/to/composer.json');
if (!$reader->canRead()) {
throw new Exception("Unable to read the JSON file.");
}
if (!$reader->canWrite()) {
throw new Exception("Unable to write to the JSON file.");
}
// Dump the full content
var_dump($reader->getContent());
```
### Reading Section Data
Retrieve an array of objects for each package in the `require` section of the composer.json file:
```php
$reader = new ComposerReader('path/to/composer.json');
$section = new RequireSection($reader);
foreach ($section as $package) {
echo $package->name . ' with ' . $package->constraint;
// Check if the package version is greater than a given version constraint.
if ($package->greaterThan('^6.5')) {
echo "Numerous releases available!";
}
}
```
Retrieve an array of objects for each PSR definition in the `autoload` section of the composer.json file:
```php
$reader = new ComposerReader('path/to/composer.json');
$section = new AutoloadSection($reader, AutoloadSection::TYPE_PSR4);
foreach ($section as $autoload) {
echo $autoload->namespace . ' with ' . $autoload->source;
}
```
The following section readers are available for the composer schema ([Composer Schema Documentation](https://getcomposer.org/doc/04-schema.md)):
| Section | Class |
|----------------|--------------------|
| `require` | RequireSection |
| `require-dev` | RequireDevSection |
| `autoload` | AutoloadSection |
| `autoload-dev` | AutoloadDevSection |
Additional schema information can be retrieved from the ComposerReader object with: `$reader->contentSection('extra', null);`
### Changing Section Data
Add a new PSR autoload definition to an existing composer.json file and save it:
```php
$reader = new ComposerReader('path/to/composer.json');
// Generate a new autoload section object
$new = new Autoload($reader, 'Foo\\Bar\\', 'src/foo/bar', AutoloadSection::TYPE_PSR4);
// Store the new autoload object in the autoload section and save
$section = new AutoloadSection($reader);
$section->add($new)->save();
```
## Running Commands
To perform composer operations, use the `runCommand()` method:
```php
$reader = new ComposerReader('path/to/composer.json');
$reader->runCommand('dump-autoload'); // This is equivalent to running `composer dump-autoload`
```
This attempts to execute the dump-autoload command for the specified composer.json file. **This requires a globally installed Composer command** on your system ([Install Composer globally](https://getcomposer.org/doc/00-intro.md#globally)).
---