【PHP】trait（トレイト）の使い方｜複数のクラスで処理を再利用する方法

<?php
// これは書けない（PHP は多重継承をサポートしていない）
class ProductController extends BaseController, Loggable
{
}

<?php
trait Loggable
{
    public function log(string $message): void
    {
        // static::class は、この trait を使っているクラス名になる
        echo '[' . static::class . '] ' . $message . PHP_EOL;
    }
}

<?php
class ProductController
{
    use Loggable;   // trait を取り込む

    public function index(): void
    {
        $this->log('一覧を表示しました');
    }
}

class UserService
{
    use Loggable;   // 同じ trait を別のクラスでも使える
}

(new ProductController())->index();  // [ProductController] 一覧を表示しました
(new UserService())->log('登録完了'); // [UserService] 登録完了

<?php
namespace App\Controller;

use App\Support\Loggable;   // ← 名前空間のインポート（ファイル先頭）

class ProductController
{
    use Loggable;           // ← trait の取り込み（クラスの中）
}

<?php
trait Counter
{
    private int $count = 0;          // プロパティ
    private static int $total = 0;   // 静的プロパティ

    public function increment(): int // メソッド
    {
        self::$total++;
        return ++$this->count;
    }

    public static function total(): int // 静的メソッド
    {
        return self::$total;
    }
}

class Page  { use Counter; }
class Image { use Counter; }

(new Page())->increment();
(new Page())->increment();
(new Image())->increment();

echo Page::total();  // 2
echo Image::total(); // 1（静的プロパティはクラスごとに独立している）

<?php
class ReportService
{
    use Loggable, Counter;   // カンマ区切りでまとめて取り込む
}

// 下のように分けて書いても同じ
class ReportService2
{
    use Loggable;
    use Counter;
}

<?php
class BaseController
{
    public function name(): string
    {
        return '親クラス';
    }
}

trait NameTrait
{
    public function name(): string
    {
        return 'trait';
    }
}

// trait だけがある場合 → trait が親クラスに勝つ
class PostController extends BaseController
{
    use NameTrait;
}

// クラス自身にも定義がある場合 → クラス自身が最優先
class PageController extends BaseController
{
    use NameTrait;

    public function name(): string
    {
        return 'クラス自身';
    }
}

echo (new PostController())->name(); // trait
echo (new PageController())->name(); // クラス自身

<?php
trait FileLogger
{
    public function write(string $message): void
    {
        echo 'ファイルに記録: ' . $message;
    }
}

trait MailLogger
{
    public function write(string $message): void
    {
        echo 'メールで送信: ' . $message;
    }
}

class Notifier
{
    use FileLogger, MailLogger; // Fatal error: 衝突している
}

<?php
class Notifier
{
    use FileLogger, MailLogger {
        FileLogger::write insteadof MailLogger; // write は FileLogger のものを使う
        MailLogger::write as sendMail;          // 使わない方に別名を付けて残す
    }
}

$notifier = new Notifier();
$notifier->write('保存しました');    // ファイルに記録: 保存しました
$notifier->sendMail('保存しました'); // メールで送信: 保存しました

<?php
class ProductController
{
    use Loggable {
        log as protected;            // 名前はそのままで protected にする
        log as protected writeLog;   // 別名を付けつつ可視性も変える
    }
}

$controller = new ProductController();
$controller->log('外から呼ぶ'); // Error: protected なので呼び出せない

<?php
trait Validatable
{
    // 使う側のクラスに実装を強制する
    abstract protected function requiredFields(): array;

    public function validate(array $input): array
    {
        $errors = [];

        foreach ($this->requiredFields() as $field) {
            if (!isset($input[$field]) || $input[$field] === '') {
                $errors[] = $field . ' は必須項目です';
            }
        }

        return $errors;
    }
}

<?php
class ContactForm
{
    use Validatable;

    // trait が要求しているので、必ず実装しなければならない
    protected function requiredFields(): array
    {
        return ['name', 'email', 'message'];
    }
}

$form = new ContactForm();
print_r($form->validate(['name' => '山田', 'email' => '']));
// Array ( [0] => email は必須項目です [1] => message は必須項目です )

<?php
trait Singleton
{
    private static ?self $instance = null;

    public static function getInstance(): self
    {
        if (self::$instance === null) {
            // trait の中の self は「取り込んだクラス」を指す
            self::$instance = new self();
        }

        return self::$instance;
    }

    // 外部から new されないようにする
    private function __construct()
    {
        $this->init();
    }

    // 初期化処理はクラスごとに書かせる
    abstract protected function init(): void;
}

<?php
class MyPlugin
{
    use Singleton, Loggable;

    protected function init(): void
    {
        add_action('init', [$this, 'registerPostType']);
        $this->log('プラグインを初期化しました');
    }

    public function registerPostType(): void
    {
        register_post_type('book', [
            'label'        => '書籍',
            'public'       => true,
            'show_in_rest' => true,
        ]);
    }
}

MyPlugin::getInstance();

<?php
interface LoggerInterface
{
    public function log(string $message): void;
}

// 型は interface で保証し、実装は trait で配る
class ProductController implements LoggerInterface
{
    use Loggable;
}

var_dump(new ProductController() instanceof LoggerInterface); // bool(true)