Alpha Framework 3.1.0 API Documentation

SmallText extends Type implements TypeInterface

The SmallText 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) 2018, 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.

Interfaces, Classes and Traits

TypeInterface
The interface for all complex data types.

Table of Contents

MAX_SIZE  = 255
The absolute maximum size of the value for the this String.
$helper  : string
The error message for the string type when validation fails.
$password  : bool
Simple boolean to determine if the string is a password or not.
$size  : int
The size of the value for the this String.
$validationRule  : string
The validation rule for the string type.
$value  : string
The value of the string.
__construct()  : mixed
Constructor.
__toString()  : string
Used to convert the object to a printable string.
checkIsPassword()  : bool
Checks to see if the string is a password or not.
getHelper()  : string
Used to get the validation helper message string.
getRule()  : string
Get the validation rule.
getSize()  : int
Get the allowable size of the Double in the database field.
getValue()  : string
Getter for the value.
isPassword()  : mixed
Define the string as a password (making it required by validation rule).
isRequired()  : mixed
Sets up an appropriate validation rule for a required field.
setHelper()  : mixed
Set the validation helper text.
setRule()  : mixed
Setter to override the default validation rule.
setSize()  : mixed
Used to set the allowable size of the String in the database field.
setValue()  : mixed
Setter for the value.

Constants

MAX_SIZE

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

public int MAX_SIZE = 255
Tags
since
1.0

Properties

$helper

The error message for the string type when validation fails.

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

$password

Simple boolean to determine if the string is a password or not.

private bool $password = false
Tags
since
1.0

$size

The size of the value for the this String.

private int $size = 255
Tags
since
1.0

$validationRule

The validation rule for the string type.

private string $validationRule
Tags
since
1.0

$value

The value of the string.

private string $value
Tags
since
1.0

Methods

__construct()

Constructor.

public __construct([string $val = '' ]) : mixed
Parameters
$val : string = ''
Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

__toString()

Used to convert the object to a printable string.

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

checkIsPassword()

Checks to see if the string is a password or not.

public checkIsPassword() : bool
Tags
since
1.0
Return values
bool —

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 Double in the database field.

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

getValue()

Getter for the value.

public getValue() : string
Tags
since
1.0
Return values
string —

isPassword()

Define the string as a password (making it required by validation rule).

public isPassword([bool $pass = true ]) : mixed
Parameters
$pass : bool = true
Tags
since
1.0
Return values
mixed —

isRequired()

Sets up an appropriate validation rule for a required field.

public isRequired([bool $req = true ]) : mixed
Parameters
$req : bool = true
Tags
since
1.0
Return values
mixed —

setHelper()

Set the validation helper text.

public setHelper(string $helper) : mixed
Parameters
$helper : string
Tags
since
1.0
Return values
mixed —

setRule()

Setter to override the default validation rule.

public setRule(string $rule) : mixed
Parameters
$rule : string
Tags
since
1.0
Return values
mixed —

setSize()

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

public setSize(int $size) : mixed
Parameters
$size : int
Tags
since
1.0
throws
IllegalArguementException
Return values
mixed —

Search results