ajthinking/php-file-manipulator-host

Manipulate PHP files using a fluent syntax

PHP-FILE-MANIPULATOR

Programatically manipulate PHP / Laravel files on disk with an intuiutive, fluent API.

Installation

composer require ajthinking/php-file-manipulator

Examples

use Ajthinking\PHPFile;
use Ajthinking\LaravelFile;

// list class methods
PHPFile::load('app/User.php')
    ->classMethods()

// move User.php to a Models directory
PHPFile::load('app/User.php')
    ->namespace('App\Models')
    ->move('app/Models/User.php')

// install a package trait
PHPFile::load('app/User.php')
    ->addUseStatements('Package\Tool')
    ->addTraitUseStatement('Tool')
    ->save()

// find files with the query builder
PHPFile::in('database/migrations')
    ->where('classExtends', 'Migration')
    ->get()
    ->each(function($file) {
        echo $file->className()
    });

// add relationship methods
LaravelFile::load('app/User.php')
    ->addHasMany('App\Car')
    ->addHasOne('App\Life')
    ->addBelongsTo('App\Wife')
    ->save()

// add a route
LaravelFile::load('routes/web.php')
    ->addRoute('dummy', 'Controller@method')
    ->save()
    
// preview will write result relative to storage/.preview
LaravelFile::load('app/User.php')
    ->setClassName('Mistake')
    ->preview()

// add items to protected properties
LaravelFile::load('app/User.php')
    ->addFillable('message')
    ->addCasts(['is_admin' => 'boolean'])
    ->addHidden('secret')    

Running tests

# the test suite requires that you have the package installed in a laravel project
vendor/phpunit/phpunit/phpunit packages/Ajthinking/PHPFileManipulator/tests

License

MIT

Contributing

PRs and issues are welcome.

TODO

task	status
Make the test work without being inside a host application	-
How handle base_path() when not in a Laravel app?	-
Create a dedicated Storage disk (storage/php-file-manipulator/preview etc) ???	-
It should be able to add use statements with aliases	-
It should be capable of reading/writing GroupUse, example: use Package\{Alfa, Beta};	-
Simplify adding multiline docblocks on methods	-
Group related resources (PHP/Laravel Reources in separate folders)	-
Can it resolve resources from parent classes and traits???	-
Add the missing relationships: https://laravel.com/docs/6.x/eloquent-relationships#introduction	-
Make a minimal querybuilder	-
Publish to packagist	-

API

Resource	GET	SET	ADD	REMOVE
Namespace	yes	yes
Uses	yes	yes
ClassName	$file->className()	$file->className('newName)
ClassExtends	yes	yes	yes	yes
ClassImplements	yes	yes	yes	yes
HasManyMethods			$file->addHasManyMethods(['App\Car'])

Acknowledgements

• Built with nikic/php-parser
• PSR Printing fixes borrowed from tcopestake/PHP-Parser-PSR-2-pretty-printer

Stay tuned!

Follow me on twitter: @ajthinking

Help me continue this work | Patreon