kkszymanowski/traitor

Add a trait use statement to existing PHP class

1.1.0 2024-01-29 09:23 UTC

Requires

• php: >=5.4
• nikic/php-parser: ^1.0|^2.0|^3.0|^4.0|^5.0

Requires (Dev)

• phpunit/phpunit: 8.*

MIT

• Kuba Szymanowski

• php
• trait
• add

README

A PHP package for automatically adding a trait use statement to a given class.

Installation

Via composer:

composer require kkszymanowski/traitor

Usage

• Basic usage:

use Traitor\Traitor;

Traitor::addTrait(FooTrait::class)->toClass(FooClass:class);

• Add multiple traits:

use Traitor\Traitor;

Traitor::addTraits([
    FooTrait::class,
    BarTrait::class,
    BazTrait::class
])->toClass(FooClass::class);

//or

Traitor::addTrait(FooTrait::class)
       ->addTrait(BarTrait::class)
       ->addTrait(BazTrait::class)
       ->toClass(FooClass::class);

• Check if class already uses trait:

use Traitor\Traitor;

$alreadyUses = Traitor::alreadyUses(FooClass::class, BarTrait::class);

• Only generate output without changing files:

use Traitor\Handlers\AbstractTreeHandler;

$handler = new AbstractTreeHandler(file($originalFilePath), FooTrait::class, BarClass::class);

$newContent = $handler->handle()->toString();

Note, that AbstractTreeHandler accepts input file as an array of lines, such as one produced from file() call.

Behavior

Adding a new trait use statement does not change in any way formatting of your file(or at least it shouldn't).

If the trait is not present in the use section below the namespace declaration, it will be also added there, below any existing imports.

If it's not present in the use section in the class body, it will be added there above first existing use statement, on it's own line:

use Bar\PreviouslyExistingTrait;
use Baz\NewlyAddedTrait; // Here

class Foo
{
    use NewlyAddedTrait; // And here
    use PreviouslyExistingTrait;
}