, Jam Warehouse (Pty) Ltd, South Africa * @package documentmanagement.archiving */ KTUtil::extractGPC('fArchivingTypeID', 'fDocumentID'); /** * Displays an error message */ function renderErrorMessage($sErrorMessage) { $sToRender = ""; $sToRender .= ""; $sToRender .= "

$sErrorMessage

"; return $sToRender; } function renderDocumentTransactionListBox($iDocumentTransactionID) { global $default; $oPatternListBox = & new PatternListBox($default->transaction_types_table, "name", "id", "fDocumentTransactionID"); $oPatternListBox->setWhereClause("ST.name in ('View','Download')"); if (isset($iDocumentTransactionID)) { $oPatternListBox->setSelectedValue($iDocumentTransactionID); } return $oPatternListBox->render(); } function renderArchivingTypeListBox() { global $default, $fArchivingTypeID; $oPatternListBox = & new PatternListBox($default->archiving_type_lookup_table, "name", "id", "fArchivingTypeID"); $oPatternListBox->setPostBackOnChange(true); $oPatternListBox->setSelectedValue($fArchivingTypeID); return $oPatternListBox->render(); } function renderTimeUnitsListBox($iTimeUnitID) { global $default; $oPatternListBox = & new PatternListBox($default->time_unit_lookup_table, "name", "id", "fTimeUnitID"); if (isset($iTimeUnitID)) { $oPatternListBox->setSelectedValue($iTimeUnitID); } return $oPatternListBox->render(); } function renderChooseArchivingTypeForm() { global $default, $fDocumentID; $sToRender = ""; $sToRender .= ""; $sToRender .= ""; // hidden archive settings references $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "
" . _("Choose the archiving type for this document") . "
" . _("Archiving Type") . ":" . renderArchivingTypeListBox() . "
" . generateControllerLink("viewDocument", "fDocumentID=$fDocumentID&fShowSection=archiveSettings", "") . "
"; return $sToRender; } function getDateArchivingJavascript() { $sToRender .= "\n\n\n\n"; return $sToRender; } function getUtilisationArchivingJavascript() { $sToRender .= "\n\n\n\n"; return $sToRender; } function renderTimePeriod($sHeading, $sFooter = "", $oTimePeriod = null) { global $default; $sToRender .= ""; if (strlen($sHeading) > 0) { $sToRender .= "$sHeading:"; } $sToRender .= "getUnits() : "") . "\">"; $sToRender .= "  " . renderTimeUnitsListBox( ($oTimePeriod ? $oTimePeriod->getTimeUnitID() : null) ) . $sFooter; $sToRender .= "  "; $sToRender .= ""; return $sToRender; } /** * Displays the edit archive settings form * * @param integer the archive settings to modify, null display an add form */ function renderArchiveSettingsForm($iDocumentID, $oArchiveSettings, $iArchivingTypeID = -1) { global $default, $fDocumentID; if ($oArchiveSettings) { $sToRender .= "(" . _("in order to change the archiving type for this document, click the 'Remove' button and add new archiving settings") . ")"; $iArchivingTypeID = $oArchiveSettings->getArchivingTypeID(); } $sArchivingType = lookupName($default->archiving_type_lookup_table, $iArchivingTypeID); $sToRender .= ""; // TODO: calendar control integration switch ($sArchivingType) { case "Date" : $sToRender .= ""; $sToRender .= ""; $sToRender .= ""; if ($oArchiveSettings) { $oTimePeriod = TimePeriod::get($oArchiveSettings->getTimePeriodID()); $sToRender .= renderTimePeriod(_("Expires after"), _("from document creation date"), $oTimePeriod); } else { $sToRender .= renderTimePeriod(_("Expires after"), _("from document creation date")); } $sToRender .= getDateArchivingJavascript(); break; case "Utilisation" : $sToRender .= ""; $sToRender .= ""; if ($oArchiveSettings) { $oTimePeriod = TimePeriod::get($oArchiveSettings->getTimePeriodID()); $sToRender .= renderTimePeriod("", "", $oTimePeriod); } else { $sToRender .= renderTimePeriod(""); } if ($oArchiveSettings) { $iDocumentTransactionID = $oArchiveSettings->getDocumentTransactionID(); } $sToRender .= ""; $sToRender .= getUtilisationArchivingJavascript(); break; } // hidden archive settings references $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n"; if ($oArchiveSettings) { $sToRender .= "\n"; $sToRender .= "
Archive By Date
" . _("Expiration Date") . ":getExpirationDate() == "0000-00-00" ? "" : $oArchiveSettings->getExpirationDate()) . "\"" : "") . ">"; $sToRender .= "  graphicsUrl/calendar/calendar.gif\" name=\"imgCalendar\" width=\"34\" height=\"21\" border=\"0\" alt=\"\">"; $sToRender .= "  
Archive By Utilisation
Archive document
" . sprintf(_("after the last %s transactions"), renderDocumentTransactionListBox($iDocumentTransactionID)) . "
\n"; $sToRender .= generateControllerLink("modifyDocumentArchiveSettings", "fDocumentID=$fDocumentID&fDelete=1", ""); } else { $sToRender .= "
\n"; $sToRender .= generateControllerLink("addDocumentArchiveSettings", "fDocumentID=$fDocumentID", ""); } $sToRender .= generateControllerLink("viewDocument", "fDocumentID=$fDocumentID&fShowSection=archiveSettings", "") . "
"; return $sToRender; } /** * Displays the edit document archive settings page */ function renderEditArchiveSettingsPage($iDocumentID, $oArchiveSettings, $sErrorMessage = "") { global $default; $sToRender .= renderHeading(_("Edit Document Archive Settings")); $sToRender .= displayDocumentPath($iDocumentID); if (strlen($sErrorMessage) > 0) { $sToRender .= renderErrorMessage($sErrorMessage); } $sToRender .= "\n"; $sToRender .= renderArchiveSettingsForm($iDocumentID, $oArchiveSettings); $sToRender .= "
\n"; return $sToRender; } /** * Displays the add document archive settings page */ function renderAddArchiveSettingsPage($iDocumentID, $iArchivingTypeID = false, $sErrorMessage = "") { global $default; $sToRender .= renderHeading(_("Add Document Archive Settings")); $sToRender .= displayDocumentPath($iDocumentID); if (strlen($sErrorMessage) > 0) { $sToRender .= renderErrorMessage($sErrorMessage); } $sToRender .= "\n"; if ($iArchivingTypeID) { $sToRender .= renderArchiveSettingsForm($iDocumentID, null, $iArchivingTypeID); } else { $sToRender .= renderChooseArchivingTypeForm(); } $sToRender .= "
\n"; return $sToRender; } /** * Display the confirmation page for manual archiving of a document */ function renderArchiveConfirmationPage($iDocumentID, $sErrorMessage = "") { global $default; $sToRender = renderHeading(_("Archive Document")); if (strlen($sErrorMessage) > 0) { $sToRender .= renderErrorMessage($sErrorMessage); } $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n\n"; $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= "\n"; $sToRender .= ""; $sToRender .= ""; $sToRender .= "
" . _("You have chosen to archive the document entitled") . " '" . Document::getDocumentName($iDocumentID) . "'.
" . _("Select 'Archive' to confirm, or 'Cancel' to cancel.") . "
 
" . generateControllerLink("viewDocument", "fDocumentID=$iDocumentID&fShowSection=archiveSettings", "") . "
\n"; return $sToRender; } ?>