quintenmbusiness/php-ast-toolkit

A powerful PHP toolkit for analyzing, modifying, and generating code using AST (Abstract Syntax Tree).

0.1.3 2024-12-15 00:49 UTC

Requires

• php: >=8.1
• illuminate/collections: ^11.0
• nikic/php-parser: ^5.3

Requires (Dev)

• phpunit/phpunit: ^10.0 || ^9.5

MIT

• Quinten Muijser

README

PhpAstCodeToolkit is a PHP library that simplifies working with Abstract Syntax Trees (AST) by providing utilities to analyze, modify, and generate PHP code. Built on top of the powerful nikic/php-parser, it offers a streamlined API for developers.

Features

• Analyze PHP files and extract class, method, and property information.
• Modify existing code structures using a clean object-oriented approach.
• Generate interfaces and classes programmatically.
• Synchronize changes between the AST and source code.
• Lightweight and easy to integrate into any PHP project.

Installation

Install the package via Composer:

composer require quintenmbusiness/php-ast-code-toolkit

Usage

Analyzing PHP Files

Use the DirectoryScanner to analyze PHP files in a directory and extract class information.

use quintenmbusiness\PhpAstCodeGenerationHelper\Core\DirectoryScanner;
use quintenmbusiness\PhpAstCodeGenerationHelper\Core\ClassFilter;

$scanner = new DirectoryScanner();
$classes = $scanner->scan('/path/to/php/files', true);
$filter = new ClassFilter($classes);

// Search for a specific class
$class = $filter->searchByClassName('MyClass')[0];

Modifying a Class

Change the name of a class and update a method:

$class->updateName('NewClassName');
$class->methods[0]->updateName('newMethodName');
$class->save();

Generating an Interface

Create an interface from an existing class:

$newInterfacePath = '/path/to/NewInterface.php';
$class->createInterfaceVersion(
    newName: 'NewInterface',
    newPath: $newInterfacePath,
    newExtends: null,
    newImplements: [],
    updateOriginal: true
);

Copying a Class

Copy a class to a new file:

$newFilePath = '/path/to/NewClass.php';
$newClass = $class->copy($newFilePath);

Requirements

• PHP 8.1 or higher
• nikic/php-parser (installed automatically via Composer)

Credits

This library is powered by nikic/php-parser.

License

PhpAstCodeToolkit is open-source software licensed under the MIT License.