kkszymanowski/traitor

Add a trait use statement to existing PHP class

Traitor

, _(*1)

A PHP package for automatically adding a trait use statement to a given class., _(*2)

Installation

Via composer:, _(*3)

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., _(*4)

Behavior

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

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

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:, _(*7)

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

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