Class Enum

The Enum complex data type

AlphaType

Enum implements AlphaTypeInterface

Package: alpha::model::types
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Enum.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.0
Located at model/types/Enum.inc

Methods summary
`public`	# `__construct( array $opts = array('') )` Constructor that sets up the enum options Constructor that sets up the enum options Parameters `$opts` `array` $opts Throws `IllegalArguementException` Since 1.0
`public`	# `setOptions( array $opts )` Setter for the enum options Setter for the enum options Parameters `$opts` `array` $opts Throws `IllegalArguementException` Since 1.0
`public array`	# `getOptions( boolean $alphaSort = false )` Get the array of enum options Get the array of enum options Parameters `$alphaSort` `boolean` $alphaSort Set to true if you want the Enum options in alphabetical order (default false) Returns `array` Since 1.0
`public string`	# `getValue( )` Used to get the current enum item Used to get the current enum item Returns `string` Since 1.0 Implementation of `AlphaTypeInterface::getValue()`
`public`	# `setValue( string $item )` Used to select the current enum item Used to select the current enum item Parameters `$item` `string` $item The item to set as selected in the Enum Throws `IllegalArguementException` Since 1.0 Implementation of `AlphaTypeInterface::setValue()`

Methods inherited from AlphaType
`__toString(), getHelper(), setHelper()`

Properties summary
`private array`	`$options`		# An array of valid enum options An array of valid enum options Since 1.0
`private string`	`$value`	`''`	# The currently selected enum option The currently selected enum option Since 1.0
`protected string`	`$helper`	`'Not a valid enum option!'`	# The message to display to the user when validation fails The message to display to the user when validation fails Since 1.0

Packages

Classes

Interfaces

Class Enum

Parameters

Throws

Since

Parameters

Throws

Since

Parameters

Returns

Since

Returns

Since

Implementation of

Parameters

Throws

Since

Implementation of

Since

Since

Since