PHP et énumérations


1149

Je sais que PHP n'a pas d'énumérations natives. Mais je m'y suis habitué du monde Java. J'adorerais utiliser les énumérations comme un moyen de donner des valeurs prédéfinies que les fonctionnalités de complétion automatique des IDE pourraient comprendre.

Les constantes font l'affaire, mais il y a le problème de collision de l'espace de noms et (ou en fait parce qu'elles) sont globales. Les tableaux n'ont pas le problème d'espace de noms, mais ils sont trop vagues, ils peuvent être écrasés lors de l'exécution et les IDE savent rarement (jamais?) Comment remplir automatiquement leurs clés.

Y a-t-il des solutions / solutions de contournement que vous utilisez couramment? Est-ce que quelqu'un se souvient si les gars de PHP ont eu des pensées ou des décisions concernant les énumérations?



1
J'ai créé une fonction de contournement qui énumère les constantes au niveau du bit ou non. Je n'ai pas remarqué que vous avez posé cette question auparavant, mais j'ai une meilleure solution que les variables de classe ici: stackoverflow.com/questions/3836385/…
NoodleOfDeath


Cela vous dérange de partager un peu plus sur le problème des constantes? "Les constantes font l'affaire, mais il y a le problème de collision de l'espace de noms et (ou en fait parce qu'elles) sont globales."
XuDing

Réponses:


1492

Selon le cas d'utilisation, j'utiliserais normalement quelque chose de simple comme le suivant:

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

$today = DaysOfWeek::Sunday;

Cependant, d'autres cas d'utilisation peuvent nécessiter plus de validation des constantes et des valeurs. Sur la base des commentaires ci-dessous sur la réflexion, et quelques autres notes , voici un exemple étendu qui pourrait mieux servir un éventail beaucoup plus large de cas:

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);
    }
}

En créant une classe d'énumération simple qui étend BasicEnum, vous avez désormais la possibilité d'utiliser des méthodes pour une validation d'entrée simple:

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

En remarque, chaque fois que j'utilise la réflexion au moins une fois sur une classe statique / const où les données ne changeront pas (comme dans une énumération), je mets en cache les résultats de ces appels de réflexion, car en utilisant à chaque fois de nouveaux objets de réflexion aura éventuellement un impact notable sur les performances (stocké dans un tableau associatif pour plusieurs énumérations).

Maintenant que la plupart des gens sont enfin passés à au moins 5.3 et SplEnumsont disponibles, c'est certainement une option viable également - tant que cela ne vous dérange pas la notion traditionnellement peu intuitive d'avoir des instanciations d' énumération réelles dans votre base de code. Dans l'exemple ci-dessus, BasicEnumet DaysOfWeekne peuvent pas du tout être instanciés, ni ne devraient l'être.


70
J'utilise ça aussi. Vous pouvez également envisager de créer la classe abstractet final, donc elle ne peut pas être instanciée ou étendue.
ryeguy

21
Vous pouvez faire un cours à la fois abstractet final? Je sais qu'en Java, ce n'est pas autorisé. Vous pouvez le faire en php?
corsiKa

20
@ryeguy Il semble que vous ne puissiez pas faire les deux abstract et final. Dans ce cas, je choisirais l'abstrait.
Nicole

45
À propos de résumé ou final; Je les rend définitifs et je leur donne un constructeur privé vide
rael_kid

21
Soyez prudent avec l'utilisation de 0, afin de ne pas rencontrer de problèmes de comparaison de fausseté imprévus, par exemple l'équivalence avec nullet amis dans une switchdéclaration. Été là.
yitznewton

185

Il existe également une extension native. Le SplEnum

SplEnum donne la possibilité d'émuler et de créer des objets d'énumération nativement en PHP.

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

Attention:

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

L'extension PECL n'est pas fournie avec PHP.

Une DLL pour cette extension PECL est actuellement indisponible.


4
Voici un exemple avec splenum: dreamincode.net/forums/topic/201638-enum-in-php
Nordes

4
J'ai reculé, je l'aime mieux quand je peux voir le lien. Cela me donne des informations contextuelles.
markus

5
J'ai reculé à nouveau. Je ne veux pas que vous éditiez le lien.
markus

6
Soyez prudent en utilisant cela. Les types SPL sont expérimentaux: "Cette extension est EXPERIMENTALE. Le comportement de cette extension, y compris les noms de ses fonctions et toute autre documentation entourant cette extension, peut changer sans préavis dans une future version de PHP. Cette extension doit être utilisée à vos propres risques. "
bzeaman

6
SplEnum n'est pas fourni avec PHP, il a besoin de l' extension
SPL_Types

46

Et les constantes de classe?

<?php

class YourClass
{
    const SOME_CONSTANT = 1;

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

echo YourClass::SOME_CONSTANT;

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

Je préfère cette approche simple
David Lemon

echoConstantpeut être remplacé par __toString. Et puis simplementecho $c
Justinas

35

La meilleure réponse ci-dessus est fantastique. Cependant, si vous extendle faites de deux manières différentes, quelle que soit l'extension effectuée en premier, un appel aux fonctions créera le cache. Ce cache sera ensuite utilisé par tous les appels suivants, quelle que soit l'extension par laquelle les appels sont lancés ...

Pour résoudre ce problème, remplacez la variable et la première fonction par:

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
Eu ce problème même. Brian ou une personne disposant de privilèges de modification devrait en parler dans la réponse acceptée. Je l'ai résolu dans mon code en utilisant la méthode 'static ::' au lieu de 'self ::' dans la fonction getConstants () et en re-déclarant le $ constCache dans les énumérations enfants.
Sp3igel

Ce n'est peut-être pas sexy, mais utiliser une constante d'interface peut être la meilleure façon de procéder en PHP.
Anthony Rutledge

27

J'ai utilisé des classes avec des constantes:

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

print Enum::NAME;

27

J'utilise à la interfaceplace de class:

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

var $today = DaysOfWeek::Sunday;

6
class Foo implements DaysOfWeek { }et puis Foo::Sunday... quoi?
Dan Lugg

3
L'auteur de la question demande une solution pour deux choses: l'espace de noms et l'auto-complétion par les IDE. Comme le suggère la réponse la mieux notée, la manière la plus simple consiste à utiliser class(ou interface, ce qui n'est qu'une question de préférence).
Andi T

4
les interfaces sont utilisées pour renforcer l'intégrité de l'implémentation de classe, cela est hors de la portée d'une interface
user3886650

2
@ user3886650 Les interfaces peuvent et ont été / sont utilisées en Java pour conserver des valeurs constantes. Vous n'êtes donc pas obligé d'instancier une classe uniquement pour obtenir des valeurs constantes et n'importe quel IDE propose la complétion de code sur elles. De plus, si vous créez une classe qui implémente cette interface, elle héritera de toutes ces constantes - assez pratique parfois.
Alex

@ user3886650 Vrai, mais en PHP, les interfaces peuvent avoir des constantes. En outre, ces constantes d'interface ne peuvent pas être remplacées par l'implémentation de classes ou de leurs enfants. En effet, c'est la meilleure réponse en termes de PHP, car tout ce qui peut être remplacé ne fonctionne pas vraiment comme une constante. Constante devrait signifier constante, pas parfois (même si le polymorphisme peut parfois être utile).
Anthony Rutledge le

25

J'ai commenté certaines des autres réponses ici, alors je me suis dit que j'allais aussi peser. En fin de compte, étant donné que PHP ne prend pas en charge les énumérations typées, vous pouvez suivre l'une des deux méthodes suivantes: pirater les énumérations typées ou vivre avec le fait qu'elles sont extrêmement difficiles à pirater efficacement.

Je préfère vivre avec le fait et utiliser à la place le const méthode que d'autres réponses ont utilisée ici d'une manière ou d'une autre:

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());
    }

}

Un exemple d'énumération:

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;

}

En utilisant Enumcomme une classe de base à partir de laquelle toutes les autres énumérations étendent permet des méthodes d'aide, tels que toArray, isValidet ainsi de suite. Pour moi, les énumérations tapées ( et la gestion de leurs instances ) se retrouvent trop compliquées.


Hypothétique

Si , il existait une __getStaticméthode magique ( et de préférence aussi une __equalsméthode magique ), une grande partie de cela pourrait être atténuée avec une sorte de modèle multiton.

( Ce qui suit est hypothétique; cela ne fonctionnera pas , mais peut-être qu'un jour ça le sera )

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

J'aime vraiment la simplicité de cette réponse. C'est le genre de chose à laquelle vous pouvez revenir plus tard et comprendre rapidement comment cela fonctionne sans donner l'impression que vous avez fait une sorte d'approche piratée. Dommage qu'il n'ait pas plus de votes positifs.
Reactgular

23

Eh bien, pour un simple java comme enum en php, j'utilise:

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];
    }
}

Et pour l'appeler:

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

Mais je suis un débutant PHP, aux prises avec la syntaxe, donc ce n'est peut-être pas la meilleure façon. J'en ai expérimenté quelques-unes avec les constantes de classe, en utilisant la réflexion pour obtenir le nom de la constante à partir de sa valeur, peut-être plus propre.


Bonne réponse, la plupart des autres réponses utilisent des classes. Cependant, vous ne pouvez pas avoir de classes imbriquées.
Keyo

Cela a l'avantage de pouvoir parcourir les valeurs avec foreach. Et au détriment qu'une valeur illégale n'est pas capturée.
Bob Stein

2
Pas de complétion automatique dans l'IDE, donc cela stimulerait les devinettes. Les constantes permettraient la complétion automatique, sonne mieux.
KrekkieD

19

Quatre ans plus tard, je suis tombé à nouveau sur ce sujet. Mon approche actuelle est la suivante, car elle permet l'achèvement du code dans l'IDE ainsi que la sécurité des types:

Classe de base:

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;
    }
}

Exemple d'énumération:

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); }      
}

Exemple d'utilisation:

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');

Notez que toutes les instances de la même entrée d'énumération sont identiques:

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

Vous pouvez également l'utiliser dans une instruction switch:

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

Vous pouvez également créer une entrée d'énumération par nom ou valeur:

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

Ou vous pouvez simplement obtenir le nom (c'est-à-dire le nom de la fonction) à partir d'une entrée d'énumération existante:

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

+1 pour un constructeur privé. Je ne ferais pas de classe abstraite d'aide, juste une classe simple, un constructeur privé et certainsconst Monday = DaysOfWeek('Monday');
Kangur

9

J'ai trouvé cette bibliothèque sur github et je pense qu'elle fournit une alternative très décente aux réponses ici.

Implémentation de PHP Enum inspirée de SplEnum

  • Vous pouvez saisir un indice: function setAction(Action $action) {
  • Vous pouvez enrichir l'énumération avec des méthodes (par exemple format,parse ...)
  • Vous pouvez étendre l'énumération pour ajouter de nouvelles valeurs (faites votre énumération finalpour l'empêcher)
  • Vous pouvez obtenir une liste de toutes les valeurs possibles (voir ci-dessous)

Déclaration

<?php
use MyCLabs\Enum\Enum;

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

Usage

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

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

valeurs d'énumération type-hint:

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

1
C'est la bonne réponse (pour l'instant, jusqu'à ce que enumsoit ajouté en PHP 7.x) car elle permet l'indication de type.
Tobia

1
Non seulement __toString()cela permet d'indiquer le type, mais en raison de la magie, cela vous permet de faire ce que vous voulez généralement avec les énumérations - utilisez-les dans une instruction switchor if, en comparant directement avec les valeurs des consts. IMO est la meilleure approche en dehors du support de l'énumération native.
LinusR

7

Si vous devez utiliser des énumérations globalement uniques (c'est-à-dire même lorsque vous comparez des éléments entre des énumérations différentes) et faciles à utiliser, n'hésitez pas à utiliser le code suivant. J'ai également ajouté quelques méthodes que je trouve utiles. Vous trouverez des exemples dans les commentaires tout en haut du code.

<?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
J'aime beaucoup ça. Cependant, l'une des principales plaintes est la capacité de l'EDI à récupérer les valeurs pour la saisie semi-automatique. Je ne suis pas sûr que cela serait possible sans un addon personnalisé pour l'IDE. Non pas que cela ne pouvait pas être fait, cela prendrait juste un peu de travail.
corsiKa

2
En utilisant eval()juste pour que vous pouvez déclarer de nouvelles énumérations exécution? Eek. Je ne le sens pas. Comment empêchez-vous d'autres classes de créer une classe Enum incorrecte avant de définir la bonne? Les Enums ne sont-ils pas connus avant l'exécution? Et comme @corsiKa l'a laissé entendre, aucune autocomplétion IDE. Le seul avantage que je vois est le codage paresseux.
KrekkieD

7

J'aime aussi les énumérations de Java et pour cette raison, j'écris mes énumérations de cette manière, je pense que c'est le comportement le plus similaire à celui de Java, bien sûr, si certains veulent utiliser plus de méthodes de Java, écrivez-le ici, ou dans classe abstraite mais l'idée principale est intégrée dans le code ci-dessous


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
Je fais à peu près la même chose, avec deux petits ajouts cependant: j'ai caché les valeurs statiques derrière les getters statiques. L' une des raisons est que je préfère visuellement FruitsEnum::Apple()plus FruitsEnum::$Apple, mais la raison la plus importante est d'empêcher quiconque de cadre $APPLE, brisant ainsi le ENUM pour toute l'application. L'autre est un simple indicateur statique privé $initializedqui garantit que l'appel init()devient non-op après l'avoir appelé pour la première fois (donc personne ne peut jouer avec ça non plus).
Martin Ender

J'ai aimé Martin. .init()est bizarre, et ça ne me dérange pas l'approche getter.
Sebas

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

La solution la plus courante que j'ai vue pour les énumérations en PHP a été de créer une classe d'énumération générique, puis de l'étendre. Vous pouvez jeter un oeil à ce .

MISE À JOUR: Alternativement, j'ai trouvé cela sur phpclasses.org.


1
Bien que l'implémentation soit simple et ferait probablement l'affaire, l'inconvénient est que les IDE ne savent probablement pas comment remplir automatiquement les énumérations. Je n'ai pas pu inspecter celui de phpclasses.org, car il voulait que je m'enregistre.
Henrik Paul

5

Voici une bibliothèque github pour gérer les énumérations de type sécurisé en php:

Cette bibliothèque gère la génération de classes, la mise en cache des classes et implémente le modèle de conception Type Safe Enumeration, avec plusieurs méthodes d'assistance pour traiter les énumérations, comme la récupération d'un ordinal pour le tri des énumérations ou la récupération d'une valeur binaire, pour les combinaisons d'énumérations.

Le code généré utilise un ancien fichier de modèle PHP simple, qui est également configurable, afin que vous puissiez fournir votre propre modèle.

C'est un test complet recouvert de phpunit.

php-enums sur github (n'hésitez pas à bifurquer)

Utilisation: (@see usage.php, ou tests unitaires pour plus de détails)

<?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";
}

Production:

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

J'ai pris l'habitude d'utiliser l'approche ci-dessous car elle me donne la possibilité d'avoir une sécurité de type pour les paramètres de fonction, une saisie automatique dans NetBeans et de bonnes performances. La seule chose que je n'aime pas trop, c'est que vous devez appeler [extended class name]::enumerate();après avoir défini la classe.

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");

Rien ne vous empêche de redéfinir les valeurs d'énumération:DaysOfWeek::$MONDAY = 3;
KrekkieD

@BrianFisher, je sais que c'est un peu tard maintenant, mais, si vous n'aimez pas appeler [extended class name]::enumerate();après la définition, pourquoi ne le faites-vous pas dans la construction?
Can O 'Spam

4

Ma définition de classe Enum ci-dessous est fortement typée et très naturelle à utiliser et à définir.

Définition:

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

Basculer sur Enum

$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

Passez Enum comme paramètre (fortement tapé)

/** 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

Echo Enum sous forme de chaîne

echo "I have an $myFruit\n";

>> I have an APPLE

Obtenez Enum par entier

$myFruit = Fruit::getByValue(2);

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

>> Now I have an ORANGE

Obtenez Enum par nom

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

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

>> But I definitely prefer an APPLE

La classe 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;
    }

}

Une addition

Vous pouvez bien sûr également ajouter des commentaires pour les 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

Je me rends compte que c'est un fil très, très, très ancien, mais j'y ai réfléchi et je voulais savoir ce que les gens pensaient.

Notes: Je jouais avec cela et j'ai réalisé que si je venais de modifier la __call()fonction, vous pouvez vous rapprocher encore plus de la réalité enums. La __call()fonction gère tous les appels de fonction inconnus. enumsSupposons donc que vous souhaitiez créer trois RED_LIGHT, YELLOW_LIGHT et GREEN_LIGHT. Vous pouvez le faire maintenant en procédant simplement comme suit:

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

Une fois définis, il vous suffit de les rappeler pour obtenir les valeurs:

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

et vous devriez obtenir 0, 1 et 2. Amusez-vous! C'est également maintenant sur GitHub.

Mise à jour: je l'ai fait pour que les fonctions __get()et __set()soient maintenant utilisées. Ceux-ci vous permettent de ne pas avoir à appeler une fonction à moins que vous ne le souhaitiez. Au lieu de cela, maintenant vous pouvez simplement dire:

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

Pour la création et l'obtention des valeurs. Parce que les variables n'ont pas été définies initialement, la __get()fonction est appelée (car il n'y a pas de valeur spécifiée) qui voit que l'entrée dans le tableau n'a pas été effectuée. Il effectue donc l'entrée, lui attribue la dernière valeur donnée plus un (+1), incrémente la dernière variable de valeur et renvoie VRAI. Si vous définissez la valeur:

$c->RED_LIGHT = 85;

Puis le __set() fonction est appelée et la dernière valeur est ensuite définie sur la nouvelle valeur plus un (+1). Alors maintenant, nous avons un assez bon moyen de faire des énumérations et elles peuvent être créées à la volée.

<?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

Je sais que c'est un vieux fil, mais aucune des solutions de contournement que j'ai vues ne ressemblait vraiment à des énumérations, car presque toutes les solutions de contournement vous obligent à attribuer manuellement des valeurs aux éléments d'énumération, ou vous obligent à passer un tableau de clés d'énumération à un une fonction. J'ai donc créé ma propre solution pour cela.

Pour créer une classe enum en utilisant ma solution, on peut simplement étendre cette classe Enum ci-dessous, créer un tas de variables statiques (pas besoin de les initialiser), et faire un appel à yourEnumClass :: init () juste en dessous de la définition de votre classe enum .

edit: Cela ne fonctionne que dans php> = 5.3, mais il peut probablement être modifié pour fonctionner également dans les anciennes versions

/**
 * 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

Vous pouvez maintenant utiliser la classe SplEnum pour la créer en mode natif. Selon la documentation officielle.

SplEnum donne la possibilité d'émuler et de créer des objets d'énumération nativement en 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;
}
?>

Veuillez noter qu'il s'agit d'une extension qui doit être installée, mais qui n'est pas disponible par défaut. Qui relève des types spéciaux décrits dans le site Web php lui-même. L'exemple ci-dessus est tiré du site PHP.


3

Enfin, une réponse PHP 7.1+ avec des constantes qui ne peuvent pas être remplacées.

/**
 * 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.
}

Si vous utilisez des espaces de noms, la complétion de code devrait fonctionner.

Cependant, ce faisant, vous perdez la possibilité de masquer les constantes au sein de la famille de classes ( protected) ou de la classe seule ( private). Par définition, tout dans un Interfaceestpublic .

Manuel PHP: Interfaces


Ce n'est pas Java. Cela fonctionne dans les cas où le modèle de polymorphisme / stratégie n'est pas requis pour remplacer les constantes dans une classe parente.
Anthony Rutledge le

2

Ceci est mon point de vue sur l'énumération "dynamique" ... afin que je puisse l'appeler avec des variables, ex. à partir d'un formulaire.

regardez la version mise à jour sous ce bloc de code ...

$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);
    }
}

MISE À JOUR: Meilleure façon de le faire ...

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;

}

Appeler avec

EnumCategory::${$category};

5
Le problème avec cet être; EnumCategory::$sport = 9;. Bienvenue au musée du sport. const est la meilleure façon de le faire.
Dan Lugg

2

La réponse acceptée est la voie à suivre et est en fait ce que je fais pour plus de simplicité. La plupart des avantages de l'énumération sont offerts (lisibles, rapides, etc.). Un concept manque cependant: la sécurité de type. Dans la plupart des langues, les énumérations sont également utilisées pour restreindre les valeurs autorisées. Voici un exemple de la façon dont la sécurité de type peut également être obtenue en utilisant des constructeurs privés, des méthodes d'instanciation statique et une vérification de type:

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());

On pourrait même aller plus loin: l'utilisation de constantes dans la classe DaysOfWeek pourrait conduire à une mauvaise utilisation: par exemple, on pourrait l'utiliser à tort de cette façon:

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

ce qui est faux (appelle constante entière). Nous pouvons éviter cela en utilisant des variables statiques privées au lieu de constantes:

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;
  }

}

Bien sûr, il n'est pas possible d'accéder aux constantes entières (c'était en fait le but). La méthode intVal permet de convertir un objet DaysOfWeek en sa représentation entière.

Notez que nous pourrions même aller plus loin en implémentant un mécanisme de mise en cache dans les méthodes d'instanciation pour économiser de la mémoire dans le cas où les énumérations sont largement utilisées ...

J'espère que cela vous aidera


2

Quelques bonnes solutions ici!

Voici ma version.

  • C'est fortement tapé
  • Cela fonctionne avec l'auto-complétion IDE
  • Les énumérations sont définies par un code et une description, où le code peut être un entier, une valeur binaire, une chaîne courte ou essentiellement tout ce que vous voulez. Le motif pourrait facilement être étendu pour prendre en charge d'autres propriétés.
  • Il prend en charge les comparaisons de valeur (==) et de référence (===) et fonctionne dans les instructions switch.

Je pense que le principal inconvénient est que les membres enum doivent être déclarés et instanciés séparément, en raison des descriptions et de l'incapacité de PHP à construire des objets au moment de la déclaration de membre statique. J'imagine qu'un moyen de contourner cela pourrait être d'utiliser la réflexion avec des commentaires de doc analysés à la place.

L'énumération abstraite ressemble à ceci:

<?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;
    }
}

Voici un exemple d'énumération concrète:

<?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();

Qui peut être utilisé comme ceci:

<?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;

Et produit cette sortie:

1: Ma première valeur

array (3) {
[1] =>
object (EMyEnum) # 1 (2) {
["code": "AbstractEnum": private] =>
int (1)
["description": "AbstractEnum": private] =>
string (14) "My first value"
}
[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)
["description": "AbstractEnum": private] =>
string (14) "Ma troisième valeur"
}
}

Ma deuxième valeur


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 ) );

N'utilisez pas la réflexion. Cela rend extrêmement difficile de raisonner sur votre code et de localiser où quelque chose est utilisé, et a tendance à casser les outils d'analyse statique (par exemple ce qui est intégré à votre IDE).


2

L'un des aspects manquant dans certaines des autres réponses ici est une façon d'utiliser les énumérations avec des indications de type.

Si vous définissez votre énumération comme un ensemble de constantes dans une classe abstraite, par exemple

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

alors vous ne pouvez pas taper hint it dans un paramètre de fonction - pour un, parce qu'il n'est pas instanciable, mais aussi parce que le type de ShirtSize::SMALLest int, non ShirtSize.

C'est pourquoi les énumérations natives en PHP seraient bien meilleures que tout ce que nous pouvons trouver. Cependant, nous pouvons approximer une énumération en conservant une propriété privée qui représente la valeur de l'énumération, puis en restreignant l'initialisation de cette propriété à nos constantes prédéfinies. Pour éviter que l'énumération soit instanciée arbitrairement (sans la surcharge de vérification de type d'une liste blanche), nous rendons le constructeur privé.

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); }
}

Ensuite, nous pouvons utiliser ShirtSizecomme ceci:

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";

De cette façon, la plus grande différence du point de vue de l'utilisateur est que vous devez virer de bord sur ()le nom de la constante.

Cependant, un inconvénient est que ===(qui compare l'égalité des objets) retournera false lorsqu'il ==retourne true. Pour cette raison, il est préférable de fournir une equalsméthode, afin que les utilisateurs n'aient pas à se rappeler d'utiliser ==et de ne ===pas comparer deux valeurs d'énumération.

EDIT: Quelques réponses existantes sont très similaires, en particulier: https://stackoverflow.com/a/25526473/2407870 .


2

En marchant sur la réponse de @Brian Cline, je pensais que je pourrais donner mes 5 cents

<?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];
    }
}

pour une raison quelconque, je ne peux pas appeler cette fonction. Cela me dit que de telles fonctions ne sont pas déclarées. Qu'est-ce que je fais mal? [classe Enum de base située dans un autre fichier et j'utilise include('enums.php');]. Pour une raison quelconque, il ne voit pas les fonctions déclarées dans Enum pour les classes enfants ...
Andrew

Aussi ... comment le définir à partir d'une chaîne? qqh comme$currentSeason.set("Spring");
Andrew

1

Ma tentative de créer une énumération avec PHP ... est extrêmement limitée car elle ne prend pas en charge les objets en tant que valeurs d'énumération, mais reste quelque peu utile ...

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();
    }
}

il est limité dans de nombreuses directions et les réponses existantes en offrent beaucoup plus. Je dirais que cela n'ajoute rien d'utile.
hakre

1

Hier, j'ai écrit ce cours sur mon blog . Je pense que c'est peut-être facile à utiliser dans les scripts 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;
    }
}

Usage:

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

2
Mais c'est une bonne classe et le nom des fonctions est natif. Et translate.google.ru peut aussi aider.
Arturgspb

2
Utilisez les gars de chrome et traduisez-le, si vous êtes programmeurs, vous lisez le code!
Markus

8
En général, il est toujours préférable d'inclure le code dans la réponse, plutôt que de créer un lien vers une ressource externe qui peut ou non être présente dans 'n' mois / années, etc.
John Parker

Ma classe est si grande et je pense que la lecture de ce post sera gênante.
Arturgspb

Je pense que deux mauvaises choses ici: c'est en russe (chaque programmeur doit connaître l'anglais et l'utiliser, même dans les commentaires) & ce n'est pas inclus ici. Voir l'aide pour inclure un code énorme.
gaRex
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.