# Class Integer

The Integer complex data type

  AlphaType
  Integer implements AlphaTypeInterface

Package: alpha::model::types
Copyright: Copyright (c) 2012, 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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Integer.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.0
Located at model/types/Integer.inc

Methods summary
`public` | # `__construct( integer $val = 0 )` Constructor Constructor #### Parameters $val `integer` $val #### Throws ``IllegalArguementException`` #### Since 1.0
`public` | # `setValue( integer $val )` Setter for the Integer value Setter for the Integer value #### Parameters $val `integer` $val #### Throws ``IllegalArguementException`` #### Since 1.0 #### Implementation of `AlphaTypeInterface::setValue()`
`public integer` | # `getValue( )` Getter for the Integer value Getter for the Integer value #### Returns `integer` #### Since 1.0 #### Implementation of `AlphaTypeInterface::getValue()`
`public string` | # `getRule( )` Get the validation rule Get the validation rule #### Returns `string` #### Since 1.0
`public` | # `setSize( integer $size )` Used to set the allowable size of the Integer in the database field Used to set the allowable size of the Integer in the database field #### Parameters $size `integer` $size #### Throws ``IllegalArguementException`` #### Since 1.0
`public integer` | # `getSize( )` Get the allowable size of the Integer in the database field Get the allowable size of the Integer in the database field #### Returns `integer` #### Since 1.0
`public static` | # `zeroPad( integer $val )` Returns the integer value provided but padded with zeros to MAX_SIZE Returns the integer value provided but padded with zeros to MAX_SIZE #### Parameters $val `integer` $val #### Since 1.0

Methods inherited from AlphaType
`__toString(), getHelper(), setHelper()`

Constants summary
`integer` | `MAX_SIZE` | `11` | # The absolute maximum size of the value for the this Integer The absolute maximum size of the value for the this Integer #### Since 1.0

Properties summary
`private integer` | $value | `` | # The value of the Integer The value of the Integer #### Since 1.0
`private string` | $validationRule | `` | # The validation rule (reg-ex) applied to Integer values The validation rule (reg-ex) applied to Integer values #### Since 1.0
`protected string` | $helper | `'Not a valid integer value!'` | # The error message for the Integer type when validation fails The error message for the Integer type when validation fails #### Since 1.0
`private integer` | $size | `11` | # The size of the value for the Integer The size of the value for the Integer #### Since 1.0