Antidot PHP API  version 0.16.0
##PHP API to simplify integration of Antidot components
 All Classes Files Functions Variables Groups Pages
Static Protected Member Functions | List of all members
BasicEnum Class Reference

Base class for pseudo enumerators. More...

Inheritance diagram for BasicEnum:
AfsCount AfsFacetCombination AfsFacetLayout AfsFacetMode AfsFacetOrder AfsFacetType AfsFacetValuesSortMode AfsFtsMode AfsHelperFormat AfsOrigin AfsProducer AfsServiceStatus AfsSortBuiltins AfsSortOrder

Static Protected Member Functions

static check_val ($instance, $value, $msg=null)
 Checks whether the value is valid.

Detailed Description

Base class for pseudo enumerators.

You whould derive from this class to create your own pseudo enum.

Member Function Documentation

static check_val (   $instance,
  $value,
  $msg = null 
)
staticprotected

Checks whether the value is valid.

Parameters
$value[in] value to test.
$msg[in] message of the launched exception on failling test.
Exceptions
InvalidArgumentExceptionwhen provided value is invalid.