Class String

The String complex data type

AlphaType

String 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: String.inc 1496 2012-02-12 20:32:21Z alphadev $
Since: 1.0
Located at model/types/String.inc

Methods summary
`public`	# `__construct( string $val = '' )` Constructor Constructor Parameters `$val` `string` $val Throws `IllegalArguementException` Since 1.0
`public`	# `setValue( string $val )` Setter for the value Setter for the value Parameters `$val` `string` $val Throws `IllegalArguementException` Since 1.0 Implementation of `AlphaTypeInterface::setValue()`
`public string`	# `getValue( )` Getter for the value Getter for the value Returns `string` Since 1.0 Implementation of `AlphaTypeInterface::getValue()`
`public`	# `setRule( string $rule )` Setter to override the default validation rule Setter to override the default validation rule Parameters `$rule` `string` $rule Since 1.0
`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 String in the database field Used to set the allowable size of the String in the database field Parameters `$size` `integer` $size Throws `IllegalArguementException` Since 1.0
`public integer`	# `getSize( )` Get the allowable size of the Double in the database field Get the allowable size of the Double in the database field Returns `integer` Since 1.0
`public`	# `isRequired( boolean $req = true )` Sets up an appropriate validation rule for a required field Sets up an appropriate validation rule for a required field Parameters `$req` `boolean` $req Since 1.0
`public`	# `isPassword( boolean $pass = true )` Define the string as a password (making it required by validation rule) Define the string as a password (making it required by validation rule) Parameters `$pass` `boolean` $pass Since 1.0
`public boolean`	# `checkIsPassword( )` Checks to see if the string is a password or not Checks to see if the string is a password or not Returns `boolean` Since 1.0

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

Constants summary
`integer`	`MAX_SIZE`	`255`	# The absolute maximum size of the value for the this String The absolute maximum size of the value for the this String Since 1.0

Properties summary
`private string`	`$value`		# The value of the string The value of the string Since 1.0
`private string`	`$validationRule`		# The validation rule for the string type The validation rule for the string type Since 1.0
`protected string`	`$helper`	`'Not a valid string value!'`	# The error message for the string type when validation fails The error message for the string type when validation fails Since 1.0
`private integer`	`$size`	`255`	# The size of the value for the this String The size of the value for the this String Since 1.0
`private boolean`	`$password`	`false`	# Simple boolean to determine if the string is a password or not Simple boolean to determine if the string is a password or not Since 1.0

Packages

Classes

Interfaces

Class String

Parameters

Throws

Since

Parameters

Throws

Since

Implementation of

Returns

Since

Implementation of

Parameters

Since

Returns

Since

Parameters

Throws

Since

Returns

Since

Parameters

Since

Parameters

Since

Returns

Since

Since

Since

Since

Since

Since

Since