Stars: 237
Forks: 17
Pull Requests: 69
Issues: 12
Watchers: 5
Last Updated: 2023-02-11 11:47:36
Edit PHP files programmatically
License:
Languages: PHP
FileQueryBuilders
and AbstractSyntaxTreeQueryBuilders
composer require ajthinking/archetype
That's it! Check out introduction of concepts below or review the API examples
PHPFile
read/write APIuse Archetype\Facades\PHPFile;
// Create new files
PHPFile::make()->class(\Acme\Product::class)
->use('Shippable')
->public()->property('stock', -1)
->save();
// Modify existing files
PHPFile::load(\App\Models\User::class)
->className('NewClassName')
->save();
LaravelFile
read/write APIuse Archetype\Facades\LaravelFile; // extends PHPFile
// Expanding on our User model
LaravelFile::user()
->add()->use(['App\Traits\Dumpable', 'App\Contracts\PlayerInterface'])
->add()->implements('PlayerInterface')
->table('gdpr_users')
->add()->fillable('nickname')
->remove()->hidden()
->empty()->casts()
->hasMany('App\Game')
->belongsTo('App\Guild')
->save()
->render();
<?php
namespace App\Models;
use App\Contracts\PlayerInterface;
use App\Traits\Dumpable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
class User extends Authenticatable implements PlayerInterface
{
use HasApiTokens, HasFactory, Notifiable;
protected $table = 'gdpr_users';
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
'nickname',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [];
/**
* Get the associated Guild
*/
public function guild()
{
return $this->belongsTo(Guild::class);
}
/**
* Get the associated Games
*/
public function games()
{
return $this->hasMany(Game::class);
}
}
Filter and retrieve a set of files to interact with.
// find files with the query builder
PHPFile::in('database/migrations')
->where('extends', 'Migration')
->andWhere('className', 'like', 'Create')
->get() // returns Collection of PHPFiles
// Quickly find the Laravel User file
$file = LaravelFile::user();
// Quickly find Laravel specific files
LaravelFile::models()->get();
LaravelFile::controllers()->get();
LaravelFile::serviceProviders()->get();
// ...
As seen in the previous examples we can query and manipulate nodes with simple or primitive values, such as strings and arrays. However, if we want to perform custom or more in dept queries we must use the ASTQueryBuilder
.
Example: how can we fetch explicit column names in a migration file?
LaravelFile::load('database/migrations/2014_10_12_000000_create_users_table.php')
->astQuery() // get a ASTQueryBuilder
->classMethod()
->where('name->name', 'up')
->staticCall()
->where('class', 'Schema')
->where('name->name', 'create')
->args
->closure()
->stmts
->methodCall()
->where('var->name', 'table')
->args
->value
->value
->get();
The ASTQueryBuilder examines all possible paths and automatically terminates those that cant complete the query:
The ASTQueryBuilder relies entirely on nikic/php-parser. Available query methods mirror the PhpParser
types and properties. To understand this syntax better you may want to tinker with dd($file->ast())
while building your queries. Basic conventions are listed below.
method()
,staticCall()
...)args
,stmts
...)where(...)
get()
ASTQueryBuilder
also supports removing, replacing and injecting nodes 🔧
// Replace a node property
$file->astQuery()
->class()
->name
->replaceProperty('name', $newClassName)
->commit() // updates the file's AST
->end() // exit query
->save()
If a file can't be parsed, a FileParseError
will be thrown. This can happen if you try to explicitly load a broken file but also when performing queries matching one or more problematic files.
To see all offending files run php artisan archetype:errors
. To ignore files with problems, put them in config/archetype.php
-> ignored_paths
.
php artisan vendor:publish --provider="Archetype\ServiceProvider"
PRs and issues are welcome 🙏 Feel free to take a stab at an incomplete test.
git clone [email protected]:ajthinking/archetype.git
cd archetype
composer install
./vendor/bin/pest
MIT