Class Enum

Based on SplEnum, this class allows enumerated types to be created.

Extend this class to create your enums in the following way

class Fruit extends Enum
{
     const APPLE = 1;
     const ORANGE = 2;
     const _DEFAULT = 1;
}

_DEFAULT is optional and will be used if no paramater is passed to the constructor

echo new Fruit();
echo new Fruit(Fruit::ORANGE);
echo Fruit::valueOf("orange");

Will output: 1 2 2

picon\Enum implements picon\Identifiable, picon\Equalable

Abstract
Namespace: picon
Package: domain
Author: Martin Cassidy
Located at domain/Enum.php

Methods summary
`public`	# `__construct( Object $value = null )` Create a new enum Create a new enum Parameters `$value` `Object` The enum value
`public static The`	# `valueOf( String $obj )` Create an enum for the given value Create an enum for the given value Parameters `$obj` `String` A string of the value Returns `The` enum for the value, or null if no value can be found
`public static Array`	# `values( Boolean $includeDefault = false )` Gets all the posible values for this enum Gets all the posible values for this enum Parameters `$includeDefault` `Boolean` include the default value, defaults to false Returns `Array` of values for this enum
`public A`	# `__toString( )` Returns `A` String representation of the enum
`public Boolean`	# `equals( picon\Enum $enum )` Tests if two enums are equal Tests if two enums are equal Parameters `$enum` `picon\Enum` The enum to test against Returns `Boolean` true if the enum's match, false otherwise. False if the passed object is not a valid enum Implementation of `picon\Equalable::equals`
`public static`	# `getIdentifier( )` Implementation of `picon\Identifiable::getIdentifier`

Constants summary
`string`	`DEFAULT_NAME`	`"_DEFAULT"`	#