DocumentArchiving.inc
4.5 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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?php
/**
* $Id$
*
* Represents archive settings for a document.
*
* Copyright (c) 2003 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.archiving
*/
class DocumentArchiving extends KTEntity {
/**
* The primary key
*/
var $iId;
/**
* The document ID
*/
var $iDocumentID;
/**
* The archiving settings
*/
var $iArchivingSettingsID;
/**
* Constructs an archive settings instance
*
* @param integer the document id
* @param integer the archiving type id
* @param integer the archiving settings id
*/
function DocumentArchiving($iNewDocumentID, $iNewArchivingSettingsID) {
global $default;
// primary key not set as this is not stored yet
$this->iId = -1;
$this->iDocumentID = $iNewDocumentID;
$this->iArchivingSettingsID = $iNewArchivingSettingsID;
}
/**
* Gets the primary key
*/
function getID(){
return $this->iId;
}
/**
* Gets the document id
*/
function getDocumentID(){
return $this->iDocumentID;
}
/**
* Sets the document id
*
* @param integer the new document id
*/
function setDocumentID($iNewDocumentID){
$this->iDocumentID = $iNewDocumentID;
}
/**
* Gets the archiving settings
*/
function getArchivingSettingsID(){
return $this->iArchivingSettingsID;
}
/**
* Sets the archiving settings
*
* @param integer the new archiving settings
*/
function setArchivingSettingsID($iNewArchivingSettingsID){
$this->iArchivingSettingsID = $iNewArchivingSettingsID;
}
function _fieldValues () {
return array(
'document_id' => $this->iDocumentID,
'archiving_settings_id' => $this->iArchivingSettingsID,
);
}
function _table () {
global $default;
return $default->document_archiving_table;
}
/**
* Static function. Given a document primary key will create
* a DocumentArchiving object and populate it with the corresponding
* database values
*
* @return DocumentArchiving populated DocumentArchiving object on success, false otherwise
*/
function & getFromDocumentID($iDocumentID) {
global $default;
$sql = $default->db;
$sql->query(array("SELECT * FROM $default->document_archiving_table WHERE document_id = ?", $iDocumentID));/*ok*/
if ($sql->next_record()) {
$oDocumentArchiving = & new DocumentArchiving($sql->f("document_id"), $sql->f("archiving_settings_id"));
$oDocumentArchiving->iId = $sql->f("id");
return $oDocumentArchiving;
}
return false;
}
/**
* Static function. Given a news item primary key will create
* a DocumentArchiving object and populate it with the corresponding
* database values
*
* @return DocumentArchiving populated DocumentArchiving object on success, false otherwise
*/
function & get($iDocumentArchivingID) {
global $default;
$sql = $default->db;
$sql->query(array("SELECT * FROM $default->document_archiving_table WHERE id = ?", $iDocumentArchivingID));/*ok*/
if ($sql->next_record()) {
$oDocumentArchiving = & new DocumentArchiving($sql->f("document_id"), $sql->f("archiving_settings_id"));
$oDocumentArchiving->iId = $iDocumentArchivingID;
return $oDocumentArchiving;
}
return false;
}
/**
* Static function
* Get a list of DocumentArchiving objects
*
* @param String Where clause (optional)
* @return Array array of DocumentArchiving objects, false otherwise
*/
function getList($sWhereClause = null) {
return KTEntityUtil::getList(DocumentArchiving::_table(), 'DocumentArchiving', $sWhereClause);
}
}