php のクラスにおいて、継承される定数を制限したい

Question

実現したいこと

php のクラス継承で、子クラスは親クラスの定数を一部しか使えないよう制限したいです。

現状と問題

以下のように PrivateItemKind と SharedItemkind などがあり、一方にしかない値 (TAG_KIND_ID) があります。

しかし以下のようにすると、BOOK_KIND_ID の値が 2 だったり 1 だったり、ズレることになりますよね。(TAG_KIND_ID は PrivateItemKind でしか使わないため、ID の連番を詰めると BOOK_KIND_ID の値がズレる。)

このズレれをうまく解消する方法を知りたいです。

class PrivateItemKind 
{
    const TAG_KIND_ID = 1;
    const BOOK_KIND_ID = 2; // BOOK_KIND_ID の値が 2
    const USER_KIND_ID = 3;
}

class SharedItemkind
{
    const BOOK_KIND_ID = 1; // BOOK_KIND_ID の値が 1
    const USER_KIND_ID = 2;
}

解決策

解決策A

まず素朴に考える解決策は、以下のように定数名に接頭辞をつけ区別することです。これなら「同じ定数名なのに値が違う」という上記のズレは生じません。

class PrivateItemKind 
{
    const PRIVATE_TAG_KIND_ID = 1;
    const PRIVATE_BOOK_KIND_ID = 2;
    const PRIVATE_USER_KIND_ID = 3;
}

class SharedItemkind 
{
    const SHARED_BOOK_KIND_ID = 1;
    const SHARED_USER_KIND_ID = 2;
}

しかし「本というアイテム種別」という同じ意味なのに、プライベートなのかシェアされたのかという違いによって異なる定数名にすることに違和感を覚えます。（そうすることが一般的なら、私の違和感は初心者特有のものでしょうから受け入れたいと思いますが、いかがでしょうか？）

解決策B

続いての解決策の方が筋が良さそうかと思い本質問のタイトルとさせていただきました。
つまり、親クラス ItemKindMaster で定数を宣言し、子クラスは必要な値のみ宣言するという方法です。

abstract class ItemKindMaster
{
    const TAG_KIND_ID = 1;
    const BOOK_KIND_ID = 2;
    const USER_KIND_ID = 3;
}

class PrivateItemKind extends ItemKindMaster
{
    // 必要な値のみ宣言する
    const TAG_KIND_ID = parent::TAG_KIND_ID;
    const BOOK_KIND_ID = parent::BOOK_KIND_ID;
    const USER_KIND_ID = parent::USER_KIND_ID;
}

class SharedItemkind extends ItemKindMaster
{
    // 必要な値のみ宣言する
    const BOOK_KIND_ID = parent::BOOK_KIND_ID;
    const USER_KIND_ID = parent::USER_KIND_ID;
}

こちらの方法でも「同じ定数名なのに値が違う」という上記のズレは生じなくなるのでよさそうかと思ったのですが、

しかし (ItemKindMaster を継承しているので当たり前ですが)、以下のように呼べてしまいました。
SharedItemkind には TAG_KIND_ID を持たせたくないのに、これでは困ります。

echo SharedItemkind::TAG_KIND_ID;

そこで改めて質問になります。子クラスは親クラスの定数を一部しか使えないよう制限したい (SharedItemkind は TAG_KIND_ID を持たせたくない) のですが、どうすべきでしょうか？

バージョン

php 8.2 です。

補足

もしかして以下のように、null を再代入し、使えないことを明示する。という解決策がベストでしょうか？

abstract class ItemKindMaster
{
    const TAG_KIND_ID = 1;
    const BOOK_KIND_ID = 2;
    const USER_KIND_ID = 3;
}

class PrivateItemKind extends ItemKindMaster
{
    const TAG_KIND_ID = parent::TAG_KIND_ID;
    const BOOK_KIND_ID = parent::BOOK_KIND_ID;
    const USER_KIND_ID = parent::USER_KIND_ID;
}

class SharedItemkind extends ItemKindMaster
{
    const TAG_KIND_ID = null; // 使えないことを明示する
    const BOOK_KIND_ID = parent::BOOK_KIND_ID;
    const USER_KIND_ID = parent::USER_KIND_ID;
}

Comments

[maisumakun]

> SharedItemkind には TAG_KIND_ID を持たせたくないのに

「あるけど使わない」では、具体的に何が困るのでしょうか？

[munekun]

コメントありがとうございます。検証のときに邪魔になりそうだと思いました。うっかり利用してしまうとデータベースに想定しない値が入ってしまうのではと懸念しています。

[otn]

> うっかり利用してしまうとデータベースに想定しない値が入ってしまうのではと
それは、DBに書く処理の中で、値をチェックしてエラーにすべきですが、それが漏れているということですかね？

私も「何が困るんだろう？？」と思ってました。

[munekun]

そのチェックにおいて、「ItemKindMaster に含まれる値である」というチェックだけだど、「プライベートアイテムではないのにうっかり TAG_KIND_ID を持たせてしまっていも、チェックを通ってしまう」という問題に困ったのです。
なので PrivateItemKind と SharedItemkind というふうに分けてみようと思い、質問に至った次第です。

Answer 1

TAG_KIND_ID は PrivateItemKind でしか使わないため、ID の連番を詰めると BOOK_KIND_ID の値がズレる。

IDは、「連番」とか「（間を）詰める」とかを考える事が、勘違いや「沼」への第一歩だと思います。
ナニカを特定する値でありさえすれば良いのではありませんか？

「本というアイテム種別」という同じ意味なのに、プライベートなのかシェアされたのかという違いによって異なる定数名にすることに違和感を覚えます。

同じ意味ではなく「プライベートなのかシェアされたのかという違い」があるのでは？
それを意味するのがTAG_KIND_IDとするには定数名が筋悪だと思いますが、

もしかして以下のように、null を再代入

で示されているのは、当初の予定と値がズレているのでは？
＿＿当初はSharedItemkind::BOOK_KIND_IDは1、例示では2

少し無理やり感はありますが、ご提示のモノを改造するとこんな感じかと。

abstract class ItemKindMaster
{
    const KIND_ID_BASE = 0;
}

class PrivateItemKind extends ItemKindMaster
{
    const TAG_KIND_ID = parent::KIND_ID_BASE + 1;
    const BOOK_KIND_ID = parent::KIND_ID_BASE + 2;
    const USER_KIND_ID = parent::KIND_ID_BASE + 3;
}

class SharedItemkind extends ItemKindMaster
{
    const BOOK_KIND_ID = parent::KIND_ID_BASE + 1;
    const USER_KIND_ID = parent::KIND_ID_BASE + 2;
}
echo SharedItemkind::TAG_KIND_ID;  // Fatal error: Uncaught Error: Undefined constant SharedItemkind::TAG_KIND_ID

ただし、前述の通り、方向性が良いのかは少々疑問がありますが...

Comments

[munekun]

> 「連番」とか「（間を）詰める」とかを考える事が、勘違いや「沼」への第一歩
たしかに、人間向けだとこう考えて沼ってしまいますけれど、機械にとっては関係なくて「ナニカを特定する値でありさえすれば良い」ですね。

> ご提示のモノを改造するとこんな感じかと。
すごい、そんな方法、全然思いつけませんでした。ありがとうございます。

[tezcello]

一応解決という事なので、考えた甲斐がありました。

> たしかに、（略）
逆方向にも考えてみると良いと思います。
これらの ID値はどこかに記録されるモノなのでしょうけれど、（質問者さんのやりたい事のままにすると）その記録された値には意味が複数あって、状況を加味しないと意味を特定する事が出来ません。
これは困る事になりませんか？
＿＿いや、必ず困った事に...

Answer 2

• BOOK_KIND_ID の値が 2 だったり 1 だったり、ズレることを避けたい
• PrivateItemKindからは PrivateItemKind::TAG_KIND_ID では変数にアクセスさせたくない

という要件であれば下記で満たせるかと思います

class PrivateItemKind 
{
    const BOOK_KIND_ID = 2;
    const USER_KIND_ID = 3;
}

class SharedItemkind extends PrivateItemKind 
{
    const TAG_KIND_ID = 1;
}

ただ、privateなconstが複数になると管理が複雑になるでしょう。
(次に FOO_KIND_ID がきたら4にするのか等)
privateまたはpublicなものを離れた値にする、変更が起きやすいものであればDB管理にするなどの工夫も必要になります。

実業務上でクラスをこのような実装にしなければいけないケースはあまり思いつきません。
そもそもなぜprivateにする必要があるのか、idをソースコードに持つ仕様だと変更し辛いが良いのか、といった部分は再確認されたほうが良いかと思います。

Comments

[munekun]

> という要件であれば下記で満たせるかと思います
たしかにそうですね。ありがとうございます。ただ質問は簡易にしてしまいましたが、実際は包含関係ではない (一方にしかない値は互いに持つ) ので、すこし工夫が必要そうでした。

> 実業務上でクラスをこのような実装にしなければいけないケースはあまり思いつきません
あれ？そうなのですね。マスタテーブルの枠槍を持ったクラスという感じで作ってみたのですが、そもそも妙な実装だったでしょうか。考え直してみます。