Alpha Framework alpha--model--types
[ class tree: alpha--model--types ] [ index: alpha--model--types ] [ all elements ]

Class: Boolean

Source Location: /model/types/Boolean.inc

Class Boolean

Class Overview

Implements interfaces:

The Boolean complex data type

Located in /model/types/Boolean.inc [line 51]

AlphaType
   |
   --Boolean
Author(s):
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: Boolean.inc 1341 2011-03-17 15:02:02Z 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

Methods

[ 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 error message returned for invalid values

[ Top ]
Method Summary
Boolean   __construct()   Constructor
boolean   getBooleanValue()   Used to get the boolean value of the Boolean
integer   getValue()   Used to get the binary (1/0) value of the Boolean. This is the value stored in the database.
void   setValue()   Used to set the Boolean value.
string   __toString()   Used to convert the object to a printable string

[ Top ]
Properties
string   $helper = 'Not a valid Boolean value!' [line 75]

The error message returned for invalid values

API Tags:
Access:  protected

Information Tags:
Since:  1.0

[ Top ]
Methods
Constructor __construct  [line 84]

  Boolean __construct( [boolean $val = true]  )

Constructor

Parameters:
boolean   $val: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
getBooleanValue  [line 137]

  boolean getBooleanValue( )

Used to get the boolean value of the Boolean


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getValue  [line 127]

  integer getValue( )

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


API Tags:
Access:  public

Information Tags:
Since:  1.0

Implementation of:
AlphaTypeInterface::getValue()
Get the value

[ Top ]
setValue  [line 106]

  void setValue( mixed $val  )

Used to set the Boolean value.

Parameters:
mixed   $val:  Will accept a boolean true/false or integer 1/0.

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

Implementation of:
AlphaTypeInterface::setValue()
Set the value of the type

[ Top ]
__toString  [line 147]

  string __toString( )

Used to convert the object to a printable string


API Tags:
Access:  public

Information Tags:
Since:  1.0

Redefinition of:
AlphaType::__toString()
Used to convert the object to a printable string

Implementation of:
AlphaTypeInterface::__toString()
Convert the valud of the complex type to a string

[ Top ]

Documentation generated on Thu, 17 Mar 2011 16:43:55 +0000 by phpDocumentor 1.4.3