Docs For Class Boolean

Description

A simple Boolean data type.

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

Located in /harmoni/core/Primitives/Objects/Boolean.class.php (line 16)

SObject
   |
   --Boolean

Direct descendents

Class	Description
StorableBoolean	This is the StorablePrimitive equivalent of Boolean.

Variable Summary

mixed $_bool

Method Summary

Boolean Boolean ([mixed $value = true])

object Boolean false ()

ref fromString (string $aString)

boolean isEqualTo (object $anObject)

boolean isFalse ()

boolean isTrue ()

string printableString ()

object Boolean true ()

boolean value ()

ref withValue (string $value)

Variables

mixed $_bool (line 20)

Methods

Constructor Boolean (line 82)

*******************************************************

Instance Methods *******************************************************

Boolean Boolean ([mixed $value = true])

false (line 60)

Instantiates a new Boolean object with the value, false.

static:
since: 8/11/05
access: public

object Boolean false ()

fromString (line 47)

Instantiates a new Boolean object from a known string

return: object
since: 3/14/06
access: public

ref fromString (string $aString)

string $aString: true(case insensitive) is true if not, it's false

isEqualTo (line 118)

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.

isFalse (line 143)

Answer true if this object represents a 'false' value, false otherwise.

since: 9/29/05
access: public

boolean isFalse ()

isTrue (line 132)

Answer true if this object represents a 'true' value, false otherwise.

since: 9/29/05
access: public

boolean isTrue ()

printableString (line 104)

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.

true (line 73)

Instantiates a new Boolean object with the value, true.

static:
since: 8/11/05
access: public

object Boolean true ()

value (line 91)

Returns the boolean value.

access: public

boolean value ()

withValue (line 33)

Instantiates a new Boolean object with the passed value.

return: object
static:
access: public

ref withValue (string $value)

string $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()