The SplEnum class

(No version information available, might only be in SVN)

Introduction

SplEnum gives the ability to emulate and create enumeration objects natively in PHP.

Class synopsis

SplEnum extends SplType {

/* Constants */

const NULL __default = null ;

/* Methods */

public array getConstList ([ bool $include_default = false ] )

/* Inherited methods */

SplType::__construct ([ mixed $initial_value [, bool $strict ]] )

}

Predefined Constants

SplEnum::__default

Examples

Example #1 SplEnum usage example


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

The above example will output:

6
Value not a const in enum Month

SplEnum::getConstList — Returns all consts (possible values) as an array.

The SplEnum class

Introduction

Class synopsis

Predefined Constants

Examples

Table of Contents