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

Class: Text

Source Location: /model/types/Text.inc

Class Text

Class Overview

Implements interfaces:

The Text complex data type

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

AlphaType
   |
   --Text
Author(s):
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: Text.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

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 Text

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

[ Top ]
Method Summary
boolean   getAllowHTML()   Get the $allowHTML value
string   getRule()   Get the validation rule
integer   getSize()   Get the allowable size of the Double in the database field
string   getValue()   Getter for the value
Text   __construct()   Constructor
void   setAllowHTML()   Set the $allowHTML value
void   setRule()   Setter to override the default validation rule
void   setSize()   Used to set the allowable size of the Text in the database field
void   setValue()   Setter for the value

[ Top ]
Properties
string   $helper = 'Not a valid text value!' [line 83]

The error message for the string type when validation fails

API Tags:
Access:  protected

Information Tags:
Since:  1.0

[ Top ]
Methods
getAllowHTML  [line 213]

  boolean getAllowHTML( )

Get the $allowHTML value


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getRule  [line 168]

  string getRule( )

Get the validation rule


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getSize  [line 193]

  integer getSize( )

Get the allowable size of the Double in the database field


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getValue  [line 148]

  string getValue( )

Getter for the value


API Tags:
Access:  public

Information Tags:
Since:  1.0

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

[ Top ]
Constructor __construct  [line 108]

  Text __construct( [string $val = '']  )

Constructor

Parameters:
string   $val: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
setAllowHTML  [line 203]

  void setAllowHTML( boolean $allowHTML  )

Set the $allowHTML value

Parameters:
boolean   $allowHTML: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setRule  [line 158]

  void setRule( string $rule  )

Setter to override the default validation rule

Parameters:
string   $rule: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setSize  [line 179]

  void setSize( integer $size  )

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

Parameters:
integer   $size: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
setValue  [line 130]

  void setValue( string $val  )

Setter for the value

Parameters:
string   $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 = 65535 [line 99]

The absolute maximum size of the value for the this Text

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:40 +0000 by phpDocumentor 1.4.3