Alpha Framework 4.0.0 API Documentation

Integer extends Type
in package
implements TypeInterface

The Integer 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) 2021, 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.

Table of Contents

Interfaces

TypeInterface
The interface for all complex data types.

Constants

MAX_SIZE  = 11
The absolute maximum size of the value for the this Integer.

Properties

$helper  : string
The error message for the Integer type when validation fails.
$size  : int
The size of the value for the Integer.
$validationRule  : string
The validation rule (reg-ex) applied to Integer values.
$value  : int
The value of the Integer.

Methods

__construct()  : mixed
Constructor.
__toString()  : string
Used to convert the object to a printable string.
getHelper()  : string
Used to get the validation helper message string.
getRule()  : string
Get the validation rule.
getSize()  : int
Get the allowable size of the Integer in the database field.
getValue()  : int
Getter for the Integer value.
setHelper()  : void
Set the validation helper text.
setSize()  : void
Used to set the allowable size of the Integer in the database field.
setValue()  : void
Setter for the Integer value.
zeroPad()  : string
Returns the integer value provided but padded with zeros to MAX_SIZE.

Constants

MAX_SIZE

The absolute maximum size of the value for the this Integer.

public int MAX_SIZE = 11
Tags
since
1.0

Properties

$helper

The error message for the Integer type when validation fails.

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

$size

The size of the value for the Integer.

private int $size = 11
Tags
since
1.0

$validationRule

The validation rule (reg-ex) applied to Integer values.

private string $validationRule
Tags
since
1.0

$value

The value of the Integer.

private int $value
Tags
since
1.0

Methods

__toString()

Used to convert the object to a printable string.

public __toString() : string
Tags
since
1.0
Return values
string

getHelper()

Used to get the validation helper message string.

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

getRule()

Get the validation rule.

public getRule() : string
Tags
since
1.0
Return values
string

getSize()

Get the allowable size of the Integer in the database field.

public getSize() : int
Tags
since
1.0
Return values
int

getValue()

Getter for the Integer value.

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

setHelper()

Set the validation helper text.

public setHelper(string $helper) : void
Parameters
$helper : string
Tags
since
1.0

setSize()

Used to set the allowable size of the Integer in the database field.

public setSize(int $size) : void
Parameters
$size : int
Tags
since
1.0
throws
IllegalArguementException

zeroPad()

Returns the integer value provided but padded with zeros to MAX_SIZE.

public static zeroPad(int $val) : string
Parameters
$val : int
Tags
since
1.0
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results