it-swarm.com.de

PHP und Aufzählungen

Ich weiß, dass PHP keine nativen Aufzählungen hat. Aber ich habe mich an sie aus der Java Welt gewöhnt. Ich würde gerne Aufzählungen verwenden, um vordefinierte Werte anzugeben, die die automatischen Vervollständigungsfunktionen von IDEs verstehen könnten.

Konstanten machen den Trick, aber es gibt das Namespace-Kollisionsproblem und (oder tatsächlich weil) sie sind global. Arrays haben zwar kein Namespace-Problem, sind aber zu vage, können zur Laufzeit überschrieben werden und IDEs können ihre Schlüssel nur selten (nie?) Automatisch ausfüllen.

Gibt es Lösungen/Problemumgehungen, die Sie häufig verwenden? Erinnert sich jemand, ob die PHP Leute irgendwelche Gedanken oder Entscheidungen bezüglich der Aufzählungen hatten?

1094
Henrik Paul

Abhängig vom Anwendungsfall würde ich normalerweise etwas Einfaches wie das Folgende verwenden:

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

$today = DaysOfWeek::Sunday;

Andere Anwendungsfälle erfordern jedoch möglicherweise eine genauere Validierung von Konstanten und Werten. Basierend auf den Kommentaren über Reflexion und ein paar andere Anmerkungen ist hier ein erweitertes Beispiel, das einen viel breiteren Bereich von Fällen besser bedienen kann:

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

Durch das Erstellen einer einfachen Enum-Klasse, die BasicEnum erweitert, können Sie jetzt Methoden für die einfache Eingabevalidierung verwenden:

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

Als Randnotiz: Ich benutze jedes Mal mindestens eine Reflektion für eine statische/const-Klasse, bei der sich die Daten nicht ändern (wie in einer Aufzählung) ), Ich habe die Ergebnisse dieser Reflection-Aufrufe zwischengespeichert, da die Verwendung neuer Reflection-Objekte jedes Mal eine spürbare Auswirkung auf die Leistung hat (in einem assoziativen Array für mehrere Aufzählungen gespeichert).

Jetzt, da die meisten Leute endlich auf mindestens 5.3 aktualisiert haben und SplEnum verfügbar ist, ist dies sicherlich auch eine praktikable Option solange es Ihnen nichts ausmacht, die traditionell unintuitive Vorstellung zu haben, tatsächliche Enum-Instanzen in Ihrer Codebasis zu haben. Im obigen Beispiel können BasicEnum und DaysOfWeek überhaupt nicht instanziiert werden und sollten es auch nicht sein.

1433
Brian Cline

Es gibt auch eine native Erweiterung. Das SplEnum

SplEnum bietet die Möglichkeit, Aufzählungsobjekte nativ in PHP zu emulieren und zu erstellen.

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

174
markus

Was ist mit Klassenkonstanten?

<?php

class YourClass
{
    const SOME_CONSTANT = 1;

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

echo YourClass::SOME_CONSTANT;

$c = new YourClass;
$c->echoConstant();
44
Peter Bailey

Die Antwort oben ist fantastisch. Wenn Sie es jedoch auf zwei verschiedene Arten extend, dann führt jede Erweiterung, die zuerst ausgeführt wird, zu einem Aufruf der Funktionen, die den Cache erstellen. Dieser Cache wird dann von allen nachfolgenden Aufrufen verwendet, unabhängig davon, von welcher Nebenstelle die Aufrufe initiiert werden ...

Um dies zu lösen, ersetzen Sie die Variable und die erste Funktion durch:

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];
}
34
Neil Townsend

Ich verwende interface anstelle von class:

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

var $today = DaysOfWeek::Sunday;
28
Andi T

Ich habe Klassen mit Konstanten verwendet:

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

print Enum::NAME;
26
andy.gurin

Ich habe einige der anderen Antworten hier kommentiert, so dass ich dachte, ich würde auch wiegen. Da PHP keine typisierten Aufzählungen unterstützt, können Sie zwei Möglichkeiten wählen: typisierte Aufzählungen hacken oder damit leben, dass es extrem schwierig ist, sie effektiv zu hacken .

Ich lebe lieber mit der Tatsache und verwende stattdessen die const -Methode, die andere Antworten hier auf die eine oder andere Weise verwendet haben:

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

}

Eine beispielhafte Aufzählung:

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;

}

Die Verwendung von Enum als Basisklasse, von der alle anderen Aufzählungen ausgehen, ermöglicht Hilfsmethoden wie toArray, isValid und so weiter. Für mich sind getippte Aufzählungen ( und das Verwalten ihrer Instanzen einfach zu chaotisch.


Hypothetisch

If, es gab eine __getStatic -Zaubermethode ( und vorzugsweise auch eine __equals -Zaubermethode ) Vieles davon könnte mit einer Art Multiton-Muster gemildert werden.

( Das Folgende ist hypothetisch; es wird nicht funktionieren, obwohl es vielleicht eines Tages funktionieren wird )

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
24
Dan Lugg

Nun, für ein einfaches Java wie Enum in PHP verwende ich:

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

Und um es zu nennen:

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

Aber ich bin ein PHP Anfänger, der mit der Syntax kämpft, so dass dies möglicherweise nicht der beste Weg ist. Ich habe einige mit Klassenkonstanten experimentiert. Die Verwendung von Reflection, um den Namen der Konstanten aus ihrem Wert zu ermitteln, ist möglicherweise sinnvoller.

23
aelg

Vier Jahre später bin ich wieder darauf gestoßen. Mein aktueller Ansatz ist dieser, da er die Code-Vervollständigung in der IDE sowie die Typensicherheit ermöglicht:

Basisklasse:

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

Beispiel Aufzählung:

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

Beispielverwendung:

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

Beachten Sie, dass alle Instanzen desselben Enum-Eintrags identisch sind:

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

Sie können es auch innerhalb einer switch-Anweisung verwenden:

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

Sie können auch einen Aufzählungseintrag nach Name oder Wert erstellen:

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

Oder Sie können den Namen (d. H. Den Funktionsnamen) einfach aus einem vorhandenen Enum-Eintrag abrufen:

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

Ich fand diese Bibliothek auf Github und ich denke, es bietet eine sehr anständige Alternative zu den Antworten hier.

Die Implementierung von PHP Enum wurde von SplEnum inspiriert

  • Sie können Folgendes eingeben: function setAction(Action $action) {
  • Sie können die Aufzählung mit Methoden anreichern (z. B. format, parse,…).
  • Sie können die Aufzählung erweitern, um neue Werte hinzuzufügen (machen Sie Ihre Aufzählung final, um dies zu verhindern).
  • Sie können eine Liste aller möglichen Werte erhalten (siehe unten)

Erklärung

<?php
use MyCLabs\Enum\Enum;

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

Verwendungszweck

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

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

typ-Hinweis-Aufzählungswerte:

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

Wenn Sie Aufzählungen verwenden müssen, die global eindeutig sind (d. H. Wenn Sie Elemente zwischen verschiedenen Aufzählungen vergleichen) und die einfach zu verwenden sind, können Sie den folgenden Code verwenden. Ich habe auch einige Methoden hinzugefügt, die ich nützlich finde. Beispiele finden Sie in den Kommentaren ganz oben im Code.

<?php

/**
 * Class Enum
 * 
 * @author Christopher Fox <[email protected]>
 *
 * @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";
    }

}


?>
7
Christopher Fox

Ich mag auch Aufzählungen von Java und aus diesem Grund schreibe ich meine Aufzählungen auf diese Weise, ich denke, dies ist das ähnlichste Verhalten wie in Java Aufzählungen, natürlich, wenn einige es wollen Verwenden Sie mehr Methoden von Java, schreiben Sie sie hier oder in einer abstrakten Klasse, aber die Kernidee ist in den folgenden Code eingebettet


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

7
user667540

Die häufigste Lösung, die ich in PHP für enum gesehen habe, war, eine generische enum-Klasse zu erstellen und sie dann zu erweitern. Sie könnten einen Blick auf this werfen.

AKTUALISIEREN: Alternativ habe ich this von phpclasses.org gefunden.

5
Noah Goodrich

Es könnte so einfach sein wie

enum DaysOfWeek {
    Sunday,
    Monday,
    // ...
}

in der Zukunft.

PHP RFC: Enumerated Types

5
mykhal
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
jglatre

Hier ist eine Github-Bibliothek für den Umgang mit typsicheren Enumerationen in PHP:

Diese Bibliothek verwaltet die Generierung von Klassen und das Zwischenspeichern von Klassen und implementiert das Entwurfsmuster Type Safe Enumeration mit verschiedenen Hilfsmethoden für den Umgang mit Aufzählungen, z. B. das Abrufen einer Ordnungszahl zum Sortieren von Aufzählungen oder das Abrufen eines Binärwerts für Aufzählungskombinationen.

Der generierte Code verwendet eine einfache alte PHP-Vorlagendatei, die ebenfalls konfigurierbar ist, sodass Sie Ihre eigene Vorlage bereitstellen können.

Es ist ein vollständiger Test, der mit phpunit abgedeckt ist.

PHP-Enums auf Github (Fühlen Sie sich frei zu gabeln)

Verwendung: (@see usage.php oder Unit-Tests für weitere Details)

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

Ausgabe:

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
5
zanshine

Ich habe mich für den folgenden Ansatz entschieden, da ich dadurch die Möglichkeit habe, die Sicherheit der Funktionseinstellungen zu gewährleisten, in NetBeans automatisch zu vervollständigen und eine gute Leistung zu erzielen. Das einzige, was ich nicht besonders mag, ist, dass Sie [extended class name]::enumerate(); aufrufen müssen, nachdem Sie die Klasse definiert haben.

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");
4
Brian Fisher

Meine Enum-Klassendefinition unten ist stark typisiert und sehr natürlich zu verwenden und zu definieren.

Definition:

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

Enum umschalten

$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

Übergebe Enum als Parameter (stark typisiert)

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

echo "I have an $myFruit\n";

>> I have an Apple

Get Enum by integer

$myFruit = Fruit::getByValue(2);

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

>> Now I have an ORANGE

Get Enum by Name

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

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

>> But I definitely prefer an Apple

Die Aufzählungsklasse:

/**
 * @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;
    }

}

Addition

Sie können natürlich auch Kommentare für IDEs hinzufügen

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
Torge

Mir ist klar, dass dies ein sehr, sehr, sehr alter Thread ist, aber ich hatte darüber nachgedacht und wollte wissen, was die Leute dachten.

Anmerkungen: Ich habe damit herumgespielt und festgestellt, dass Sie mit der __call() -Funktion sogar noch näher an die tatsächliche enums herankommen können. Die Funktion __call() behandelt alle unbekannten Funktionsaufrufe. Angenommen, Sie möchten drei enums RED_LIGHT, YELLOW_LIGHT und GREEN_LIGHT erstellen. Sie können dies jetzt tun, indem Sie einfach Folgendes tun:

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

Einmal definiert, müssen Sie sie nur noch einmal aufrufen, um die Werte zu erhalten:

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

und du solltest 0, 1 und 2 bekommen. Viel Spaß! Dies ist jetzt auch auf GitHub möglich.

Update: Ich habe es so gemacht, dass jetzt die Funktionen __get() und __set() verwendet werden. Mit diesen können Sie eine Funktion nur aufrufen, wenn Sie dies möchten. Stattdessen können Sie jetzt einfach sagen:

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

Für die Schaffung und das Erhalten der Werte. Da die Variablen ursprünglich nicht definiert wurden, wird die Funktion __get() aufgerufen (da kein Wert angegeben ist), die feststellt, dass der Eintrag im Array nicht vorgenommen wurde. Es nimmt also die Eingabe vor, weist ihr den zuletzt angegebenen Wert plus eins (+1) zu, inkrementiert die letzte Wertevariable und gibt WAHR zurück. Wenn Sie den Wert einstellen:

$c->RED_LIGHT = 85;

Dann wird die Funktion __set() aufgerufen und der letzte Wert auf den neuen Wert plus eins (+1) gesetzt. Jetzt haben wir also eine ziemlich gute Möglichkeit, Enums zu erstellen, und sie können im laufenden Betrieb erstellt werden.

<?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
#           [email protected]  :-)
#
#   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";

?>
4
Mark Manning

Jetzt können Sie die Klasse SplEnum verwenden, um sie nativ zu erstellen. Gemäß der offiziellen Dokumentation.

SplEnum bietet die Möglichkeit, Aufzählungsobjekte nativ in PHP zu emulieren und zu erstellen.

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

Bitte beachten Sie, dass es sich um eine Erweiterung handelt, die installiert werden muss, aber standardmäßig nicht verfügbar ist. Was kommt unter Special Types in der PHP-Website selbst beschrieben. Das obige Beispiel stammt von der Site PHP.

3
Krishnadas PC

Ich weiß, dass dies ein alter Thread ist, aber keine der Problemumgehungen, die ich gesehen habe, sah wirklich wie Aufzählungen aus, da fast alle Problemumgehungen erfordern, dass Sie den Aufzählungselementen manuell Werte zuweisen, oder Sie müssen ein Array von Aufzählungsschlüsseln an a übergeben Funktion. Also habe ich meine eigene Lösung dafür geschaffen.

Um eine Aufzählungsklasse mit meiner Lösung zu erstellen, können Sie diese Aufzählungsklasse einfach weiter unten erweitern, eine Reihe statischer Variablen erstellen (sie müssen nicht initialisiert werden) und IhreEnumClass :: init () direkt unter der Definition Ihrer Aufzählungsklasse aufrufen .

edit: Dies funktioniert nur in php> = 5.3, aber es kann wahrscheinlich geändert werden, um auch in älteren Versionen zu funktionieren

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

Einer der Aspekte, die in einigen anderen Antworten fehlen, ist die Verwendung von Aufzählungen mit Typhinweisen.

Wenn Sie Ihre Aufzählung als eine Reihe von Konstanten in einer abstrakten Klasse definieren, z.

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

dann können Sie keinen Hinweis in einen Funktionsparameter eingeben - zum einen, weil er nicht instanziierbar ist, aber auch, weil der Typ von ShirtSize::SMALLint ist, nicht ShirtSize.

Das ist der Grund, warum native Enums in PHP so viel besser wären als alles, was wir uns vorstellen können. Sie können eine Aufzählung jedoch approximieren, indem Sie eine Privateigenschaft beibehalten, die den Wert der Aufzählung darstellt, und dann die Initialisierung dieser Eigenschaft auf unsere vordefinierten Konstanten beschränken. Um zu verhindern, dass die Aufzählung willkürlich instanziiert wird (ohne den Aufwand, eine Whitelist zu überprüfen), machen wir den Konstruktor privat.

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

Dann können wir ShirtSize so verwenden:

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

Auf diese Weise besteht der größte Unterschied aus Sicht des Benutzers darin, dass Sie einen () für den Namen der Konstante anheften müssen.

Ein Nachteil ist jedoch, dass === (der die Objektgleichheit vergleicht) false zurückgibt, wenn == true zurückgibt. Aus diesem Grund ist es am besten, eine equals -Methode bereitzustellen, damit Benutzer nicht daran denken müssen, == und nicht === zu verwenden, um zwei Aufzählungswerte zu vergleichen.

BEARBEITEN: Einige der vorhandenen Antworten sind sehr ähnlich, insbesondere: https://stackoverflow.com/a/25526473/240787 .

2
Chris Middleton

Einige gute Lösungen hier!

Hier ist meine Version.

  • Es ist stark getippt
  • Es funktioniert mit IDE Auto-Vervollständigung
  • Aufzählungen werden durch einen Code und eine Beschreibung definiert, wobei der Code eine Ganzzahl, ein Binärwert, eine kurze Zeichenfolge oder im Grunde alles andere sein kann, was Sie möchten. Das Muster könnte leicht erweitert werden, um andere Eigenschaften zu unterstützen.
  • Es unterstützt Vergleiche von Werten (==) und Referenzen (===) und funktioniert in switch-Anweisungen.

Ich denke, der Hauptnachteil ist, dass Enum-Member separat deklariert und instanziiert werden müssen, da Beschreibungen vorliegen und PHP keine Objekte zum Zeitpunkt der statischen Member-Deklaration erstellen kann. Ich vermute, ein Weg, dies zu umgehen, könnte darin bestehen, stattdessen Reflektion mit analysierten Dokumentkommentaren zu verwenden.

Die abstrakte Aufzählung sieht folgendermaßen aus:

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

Hier ist ein Beispiel für eine konkrete Aufzählung:

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

Welches kann so verwendet werden:

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

Und erzeugt diese Ausgabe:

1: Mein erster Wert

array (3) {
[1] =>
Objekt (EMyEnum) # 1 (2) {
["code": "AbstractEnum": privat] =>
int (1)
["description": "AbstractEnum": privat] =>
string (14) "Mein erster Wert"
}
[2] =>
Objekt (EMyEnum) # 2 (2) {
["code": "AbstractEnum": privat] =>
int (2)
["description": "AbstractEnum": privat] =>
string (15) "Mein zweiter Wert"
}
[3] =>
Objekt (EMyEnum) # 3 (2) {
["code": "AbstractEnum": privat] =>
int (3)
["description": "AbstractEnum": privat] =>
string (14) "Mein dritter Wert"
}
}

Mein zweiter Wert

2
Dan King
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 ) );

Verwenden Sie keine Reflexion. Dadurch ist es äußerst schwierig, über Ihren Code nachzudenken und festzustellen, wo etwas verwendet wird, und statische Analysewerkzeuge (z. B. das, was in Ihre IDE integriert ist) können beschädigt werden.

2
Jesse

Die akzeptierte Antwort ist der Weg zu gehen und ist eigentlich das, was ich der Einfachheit halber tue. Die meisten Vorteile der Aufzählung werden angeboten (lesbar, schnell usw.). Ein Konzept fehlt jedoch: Typensicherheit. In den meisten Sprachen werden Aufzählungen auch verwendet, um zulässige Werte einzuschränken. Im Folgenden finden Sie ein Beispiel dafür, wie die Typensicherheit auch mit privaten Konstruktoren, statischen Instanziierungsmethoden und der Typüberprüfung erreicht werden kann:

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

Wir könnten sogar noch weiter gehen: Die Verwendung von Konstanten in der DaysOfWeek-Klasse könnte zu Missbrauch führen: z. man könnte es fälschlicherweise so benutzen:

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

das ist falsch (ruft eine Ganzzahlkonstante auf). Wir können dies verhindern, indem wir private statische Variablen anstelle von Konstanten verwenden:

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

}

Natürlich ist es nicht möglich, auf ganzzahlige Konstanten zuzugreifen (dies war eigentlich der Zweck). Mit der Methode intVal können Sie ein DaysOfWeek-Objekt in seine Ganzzahldarstellung konvertieren.

Beachten Sie, dass wir sogar noch weiter gehen könnten, indem wir einen Caching-Mechanismus in Instantiierungsmethoden implementieren, um Speicherplatz zu sparen, wenn Aufzählungen häufig verwendet werden ...

Hoffe das wird helfen

2

Als ich auf die Antwort von Brian Cline trat, dachte ich, ich könnte meine 5 Cent geben

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

Aufgezeigte Lösung funktioniert gut. Sauber und glatt.

Wenn Sie jedoch stark typisierte Aufzählungen wünschen, können Sie dies verwenden:

class TestEnum extends Enum
{
    public static $TEST1;
    public static $TEST2;
}
TestEnum::init(); // Automatically initializes enum values

Mit einer Enum-Klasse, die wie folgt aussieht:

class Enum
{
    public static function parse($enum)
    {
        $class = get_called_class();
        $vars = get_class_vars($class);
        if (array_key_exists($enum, $vars)) {
            return $vars[$enum];
        }
        return null;
    }

    public static function init()
    {
        $className = get_called_class();
        $consts = get_class_vars($className);
        foreach ($consts as $constant => $value) {
            if (is_null($className::$$constant)) {
                $constantValue = $constant;
                $constantValueName = $className . '::' . $constant . '_VALUE';
                if (defined($constantValueName)) {
                    $constantValue = constant($constantValueName);
                }
                $className::$$constant = new $className($constantValue);
            }
        }
    }

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

Auf diese Weise werden die Enum-Werte und stark typisiert

TestEnum::$TEST1 === TestEnum::parse('TEST1') // true statement

1
Hervé Labas

Ich habe eine Bibliothek erstellt, die auf Brian Clines Antwort basiert. Sie heißt greg0ire/enum Viel Spaß!

1
greg0ire

Schließlich eine PHP 7.1 + Antwort mit Konstanten, die nicht überschrieben werden können.

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

Wenn Sie Namespaces verwenden, sollte die Code-Vervollständigung funktionieren.

Dadurch verlieren Sie jedoch die Möglichkeit, die Konstanten in der Klassenfamilie (protected) oder nur in der Klasse (private) auszublenden. Per Definition ist alles in einem Interfacepublic.

PHP Manual: Interfaces

1

Gestern habe ich diese Klasse geschrieben auf meinem Blog . Ich denke, es ist vielleicht einfach für die Verwendung in PHP-Skripten:

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

Verwendungszweck:

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

Dies ist meine Einstellung zu "dynamischer" Aufzählung ... damit ich sie mit Variablen aufrufen kann, z. aus einem Formular.

siehe aktualisierte Version unter diesem Codeblock ...

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

PDATE: Besser so ...

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;

}

Mit anrufen

EnumCategory::${$category};
1
Anders

Eine einfachere und leichtere Version ohne Reflektion:

abstract class enum {
    private function __construct() {}
    static function has($const) {
        $name = get_called_class();
        return defined("$name::$const");
    }
    static function value($const) {
        $name = get_called_class();
        return defined("$name::$const")? constant("$name::$const") : false;
    }
}

Verwendungszweck:

class requestFormat  extends enum { const HTML = 1; const JSON = 2; const XML  = 3; const FORM = 4; }

echo requestFormat::value('JSON'); // 2
echo requestFormat::has('JSON');   // true

Dies bietet den Vorteil von Konstanten und ermöglicht auch die Überprüfung ihrer Gültigkeit. Es fehlen jedoch andere ausgefallene Funktionen, die bei komplexeren Lösungen zur Verfügung stehen. Je offensichtlicher die Unfähigkeit ist, die Umkehrung eines Werts zu überprüfen (im obigen Beispiel Sie) kann nicht überprüfen, ob '2' ein gültiger Wert ist)

0
Ismaelj

Ich habe kürzlich eine einfache Bibliothek für PHP Enums entwickelt: https://github.com/dnl-blkv/simple-php-enum

Zum Zeitpunkt des Schreibens dieser Antwort befindet sie sich noch in der Vorabversion, ist jedoch bereits voll funktionsfähig, gut dokumentiert und auf Packagist veröffentlicht.

Dies ist möglicherweise eine praktische Option, wenn Sie nach einfach zu implementierenden Enums suchen, die denen von C/C++ ähneln.

0
dnl-blkv

Wenn Sie Typensicherheit und eine Reihe von Konstanten benötigen, die mit diesem Typ übereinstimmen, müssen Sie eine abstrakte Klasse für Ihre Aufzählung haben und diese Klasse dann mit einem gesperrten Konstruktor erweitern, wie folgt:

abstract class DaysOfWeekEnum{
    public function __construct(string $value){
        $this->value = $value; 
    }
    public function __toString(){
        return $this->value;
    }

}
class Monday extends DaysOfWeekEnum{
    public function __construct(){
        parent::__construct("Monday");
    }
}

class Tuesday extends DaysOfWeekEnum{
    public function __construct(){
        parent::__construct("Tuesday");
    }
}

Dann können Sie Ihre Methoden veranlassen, eine Instanz von DaysOfWeek zu nehmen und eine Instanz von Montag, Dienstag usw. zu übergeben. Der einzige Nachteil ist, dass Sie eine Instanz jedes Mal neu erstellen müssen, wenn Sie Ihre Aufzählung verwenden möchten, aber ich finde es lohnt sich.

function printWeekDay(DaysOfWeek $day){
    echo "Today is $day.";
}

printWeekDay(new Monday());
0
user986730
// My Enumeration Class
class Enum
{
    protected $m_actions = array();

    public function __construct($actions)
    {
        $this->init($actions);
    }

    public function init($actions)
    {
        $this->m_actions = array();
        for($i = 0; $i < count($actions); ++$i)
        {
            $this->m_actions[$actions[$i]] = ($i + 1); 
            define($actions[$i], ($i + 1));
        }
    }

    public function toString($index)
    {
        $keys = array_keys($this->m_actions);
        for($i = 0; $i < count($keys); ++$i)
        {
            if($this->m_actions[$keys[$i]] == $index)
            {
                return $keys[$i];
            }
        }

        return "undefined";
    }

    public function fromString($str)
    {
        return $this->m_actions[$str];
    }
}

// Enumeration creation
$actions = new Enum(array("CREATE", "READ", "UPDATE", "DELETE"));

// Examples
print($action_objects->toString(DELETE));
print($action_objects->fromString("DELETE"));

if($action_objects->fromString($_POST["myAction"]) == CREATE)
{
    print("CREATE");
}
0
Imagine Breaker

Mein Versuch, eine Aufzählung mit PHP zu erstellen, ist äußerst begrenzt, da Objekte als Aufzählungswerte nicht unterstützt werden, aber dennoch etwas nützlich sind ...

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