PHPと列挙


1149

PHPにはネイティブの列挙型がないことを知っています。しかし、私はJavaの世界から彼らに慣れてきました。IDEのオートコンプリート機能が理解できる定義済みの値を与える方法として、列挙型を使用したいと思います。

定数でうまくいきますが、名前空間の衝突の問題があり(そして実際には)、それらはグローバルです。配列には名前空間の問題はありませんが、あいまいであり、実行時に上書きされる可能性があり、IDEがキーを自動入力する方法を知っていることはほとんどありません(ありませんか?)。

一般的に使用する解決策/回避策はありますか?PHPの連中が列挙型について何か考えや決断をしたかどうか覚えている人はいますか



1
定数をビット単位で列挙するかどうかを列挙する回避策関数を作成しました。あなたはこの前に尋ね気づくが、私はここではクラス変数より良い解決策を持っていなかった。stackoverflow.com/questions/3836385/...
NoodleOfDeath


定数の問題についてもう少し詳しく教えていただけませんか?「定数はそのトリックを行いますが、名前空間の衝突の問題があり、そして(または実際には)それらはグローバルです。」
XuDing 2017年

回答:


1492

ユースケースにもよりますが、通常は次のような簡単なものを使用します。

abstract class DaysOfWeek
{
    const Sunday = 0;
    const Monday = 1;
    // etc.
}

$today = DaysOfWeek::Sunday;

ただし、他のユースケースでは、定数と値の検証をさらに必要とする場合があります。以下のリフレクションに関するコメント、およびその他のいくつかのメモに基づいて、はるかに広い範囲のケースにより適切に対応できる拡張された例を次に示します。

abstract class BasicEnum {
    private static $constCacheArray = NULL;

    private static function getConstants() {
        if (self::$constCacheArray == NULL) {
            self::$constCacheArray = [];
        }
        $calledClass = get_called_class();
        if (!array_key_exists($calledClass, self::$constCacheArray)) {
            $reflect = new ReflectionClass($calledClass);
            self::$constCacheArray[$calledClass] = $reflect->getConstants();
        }
        return self::$constCacheArray[$calledClass];
    }

    public static function isValidName($name, $strict = false) {
        $constants = self::getConstants();

        if ($strict) {
            return array_key_exists($name, $constants);
        }

        $keys = array_map('strtolower', array_keys($constants));
        return in_array(strtolower($name), $keys);
    }

    public static function isValidValue($value, $strict = true) {
        $values = array_values(self::getConstants());
        return in_array($value, $values, $strict);
    }
}

BasicEnumを拡張する単純な列挙型クラスを作成することにより、メソッドを使用して単純な入力検証を行うことができるようになります。

abstract class DaysOfWeek extends BasicEnum {
    const Sunday = 0;
    const Monday = 1;
    const Tuesday = 2;
    const Wednesday = 3;
    const Thursday = 4;
    const Friday = 5;
    const Saturday = 6;
}

DaysOfWeek::isValidName('Humpday');                  // false
DaysOfWeek::isValidName('Monday');                   // true
DaysOfWeek::isValidName('monday');                   // true
DaysOfWeek::isValidName('monday', $strict = true);   // false
DaysOfWeek::isValidName(0);                          // false

DaysOfWeek::isValidValue(0);                         // true
DaysOfWeek::isValidValue(5);                         // true
DaysOfWeek::isValidValue(7);                         // false
DaysOfWeek::isValidValue('Friday');                  // false

余談ですが、少なくとも1回はリフレクションを使用します データが変更されないstatic / constクラス(列挙型など)では常に、それらのリフレクションコールの結果をキャッシュします。最終的には顕著なパフォーマンスへの影響があります(複数の列挙型に対して連想配列に格納されます)。

ほとんどの人がようやく 5.3 アップグレードしてSplEnum利用可能になったので、コードベース全体で実際の列挙型のインスタンス化を行うという従来の直感的ではない概念を気にしない限り、これも確かに実行可能なオプションです。上記の例では、BasicEnumDaysOfWeekすべてでインスタンス化することができない、また彼らはする必要があります。


70
私も使っています。クラスabstractとを作成することも検討してください。そのfinalため、インスタンス化したり拡張したりすることはできません。
ryeguy

21
あなたは、両方のクラスを作ることができるabstractfinal?これはJavaでは許可されていません。あなたはそれをphpで行うことができますか?
corsiKa 2011

20
@ryeguyとの両方 abstractを作ることはできないようですfinal。その場合、私は抽象に行きます。
ニコール

45
アブストラクトまたはファイナルについて。私はそれらを最終的なものにし、空のプライベートコンストラクターを与えます
rael_kid

21
0の使用には注意が必要です。これにより、予期しない偽の比較問題(ステートメントnull内の同値や友人など)に遭遇することがなくなりswitchます。行ったことがある。
yitznewton 2013年

185

ネイティブ拡張もあります。SplEnum

SplEnumは、PHPでネイティブに列挙オブジェクトをエミュレートおよび作成する機能を提供します。

http://www.php.net/manual/en/class.splenum.php

注意:

https://www.php.net/manual/en/spl-types.installation.php

PECL拡張モジュールはPHPにバンドルされていません。

このPECL拡張機能のDLLは現在使用できません。


4
これが脾臓の例です:dreamincode.net/forums/topic/201638-enum-in-php
Nordes

4
私はロールバックしました。リンクが表示されたときのほうが好きです。コンテキスト情報を提供します。
マーカス'26 / 07/26

5
私は再びロールバックしました。リンクを編集してほしくありません。
マーカス2014

6
これを使用するように注意してください。SPLタイプは実験的です:「この拡張機能は実験的です。関数の名前やこの拡張機能を取り巻くその他のドキュメントを含むこの拡張機能の動作は、PHPの将来のリリースで予告なく変更される可能性があります。この拡張機能は自己責任で使用する必要があります。 」
bzeaman 2016年

6
SplEnumはPHPにバンドルされていません。SPL_Types拡張が必要です
Kwadz

46

クラス定数はどうですか?

<?php

class YourClass
{
    const SOME_CONSTANT = 1;

    public function echoConstant()
    {
        echo self::SOME_CONSTANT;
    }
}

echo YourClass::SOME_CONSTANT;

$c = new YourClass;
$c->echoConstant();

私はこの単純なアプローチを好む
デビッドレモン

echoConstantと置き換えることができます__toString。そして単純にecho $c
Justinas

35

上記の上の答えは素晴らしいです。ただし、extend 2つの異なる方法でそれを行う場合は、最初に行われた拡張によって、関数が呼び出されてキャッシュが作成されます。その後、このキャッシュは、呼び出しがどの内線番号によって開始された場合でも、以降のすべての呼び出しで使用されます...

これを解決するには、変数と最初の関数を次のように置き換えます。

private static $constCacheArray = null;

private static function getConstants() {
    if (self::$constCacheArray === null) self::$constCacheArray = array();

    $calledClass = get_called_class();
    if (!array_key_exists($calledClass, self::$constCacheArray)) {
        $reflect = new \ReflectionClass($calledClass);
        self::$constCacheArray[$calledClass] = $reflect->getConstants();
    }

    return self::$constCacheArray[$calledClass];
}

2
これだけの問題がありました。ブライアンまたは編集権限を持つ誰かは、受け入れられた回答でそれに触れるべきです。getConstants()関数で 'self ::'の代わりに 'static ::'メソッドを使用して、子列挙で$ constCacheを再宣言することで、コードでそれを解決しました。
Sp3igel 2014

魅力的ではないかもしれませんが、PHPではインターフェイス定数を使用するのが最善の方法です。
Anthony Rutledge 2018

27

私は定数を持つクラスを使用しました:

class Enum {
    const NAME       = 'aaaa';
    const SOME_VALUE = 'bbbb';
}

print Enum::NAME;

27

私はinterface代わりに使用しますclass

interface DaysOfWeek
{
    const Sunday = 0;
    const Monday = 1;
    // etc.
}

var $today = DaysOfWeek::Sunday;

6
class Foo implements DaysOfWeek { }そしてFoo::Sunday...何?
Dan Lugg、2013

3
質問の作成者は、名前空間とIDEによるオートコンプリートの2つの解決策を求めています。一流の回答が示唆するように、最も簡単な方法は、使用することですclass(またはinterface、これは好みの問題です)。
アンディT

4
インターフェイスはクラス実装の整合性を強制するために使用されます。これはインターフェイスの範囲外です
user3886650

2
@ user3886650インターフェイスは、定数値を維持するためにJavaで使用でき、使用されました。そのため、定数値を取得するためだけにクラスをインスタンス化する必要はなく、IDEはそれらに対してコード補完を提供します。また、そのインターフェイスを実装するクラスを作成すると、それらの定数がすべて継承されます。
Alex

@ user3886650真ですが、PHPではインターフェースに定数を含めることができます。さらに、これらのインターフェース定数は、クラスまたはその子を実装することによってオーバーライドできません。事実上、これはPHPに関して最良の回答です。オーバーライドできるものはすべて、定数のように実際に機能するわけではないためです。定数は定数ではなく、定数を意味する必要があります(多型が役立つ場合もあります)。
Anthony Rutledge 2018

25

ここで他のいくつかの回答についてコメントしたので、私も検討することを考えました。結局のところ、PHPは型付きの列挙型をサポートしていないため、型付きの列挙型をハックするか、効果的にハッキングするのが非常に難しいという事実を受け入れることができます。

私は事実を受け入れ、代わりに、constここで他の回答が何らかの方法で使用した方法を使用します。

abstract class Enum
{

    const NONE = null;

    final private function __construct()
    {
        throw new NotSupportedException(); // 
    }

    final private function __clone()
    {
        throw new NotSupportedException();
    }

    final public static function toArray()
    {
        return (new ReflectionClass(static::class))->getConstants();
    }

    final public static function isValid($value)
    {
        return in_array($value, static::toArray());
    }

}

列挙の例:

final class ResponseStatusCode extends Enum
{

    const OK                         = 200;
    const CREATED                    = 201;
    const ACCEPTED                   = 202;
    // ...
    const SERVICE_UNAVAILABLE        = 503;
    const GATEWAY_TIME_OUT           = 504;
    const HTTP_VERSION_NOT_SUPPORTED = 505;

}

使用してEnum、他のすべての列挙が延びるから基底クラスとしてはのようなヘルパーメソッドを可能にするtoArrayisValidなど。私にとって、型付けされた列挙(およびそれらのインスタンスの管理)は、あまりにも面倒になってしまいます。


仮説

もしそうなら__getStatic魔法の方法が存在しました(そしてできれば__equals魔法の方法もありました))これの多くは一種のマルチトンパターンで軽減することができます。

以下は、仮定に基づくものである。それはしません仕事、それはでしょうが、おそらく1日

final class TestEnum
{

    private static $_values = [
        'FOO' => 1,
        'BAR' => 2,
        'QUX' => 3,
    ];
    private static $_instances = [];

    public static function __getStatic($name)
    {
        if (isset(static::$_values[$name]))
        {
            if (empty(static::$_instances[$name]))
            {
                static::$_instances[$name] = new static($name);
            }
            return static::$_instances[$name];
        }
        throw new Exception(sprintf('Invalid enumeration value, "%s"', $name));
    }

    private $_value;

    public function __construct($name)
    {
        $this->_value = static::$_values[$name];
    }

    public function __equals($object)
    {
        if ($object instanceof static)
        {
            return $object->_value === $this->_value;
        }
        return $object === $this->_value;
    }

}

$foo = TestEnum::$FOO; // object(TestEnum)#1 (1) {
                       //   ["_value":"TestEnum":private]=>
                       //   int(1)
                       // }

$zap = TestEnum::$ZAP; // Uncaught exception 'Exception' with message
                       // 'Invalid enumeration member, "ZAP"'

$qux = TestEnum::$QUX;
TestEnum::$QUX == $qux; // true
'hello world!' == $qux; // false

私はこの答えの単純さが好きです。これは、後で戻って、ハッキングされたアプローチのように見せることなく、それがどのように機能するかをすばやく理解できるようなものです。残念ながら、賛成票はこれ以上ありません。
Reactgular

23

まあ、phpのenumのような単純なJavaの場合は、次のようにします。

class SomeTypeName {
    private static $enum = array(1 => "Read", 2 => "Write");

    public function toOrdinal($name) {
        return array_search($name, self::$enum);
    }

    public function toString($ordinal) {
        return self::$enum[$ordinal];
    }
}

そしてそれを呼び出すには:

SomeTypeName::toOrdinal("Read");
SomeTypeName::toString(1);

しかし、私はPHPの初心者であり、構文に苦労しているため、これは最善の方法ではない可能性があります。クラス定数をいくつか試してみましたが、Reflectionを使用してその値から定数名を取得すると、見栄えがよくなる可能性があります。


良い答えです。他のほとんどの答えはクラスを使用しています。ただし、クラスをネストすることはできません。
Keyo

これには、foreachを使用して値を反復処理できるという利点があります。そして、違法な値が捕まらないという不利益。
ボブスタイン

2
ただし、IDEには自動補完がないため、推測作業が刺激されます。定数はオートコンプリートを有効にし、より良い音になります。
KrekkieD 2014

19

4年後、私はこれに再び遭遇しました。IDEでのコード補完とタイプセーフが可能なため、現在のアプローチはこれです。

基本クラス:

abstract class TypedEnum
{
    private static $_instancedValues;

    private $_value;
    private $_name;

    private function __construct($value, $name)
    {
        $this->_value = $value;
        $this->_name = $name;
    }

    private static function _fromGetter($getter, $value)
    {
        $reflectionClass = new ReflectionClass(get_called_class());
        $methods = $reflectionClass->getMethods(ReflectionMethod::IS_STATIC | ReflectionMethod::IS_PUBLIC);    
        $className = get_called_class();

        foreach($methods as $method)
        {
            if ($method->class === $className)
            {
                $enumItem = $method->invoke(null);

                if ($enumItem instanceof $className && $enumItem->$getter() === $value)
                {
                    return $enumItem;
                }
            }
        }

        throw new OutOfRangeException();
    }

    protected static function _create($value)
    {
        if (self::$_instancedValues === null)
        {
            self::$_instancedValues = array();
        }

        $className = get_called_class();

        if (!isset(self::$_instancedValues[$className]))
        {
            self::$_instancedValues[$className] = array();
        }

        if (!isset(self::$_instancedValues[$className][$value]))
        {
            $debugTrace = debug_backtrace();
            $lastCaller = array_shift($debugTrace);

            while ($lastCaller['class'] !== $className && count($debugTrace) > 0)
            {
                $lastCaller = array_shift($debugTrace);
            }

            self::$_instancedValues[$className][$value] = new static($value, $lastCaller['function']);
        }

        return self::$_instancedValues[$className][$value];
    }

    public static function fromValue($value)
    {
        return self::_fromGetter('getValue', $value);
    }

    public static function fromName($value)
    {
        return self::_fromGetter('getName', $value);
    }

    public function getValue()
    {
        return $this->_value;
    }

    public function getName()
    {
        return $this->_name;
    }
}

列挙型の例:

final class DaysOfWeek extends TypedEnum
{
    public static function Sunday() { return self::_create(0); }    
    public static function Monday() { return self::_create(1); }
    public static function Tuesday() { return self::_create(2); }   
    public static function Wednesday() { return self::_create(3); }
    public static function Thursday() { return self::_create(4); }  
    public static function Friday() { return self::_create(5); }
    public static function Saturday() { return self::_create(6); }      
}

使用例:

function saveEvent(DaysOfWeek $weekDay, $comment)
{
    // store week day numeric value and comment:
    $myDatabase->save('myeventtable', 
       array('weekday_id' => $weekDay->getValue()),
       array('comment' => $comment));
}

// call the function, note: DaysOfWeek::Monday() returns an object of type DaysOfWeek
saveEvent(DaysOfWeek::Monday(), 'some comment');

同じ列挙型エントリのすべてのインスタンスは同じであることに注意してください。

$monday1 = DaysOfWeek::Monday();
$monday2 = DaysOfWeek::Monday();
$monday1 === $monday2; // true

また、switchステートメント内で使用することもできます。

function getGermanWeekDayName(DaysOfWeek $weekDay)
{
    switch ($weekDay)
    {
        case DaysOfWeek::Monday(): return 'Montag';
        case DaysOfWeek::Tuesday(): return 'Dienstag';
        // ...
}

名前または値で列挙エントリを作成することもできます。

$monday = DaysOfWeek::fromValue(2);
$tuesday = DaysOfWeek::fromName('Tuesday');

または、既存の列挙型エントリから名前(つまり、関数名)を取得することもできます。

$wednesday = DaysOfWeek::Wednesday()
echo $wednesDay->getName(); // Wednesday

プライベートコンストラクタの場合は+1。私は、抽象クラス、単純なクラス、プライベートコンストラクタといくつかのヘルパーことはないだろうconst Monday = DaysOfWeek('Monday');
Kangur

9

このライブラリを見つけましたをgithubでたが、ここでの答えに対する非常にまともな代替手段を提供すると思います。

SplEnumに触発されたPHP Enumの実装

  • あなたはタイプヒントすることができます: function setAction(Action $action) {
  • メソッドで列挙型を充実させることができます(例えばformatparse、...)
  • enumを拡張して新しい値を追加できます(enumを作成します) finalをそれを防止します)
  • 可能なすべての値のリストを取得できます(以下を参照)

宣言

<?php
use MyCLabs\Enum\Enum;

/**
 * Action enum
 */
class Action extends Enum
{
    const VIEW = 'view';
    const EDIT = 'edit';
}

使用法

<?php
$action = new Action(Action::VIEW);

// or
$action = Action::VIEW();

タイプヒントの列挙値:

<?php
function setAction(Action $action) {
    // ...
}

1
これは正解です(現時点でenumは、PHP 7.xで追加されるまで)。
トビア2016年

1
だけでなく、これはタイプヒンティングが、理由の許可ん__toString()魔法、それはあなたが、一般的に、本当に列挙型とにやりたいことができます-にそれらを使用するswitchか、ifconstsの値と直接比較し、声明。ネイティブ列挙型サポートIMOを除く最善のアプローチ。
LinusR

7

グローバルに一意で(異なるEnum間で要素を比較する場合でも)、使いやすい列挙型を使用する必要がある場合は、次のコードを自由に使用してください。また、便利だと思う方法もいくつか追加しました。コードの最上部にあるコメントに例があります。

<?php

/**
 * Class Enum
 * 
 * @author Christopher Fox <christopher.fox@gmx.de>
 *
 * @version 1.0
 *
 * This class provides the function of an enumeration.
 * The values of Enum elements are unique (even between different Enums)
 * as you would expect them to be.
 *
 * Constructing a new Enum:
 * ========================
 *
 * In the following example we construct an enum called "UserState"
 * with the elements "inactive", "active", "banned" and "deleted".
 * 
 * <code>
 * Enum::Create('UserState', 'inactive', 'active', 'banned', 'deleted');
 * </code>
 *
 * Using Enums:
 * ============
 *
 * The following example demonstrates how to compare two Enum elements
 *
 * <code>
 * var_dump(UserState::inactive == UserState::banned); // result: false
 * var_dump(UserState::active == UserState::active); // result: true
 * </code>
 *
 * Special Enum methods:
 * =====================
 *
 * Get the number of elements in an Enum:
 *
 * <code>
 * echo UserState::CountEntries(); // result: 4
 * </code>
 *
 * Get a list with all elements of the Enum:
 *
 * <code>
 * $allUserStates = UserState::GetEntries();
 * </code>
 *
 * Get a name of an element:
 *
 * <code>
 * echo UserState::GetName(UserState::deleted); // result: deleted
 * </code>
 *
 * Get an integer ID for an element (e.g. to store as a value in a database table):
 * This is simply the index of the element (beginning with 1).
 * Note that this ID is only unique for this Enum but now between different Enums.
 *
 * <code>
 * echo UserState::GetDatabaseID(UserState::active); // result: 2
 * </code>
 */
class Enum
{

    /**
     * @var Enum $instance The only instance of Enum (Singleton)
     */
    private static $instance;

    /**
     * @var array $enums    An array of all enums with Enum names as keys
     *          and arrays of element names as values
     */
    private $enums;

    /**
     * Constructs (the only) Enum instance
     */
    private function __construct()
    {
        $this->enums = array();
    }

    /**
     * Constructs a new enum
     *
     * @param string $name The class name for the enum
     * @param mixed $_ A list of strings to use as names for enum entries
     */
    public static function Create($name, $_)
    {
        // Create (the only) Enum instance if this hasn't happened yet
        if (self::$instance===null)
        {
            self::$instance = new Enum();
        }

        // Fetch the arguments of the function
        $args = func_get_args();
        // Exclude the "name" argument from the array of function arguments,
        // so only the enum element names remain in the array
        array_shift($args);
        self::$instance->add($name, $args);
    }

    /**
     * Creates an enumeration if this hasn't happened yet
     * 
     * @param string $name The class name for the enum
     * @param array $fields The names of the enum elements
     */
    private function add($name, $fields)
    {
        if (!array_key_exists($name, $this->enums))
        {
            $this->enums[$name] = array();

            // Generate the code of the class for this enumeration
            $classDeclaration =     "class " . $name . " {\n"
                        . "private static \$name = '" . $name . "';\n"
                        . $this->getClassConstants($name, $fields)
                        . $this->getFunctionGetEntries($name)
                        . $this->getFunctionCountEntries($name)
                        . $this->getFunctionGetDatabaseID()
                        . $this->getFunctionGetName()
                        . "}";

            // Create the class for this enumeration
            eval($classDeclaration);
        }
    }

    /**
     * Returns the code of the class constants
     * for an enumeration. These are the representations
     * of the elements.
     * 
     * @param string $name The class name for the enum
     * @param array $fields The names of the enum elements
     *
     * @return string The code of the class constants
     */
    private function getClassConstants($name, $fields)
    {
        $constants = '';

        foreach ($fields as $field)
        {
            // Create a unique ID for the Enum element
            // This ID is unique because class and variables
            // names can't contain a semicolon. Therefore we
            // can use the semicolon as a separator here.
            $uniqueID = $name . ";" . $field;
            $constants .=   "const " . $field . " = '". $uniqueID . "';\n";
            // Store the unique ID
            array_push($this->enums[$name], $uniqueID);
        }

        return $constants;
    }

    /**
     * Returns the code of the function "GetEntries()"
     * for an enumeration
     * 
     * @param string $name The class name for the enum
     *
     * @return string The code of the function "GetEntries()"
     */
    private function getFunctionGetEntries($name) 
    {
        $entryList = '';        

        // Put the unique element IDs in single quotes and
        // separate them with commas
        foreach ($this->enums[$name] as $key => $entry)
        {
            if ($key > 0) $entryList .= ',';
            $entryList .= "'" . $entry . "'";
        }

        return  "public static function GetEntries() { \n"
            . " return array(" . $entryList . ");\n"
            . "}\n";
    }

    /**
     * Returns the code of the function "CountEntries()"
     * for an enumeration
     * 
     * @param string $name The class name for the enum
     *
     * @return string The code of the function "CountEntries()"
     */
    private function getFunctionCountEntries($name) 
    {
        // This function will simply return a constant number (e.g. return 5;)
        return  "public static function CountEntries() { \n"
            . " return " . count($this->enums[$name]) . ";\n"
            . "}\n";
    }

    /**
     * Returns the code of the function "GetDatabaseID()"
     * for an enumeration
     * 
     * @return string The code of the function "GetDatabaseID()"
     */
    private function getFunctionGetDatabaseID()
    {
        // Check for the index of this element inside of the array
        // of elements and add +1
        return  "public static function GetDatabaseID(\$entry) { \n"
            . "\$key = array_search(\$entry, self::GetEntries());\n"
            . " return \$key + 1;\n"
            . "}\n";
    }

    /**
     * Returns the code of the function "GetName()"
     * for an enumeration
     *
     * @return string The code of the function "GetName()"
     */
    private function getFunctionGetName()
    {
        // Remove the class name from the unique ID 
        // and return this value (which is the element name)
        return  "public static function GetName(\$entry) { \n"
            . "return substr(\$entry, strlen(self::\$name) + 1 , strlen(\$entry));\n"
            . "}\n";
    }

}


?>

1
私はこれが大好きです。ただし、主な不満の1つは、オートコンプリートの値を取得するIDEの機能です。IDEのカスタムアドオンがなくてもこれが可能かどうかはわかりません。それができなかったということではなく、ただいくらかの作業が必要になるだけです。
corsiKa 2011

2
使用してeval()新しい列挙型のランタイムを宣言することができますちょうどそう?ねえ。私はそれを感じていません。適切なクラスを定義する前に、他のクラスが誤ったEnumクラスを作成しないようにするにはどうすればよいですか?Enumは実行前に認識されていませんか?そして、@ corsiKaが暗示するように、IDEのオートコンプリートはありません。私が見る唯一の利点は、遅延コーディングです。
KrekkieD 2014

7

私はJavaの列挙型も好きなので、このように自分の列挙型をこのように記述します。Java列挙型のように、これを最もよく似た振る舞いだと思います。抽象クラスですが、コアアイデアは以下のコードに埋め込まれています


class FruitsEnum {

    static $APPLE = null;
    static $ORANGE = null;

    private $value = null;

    public static $map;

    public function __construct($value) {
        $this->value = $value;
    }

    public static function init () {
        self::$APPLE  = new FruitsEnum("Apple");
        self::$ORANGE = new FruitsEnum("Orange");
        //static map to get object by name - example Enum::get("INIT") - returns Enum::$INIT object;
        self::$map = array (
            "Apple" => self::$APPLE,
            "Orange" => self::$ORANGE
        );
    }

    public static function get($element) {
        if($element == null)
            return null;
        return self::$map[$element];
    }

    public function getValue() {
        return $this->value;
    }

    public function equals(FruitsEnum $element) {
        return $element->getValue() == $this->getValue();
    }

    public function __toString () {
        return $this->value;
    }
}
FruitsEnum::init();

var_dump(FruitsEnum::$APPLE->equals(FruitsEnum::$APPLE)); //true
var_dump(FruitsEnum::$APPLE->equals(FruitsEnum::$ORANGE)); //false
var_dump(FruitsEnum::$APPLE instanceof FruitsEnum); //true
var_dump(FruitsEnum::get("Apple")->equals(FruitsEnum::$APPLE)); //true - enum from string
var_dump(FruitsEnum::get("Apple")->equals(FruitsEnum::get("Orange"))); //false

3
私はほとんど同じことをしていますが、2つの小さな追加があります。静的なゲッターの背後に静的な値を隠しています。理由の1つは、視覚的にを優先FruitsEnum::Apple()することFruitsEnum::$Appleですが、より重要な理由は、他の$APPLEユーザーがを設定できないようにし、アプリケーション全体の列挙型を壊すことです。もう1つは単純なプライベートスタティックフラグ$initializedでありinit()、最初に呼び出した後、呼び出しが何もしないことを確認します(そのため、誰もそれを混乱させることはできません)。
マーティンエンダー2013

私はマーティンが好きでした。.init()奇妙で、ゲッターのアプローチを気にしません。
セバス

7
abstract class Enumeration
{
    public static function enum() 
    {
        $reflect = new ReflectionClass( get_called_class() );
        return $reflect->getConstants();
    }
}


class Test extends Enumeration
{
    const A = 'a';
    const B = 'b';    
}


foreach (Test::enum() as $key => $value) {
    echo "$key -> $value<br>";
}


5

PHPの列挙型で見た最も一般的な解決策は、汎用列挙型クラスを作成してから拡張することです。これを見てください。

更新:または、phpclasses.orgからこれを見つけました。


1
実装は洗練されており、おそらく機能しますが、これの欠点は、IDEがおそらく列挙型を自動入力する方法を知らないことです。phpclasses.orgからの登録は確認できませんでした。登録を求めていたためです。
Henrik Paul、

5

PHPでタイプセーフな列挙を処理するためのgithubライブラリを次に示します。

このライブラリは、クラス生成とクラスキャッシングを処理し、タイプセーフ列挙デザインパターンを実装します。列挙型を処理するための序数の取得や列挙型の組み合わせのためのバイナリ値の取得など、列挙型を処理するためのいくつかのヘルパーメソッドを備えています。

生成されたコードは、設定も可能なプレーンな古いphpテンプレートファイルを使用するため、独自のテンプレートを提供できます。

これはphpunitでカバーされた完全なテストです。

githubのphp-enums(お気軽にforkしてください)

使用法:(@see usage.php、または詳細については単体テスト)

<?php
//require the library
require_once __DIR__ . '/src/Enum.func.php';

//if you don't have a cache directory, create one
@mkdir(__DIR__ . '/cache');
EnumGenerator::setDefaultCachedClassesDir(__DIR__ . '/cache');

//Class definition is evaluated on the fly:
Enum('FruitsEnum', array('apple' , 'orange' , 'rasberry' , 'bannana'));

//Class definition is cached in the cache directory for later usage:
Enum('CachedFruitsEnum', array('apple' , 'orange' , 'rasberry' , 'bannana'), '\my\company\name\space', true);

echo 'FruitsEnum::APPLE() == FruitsEnum::APPLE(): ';
var_dump(FruitsEnum::APPLE() == FruitsEnum::APPLE()) . "\n";

echo 'FruitsEnum::APPLE() == FruitsEnum::ORANGE(): ';
var_dump(FruitsEnum::APPLE() == FruitsEnum::ORANGE()) . "\n";

echo 'FruitsEnum::APPLE() instanceof Enum: ';
var_dump(FruitsEnum::APPLE() instanceof Enum) . "\n";

echo 'FruitsEnum::APPLE() instanceof FruitsEnum: ';
var_dump(FruitsEnum::APPLE() instanceof FruitsEnum) . "\n";

echo "->getName()\n";
foreach (FruitsEnum::iterator() as $enum)
{
  echo "  " . $enum->getName() . "\n";
}

echo "->getValue()\n";
foreach (FruitsEnum::iterator() as $enum)
{
  echo "  " . $enum->getValue() . "\n";
}

echo "->getOrdinal()\n";
foreach (CachedFruitsEnum::iterator() as $enum)
{
  echo "  " . $enum->getOrdinal() . "\n";
}

echo "->getBinary()\n";
foreach (CachedFruitsEnum::iterator() as $enum)
{
  echo "  " . $enum->getBinary() . "\n";
}

出力:

FruitsEnum::APPLE() == FruitsEnum::APPLE(): bool(true)
FruitsEnum::APPLE() == FruitsEnum::ORANGE(): bool(false)
FruitsEnum::APPLE() instanceof Enum: bool(true)
FruitsEnum::APPLE() instanceof FruitsEnum: bool(true)
->getName()
  APPLE
  ORANGE
  RASBERRY
  BANNANA
->getValue()
  apple
  orange
  rasberry
  bannana
->getValue() when values have been specified
  pig
  dog
  cat
  bird
->getOrdinal()
  1
  2
  3
  4
->getBinary()
  1
  2
  4
  8

4

関数パラメーターのタイプセーフ、NetBeansでのオートコンプリート、優れたパフォーマンスを実現する機能を備えているため、以下のアプローチを採用しました。私があまり好きではないことの1つは[extended class name]::enumerate();、クラスを定義した後に呼び出す必要があることです。

abstract class Enum {

    private $_value;

    protected function __construct($value) {
        $this->_value = $value;
    }

    public function __toString() {
        return (string) $this->_value;
    }

    public static function enumerate() {
        $class = get_called_class();
        $ref = new ReflectionClass($class);
        $statics = $ref->getStaticProperties();
        foreach ($statics as $name => $value) {
            $ref->setStaticPropertyValue($name, new $class($value));
        }
    }
}

class DaysOfWeek extends Enum {
    public static $MONDAY = 0;
    public static $SUNDAY = 1;
    // etc.
}
DaysOfWeek::enumerate();

function isMonday(DaysOfWeek $d) {
    if ($d == DaysOfWeek::$MONDAY) {
        return true;
    } else {
        return false;
    }
}

$day = DaysOfWeek::$MONDAY;
echo (isMonday($day) ? "bummer it's monday" : "Yay! it's not monday");

enum値の再定義を妨げるものは何もありませんDaysOfWeek::$MONDAY = 3;
。– KrekkieD

@BrianFisher、私はそれが今は遅いことを知っていますが、[extended class name]::enumerate();定義後に呼び出したくない場合は、なぜ構造でそれを行わないのですか?
Can O 'Spam

4

以下のEnumクラスの定義は厳密に型指定されており、使用および定義するのが非常に自然です。

定義:

class Fruit extends Enum {
    static public $APPLE = 1;
    static public $ORANGE = 2;
}
Fruit::initialize(); //Can also be called in autoloader

列挙型を切り替える

$myFruit = Fruit::$APPLE;

switch ($myFruit) {
    case Fruit::$APPLE  : echo "I like apples\n";  break;
    case Fruit::$ORANGE : echo "I hate oranges\n"; break;
}

>> I like apples

Enumをパラメーターとして渡す(厳密に型指定)

/** Function only accepts Fruit enums as input**/
function echoFruit(Fruit $fruit) {
    echo $fruit->getName().": ".$fruit->getValue()."\n";
}

/** Call function with each Enum value that Fruit has */
foreach (Fruit::getList() as $fruit) {
    echoFruit($fruit);
}

//Call function with Apple enum
echoFruit(Fruit::$APPLE)

//Will produce an error. This solution is strongly typed
echoFruit(2);

>> APPLE: 1
>> ORANGE: 2
>> APPLE: 1
>> Argument 1 passed to echoFruit() must be an instance of Fruit, integer given

Enumを文字列としてエコー

echo "I have an $myFruit\n";

>> I have an APPLE

整数で列挙を取得

$myFruit = Fruit::getByValue(2);

echo "Now I have an $myFruit\n";

>> Now I have an ORANGE

名前で列挙を取得

$myFruit = Fruit::getByName("APPLE");

echo "But I definitely prefer an $myFruit\n\n";

>> But I definitely prefer an APPLE

Enumクラス:

/**
 * @author Torge Kummerow
 */
class Enum {

    /**
     * Holds the values for each type of Enum
     */
    static private $list = array();

    /**
     * Initializes the enum values by replacing the number with an instance of itself
     * using reflection
     */
    static public function initialize() {
        $className = get_called_class();
        $class = new ReflectionClass($className);
        $staticProperties = $class->getStaticProperties();

        self::$list[$className] = array();

        foreach ($staticProperties as $propertyName => &$value) {
            if ($propertyName == 'list')
                continue;

            $enum = new $className($propertyName, $value);
            $class->setStaticPropertyValue($propertyName, $enum);
            self::$list[$className][$propertyName] = $enum;
        } unset($value);
    }


    /**
     * Gets the enum for the given value
     *
     * @param integer $value
     * @throws Exception
     *
     * @return Enum
     */
    static public function getByValue($value) {
        $className = get_called_class();
        foreach (self::$list[$className] as $propertyName=>&$enum) {
            /* @var $enum Enum */
            if ($enum->value == $value)
                return $enum;
        } unset($enum);

        throw new Exception("No such enum with value=$value of type ".get_called_class());
    }

    /**
     * Gets the enum for the given name
     *
     * @param string $name
     * @throws Exception
     *
     * @return Enum
     */
    static public function getByName($name) {
        $className = get_called_class();
        if (array_key_exists($name, static::$list[$className]))
            return self::$list[$className][$name];

        throw new Exception("No such enum ".get_called_class()."::\$$name");
    }


    /**
     * Returns the list of all enum variants
     * @return Array of Enum
     */
    static public function getList() {
        $className = get_called_class();
        return self::$list[$className];
    }


    private $name;
    private $value;

    public function __construct($name, $value) {
        $this->name = $name;
        $this->value = $value;
    }

    public function __toString() {
        return $this->name;
    }

    public function getValue() {
        return $this->value;
    }

    public function getName() {
        return $this->name;
    }

}

添加

もちろんIDEのコメントを追加することもできます

class Fruit extends Enum {

    /**
     * This comment is for autocomplete support in common IDEs
     * @var Fruit A yummy apple
     */
    static public $APPLE = 1;

    /**
     * This comment is for autocomplete support in common IDEs
     * @var Fruit A sour orange
     */
    static public $ORANGE = 2;
}

//This can also go to the autoloader if available.
Fruit::initialize();

4

これは非常に古いスレッドであることに気づきましたが、これについて考えていて、人々の考えを知りたいと思っていました。

注:私はこれで遊んでいて、__call()関数を変更しただけで実際の値にさらに近づくことができることに気付きましたenums。この__call()関数は、すべての不明な関数呼び出しを処理します。それでは、3つのenumsRED_LIGHT、YELLOW_LIGHT、GREEN_LIGHT を作成するとします。これを行うには、次のようにします。

$c->RED_LIGHT();
$c->YELLOW_LIGHT();
$c->GREEN_LIGHT();

定義したら、値を取得するために再度呼び出すだけです。

echo $c->RED_LIGHT();
echo $c->YELLOW_LIGHT();
echo $c->GREEN_LIGHT();

0、1、2が表示されます。楽しんでください!これもGitHubで公開されています。

更新:__get()__set()関数の両方が使用されるように作成しました。これらを使用すると、必要でない限り、関数を呼び出す必要がなくなります。代わりに、今あなたはただ言うことができます:

$c->RED_LIGHT;
$c->YELLOW_LIGHT;
$c->GREEN_LIGHT;

値の作成と取得の両方。最初に変数が定義されていないため、__get()(値が指定されていないため)関数が呼び出され、配列内のエントリが作成されていないことが確認されます。したがって、エントリを作成し、最後に指定された値にプラス1(+1)を割り当て、最後の値の変数をインクリメントし、TRUEを返します。値を設定した場合:

$c->RED_LIGHT = 85;

次に、__set()関数が呼び出され、最後の値が新しい値+ 1に設定されます。これで、列挙型を作成するためのかなり良い方法ができました。列挙型はその場で作成できます。

<?php
################################################################################
#   Class ENUMS
#
#       Original code by Mark Manning.
#       Copyrighted (c) 2015 by Mark Manning.
#       All rights reserved.
#
#       This set of code is hereby placed into the free software universe
#       via the GNU greater license thus placing it under the Copyleft
#       rules and regulations with the following modifications:
#
#       1. You may use this work in any other work.  Commercial or otherwise.
#       2. You may make as much money as you can with it.
#       3. You owe me nothing except to give me a small blurb somewhere in
#           your program or maybe have pity on me and donate a dollar to
#           sim_sales@paypal.com.  :-)
#
#   Blurb:
#
#       PHP Class Enums by Mark Manning (markem-AT-sim1-DOT-us).
#       Used with permission.
#
#   Notes:
#
#       VIM formatting.  Set tabs to four(4) spaces.
#
################################################################################
class enums
{
    private $enums;
    private $clear_flag;
    private $last_value;

################################################################################
#   __construct(). Construction function.  Optionally pass in your enums.
################################################################################
function __construct()
{
    $this->enums = array();
    $this->clear_flag = false;
    $this->last_value = 0;

    if( func_num_args() > 0 ){
        return $this->put( func_get_args() );
        }

    return true;
}
################################################################################
#   put(). Insert one or more enums.
################################################################################
function put()
{
    $args = func_get_args();
#
#   Did they send us an array of enums?
#   Ex: $c->put( array( "a"=>0, "b"=>1,...) );
#   OR  $c->put( array( "a", "b", "c",... ) );
#
    if( is_array($args[0]) ){
#
#   Add them all in
#
        foreach( $args[0] as $k=>$v ){
#
#   Don't let them change it once it is set.
#   Remove the IF statement if you want to be able to modify the enums.
#
            if( !isset($this->enums[$k]) ){
#
#   If they sent an array of enums like this: "a","b","c",... then we have to
#   change that to be "A"=>#. Where "#" is the current count of the enums.
#
                if( is_numeric($k) ){
                    $this->enums[$v] = $this->last_value++;
                    }
#
#   Else - they sent "a"=>"A", "b"=>"B", "c"=>"C"...
#
                    else {
                        $this->last_value = $v + 1;
                        $this->enums[$k] = $v;
                        }
                }
            }
        }
#
#   Nope!  Did they just sent us one enum?
#
        else {
#
#   Is this just a default declaration?
#   Ex: $c->put( "a" );
#
            if( count($args) < 2 ){
#
#   Again - remove the IF statement if you want to be able to change the enums.
#
                if( !isset($this->enums[$args[0]]) ){
                    $this->enums[$args[0]] = $this->last_value++;
                    }
#
#   No - they sent us a regular enum
#   Ex: $c->put( "a", "This is the first enum" );
#
                    else {
#
#   Again - remove the IF statement if you want to be able to change the enums.
#
                        if( !isset($this->enums[$args[0]]) ){
                            $this->last_value = $args[1] + 1;
                            $this->enums[$args[0]] = $args[1];
                            }
                        }
                }
            }

    return true;
}
################################################################################
#   get(). Get one or more enums.
################################################################################
function get()
{
    $num = func_num_args();
    $args = func_get_args();
#
#   Is this an array of enums request? (ie: $c->get(array("a","b","c"...)) )
#
    if( is_array($args[0]) ){
        $ary = array();
        foreach( $args[0] as $k=>$v ){
            $ary[$v] = $this->enums[$v];
            }

        return $ary;
        }
#
#   Is it just ONE enum they want? (ie: $c->get("a") )
#
        else if( ($num > 0) && ($num < 2) ){
            return $this->enums[$args[0]];
            }
#
#   Is it a list of enums they want? (ie: $c->get( "a", "b", "c"...) )
#
        else if( $num > 1 ){
            $ary = array();
            foreach( $args as $k=>$v ){
                $ary[$v] = $this->enums[$v];
                }

            return $ary;
            }
#
#   They either sent something funky or nothing at all.
#
    return false;
}
################################################################################
#   clear(). Clear out the enum array.
#       Optional.  Set the flag in the __construct function.
#       After all, ENUMS are supposed to be constant.
################################################################################
function clear()
{
    if( $clear_flag ){
        unset( $this->enums );
        $this->enums = array();
        }

    return true;
}
################################################################################
#   __call().  In case someone tries to blow up the class.
################################################################################
function __call( $name, $arguments )
{
    if( isset($this->enums[$name]) ){ return $this->enums[$name]; }
        else if( !isset($this->enums[$name]) && (count($arguments) > 0) ){
            $this->last_value = $arguments[0] + 1;
            $this->enums[$name] = $arguments[0];
            return true;
            }
        else if( !isset($this->enums[$name]) && (count($arguments) < 1) ){
            $this->enums[$name] = $this->last_value++;
            return true;
            }

    return false;
}
################################################################################
#   __get(). Gets the value.
################################################################################
function __get($name)
{
    if( isset($this->enums[$name]) ){ return $this->enums[$name]; }
        else if( !isset($this->enums[$name]) ){
            $this->enums[$name] = $this->last_value++;
            return true;
            }

    return false;
}
################################################################################
#   __set().  Sets the value.
################################################################################
function __set( $name, $value=null )
{
    if( isset($this->enums[$name]) ){ return false; }
        else if( !isset($this->enums[$name]) && !is_null($value) ){
            $this->last_value = $value + 1;
            $this->enums[$name] = $value;
            return true;
            }
        else if( !isset($this->enums[$name]) && is_null($value) ){
            $this->enums[$name] = $this->last_value++;
            return true;
            }

    return false;
}
################################################################################
#   __destruct().  Deconstruct the class.  Remove the list of enums.
################################################################################
function __destruct()
{
    unset( $this->enums );
    $this->enums = null;

    return true;
}

}
#
#   Test code
#
#   $c = new enums();
#   $c->RED_LIGHT(85);
#   $c->YELLOW_LIGHT = 23;
#   $c->GREEN_LIGHT;
#
#   echo $c->RED_LIGHT . "\n";
#   echo $c->YELLOW_LIGHT . "\n";
#   echo $c->GREEN_LIGHT . "\n";

?>

3

私はこれが古いスレッドであることを知っていますが、ほとんどの回避策では列挙型アイテムに手動で値を割り当てる必要があるか、列挙キーの配列を関数。だから私はこれのために私自身のソリューションを作成しました。

私のソリューションを使用して列挙型クラスを作成するには、以下のこのEnumクラスを拡張し、一連の静的変数を作成し(初期化する必要はありません)、列挙型クラスの定義のすぐ下にyourEnumClass :: init()を呼び出します。

編集:これはphp> = 5.3でのみ機能しますが、おそらく古いバージョンでも機能するように変更できます

/**
 * A base class for enums. 
 * 
 * This class can be used as a base class for enums. 
 * It can be used to create regular enums (incremental indices), but it can also be used to create binary flag values.
 * To create an enum class you can simply extend this class, and make a call to <yourEnumClass>::init() before you use the enum.
 * Preferably this call is made directly after the class declaration. 
 * Example usages:
 * DaysOfTheWeek.class.php
 * abstract class DaysOfTheWeek extends Enum{
 *      static $MONDAY = 1;
 *      static $TUESDAY;
 *      static $WEDNESDAY;
 *      static $THURSDAY;
 *      static $FRIDAY;
 *      static $SATURDAY;
 *      static $SUNDAY;
 * }
 * DaysOfTheWeek::init();
 * 
 * example.php
 * require_once("DaysOfTheWeek.class.php");
 * $today = date('N');
 * if ($today == DaysOfTheWeek::$SUNDAY || $today == DaysOfTheWeek::$SATURDAY)
 *      echo "It's weekend!";
 * 
 * Flags.class.php
 * abstract class Flags extends Enum{
 *      static $FLAG_1;
 *      static $FLAG_2;
 *      static $FLAG_3;
 * }
 * Flags::init(Enum::$BINARY_FLAG);
 * 
 * example2.php
 * require_once("Flags.class.php");
 * $flags = Flags::$FLAG_1 | Flags::$FLAG_2;
 * if ($flags & Flags::$FLAG_1)
 *      echo "Flag_1 is set";
 * 
 * @author Tiddo Langerak
 */
abstract class Enum{

    static $BINARY_FLAG = 1;
    /**
     * This function must be called to initialize the enumeration!
     * 
     * @param bool $flags If the USE_BINARY flag is provided, the enum values will be binary flag values. Default: no flags set.
     */ 
    public static function init($flags = 0){
        //First, we want to get a list of all static properties of the enum class. We'll use the ReflectionClass for this.
        $enum = get_called_class();
        $ref = new ReflectionClass($enum);
        $items = $ref->getStaticProperties();
        //Now we can start assigning values to the items. 
        if ($flags & self::$BINARY_FLAG){
            //If we want binary flag values, our first value should be 1.
            $value = 1;
            //Now we can set the values for all items.
            foreach ($items as $key=>$item){
                if (!isset($item)){                 
                    //If no value is set manually, we should set it.
                    $enum::$$key = $value;
                    //And we need to calculate the new value
                    $value *= 2;
                } else {
                    //If there was already a value set, we will continue starting from that value, but only if that was a valid binary flag value.
                    //Otherwise, we will just skip this item.
                    if ($key != 0 && ($key & ($key - 1) == 0))
                        $value = 2 * $item;
                }
            }
        } else {
            //If we want to use regular indices, we'll start with index 0.
            $value = 0;
            //Now we can set the values for all items.
            foreach ($items as $key=>$item){
                if (!isset($item)){
                    //If no value is set manually, we should set it, and increment the value for the next item.
                    $enum::$$key = $value;
                    $value++;
                } else {
                    //If a value was already set, we'll continue from that value.
                    $value = $item+1;
                }
            }
        }
    }
}

3

これで、SplEnumクラスを使用してネイティブに構築できます。公式ドキュメントによると。

SplEnumは、PHPでネイティブに列挙オブジェクトをエミュレートおよび作成する機能を提供します。

<?php
class Month extends SplEnum {
    const __default = self::January;

    const January = 1;
    const February = 2;
    const March = 3;
    const April = 4;
    const May = 5;
    const June = 6;
    const July = 7;
    const August = 8;
    const September = 9;
    const October = 10;
    const November = 11;
    const December = 12;
}

echo new Month(Month::June) . PHP_EOL;

try {
    new Month(13);
} catch (UnexpectedValueException $uve) {
    echo $uve->getMessage() . PHP_EOL;
}
?>

これはインストールする必要がある拡張機能ですが、デフォルトでは使用できません。これは、php Webサイト自体で説明されている特別なタイプの下にあります。上記の例は、PHPサイトから取得したものです。


3

最後に、オーバーライドできない定数を使用したPHP 7.1以降の回答。

/**
 * An interface that groups HTTP Accept: header Media Types in one place.
 */
interface MediaTypes
{
    /**
    * Now, if you have to use these same constants with another class, you can
    * without creating funky inheritance / is-a relationships.
    * Also, this gets around the single inheritance limitation.
    */

    public const HTML = 'text/html';
    public const JSON = 'application/json';
    public const XML = 'application/xml';
    public const TEXT = 'text/plain';
}

/**
 * An generic request class.
 */
abstract class Request
{
    // Why not put the constants here?
    // 1) The logical reuse issue.
    // 2) Single Inheritance. 
    // 3) Overriding is possible.

    // Why put class constants here?
    // 1) The constant value will not be necessary in other class families.
}

/**
 * An incoming / server-side HTTP request class.
 */
class HttpRequest extends Request implements MediaTypes
{
    // This class can implement groups of constants as necessary.
}

名前空間を使用している場合は、コード補完が機能するはずです。

ただし、これを行うと、クラスファミリー(protected)またはクラスのみ(private)内の定数を非表示にする機能が失われます。定義により、のすべてInterfacepublicです。

PHPマニュアル:インターフェース


これはJavaではありません。これは、親クラスの定数をオーバーライドするためにポリモーフィズム/戦略パターンが必要ない場合に機能します。
Anthony Rutledge 2018

2

これは、「動的」列挙型の私の見解です...変数で呼び出すことができるようにします。フォームから。

このコードブロックの下の更新されたバージョンを見てください...

$value = "concert";
$Enumvalue = EnumCategory::enum($value);
//$EnumValue = 1

class EnumCategory{
    const concert = 1;
    const festival = 2;
    const sport = 3;
    const nightlife = 4;
    const theatre = 5;
    const musical = 6;
    const cinema = 7;
    const charity = 8;
    const museum = 9;
    const other = 10;

    public function enum($string){
        return constant('EnumCategory::'.$string);
    }
}

更新:それを行うより良い方法...

class EnumCategory {

    static $concert = 1;
    static $festival = 2;
    static $sport = 3;
    static $nightlife = 4;
    static $theatre = 5;
    static $musical = 6;
    static $cinema = 7;
    static $charity = 8;
    static $museum = 9;
    static $other = 10;

}

と電話する

EnumCategory::${$category};

5
この存在の問題。EnumCategory::$sport = 9;。スポーツ博物館へようこそ。const 、それを行うためのより良い方法。
Dan Lugg、2013

2

受け入れられた答えは進むべき道であり、実際には私が単純化するためにやっていることです。列挙のほとんどの利点が提供されます(読み取り可能、高速など)。ただし、1つの概念が欠落しています。型の安全性です。ほとんどの言語では、列挙値は許可された値を制限するためにも使用されます。以下は、プライベートコンストラクター、静的インスタンス化メソッド、および型チェックを使用して型安全性を取得する方法の例です。

class DaysOfWeek{
 const Sunday = 0;
 const Monday = 1;
 // etc.

 private $intVal;
 private function __construct($intVal){
   $this->intVal = $intVal;
 }

 //static instantiation methods
 public static function MONDAY(){
   return new self(self::Monday);
 }
 //etc.
}

//function using type checking
function printDayOfWeek(DaysOfWeek $d){ //compiler can now use type checking
  // to something with $d...
}

//calling the function is safe!
printDayOfWeek(DaysOfWeek::MONDAY());

さらに進んで、DaysOfWeekクラスで定数を使用すると誤用につながる可能性があります。たとえば、次のように誤って使用する可能性があります。

printDayOfWeek(DaysOfWeek::Monday); //triggers a compiler error.

これは間違っています(整数定数を呼び出します)。定数の代わりにプライベート静的変数を使用してこれを防ぐことができます:

class DaysOfWeeks{

  private static $monday = 1;
  //etc.

  private $intVal;
  //private constructor
  private function __construct($intVal){
    $this->intVal = $intVal;
  }

  //public instantiation methods
  public static function MONDAY(){
    return new self(self::$monday);
  }
  //etc.


  //convert an instance to its integer value
  public function intVal(){
    return $this->intVal;
  }

}

もちろん、整数定数にアクセスすることはできません(これが実際に目的でした)。intValメソッドを使用すると、DaysOfWeekオブジェクトを整数表現に変換できます。

列挙が広く使用されている場合に備えて、インスタンス化メソッドにキャッシュメカニズムを実装してメモリを節約することで、さらに先に進むことができることに注意してください...

これが役に立てば幸い


2

ここにいくつかの良い解決策があります!

これが私のバージョンです。

  • 強く型付けされています
  • IDEオートコンプリートで動作します
  • 列挙型は、コードと説明によって定義されます。コードは、整数、バイナリ値、短い文字列、または基本的に必要なものであれば何でもかまいません。パターンは、ortherプロパティをサポートするように簡単に拡張できます。
  • 値(==)と参照(===)の比較をサポートし、switchステートメントで機能します。

主な欠点は、静的メンバー宣言時にオブジェクトを構築する記述とPHPの能力がないため、列挙型メンバーを個別に宣言してインスタンス化する必要があることです。これを回避する方法としては、代わりに解析されたdocコメントでリフレクションを使用することが考えられます。

抽象列挙型は次のようになります。

<?php

abstract class AbstractEnum
{
    /** @var array cache of all enum instances by class name and integer value */
    private static $allEnumMembers = array();

    /** @var mixed */
    private $code;

    /** @var string */
    private $description;

    /**
     * Return an enum instance of the concrete type on which this static method is called, assuming an instance
     * exists for the passed in value.  Otherwise an exception is thrown.
     *
     * @param $code
     * @return AbstractEnum
     * @throws Exception
     */
    public static function getByCode($code)
    {
        $concreteMembers = &self::getConcreteMembers();

        if (array_key_exists($code, $concreteMembers)) {
            return $concreteMembers[$code];
        }

        throw new Exception("Value '$code' does not exist for enum '".get_called_class()."'");
    }

    public static function getAllMembers()
    {
        return self::getConcreteMembers();
    }

    /**
     * Create, cache and return an instance of the concrete enum type for the supplied primitive value.
     *
     * @param mixed $code code to uniquely identify this enum
     * @param string $description
     * @throws Exception
     * @return AbstractEnum
     */
    protected static function enum($code, $description)
    {
        $concreteMembers = &self::getConcreteMembers();

        if (array_key_exists($code, $concreteMembers)) {
            throw new Exception("Value '$code' has already been added to enum '".get_called_class()."'");
        }

        $concreteMembers[$code] = $concreteEnumInstance = new static($code, $description);

        return $concreteEnumInstance;
    }

    /**
     * @return AbstractEnum[]
     */
    private static function &getConcreteMembers() {
        $thisClassName = get_called_class();

        if (!array_key_exists($thisClassName, self::$allEnumMembers)) {
            $concreteMembers = array();
            self::$allEnumMembers[$thisClassName] = $concreteMembers;
        }

        return self::$allEnumMembers[$thisClassName];
    }

    private function __construct($code, $description)
    {
        $this->code = $code;
        $this->description = $description;
    }

    public function getCode()
    {
        return $this->code;
    }

    public function getDescription()
    {
        return $this->description;
    }
}

具体的な列挙型の例を次に示します。

<?php

require('AbstractEnum.php');

class EMyEnum extends AbstractEnum
{
    /** @var EMyEnum */
    public static $MY_FIRST_VALUE;
    /** @var EMyEnum */
    public static $MY_SECOND_VALUE;
    /** @var EMyEnum */
    public static $MY_THIRD_VALUE;

    public static function _init()
    {
        self::$MY_FIRST_VALUE = self::enum(1, 'My first value');
        self::$MY_SECOND_VALUE = self::enum(2, 'My second value');
        self::$MY_THIRD_VALUE = self::enum(3, 'My third value');
    }
}

EMyEnum::_init();

これは次のように使用できます:

<?php

require('EMyEnum.php');

echo EMyEnum::$MY_FIRST_VALUE->getCode().' : '.EMyEnum::$MY_FIRST_VALUE->getDescription().PHP_EOL.PHP_EOL;

var_dump(EMyEnum::getAllMembers());

echo PHP_EOL.EMyEnum::getByCode(2)->getDescription().PHP_EOL;

そして、この出力を生成します:

1:最初の値

array(3){
[1] =>
object(EMyEnum)#1(2){
["code": "AbstractEnum":private] =>
int(1)
["description": "AbstractEnum":private] =>
string(14) "私の最初の値"
}
[2] =>
object(EMyEnum)#2(2){
["code": "AbstractEnum":private] =>
int(2)
["description": "AbstractEnum" :private] =>
string(15) "My second value"
}
[3] =>
object(EMyEnum)#3(2){
["code": "AbstractEnum":private] =>
int(3) string(14)「私の3番目の値」 } }
["説明": "AbstractEnum":private] =>


私の2番目の値


2
class DayOfWeek {
    static $values = array(
        self::MONDAY,
        self::TUESDAY,
        // ...
    );

    const MONDAY  = 0;
    const TUESDAY = 1;
    // ...
}

$today = DayOfWeek::MONDAY;

// If you want to check if a value is valid
assert( in_array( $today, DayOfWeek::$values ) );

リフレクションを使用しないでください。これは、コードについて推論し、何かが使用されている場所を追跡することを非常に困難にし、静的分析ツール(たとえば、IDEに組み込まれているもの)を破壊する傾向があります。


2

ここで他の回答のいくつかに欠けている側面の1つは、型ヒントで列挙型を使用する方法です。

enumを抽象クラスの定数のセットとして定義すると、例えば

abstract class ShirtSize {
    public const SMALL = 1;
    public const MEDIUM = 2;
    public const LARGE = 3;
}

その場合、関数のパラメータにヒントを入力することはできません。1つはインスタンス化できないためですShirtSize::SMALLint、is の型がnotであるためShirtSizeです。

これが、PHPのネイティブ列挙型が私たちが思いつくものよりもはるかに優れている理由です。ただし、列挙型の値を表すプライベートプロパティを保持し、このプロパティの初期化を事前定義された定数に制限することで、列挙型を近似できます。列挙型が(ホワイトリストの型チェックのオーバーヘッドなしで)任意にインスタンス化されるのを防ぐために、コンストラクターをプライベートにします。

class ShirtSize {
    private $size;
    private function __construct ($size) {
        $this->size = $size;
    }
    public function equals (ShirtSize $s) {
        return $this->size === $s->size;
    }
    public static function SMALL () { return new self(1); }
    public static function MEDIUM () { return new self(2); }
    public static function LARGE () { return new self(3); }
}

次にShirtSize、次のように使用できます。

function sizeIsAvailable ($productId, ShirtSize $size) {
    // business magic
}
if(sizeIsAvailable($_GET["id"], ShirtSize::LARGE())) {
    echo "Available";
} else {
    echo "Out of stock.";
}
$s2 = ShirtSize::SMALL();
$s3 = ShirtSize::MEDIUM();
echo $s2->equals($s3) ? "SMALL == MEDIUM" : "SMALL != MEDIUM";

このように、ユーザーの観点からの最大の違いは()、定数の名前に取り組む必要があるということです。

ただし、1つの欠点は、===(オブジェクトの等価性を比較する)==trueを返すときにfalseを返すことです。そのため、equalsユーザーが2つの列挙値を比較するの==ではなく使用することを覚えておく必要がないように、メソッドを提供するのが最善===です。

編集:既存の回答のいくつか、特にhttps://stackoverflow.com/a/25526473/2407870は非常に似ています


2

@Brian Clineの答えを踏んで、5セント払うと思った

<?php 
/**
 * A class that simulates Enums behaviour
 * <code>
 * class Season extends Enum{
 *    const Spring  = 0;
 *    const Summer = 1;
 *    const Autumn = 2;
 *    const Winter = 3;
 * }
 * 
 * $currentSeason = new Season(Season::Spring);
 * $nextYearSeason = new Season(Season::Spring);
 * $winter = new Season(Season::Winter);
 * $whatever = new Season(-1);               // Throws InvalidArgumentException
 * echo $currentSeason.is(Season::Spring);   // True
 * echo $currentSeason.getName();            // 'Spring'
 * echo $currentSeason.is($nextYearSeason);  // True
 * echo $currentSeason.is(Season::Winter);   // False
 * echo $currentSeason.is(Season::Spring);   // True
 * echo $currentSeason.is($winter);          // False
 * </code>
 * 
 * Class Enum
 * 
 * PHP Version 5.5
 */
abstract class Enum
{
    /**
     * Will contain all the constants of every enum that gets created to 
     * avoid expensive ReflectionClass usage
     * @var array
     */
    private static $_constCacheArray = [];
    /**
     * The value that separates this instance from the rest of the same class
     * @var mixed
     */
    private $_value;
    /**
     * The label of the Enum instance. Will take the string name of the 
     * constant provided, used for logging and human readable messages
     * @var string
     */
    private $_name;
    /**
     * Creates an enum instance, while makes sure that the value given to the 
     * enum is a valid one
     * 
     * @param mixed $value The value of the current
     * 
     * @throws \InvalidArgumentException
     */
    public final function __construct($value)
    {
        $constants = self::_getConstants();
        if (count($constants) !== count(array_unique($constants))) {
            throw new \InvalidArgumentException('Enums cannot contain duplicate constant values');
        }
        if ($name = array_search($value, $constants)) {
            $this->_value = $value;
            $this->_name = $name;
        } else {
            throw new \InvalidArgumentException('Invalid enum value provided');
        }
    }
    /**
     * Returns the constant name of the current enum instance
     * 
     * @return string
     */
    public function getName()
    {
        return $this->_name;
    }
    /**
     * Returns the value of the current enum instance
     * 
     * @return mixed
     */
    public function getValue()
    {
        return $this->_value;
    }
    /**
     * Checks whether this enum instance matches with the provided one.
     * This function should be used to compare Enums at all times instead
     * of an identity comparison 
     * <code>
     * // Assuming EnumObject and EnumObject2 both extend the Enum class
     * // and constants with such values are defined
     * $var  = new EnumObject('test'); 
     * $var2 = new EnumObject('test');
     * $var3 = new EnumObject2('test');
     * $var4 = new EnumObject2('test2');
     * echo $var->is($var2);  // true
     * echo $var->is('test'); // true
     * echo $var->is($var3);  // false
     * echo $var3->is($var4); // false
     * </code>
     * 
     * @param mixed|Enum $enum The value we are comparing this enum object against
     *                         If the value is instance of the Enum class makes
     *                         sure they are instances of the same class as well, 
     *                         otherwise just ensures they have the same value
     * 
     * @return bool
     */
    public final function is($enum)
    {
        // If we are comparing enums, just make
        // sure they have the same toString value
        if (is_subclass_of($enum, __CLASS__)) {
            return get_class($this) === get_class($enum) 
                    && $this->getValue() === $enum->getValue();
        } else {
            // Otherwise assume $enum is the value we are comparing against
            // and do an exact comparison
            return $this->getValue() === $enum;   
        }
    }

    /**
     * Returns the constants that are set for the current Enum instance
     * 
     * @return array
     */
    private static function _getConstants()
    {
        if (self::$_constCacheArray == null) {
            self::$_constCacheArray = [];
        }
        $calledClass = get_called_class();
        if (!array_key_exists($calledClass, self::$_constCacheArray)) {
            $reflect = new \ReflectionClass($calledClass);
            self::$_constCacheArray[$calledClass] = $reflect->getConstants();
        }
        return self::$_constCacheArray[$calledClass];
    }
}

どういうわけか、私はこの関数を呼び出すことができません。そのような関数は宣言されていないことを教えてくれます。私は何を間違っていますか?[別のファイルにある基本的なEnumクラスで、私はinclude('enums.php');] を使用しています。何らかの理由で、子クラスのEnumで宣言された関数が表示されません...
Andrew

また...文字列から設定する方法は?sth like$currentSeason.set("Spring");
Andrew

1

PHPを使用してenumを作成しようとしました... enum値としてオブジェクトをサポートしていないため、非常に制限されていますが、それでもいくらか便利です...

class ProtocolsEnum {

    const HTTP = '1';
    const HTTPS = '2';
    const FTP = '3';

    /**
     * Retrieve an enum value
     * @param string $name
     * @return string
     */
    public static function getValueByName($name) {
        return constant('self::'. $name);
    } 

    /**
     * Retrieve an enum key name
     * @param string $code
     * @return string
     */
    public static function getNameByValue($code) {
        foreach(get_class_constants() as $key => $val) {
            if($val == $code) {
                return $key;
            }
        }
    }

    /**
     * Retrieve associate array of all constants (used for creating droplist options)
     * @return multitype:
     */
    public static function toArray() {      
        return array_flip(self::get_class_constants());
    }

    private static function get_class_constants()
    {
        $reflect = new ReflectionClass(__CLASS__);
        return $reflect->getConstants();
    }
}

それは多くの方向に制限されており、既存の答えはそれをはるかに超えています。これは、実際に役立つものを追加するものではありません。
12

1

昨日このクラスをブログで書きました。phpスクリプトで使用するのはたぶん簡単だと思います。

final class EnumException extends Exception{}

abstract class Enum
{
    /**
     * @var array ReflectionClass
     */
    protected static $reflectorInstances = array();
    /**
     * Массив конфигурированного объекта-константы enum
     * @var array
     */
    protected static $enumInstances = array();
    /**
     * Массив соответствий значение->ключ используется для проверки - 
     * если ли константа с таким значением
     * @var array
     */
    protected static $foundNameValueLink = array();

    protected $constName;
    protected $constValue;

    /**
     * Реализует паттерн "Одиночка"
     * Возвращает объект константы, но но как объект его использовать не стоит, 
     * т.к. для него реализован "волшебный метод" __toString()
     * Это должно использоваться только для типизачии его как параметра
     * @paradm Node
     */
    final public static function get($value)
    {
        // Это остается здесь для увеличения производительности (по замерам ~10%)
        $name = self::getName($value);
        if ($name === false)
            throw new EnumException("Неизвестая константа");
        $className = get_called_class();    
        if (!isset(self::$enumInstances[$className][$name]))
        {
            $value = constant($className.'::'.$name);
            self::$enumInstances[$className][$name] = new $className($name, $value);
        }

        return self::$enumInstances[$className][$name];
    }

    /**
     * Возвращает массив констант пар ключ-значение всего перечисления
     * @return array 
     */
    final public static function toArray()
    {
        $classConstantsArray = self::getReflectorInstance()->getConstants();
        foreach ($classConstantsArray as $k => $v)
            $classConstantsArray[$k] = (string)$v;
        return $classConstantsArray;
    }

    /**
     * Для последующего использования в toArray для получения массива констант ключ->значение 
     * @return ReflectionClass
     */
    final private static function getReflectorInstance()
    {
        $className = get_called_class();
        if (!isset(self::$reflectorInstances[$className]))
        {
            self::$reflectorInstances[$className] = new ReflectionClass($className);
        }
        return self::$reflectorInstances[$className];
    }

    /**
     * Получает имя константы по её значению
     * @param string $value
     */
    final public static function getName($value)
    {
        $className = (string)get_called_class();

        $value = (string)$value;
        if (!isset(self::$foundNameValueLink[$className][$value]))
        {
            $constantName = array_search($value, self::toArray(), true);
            self::$foundNameValueLink[$className][$value] = $constantName;
        }
        return self::$foundNameValueLink[$className][$value];
    }

    /**
     * Используется ли такое имя константы в перечислении
     * @param string $name
     */
    final public static function isExistName($name)
    {
        $constArray = self::toArray();
        return isset($constArray[$name]);
    }

    /**
     * Используется ли такое значение константы в перечислении
     * @param string $value
     */
    final public static function isExistValue($value)
    {
        return self::getName($value) === false ? false : true;
    }   


    final private function __clone(){}

    final private function __construct($name, $value)
    {
        $this->constName = $name;
        $this->constValue = $value;
    }

    final public function __toString()
    {
        return (string)$this->constValue;
    }
}

使用法:

class enumWorkType extends Enum
{
        const FULL = 0;
        const SHORT = 1;
}

2
しかし、それは良いクラスであり、関数名はネイティブです。また、translate.google.ruも役立ちます。
Arturgspb

2
Chromeの人を使って翻訳してください。プログラマーであれば、コードを読んでください!
マーカス2011年

8
一般的に、それはむしろ、などまたは月/年での「n」があってもなくてもよい外部リソースへのリンクよりも、答えの中にコードを含めることは常に良いでしょう
ジョン・パーカー

私のクラスはとても大きいので、この投稿を読むのは不便だと思います。
Arturgspb 2011年

私はここで2つの悪い点を考えます:それはロシア語です(すべてのプログラマは英語を知っていて、コメントでもそれを使用する必要があります)&ここには含まれていません。巨大なコードを含める方法のヘルプを参照してください。
gaRex
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.