PHP入門：Traits（トレイト）について -vol.5-

よっしー

こんにちは。よっしーです(^^)

今日は、PHPのTraits（トレイト）についてご紹介します。

背景
サンプル
おわりに

背景

PHP8.2を利用したAPIを開発しているときに Traits を利用したので、そのときの調査内容を備忘としてのこしました。

こちらのサイトを参考にしています。

PHP: Traits - Manual

サンプル

もちろんです。以下は、PHPでTraitsを使用したいくつかのサンプルコードです。

サンプルコード1: ログ記録トレイト

trait LoggingTrait {
    public function log($message) {
        echo "Log: $message\n";
    }
}

class User {
    use LoggingTrait;

    public function createUser($username) {
        $this->log("User created: $username");
        // ユーザーの作成ロジック
    }
}

$user = new User();
$user->createUser("JohnDoe");

この例では、LoggingTrait は log メソッドを提供し、User クラスはこれを使用してユーザーの作成アクションを記録します。

サンプルコード2: バリデーショントレイト

trait ValidationTrait {
    public function validateEmail($email) {
        return filter_var($email, FILTER_VALIDATE_EMAIL) !== false;
    }
}

class Registration {
    use ValidationTrait;

    public function registerUser($email, $password) {
        if ($this->validateEmail($email)) {
            // 有効なメールアドレスの場合、ユーザー登録を行う
            echo "User registered successfully.\n";
        } else {
            echo "Invalid email address.\n";
        }
    }
}

$registration = new Registration();
$registration->registerUser("user@example.com", "password");

この例では、ValidationTrait はメールアドレスの有効性を検証する validateEmail メソッドを提供し、Registration クラスはこれを使用してユーザーの登録を制御します。

サンプルコード3: 複数のトレイトの組み合わせ

trait GreetingTrait {
    public function sayHello() {
        echo "Hello, ";
    }
}

trait NameTrait {
    public function sayName($name) {
        echo "$name!\n";
    }
}

class Greeter {
    use GreetingTrait, NameTrait;
}

$greeter = new Greeter();
$greeter->sayHello();
$greeter->sayName("John");

この例では、複数のトレイト GreetingTrait と NameTrait を組み合わせて、挨拶と名前の出力を行う Greeter クラスを作成します。

サンプルコード4: 数学演算トレイト

trait MathOperationsTrait {
    public function add($a, $b) {
        return $a + $b;
    }

    public function subtract($a, $b) {
        return $a - $b;
    }
}

class Calculator {
    use MathOperationsTrait;
}

$calculator = new Calculator();
echo "Addition: " . $calculator->add(5, 3) . "\n";
echo "Subtraction: " . $calculator->subtract(10, 4) . "\n";

この例では、MathOperationsTrait は加算と減算の操作を提供し、Calculator クラスはこれを使用して計算を実行します。

サンプルコード5: ログイン認証トレイト

trait AuthTrait {
    private $loggedIn = false;

    public function login($username, $password) {
        // ユーザーの認証ロジック
        if ($username === "admin" && $password === "password") {
            $this->loggedIn = true;
            echo "Login successful.\n";
        } else {
            echo "Login failed.\n";
        }
    }

    public function logout() {
        $this->loggedIn = false;
        echo "Logged out.\n";
    }
}

class UserAccount {
    use AuthTrait;
}

$userAccount = new UserAccount();
$userAccount->login("admin", "password");
$userAccount->logout();

この例では、AuthTrait はユーザーのログインとログアウトの機能を提供し、UserAccount クラスはこれを使用してユーザーアカウントを操作します。

サンプルコード6: データベース操作トレイト

trait DatabaseOperationsTrait {
    private $dbConnection;

    public function connectToDatabase($host, $username, $password) {
        $this->dbConnection = new PDO("mysql:host=$host", $username, $password);
        echo "Connected to the database.\n";
    }

    public function executeQuery($query) {
        $result = $this->dbConnection->query($query);
        echo "Query executed.\n";
        // 結果の処理
    }

    public function disconnectFromDatabase() {
        $this->dbConnection = null;
        echo "Disconnected from the database.\n";
    }
}

class DatabaseClient {
    use DatabaseOperationsTrait;
}

$client = new DatabaseClient();
$client->connectToDatabase("localhost", "user", "password");
$client->executeQuery("SELECT * FROM users");
$client->disconnectFromDatabase();

この例では、DatabaseOperationsTrait はデータベースへの接続、クエリの実行、切断などの操作を提供し、DatabaseClient クラスはこれを使用してデータベースクライアントを実装します。

サンプルコード7: キャッシュ操作トレイト

以下は、キャッシュとメモライズを使用するサンプルコードです。

trait CacheTrait {
    private $cache = [];

    public function getCachedData($key) {
        if (isset($this->cache[$key])) {
            echo "Cache hit for key: $key\n";
            return $this->cache[$key];
        } else {
            echo "Cache miss for key: $key\n";
            // キャッシュにデータを格納するためのダミーデータを生成
            $data = "Data for key: $key";
            $this->cache[$key] = $data;
            return $data;
        }
    }
}

class DataService {
    use CacheTrait;

    public function fetchData($key) {
        return $this->getCachedData($key);
    }
}

$dataService = new DataService();
echo $dataService->fetchData("A") . "\n";
echo $dataService->fetchData("B") . "\n";
echo $dataService->fetchData("A") . "\n";

このサンプルコードでは、CacheTrait はデータのキャッシュを管理し、DataService クラスはデータを取得する際にキャッシュを利用します。データがすでにキャッシュに存在する場合は「キャッシュヒット」メッセージが表示され、データがキャッシュにない場合は「キャッシュミス」メッセージが表示されます。

メモライズとしても使えるため、同じデータを何度も計算する必要がないことがわかります。

これらのサンプルコードは、さまざまな用途にTraitsを使用できることを示しています。お役に立てれば幸いです。