Alpha Framework 3.1.0 API Documentation

Enum extends Type implements TypeInterface

The Enum complex data type.

Tags
since
1.0
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2018, 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.

Interfaces, Classes and Traits

TypeInterface
The interface for all complex data types.

Table of Contents

$helper  : string
The message to display to the user when validation fails.
$options  : array<string|int, mixed>
An array of valid enum options.
$value  : string
The currently selected enum option.
__construct()  : mixed
Constructor that sets up the enum options.
__toString()  : string
Used to convert the object to a printable string.
getHelper()  : string
Used to get the validation helper message string.
getOptions()  : array<string|int, mixed>
Get the array of enum options.
getValue()  : string
Used to get the current enum item.
setHelper()  : mixed
Set the validation helper text.
setOptions()  : mixed
Setter for the enum options.
setValue()  : mixed
Used to select the current enum item.

Properties

$helper

The message to display to the user when validation fails.

protected string $helper = 'Not a valid enum option!'
Tags
since
1.0

$options

An array of valid enum options.

private array<string|int, mixed> $options
Tags
since
1.0

$value

The currently selected enum option.

private string $value = ''
Tags
since
1.0

Methods

__construct()

Constructor that sets up the enum options.

public __construct([array<string|int, mixed> $opts = array('') ]) : mixed
Parameters
$opts : array<string|int, mixed> = array('')
Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

__toString()

Used to convert the object to a printable string.

public __toString() : string
Tags
since
1.0
Return values
string —

getHelper()

Used to get the validation helper message string.

public getHelper() : string
Tags
since
1.0
Return values
string —

getOptions()

Get the array of enum options.

public getOptions([bool $alphaSort = false ]) : array<string|int, mixed>
Parameters
$alphaSort : bool = false

Set to true if you want the Enum options in alphabetical order (default false)

Tags
since
1.0
Return values
array<string|int, mixed> —

getValue()

Used to get the current enum item.

public getValue() : string
Tags
since
1.0
Return values
string —

setHelper()

Set the validation helper text.

public setHelper(string $helper) : mixed
Parameters
$helper : string
Tags
since
1.0
Return values
mixed —

setOptions()

Setter for the enum options.

public setOptions(array<string|int, mixed> $opts) : mixed
Parameters
$opts : array<string|int, mixed>
Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

setValue()

Used to select the current enum item.

public setValue(string $item) : mixed
Parameters
$item : string

The item to set as selected in the Enum

Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

Search results