Class AbstractEnum

AbstractEnum Provides an abstraction that emulates splEnum, and provides it with checkval methods. This should be extended by concrete implementations that provide their own enumerable set. Enumerable sets can then be easily created from interface constants by implementing them on an extension of this class, and can insure exact constant names or validate ambiguous parameters.

oroboros\core\abstracts\libraries\enum\AbstractEnum implements oroboros\core\interfaces\api\EnumApi

Direct known subclasses

oroboros\core\libraries\api\ClassScopes, oroboros\core\libraries\api\ClassTypes, oroboros\core\libraries\api\ExceptionCodes, oroboros\core\libraries\api\ExceptionMessages, oroboros\core\libraries\api\FlagTypes, oroboros\core\libraries\api\HttpCodes, oroboros\core\libraries\api\Regex, oroboros\core\libraries\enum\http\RequestHeaders, oroboros\core\libraries\enum\http\ResponseHeaders, oroboros\core\libraries\enum\http\StatusCodes

Abstract
Namespace: oroboros\core\abstracts\libraries\enum
Author: Brian Dayhoff mopsyd@me.com
Located at core/abstracts/libraries/enum/AbstractEnum.php

Methods summary

`public`	# `__construct( $value = null )`
`public`	# `__toString( )`
`final public static array`	# `valid( )` Returns all valid enumeration keys; Returns all valid enumeration keys; Returns array
`final public static boolean`	# `isValid( string $value )` Returns whether a specified key is valid for this enumerable class. Returns whether a specified key is valid for this enumerable class. Parameters `$value` Returns boolean
`final public static`	# `values( )` Returns a list of the constant names for this class, which represent all valid values. The default value will not be provided. Returns a list of the constant names for this class, which represent all valid values. The default value will not be provided.
`public static array`	# `blacklist( )` Override this function if you need certain class constants not to return as valid enumerable values, and return an array of the ones to exclude. This function is called internally while deciding what values are valid. Override this function if you need certain class constants not to return as valid enumerable values, and return an array of the ones to exclude. This function is called internally while deciding what values are valid. Returns array
`private static`	# `_getBlacklist( )`
`private static`	# `_getConstName( $key )`

Constants summary

`string`	`CLASS_SCOPE`	# `\oroboros\core\interfaces\api\ClassScopeApi::CLASS_SCOPE_ENUM_ABSTRACT`
`string`	`API`	# `'\\oroboros\\core\\interfaces\\api\\EnumApi'`

Constants inherited from oroboros\core\interfaces\api\EnumApi

CLASS_TYPE

Properties summary

`private`	`$_value`	#
`private static array`	`$_blacklist`	# `array( //exclude the system interoperability constants, they will never be enumerated. 'global' => array( '__default', 'OROBOROS_VERSION', 'OROBOROS_VENDOR_NAMESPACE', 'CLASS_SCOPE', 'CLASS_TITLE' ) )`

Namespaces

Classes

Class AbstractEnum

Direct known subclasses

Methods summary

Returns

Parameters

Returns

Returns

Constants summary

Constants inherited from oroboros\core\interfaces\api\EnumApi

Properties summary