From 1619e8780cc4c8cfb9d4905f43fce4e504b402c2 Mon Sep 17 00:00:00 2001 From: michael Date: Wed, 21 May 2003 15:19:24 +0000 Subject: [PATCH] removed old ArchiveSettings class --- lib/documentmanagement/ArchiveSettings.inc | 297 --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1 file changed, 0 insertions(+), 297 deletions(-) delete mode 100644 lib/documentmanagement/ArchiveSettings.inc diff --git a/lib/documentmanagement/ArchiveSettings.inc b/lib/documentmanagement/ArchiveSettings.inc deleted file mode 100644 index 7b36b27..0000000 --- a/lib/documentmanagement/ArchiveSettings.inc +++ /dev/null @@ -1,297 +0,0 @@ -, Jam Warehouse (Pty) Ltd, South Africa - * @package lib.dashboard - */ - -class ArchiveSettings { - - /** - * The primary key - */ - var $iId; - /** - * The document ID - */ - var $iDocumentID; - /** - * The archiving method- date or utilisation - */ - var $sArchivingMethod; - /** - * The expiration date - */ - var $dExpirationDate; - /** - * Document transaction utilisation marker - */ - var $iDocumentTransactionID; - /** - * The utilisation threshold - */ - var $iUtilisationThreshold; - /** - * Associative array of date units expressed as seconds - * ??: there must be a better way to do this? - */ - // (60*60*24*365); (60*60*30); (60*60*24) - var $aDateUnits = array("year" => 31536000, "month" => 108000, "day" => 86400); - - /** - * Constructs an archive settings instance - * - * @param integer the document id - * @param string the archiving method - * @param date the expiration date - * @param integer the utilisation threshold - * @param integer the document transaction id - */ - function ArchiveSettings($iNewDocumentID, $dNewExpirationDate, $iNewUtilisationThreshold, $iNewDocumentTransactionID) { - global $default; - - // primary key not set as this is not stored yet - $this->iId = -1; - $this->iDocumentID = $iNewDocumentID; - $this->dExpirationDate = $dNewExpirationDate; - $this->iUtilisationThreshold = $iNewUtilisationThreshold; - $this->iDocumentTransactionID = $iNewDocumentTransactionID; - $this->setArchivingMethod(); - } - - /** - * Gets the primary key - */ - function getID(){ - return $this->iId; - } - - /** - * Gets the document id - */ - function getDocumentID(){ - return $this->iDocumentID; - } - - /** - * Sets the document id - * - * @param string the new document id - */ - function setDocumentID($iNewDocumentID){ - $this->iDocumentID = $iNewDocumentID; - } - - /** - * Gets the expiration date - */ - function getExpirationDate(){ - return $this->dExpirationDate; - } - - /** - * Sets the expiration date - * - * @param date the new expiration date - */ - function setExpirationDate($dNewExpirationDate){ - $this->dExpirationDate = $dNewExpirationDate; - } - - /** - * Sets the expiration period - */ - function setExpirationPeriod($iNumber, $iUnit) { - } - - /** - * Gets the document transaction id - */ - function getDocumentTransactionID(){ - return $this->iDocumentTransactionID; - } - - /** - * Sets the document transaction id - * - * @param date the new document transaction id - */ - function setDocumentTransactionID($iNewDocumentTransactionID){ - $this->iDocumentTransactionID = $iNewDocumentTransactionID; - } - - /** - * Gets the utilisation threshold - */ - function getUtilisationThreshold(){ - return $this->iUtilisationThreshold; - } - - /** - * Sets the utilisation threshold - * - * @param integer the utilisation threshold - */ - function setUtilisationThreshold($iNewUtilisationThreshold){ - $this->iUtilisationThreshold = $iNewUtilisationThreshold; - } - - /** - * Returns the type of archiving being done ie. byDate or byTransaction - */ - function getArchivingMethod() { - return $this->sArchivingMethod; - } - - /** - * Sets the archiving method based on the object attributes - */ - function setArchivingMethod() { - if ($this->dExpirationDate <> "") { - $this->sArchivingMethod = "byDate"; - $this->iUtilisationThreshold = 0; - } else if ($this->iUtilisationThreshold <> 0) { - $this->sArchivingMethod = "byUtilisation"; - $this->dExpirationDate = ""; - - } - } - - /** - * Inserts the archive settings into the database - * - * @return boolean true on successful update, false otherwise - */ - function create(){ - global $default; - //if the id >= 0, then the object has already been created - if ($this->iId < 0) { - $sql = $default->db; - $result = $sql->query("INSERT INTO $default->owl_archive_settings_table (document_id, expiration_date, document_transaction_id, utilisation_threshold) " . - "VALUES ($this->iDocumentID, '$this->dExpirationDate', $this->iDocumentTransactionID, $this->iUtilisationThreshold)"); - if ($result) { - //set the current primary key - $this->iId = $sql->insert_id(); - // set the archiving method - $this->setArchivingMethod(); - return true; - } - return false; - } - return false; - } - - /** - * Update the archive settings current values in the database - * - * @return boolean true on successful update, false otherwise - */ - function update(){ - global $default; - if ($this->iId >= 0) { - $sql = $default->db; - $sQuery = "UPDATE " . $default->owl_archive_settings_table . " SET " . - "document_id = " . $this->iDocumentID . ", " . - "expiration_date = '" . $this->dExpirationDate . "', " . - "document_transaction_id = $this->iDocumentTransactionID, " . - "utilisation_threshold = $this->iUtilisationThreshold)" . - "WHERE id = $this->iId"; - $result = $sql->query($sQuery); - if ($result) { - // set the archiving method - $this->setArchivingMethod(); - return true; - } - return false; - } - return false; - } - - /** - * Delete the current archive settings from the database. Set the primary key to -1 - * on successful deletion - * - * @return boolean true and reset id to -1 on successful deletion, false otherwise - */ - function delete() { - global $default; - if ($this->iId >= 0) { - $sql = $default->db; - $result = $sql->query("DELETE FROM " . $default->owl_archive_settings_table . " WHERE id = $this->iId"); - if ($result) { - $this->iId = -1; - return true; - } - return false; - } - return false; - } - - /** - * Static function. Given a document primary key will create - * a ArchiveSettings object and populate it with the corresponding - * database values - * - * @return ArchiveSettings populated ArchiveSettings object on success, false otherwise - */ - function & getFromDocumentID($iDocumentID) { - global $default; - $sql = $default->db; - $sql->query("SELECT * FROM $default->owl_archive_settings_table WHERE document_id = $iDocumentID"); - if ($sql->next_record()) { - $oArchiveSettings = & new ArchiveSettings($sql->f("document_id"), $sql->f("expiration_date"), $sql->f("utilisation_threshold"), $sql->f("document_transaction_id")); - $oArchiveSettings->iId = $sql->f("id"); - return $oArchiveSettings; - } - return false; - } - - /** - * Static function. Given a news item primary key will create - * a ArchiveSettings object and populate it with the corresponding - * database values - * - * @return ArchiveSettings populated ArchiveSettings object on success, false otherwise - */ - function & get($iArchiveSettingsID) { - global $default; - $sql = $default->db; - $sql->query("SELECT * FROM $default->owl_archive_settings_table WHERE id = $iArchiveSettingsID"); - if ($sql->next_record()) { - $oArchiveSettings = & new ArchiveSettings($sql->f("document_id"), $sql->f("expiration_date"), $sql->f("utilisation_threshold"), $sql->f("document_transaction_id")); - $oArchiveSettings->iId = $iArchiveSettingsID; - return $oArchiveSettings; - } - return false; - } - - /** - * Static function - * Get a list of ArchiveSettings objects - * - * @param String Where clause (optional) - * @return Array array of ArchiveSettings objects, false otherwise - */ - function getList($sWhereClause = null) { - global $default; - $aArchiveSettingsArray = array(); - $sql = $default->db; - $result = $sql->query("SELECT * FROM " . $default->owl_archive_settings_table . (isset($sWhereClause) ? " WHERE " . $sWhereClause : "")); - if ($result) { - $iCount = 0; - while ($sql->next_record()) { - $oArchiveSettings = & ArchiveSettings::get($sql->f("id")); - $aArchiveSettingsArray[$iCount++] = $oArchiveSettings; - } - return $aArchiveSettingsArray; - } - return false; - } -} \ No newline at end of file -- libgit2 0.21.4