Alpha Framework 3.1.0 API Documentation

Boolean extends Type implements TypeInterface

The Boolean 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 error message returned for invalid values.
$booleanValue  : bool
The value of the Boolean.
$value  : int
The binary (1/0) value of the Boolean. This is the value stored in the database.
__construct()  : mixed
Constructor.
__toString()  : string
Used to convert the object to a printable string.
getBooleanValue()  : bool
Used to get the boolean value of the Boolean.
getHelper()  : string
Used to get the validation helper message string.
getValue()  : int
Used to get the binary (1/0) value of the Boolean. This is the value stored in the database.
setHelper()  : mixed
Set the validation helper text.
setValue()  : mixed
Used to set the Boolean value.

Properties

$helper

The error message returned for invalid values.

protected string $helper = 'Not a valid Boolean value!'
Tags
since
1.0

$booleanValue

The value of the Boolean.

private bool $booleanValue
Tags
since
1.0

$value

The binary (1/0) value of the Boolean. This is the value stored in the database.

private int $value
Tags
since
1.0

Methods

__construct()

Constructor.

public __construct([bool $val = true ]) : mixed
Parameters
$val : bool = true
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 —

getBooleanValue()

Used to get the boolean value of the Boolean.

public getBooleanValue() : bool
Tags
since
1.0
Return values
bool —

getHelper()

Used to get the validation helper message string.

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

getValue()

Used to get the binary (1/0) value of the Boolean. This is the value stored in the database.

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

setHelper()

Set the validation helper text.

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

setValue()

Used to set the Boolean value.

public setValue(mixed $val) : mixed
Parameters
$val : mixed

Will accept a boolean true/false or integer 1/0.

Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

Search results