Trait conflict resolution in PHP

Introduction

Traits let you reuse code in different classes. Sometimes, two traits have methods with the same name. Trait conflict resolution helps you decide which method to use.

You want to use two traits in one class, but both traits have a method with the same name.

You want to change which trait's method is used when there is a conflict.

You want to rename a trait's method inside a class to avoid conflicts.

You want to use one trait's method instead of another's when both have the same method name.

Syntax

PHP

class ClassName {
    use TraitA, TraitB {
        TraitA::methodName insteadof TraitB;
        TraitB::methodName as newMethodName;
    }
}

Use the 'insteadof' keyword to choose which trait's method to use when there is a conflict.

Use the 'as' keyword to give a trait's method a new name inside the class.

Examples

This example uses two traits with the same method name. We choose to use A's hello method.

PHP

<?php
trait A {
    public function hello() {
        echo "Hello from A\n";
    }
}

trait B {
    public function hello() {
        echo "Hello from B\n";
    }
}

class MyClass {
    use A, B {
        A::hello insteadof B;
    }
}

$obj = new MyClass();
$obj->hello();

Here, we use A's hello method by default, but also keep B's hello method under a new name helloFromB.

PHP

<?php
trait A {
    public function hello() {
        echo "Hello from A\n";
    }
}

trait B {
    public function hello() {
        echo "Hello from B\n";
    }
}

class MyClass {
    use A, B {
        A::hello insteadof B;
        B::hello as helloFromB;
    }
}

$obj = new MyClass();
$obj->hello();
$obj->helloFromB();

Sample Program

This program shows two traits with the same method name 'log'. We choose Logger's log method as the main one, and rename Debugger's log method to debugLog to use it separately.

PHP

<?php
trait Logger {
    public function log() {
        echo "Logging from Logger trait\n";
    }
}

trait Debugger {
    public function log() {
        echo "Logging from Debugger trait\n";
    }
}

class Application {
    use Logger, Debugger {
        Logger::log insteadof Debugger;
        Debugger::log as debugLog;
    }
}

$app = new Application();
$app->log();
$app->debugLog();

Important Notes

If you don't resolve conflicts, PHP will give an error when using traits with the same method names.

You can rename methods to keep both versions and use them separately.

Trait conflict resolution only applies when two or more traits have methods with the same name.

Summary

Traits let you reuse code in multiple classes.

When two traits have the same method name, use 'insteadof' to pick one.

Use 'as' to rename a trait's method to avoid conflicts or keep both.