Movatterモバイル変換

トレイト

PHP は、コードを再利用するための「トレイト」という仕組みを実装しています。

トレイトは、PHP のような単一継承言語でコードを再利用するための仕組みのひとつです。トレイトは、単一継承の制約を減らすために作られたもので、いくつかのメソッド群を異なるクラス階層にある独立したクラスで再利用できるようにします。トレイトとクラスを組み合わせた構文は複雑さを軽減させてくれ、多重継承や Mixin に関連するありがちな問題を回避することもできます。

トレイトはクラスと似ていますが、トレイトは単にいくつかの機能をまとめるためだけのものです。トレイト自身のインスタンスを作成することはできません。昔ながらの継承に機能を加えて、振る舞いを水平方向で構成できるようになります。つまり、継承しなくてもクラスのメンバーに追加できるようになります。

例1 トレイトの例

<?php

traitTraitA{
    public functionsayHello() {
        echo'Hello';
    }
}

traitTraitB{
    public functionsayWorld() {
        echo'World';
    }
}

classMyHelloWorld
{
    useTraitA,TraitB;// A class can use multiple traits

public functionsayHelloWorld() {
$this->sayHello();
        echo' ';
$this->sayWorld();
        echo"!\n";
    }
}

$myHelloWorld= newMyHelloWorld();
$myHelloWorld->sayHelloWorld();

?>

上の例の出力は以下となります。

Hello World!

優先順位

基底クラスから継承したメンバーよりも、トレイトで追加したメンバーのほうが優先されます。優先順位は現在のクラスのメンバーが最高で、その次がトレイトのメソッド、そしてその次にくるのが継承したメソッドとなります。

例2 優先順位の例

基底クラスから継承したメソッドは、MyHelloWorld に SayWorld トレイトから追加されたメソッドで上書きされます。この挙動は、MyHelloWorld クラスで定義したメソッドでも同じです。優先順位は現在のクラスのメンバーが最高で、その次がトレイトのメソッド、そしてその次にくるのが継承したメソッドとなります。

<?php
classBase{
    public functionsayHello() {
        echo'Hello ';
    }
}

traitSayWorld{
    public functionsayHello() {
parent::sayHello();
        echo'World!';
    }
}

classMyHelloWorldextendsBase{
    useSayWorld;
}

$o= newMyHelloWorld();
$o->sayHello();
?>

上の例の出力は以下となります。

Hello World!

例3 もうひとつの優先順位の例

<?php
traitHelloWorld{
    public functionsayHello() {
        echo'Hello World!';
    }
}

classTheWorldIsNotEnough{
    useHelloWorld;
    public functionsayHello() {
        echo'Hello Universe!';
    }
}

$o= newTheWorldIsNotEnough();
$o->sayHello();
?>

上の例の出力は以下となります。

Hello Universe!

複数のトレイト

複数のトレイトをひとつのクラスに追加するには、use 文でカンマ区切りで指定します。

例4 複数のトレイトの使用例

<?php
traitHello{
    public functionsayHello() {
        echo'Hello ';
    }
}

traitWorld{
    public functionsayWorld() {
        echo'World';
    }
}

classMyHelloWorld{
    useHello,World;
    public functionsayExclamationMark() {
        echo'!';
    }
}

$o= newMyHelloWorld();
$o->sayHello();
$o->sayWorld();
$o->sayExclamationMark();
?>

上の例の出力は以下となります。

Hello World!

衝突の解決

同じ名前のメンバーを含む複数のトレイトを追加するときには、衝突を明示的に解決しておかないと fatal エラーが発生します。

同一クラス内での複数のトレイト間の名前の衝突を解決するには、insteadof 演算子を使ってそのうちのひとつを選ばなければなりません。

この方法はひとつのメソッドだけしか使えませんが、as 演算子を使うと、メソッドのいずれかにエイリアスを追加できます。as 演算子はメソッドをリネームするわけではないので、その他のメソッドにも何も影響を及ぼさないことに注意しましょう。

例5 衝突の解決

この例では、Talker がトレイト A と B を使います。 A と B には同じ名前のメソッドがあるので、 smallTalk はトレイト B を使って bigTalk はトレイト A を使うように定義します。

Aliased_Talker は、as 演算子を使って B の bigTalk の実装にtalk というエイリアスを指定して使います。

<?php
traitA{
    public functionsmallTalk() {
        echo'a';
    }
    public functionbigTalk() {
        echo'A';
    }
}

traitB{
    public functionsmallTalk() {
        echo'b';
    }
    public functionbigTalk() {
        echo'B';
    }
}

classTalker{
    useA,B{
B::smallTalkinsteadofA;
A::bigTalkinsteadofB;
    }
}

classAliased_Talker{
    useA,B{
B::smallTalkinsteadofA;
A::bigTalkinsteadofB;
B::bigTalkastalk;
    }
}
?>

メソッドのアクセス権の変更

as 構文を使うと、クラス内でのメソッドのアクセス権も変更することができます。

例6 メソッドのアクセス権を変更する

<?php
traitHelloWorld{
    public functionsayHello() {
        echo'Hello World!';
    }
}

// sayHello のアクセス権を変更します
classMyClass1{
    useHelloWorld{sayHelloas protected; }
}

// アクセス権を変更したエイリアスメソッドを作ります
// sayHello 自体のアクセス権は変わりません
classMyClass2{
    useHelloWorld{sayHelloas privatemyPrivateHello; }
}
?>

トレイトを組み合わせたトレイト

クラスからトレイトを使えるのと同様に、トレイトからもトレイトを使えます。トレイトの定義の中でトレイトを使うと、定義したトレイトのメンバーの全体あるいは一部を組み合わせることができます。

例7 トレイトを組み合わせたトレイト

<?php
traitHello{
    public functionsayHello() {
        echo'Hello ';
    }
}

traitWorld{
    public functionsayWorld() {
        echo'World!';
    }
}

traitHelloWorld{
    useHello,World;
}

classMyHelloWorld{
    useHelloWorld;
}

$o= newMyHelloWorld();
$o->sayHello();
$o->sayWorld();
?>

上の例の出力は以下となります。

Hello World!

トレイトのメンバーの抽象化

トレイトでは、抽象メソッドを使ってクラスの要件を指定できます。アクセス権は public, protected, private をサポートしています。 PHP 8.0.0 より前のバージョンでは、 public と protected な抽象メソッドだけがサポートされていました。

警告

PHP 8.0.0 以降では、具象メソッドはシグネチャの互換性に関するルールを満たさなければなりません。これより前のバージョンでは、シグネチャは異なっていても構いませんでした。

例8 抽象メソッドによる、要件の明示

<?php
traitHello{
    public functionsayHelloWorld() {
        echo'Hello'.$this->getWorld();
    }
    abstract public functiongetWorld();
}

classMyHelloWorld{
    private$world;
    useHello;
    public functiongetWorld() {
        return$this->world;
    }
    public functionsetWorld($val) {
$this->world=$val;
    }
}
?>

トレイトの static メンバー

トレイトでは、static 変数、static メソッド、static プロパティを定義できます。

注意:
PHP 8.1.0 以降では、トレイトにある static メソッドや、 static プロパティに直接アクセスすることは、推奨されなくなりました。これらは、トレイトを使っているクラスからのみアクセスすべきものです。

例9 static変数

<?php

traitCounter
{
    public functioninc()
    {
        static$c=0;
$c=$c+1;
        echo"$c\n";
    }
}

classC1
{
    useCounter;
}

classC2
{
    useCounter;
}

$o= newC1();
$o->inc();
$p= newC2();
$p->inc();

?>

上の例の出力は以下となります。

例10 staticメソッド

<?php

traitStaticExample
{
    public static functiondoSomething()
    {
        return'Doing something';
    }
}

classExample
{
    useStaticExample;
}

echoExample::doSomething();

?>

上の例の出力は以下となります。

Doing something

例11 staticプロパティ

警告

PHP 8.3.0 より前のバージョンでは、トレイト中で定義された static プロパティは、そのトレイトを use している同じ継承階層にある全てのクラスで共有されていました。 PHP 8.3.0 以降では、子クラスが static プロパティを持つトレイトを use している場合、親クラスで定義された static プロパティとは別物とみなされるようになりました。

<?php

traitT
{
    public static$counter=1;
}

classA
{
    useT;

    public static functionincrementCounter()
    {
        static::$counter++;
    }
}

classBextendsA
{
    useT;
}

A::incrementCounter();

echoA::$counter,"\n";
echoB::$counter,"\n";

?>

上の例の PHP 8.3 での出力は、このようになります。:

プロパティ

トレイトにはプロパティも定義できます。

例12 プロパティの定義

<?php

traitPropertiesTrait
{
    public$x=1;
}

classPropertiesExample
{
    usePropertiesTrait;
}

$example= newPropertiesExample();
$example->x;

?>

トレイトでプロパティを定義したときは、クラスではそれと互換性 (公開範囲と型とreadonlyの有無、そして初期値が同じ) がない同じ名前のプロパティを定義できません。互換性がない名前を定義すると、致命的なエラーが発生します。

例13 衝突の解決

<?php
traitPropertiesTrait{
    public$same=true;
    public$different1=false;
    publicbool $different2;
    publicbool $different3;
}

classPropertiesExample{
    usePropertiesTrait;
    public$same=true;
    public$different1=true;// Fatal error
publicstring $different2;// Fatal error
readonly protectedbool $different3;// Fatal error
}
?>

定数

PHP 8.2.0 以降では、トレイトでも定数を定義できます。

例14 定数を定義する

<?php
traitConstantsTrait{
    public constFLAG_MUTABLE=1;
    final public constFLAG_IMMUTABLE=5;
}

classConstantsExample{
    useConstantsTrait;
}

$example= newConstantsExample;
echo$example::FLAG_MUTABLE;
?>

上の例の出力は以下となります。

トレイトで定数を定義したときは、クラスではそれと互換性 (公開範囲と初期値、そして final の有無が同じ) がない同じ名前の定数を定義できません。互換性がない名前を定義すると、致命的なエラーが発生します。

例15 衝突の解決

<?php
traitConstantsTrait{
    public constFLAG_MUTABLE=1;
    final public constFLAG_IMMUTABLE=5;
}

classConstantsExample{
    useConstantsTrait;
    public constFLAG_IMMUTABLE=5;// Fatal error
}
?>

Final メソッド

PHP 8.3.0 以降では、as 演算子を使ってfinal をトレイトからインポートしたメソッドに適用できるようになりました。こうすることで、子クラスでそのメソッドをオーバーライドすることを防止できます。しかし、トレイトを使うクラスは、未だそのメソッドをオーバーライドできます。

例16 トレイトからインポートするメソッドをfinal として定義する

<?php

traitCommonTrait
{
    public functionmethod()
    {
        echo'Hello';
    }
}

classFinalExampleA
{
    useCommonTrait{
CommonTrait::methodas final;// The 'final' prevents child classes from overriding the method
}
}

classFinalExampleBextendsFinalExampleA
{
    public functionmethod() {}
}

?>

上の例の出力は、たとえば以下のようになります。

Fatal error: Cannot override final method FinalExampleA::method() in ...

Found A Problem?

Learn How To Improve This Page •Submit a Pull Request •Report a Bug

Movatterモバイル変換

トレイト

優先順位

複数のトレイト

衝突の解決

メソッドのアクセス権の変更

トレイトを組み合わせたトレイト

トレイトのメンバーの抽象化

トレイトの static メンバー

プロパティ

定数

Final メソッド

Found A Problem?

User Contributed Notes25 notes