<?php
/**
* mpl           by ERB software
* @author       stefan.erb(at)erb-software.com
* @since        PHP 5.2
*/

interface IEnum{
/**
 * S T A T I S C H E   M E T H O D E N
 */
   
	/**
	 * analog der Funktion createEnum($name, $enums)
	 * @param String    Name des Enums
	 * @param Array oder Werteliste (siehe Beispiele)
	 * @static
	 */    
	public static function create($name, $enums);
	
	/**
	 * erstellt eine leere Instance der Enumklasse. Dies wird verwednet um auf
	 * Funktionen wie getEnum() etc zuzugreiffen ohne einen bestimmten ENUM auszuwählen
	 * @return Enum
	 * @static
	 */  
	public static function getInstance();
	
	/**
	 * Erstellt ein Enum anhand des Wertes
	 * @param Wert
	 * @return Enum
	 * @static
	 */    
	public static function getEnum($value);

	 /**
	 * Erstellt ein Enum anhand des Keys
	 * @param $key
	 * @return Enum
	 * @static
	 */
	public static function getEnumKey($key);
	
	/**
	 * wandelt die Enums in einen Array array('EnumName' => EnumValue)
	 * @return array
	 * @static
	 */
	public static function toArray($paramName = 'value');
	
	/**
	 * gibt alle Values als Array aus
	 * @param $glue
	 * @return String
	 * @static
	 */
	public static function implode($glue, $paramName = 'value');
   
/**
 * O B J E K T - M E T H O D E N
 */
	
	/**
	 * constructer
	 * @param $value
	 * @param $paramlist
	 */    
	public function __construct($value = NULL);

	/**
	 * gibt den Enum als String zurück. Dies entspricht dem Value
	 * @return String
	 */
	public function __toString();

	/**
	 * überprüft ob der Enum dem ausgewählten Enum entspricht
	 * @param $var
	 * @return Boolean
	 */
	public function equal($var);

	/**
	 * gibt ein Enum anhand eines passenden Wertes zurück
	 * @param $value
	 * @param $className
	 * @return Enum
	 */
	public function __getEnum($value, $className);
}
?>