| alpha--model--types

# Class: Integer Source Location: /model/types/Integer.inc ## Class Integer Class Overview
Implements interfaces: AlphaTypeInterface The Integer complex data type Located in /model/types/Integer.inc [line 51]
    AlphaType
       |
       --Integer
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: Integer.inc 1453 2011-12-04 15:12:54Z 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 $helper | Methods __construct getRule getSize getValue setSize setValue zeroPad
[ 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 Integer
[ Top ] Property Summary
string | $helper | The error message for the Integer type when validation fails
[ Top ] Method Summary
static void | zeroPad() | Returns the integer value provided but padded with zeros to MAX_SIZE
Integer | __construct() | Constructor
string | getRule() | Get the validation rule
integer | getSize() | Get the allowable size of the Integer in the database field
integer | getValue() | Getter for the Integer value
void | setSize() | Used to set the allowable size of the Integer in the database field
void | setValue() | Setter for the Integer value
[ Top ] Properties string $helper = 'Not a valid integer value!' [line 74] The error message for the Integer type when validation fails API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Methods static method zeroPad [line 182]
`static void zeroPad( integer $val )`
Returns the integer value provided but padded with zeros to MAX_SIZE Parameters:
integer | $val: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] Constructor __construct [line 99]
`Integer __construct( [integer $val = 0] )`
Constructor Parameters:
integer | $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]
`integer getSize( )`
Get the allowable size of the Integer in the database field API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] getValue [line 136]
`integer getValue( )`
Getter for the Integer 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 Integer in the database field Parameters:
integer | $size: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
[ Top ] setValue [line 119]
`void setValue( integer $val )`
Setter for the Integer value Parameters:
integer | $val: |
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Throws: | IllegalArguementException
Implementation of: AlphaTypeInterface::setValue() Set the value of the type [ Top ] Constants MAX_SIZE = 11 [line 90] The absolute maximum size of the value for the this Integer Information Tags:
Since: | 1.0
[ Top ] Documentation generated on Tue, 13 Dec 2011 20:27:05 +0000 by phpDocumentor 1.4.3