Docs For Class StorableOKIType

Description

This is the StorablePrimitive equivalent of OKIType.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: StorableOKIType.class.php,v 1.12 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/StorableOKIType.class.php (line 13)

SObject
   |
   --Type
      |
      --StorableOKIType

Method Summary

void alterQuery (mixed $query)

object asABlob ()

object asAnOKIType ()

object asAShortString ()

object asAString ()

integer insert (integer $dbID)

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

object StorableOKIType populate (array $dbRow)

void prune (integer $dbID, integer $dataID)

void update (integer $dbID, integer $dataID)

Methods

alterQuery (line 154)

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)

asABlob (line 194)

Convert this object to a StorableBlob

since: 6/9/06
access: public

object asABlob ()

asAnOKIType (line 227)

Convert this object to a OKIType

since: 6/9/06
access: public

object asAnOKIType ()

asAShortString (line 216)

Convert this object to a StorableShortString

since: 6/9/06
access: public

object asAShortString ()

asAString (line 205)

Convert this object to a StorableString

since: 6/9/06
access: public

object asAString ()

insert (line 94)

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.

makeSearchString (line 45)

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 $type, [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 $type: object $value The Primitive object to search for.

populate (line 29)

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.

access: public

object StorableOKIType populate (array $dbRow)

array $dbRow

prune (line 168)

Deletes the data row from the appropriate table.

access: public

void prune (integer $dbID, integer $dataID)

integer $dbID: The DBHandler database ID to query.
integer $dataID: The ID in the database of the data to be deleted.

update (line 124)

Uses the ID passed and updates the database row with new data.

access: public

void update (integer $dbID, integer $dataID)

integer $dbID: The DBHandler database ID to query.
integer $dataID: The ID in the database of the data to be updated.

Inherited Methods

Inherited From Type

Type::Type()
Type::fromString()
Type::getAuthority()
Type::getDescription()
Type::getDomain()
Type::getKeyword()
Type::isEqual()
Type::isEqualTo()
Type::printableString()
Type::typeToString()

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