      1: <?php
      2:
      3: /**
      4:  * The Enum complex data type
      5:  *
      6:  * @package alpha::model::types
      7:  * @since 1.0
      8:  * @author John Collins <dev@alphaframework.org>
      9:  * @version $Id: Enum.inc 1496 2012-02-12 20:32:21Z alphadev $
     10:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
     11:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).
     12:  * All rights reserved.
     13:  *
     14:  * <pre>
     15:  * Redistribution and use in source and binary forms, with or
     16:  * without modification, are permitted provided that the
     17:  * following conditions are met:
     18:  *
     19:  * * Redistributions of source code must retain the above
     20:  *   copyright notice, this list of conditions and the
     21:  *   following disclaimer.
     22:  * * Redistributions in binary form must reproduce the above
     23:  *   copyright notice, this list of conditions and the
     24:  *   following disclaimer in the documentation and/or other
     25:  *   materials provided with the distribution.
     26:  * * Neither the name of the Alpha Framework nor the names
     27:  *   of its contributors may be used to endorse or promote
     28:  *   products derived from this software without specific
     29:  *   prior written permission.
     30:  *
     31:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     32:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     33:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     34:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     35:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     36:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     37:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     38:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     39:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     40:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     41:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     42:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     43:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     44:  * </pre>
     45:  *
     46:  */
     47: class Enum extends AlphaType implements AlphaTypeInterface {
     48:     /**
     49:      * An array of valid enum options
     50:      *
     51:      * @var array
     52:      * @since 1.0
     53:      */
     54:     private $options;
     55:
     56:     /**
     57:      * The currently selected enum option
     58:      *
     59:      * @var string
     60:      * @since 1.0
     61:      */
     62:     private $value = '';
     63:
     64:     /**
     65:      * The message to display to the user when validation fails
     66:      *
     67:      * @var string
     68:      * @since 1.0
     69:      */
     70:     protected $helper = 'Not a valid enum option!';
     71:
     72:     /**
     73:      * Constructor that sets up the enum options
     74:      *
     75:      * @param array $opts
     76:      * @since 1.0
     77:      * @throws IllegalArguementException
     78:      */
     79:     public function __construct($opts=array('')) {
     80:         if(is_array($opts))
     81:             $this->options = $opts;
     82:         else
     83:             throw new IllegalArguementException('Not a valid enum option array!');
     84:     }
     85:
     86:     /**
     87:      * Setter for the enum options
     88:      *
     89:      * @param array $opts
     90:      * @since 1.0
     91:      * @throws IllegalArguementException
     92:      */
     93:     public function setOptions($opts) {
     94:         if(is_array($opts))
     95:             $this->options = $opts;
     96:         else
     97:             throw new IllegalArguementException('Not a valid enum option array!');
     98:     }
     99:
    100:     /**
    101:      * Get the array of enum options
    102:      *
    103:      * @param boolean $alphaSort Set to true if you want the Enum options in alphabetical order (default false)
    104:      * @return array
    105:      * @since 1.0
    106:      */
    107:     public function getOptions($alphaSort = false) {
    108:         if($alphaSort)
    109:             sort($this->options, SORT_STRING);
    110:         return $this->options;
    111:     }
    112:
    113:     /**
    114:      * Used to get the current enum item
    115:      *
    116:      * @return string
    117:      * @since 1.0
    118:      */
    119:     public function getValue() {
    120:         return $this->value;
    121:     }
    122:
    123:     /**
    124:      * Used to select the current enum item
    125:      *
    126:      * @param string $item The item to set as selected in the Enum
    127:      * @since 1.0
    128:      * @throws IllegalArguementException
    129:      */
    130:     public function setValue($item) {
    131:         if (in_array($item, $this->options)) {
    132:             $this->value = $item;
    133:         }else{
    134:             throw new IllegalArguementException($this->getHelper());
    135:         }
    136:     }
    137: }
    138:
    139: ?>