Docs For Class StorableString

Description

This is the StorablePrimitive equivalent of String for the dm_string table.

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

Located in /harmoni/core/dataManager/storablePrimitives/StorableString.class.php (line 15)

SObject
   |
   --String
      |
      --StorableStringAbstract
         |
         --StorableString

Method Summary

StorableString StorableString ()

void alterQuery (mixed $query)

object StorableString createAndPopulate (array $dbRow)

integer insert (integer $dbID)

string makeSearchString (ref $value, [int $searchType = SEARCH_TYPE_EQUALS])

void _setValue ($value $value)

Variables

Inherited Variables

Inherited from StorableStringAbstract

StorableStringAbstract::$_table

Inherited from String

String::$_string

Methods

Constructor StorableString (line 105)

StorableString StorableString ()

alterQuery (line 117)

Takes an existing SelectQuery and adds a table join and some columns so that when it is executed the actual data can be retrieved from the row. The join condition must be "fk_data = data_id_field", since the field "fk_data" is already part of the DataManager's table structure.

access: public

void alterQuery (mixed $query)

createAndPopulate (line 43)

Takes a single database row, which would contain the columns added by alterQuery() and extracts the values to setup the object with the appropriate data.

static:
access: public

object StorableString createAndPopulate (array $dbRow)

array $dbRow

insert (line 30)

Inserts a new row into the Database with the data contained in the object.

return: Returns the new ID of the data stored.
access: public

integer insert (integer $dbID)

integer $dbID: The DBHandler database ID to query.

Redefinition of:

StorableStringAbstract::insert(): Inserts a new row into the Database with the data contained in the object.

makeSearchString (line 59)

Returns a string that could be inserted into an SQL query's WHERE clause, based on the Primitive value that is passed. It is used when searching for datasets that contain a certain field=value pair.

return: or NULL if no searching is allowed.
static:

string makeSearchString (ref $value, [int $searchType = SEARCH_TYPE_EQUALS])

int $searchType: One of the SEARCH_TYPE_* constants, defining what type of search this should be (ie, equals, contains, greater than, less than, etc)
ref $value: object $value The Primitive object to search for.

_setValue (line 101)

Set the value

since: 7/13/05
access: private

void _setValue ($value $value)

$value $value

Inherited Methods

Inherited From StorableStringAbstract

StorableStringAbstract::asABlob()
StorableStringAbstract::asABoolean()
StorableStringAbstract::asADateTime()
StorableStringAbstract::asAFloat()
StorableStringAbstract::asAInteger()
StorableStringAbstract::asAnOKIType()
StorableStringAbstract::asAShortString()
StorableStringAbstract::asAString()
StorableStringAbstract::insert()
StorableStringAbstract::prune()
StorableStringAbstract::update()

Inherited From String

String::String()
String::fromString()
String::isEqualTo()
String::printableString()
String::withValue()

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