Docs For Class String

Description

A simple String data type.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: String.class.php,v 1.6 2007/09/04 20:25:27 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/Primitives/Collections-Text/String.class.php (line 16)

SObject
   |
   --String

Direct descendents

Class	Description
StorableStringAbstract	This is the StorablePrimitive abstract for classes with string-type data values.
Blob	A simple Blob data type.
HtmlString	A HtmlString data type. This class allows for HTML-safe string shortening.

Variable Summary

mixed $_string

Method Summary

String String ([mixed $string = ""])

ref fromString (string $aString)

boolean isEqualTo (object $anObject)

string printableString ()

ref withValue (string $value)

Variables

mixed $_string (line 20)

Methods

Constructor String (line 22)

String String ([mixed $string = ""])

fromString (line 59)

Instantiates a new String object with the passed value.

allowing 'fromString' for string values

return: object
static:
access: public

ref fromString (string $aString)

string $aString

Redefined in descendants as:

Blob::fromString() : Instantiates a new Blob object with the passed value.
HtmlString::fromString() : Instantiates a new String object with the passed value.

isEqualTo (line 75)

Answer whether the receiver and the argument are the same.

If = is redefined in any subclass, consider also redefining the message hash.

since: 7/11/05
access: public

boolean isEqualTo (object $anObject)

object $anObject

Redefinition of:

SObject::isEqualTo(): Answer whether the receiver and the argument are the same.

printableString (line 34)

Answer a String whose characters are a description of the receiver.

Override this method as needed to provide a better representation

since: 7/11/05
access: public

string printableString ()

Redefinition of:

SObject::printableString(): Answer a String whose characters are a description of the receiver.

withValue (line 45)

Instantiates a new String object with the passed value.

return: object
static:
access: public

ref withValue (string $value)

string $value

Redefined in descendants as:

Blob::withValue() : Instantiates a new Blob object with the passed value.
HtmlString::withValue() : Instantiates a new String object with the passed value.

Inherited Methods

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()