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

Class: Double

Source Location: /model/types/Double.inc

Class Double

Class Overview

Implements interfaces:

The Double complex data type

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

AlphaType
   |
   --Double
Author(s):
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: Double.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 ]
Constant Summary
MAX_SIZE   The absolute maximum size of the value for the this double

[ Top ]
Property Summary
string   $helper   The error message for the Double type when validation fails

[ Top ]
Method Summary
Double   __construct()   Constructor
string   getRule()   Get the validation rule
mixed   getSize()   Get the allowable size of the Double in the database field
double   getValue()   Getter for the Double value
void   setSize()   Used to set the allowable size of the Double in the database field
void   setValue()   Setter for the Double value
string   __toString()   Used to convert the object to a printable string

[ Top ]
Properties
string   $helper = 'Not a valid double value!' [line 74]

The error message for the Double type when validation fails

API Tags:
Access:  protected

Information Tags:
Since:  1.0

[ Top ]
Methods
Constructor __construct  [line 99]

  Double __construct( [double $val = 0.0]  )

Constructor

Parameters:
double   $val: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
getRule  [line 146]

  string getRule( )

Get the validation rule


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getSize  [line 172]

  mixed getSize( [boolean $databaseDimension = false]  )

Get the allowable size of the Double in the database field

Parameters:
boolean   $databaseDimension: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getValue  [line 136]

  double getValue( )

Getter for the Double value


API Tags:
Access:  public

Information Tags:
Since:  1.0

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

[ Top ]
setSize  [line 157]

  void setSize( integer $size  )

Used to set the allowable size of the Double in the database field

Parameters:
integer   $size: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
setValue  [line 119]

  void setValue( double $val  )

Setter for the Double value

Parameters:
double   $val: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

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

[ Top ]
__toString  [line 185]

  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 ]
Constants
MAX_SIZE = 13 [line 90]

The absolute maximum size of the value for the this double

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Thu, 17 Mar 2011 16:44:07 +0000 by phpDocumentor 1.4.3