Class: HistoricalDataObjectWrapper

Source Location: /db/HistoricalDataObjectWrapper.php

Class Overview

PEAR
   |
   --DataObjectWrapper
      |
      --HistoricalDataObjectWrapper

Created on Mar 1, 2005

Author(s):

brian.fioca@pangomedia.com

Inherited Variables

Class: DataObjectWrapper

DataObjectWrapper::$_oDataObject
DataObjectWrapper::$_stOrderBy

Inherited Methods

Class: DataObjectWrapper

DataObjectWrapper::__construct(): Constructor Initialize the data object using the table name specified in the subclass.
DataObjectWrapper::checkSecurityCriteria()
DataObjectWrapper::delete(): Deletes the DataObject Entity corresponding to this wrapper.
DataObjectWrapper::fillFromRequest(): Use this method to auto provision the db object from request data.
DataObjectWrapper::find()
DataObjectWrapper::findAll(): Initializes the underlying data object to iterate over all data
DataObjectWrapper::getForId(): Loads the underlying DataObject for its id.
DataObjectWrapper::getId(): Get the primary key for this data object.
DataObjectWrapper::getMultiFromRequest(): UNDER DEVELOPMENT
DataObjectWrapper::getNameField()
DataObjectWrapper::handleErrors()
DataObjectWrapper::makeBumpCase()
DataObjectWrapper::makeSelectOptions(): Uses the implied
DataObjectWrapper::next(): Loads the data object with the next logical entity from the database.
DataObjectWrapper::save(): Saves the DataObjectWrapper
DataObjectWrapper::toArray(): Use this method to populate page elements or template placeholders with data from this object.
DataObjectWrapper::validateSave(): Method used to validate business logic prior to saving.

Class Details

[line 35]
Created on Mar 1, 2005

--- UNDER CONSTRUCTION ------

HistoricalDataObjectWrapper is a DataObjectWrapper which includes standard members and methods for loading and persisting historical data. All methods necessary to the abstract function of retrieving active 'Epochs' of data and archiving old data are represented here for children classes to use.

Tags:

abstract:
author:	brian.fioca@pangomedia.com
since:	0.5

[ Top ]

Class Variables

$_stPrimaryKey = 'abstract_historical_id'

[line 41]

NOTE - Subclasses MUST override this property

Tags:

access:

protected

Type:	mixed
Overrides:	Array

[ Top ]

$_stTableName = 'abstract_historical_table'

[line 39]

NOTE - Subclasses MUST override this property

Tags:

access:

protected

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

method getEffectiveDate [line 65]

void getEffectiveDate(
)

Tags:

access:

public

[ Top ]

method getEffectiveForDate [line 50]

void getEffectiveForDate(
$dtDate
$dtDate)

Loads the underlying DataObject effective during the passed in date.

If there isn't one effective during the passed in date, the DataObjectWrapper remains uninitialized.

Tags:

access:

public

Parameters:

$dtDate

$dtDate

the date for which to load the epoch

[ Top ]

method getTerminationDate [line 75]

void getTerminationDate(
)

Tags:

access:

public

[ Top ]

method save [line 88]

void save(
)

Saves the HistoricalDataObjectWrapper in an historically friendly way

Tags:

access:

public

Overrides DataObjectWrapper::save() (Saves the DataObjectWrapper)

[ Top ]

method setEffectiveDate [line 70]

void setEffectiveDate(
mixed
$dtEffectiveDate)

Tags:

access:

public

[ Top ]

method setTerminationDate [line 80]

void setTerminationDate(
mixed
$dtTerminationDate)

Tags:

access:

public

[ Top ]

method terminate [line 123]

void terminate(
mixed
$dtDate)

Tags:

access:

protected

[ Top ]

Documentation generated on Sun, 27 Nov 2005 13:15:53 -0500 by phpDocumentor 1.3.0RC3