| alpha--model--types

# Class: Enum Source Location: /model/types/Enum.inc ## Class Enum Class Overview
Implements interfaces: AlphaTypeInterface The Enum complex data type Located in /model/types/Enum.inc [line 51]
    AlphaType
       |
       --Enum
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: Enum.inc 1453 2011-12-04 15:12:54Z johnc $
Copyright: | Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.
     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the
     following conditions are met:

     * Redistributions of source code must retain the above
       copyright notice, this list of conditions and the
       following disclaimer.
     * Redistributions in binary form must reproduce the above
       copyright notice, this list of conditions and the
       following disclaimer in the documentation and/or other
       materials provided with the distribution.
     * Neither the name of the Alpha Framework nor the names
       of its contributors may be used to endorse or promote
       products derived from this software without specific
       prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
     OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since: | 1.0
License: | The BSD License
| Properties $helper | Methods __construct getOptions getValue setOptions setValue
[ Top ] Inherited Properties, Constants, and Methods
Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
| Inherited From AlphaType AlphaType::getHelper() Used to get the validation helper message string AlphaType::setHelper() Set the validation helper text AlphaType::__toString() Used to convert the object to a printable string |
[ Top ] Property Summary
string | $helper | The message to display to the user when validation fails
[ Top ] Method Summary
Enum | __construct() | Constructor that sets up the enum options
array | getOptions() | Get the array of enum options
string | getValue() | Used to get the current enum item
void | setOptions() | Setter for the enum options
void | setValue() | Used to select the current enum item
[ Top ] Properties string $helper = 'Not a valid enum option!' [line 74] The message to display to the user when validation fails API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Methods Constructor __construct [line 83]
`Enum __construct( [array $opts = array('')] )`
Constructor that sets up the enum options Parameters:
array | $opts: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] getOptions [line 111]
`array getOptions( [boolean $alphaSort = false] )`
Get the array of enum options Parameters:
boolean | $alphaSort: | Set to true if you want the Enum options in alphabetical order (default false)
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getValue [line 123]
`string getValue( )`
Used to get the current enum item API Tags:
Access: | public
Information Tags:
Since: | 1.0
Implementation of: AlphaTypeInterface::getValue() Get the value [ Top ] setOptions [line 97]
`void setOptions( array $opts )`
Setter for the enum options Parameters:
array | $opts: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] setValue [line 134]
`void setValue( string $item )`
Used to select the current enum item Parameters:
string | $item: | The item to set as selected in the Enum
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
Implementation of: AlphaTypeInterface::setValue() Set the value of the type [ Top ] Documentation generated on Tue, 13 Dec 2011 20:26:51 +0000 by phpDocumentor 1.4.3