DocumentArchiveSettingsFactory.inc
4.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<?php
require_once("$default->fileSystemRoot/lib/archiving/DocumentArchiving.inc");
require_once("$default->fileSystemRoot/lib/archiving/ArchivingUtilisationSettings.inc");
require_once("$default->fileSystemRoot/lib/archiving/ArchivingDateSettings.inc");
require_once("$default->fileSystemRoot/lib/archiving/TimePeriod.inc");
/**
* $Id$
*
* Business logic for setting document archive settings
*
* Licensed under the GNU GPL. For full terms see the file DOCS/COPYING.
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.archiving
*/
class DocumentArchiveSettingsFactory {
var $iArchivingTypeID;
var $sArchivingType;
/**
* Constructs a new factory for the specified archiving type
*/
function DocumentArchiveSettingsFactory($iArchivingTypeID) {
global $default;
$this->iArchivingTypeID = $iArchivingTypeID;
$this->sArchivingType = lookupName($default->owl_archiving_type_lookup_table, $iArchivingTypeID);
}
function handleTimePeriod($iTimeUnitID, $iUnits) {
if ($iTimeUnitID && $iUnits) {
// search for an existing time period id
$aTimePeriod = TimePeriod::getList("time_unit_id=$iTimeUnitID AND units=$iUnits");
if (count($aTimePeriod) > 0) {
$iTimePeriodID = $aTimePeriod[0]->getID();
} else {
// create it
$oTimePeriod = new TimePeriod($iTimeUnitID, $iUnits);
if ($oTimePeriod->create()) {
$iTimePeriodID = $oTimePeriod->getID();
} else {
$default->log->error("couldn't create time period- " . arrayToString($oTimePeriod));
return false;
}
}
} else {
$iTimePeriodID = -1;
}
return $iTimePeriodID;
}
function create($iDocumentID, $dExpirationDate, $iDocumentTransactionID, $iTimeUnitID, $iUnits) {
global $default;
// process time period (if any)
$iTimePeriodID = $this->handleTimePeriod($iTimeUnitID, $iUnits);
// construction strings
switch ($this->sArchivingType) {
case "Date" : $sSearchConstruction = "\$aArchiveSettings = ArchivingDateSettings::getList(\"";
$sSearchConstruction .= (isset($dExpirationDate) ? "expiration_date='$dExpirationDate'" : "time_period_id=$iTimePeriodID") . "\");";
$sConstruction = "\$oArchiveSettings = new ArchivingDateSettings(\$dExpirationDate, $iTimePeriodID);";
break;
case "Utilisation" : $sSearchConstruction = "\$aArchiveSettings = ArchivingUtilisationSettings::getList(\"document_transaction_id=$iDocumentTransactionID AND time_period_id=$iTimePeriodID\");";
$sConstruction = "\$oArchiveSettings = new ArchivingUtilisationSettings($iDocumentTransactionID, $iTimePeriodID);";
break;
}
// search for the settings first
eval($sSearchConstruction);
if (count($aArchiveSettings) > 0) {
$iArchiveSettingsID = $aArchiveSettings[0]->getID();
$default->log->info("looked up archive settings id=$iArchiveSettingsID");
} else {
// create them
eval($sConstruction);
if ($oArchiveSettings->create()) {
$iArchiveSettingsID = $oArchiveSettings->getID();
} else {
$default->log->error("couldn't create archive settings- " . arrayToString($oArchiveSettings));
return false;
}
}
// now link to the documents
$oDocumentArchiving = new DocumentArchiving($iDocumentID, $this->iArchivingTypeID, $iArchiveSettingsID);
if ($oDocumentArchiving->create()) {
return true;
} else {
$default->log->error("couldn't create document archiving - " . arrayToString($oDocumentArchiving));
return false;
}
}
function update($oDocumentArchiving, $dExpirationDate, $iDocumentTransactionID, $iTimeUnitID, $iUnits) {
global $default;
// retrieve the settings
$sRetrieveConstruction = "\$oArchiveSettings = Archiving" . $this->sArchivingType . "Settings::get(\"" . $oDocumentArchiving->getArchivingSettingsID(). "\");";
eval($sRetrieveConstruction);
if ($oArchiveSettings) {
// process time period (if any)
$iTimePeriodID = $this->handleTimePeriod($iTimeUnitID, $iUnits);
$oArchiveSettings->setTimePeriodID($iTimePeriodID);
// update it based on the type
switch ($this->sArchivingType) {
case "Date" : $oArchiveSettings->setExpirationDate($dExpirationDate);
break;
case "Utilisation" : $oArchiveSettings->setDocumentTransactionID($iDocumentTransactionID);
break;
}
if ($oArchiveSettings->update()) {
return true;
} else {
$default->log->error("error updating archive settings for documentID=" . $oArchiveSettings->getDocumentID());
}
} else {
$default->log->error("couldn't retrieve archive settings");
return false;
}
}
}
?>