TimePeriod.inc
5.37 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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?php
/**
* $Id$
*
* Represents a time period.
*
* 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 TimePeriod {
/**
* The primary key
*/
var $iId;
/**
* The time units
*/
var $iTimeUnitID;
/**
* The number of units
*/
var $iUnits;
/**
* Constructs an time period instance
*
* @param date the time unit
* @param integer the expiration time period id
*/
function TimePeriod($iNewTimeUnitID, $iNewUnits) {
global $default;
// primary key not set as this is not stored yet
$this->iId = -1;
$this->iTimeUnitID = $iNewTimeUnitID;
$this->iUnits = $iNewUnits;
}
/**
* Gets the primary key
*/
function getID(){
return $this->iId;
}
/**
* Gets the time unit
*/
function getTimeUnitID() {
return $this->iTimeUnitID;
}
/**
* Sets the time unit
*
* @param integer the new time unit
*/
function setTimeUnitID($iNewTimeUnitID){
$this->iTimeUnitID = $iNewTimeUnitID;
}
/**
* Gets the units
*/
function getUnits(){
return $this->iUnits;
}
/**
* Sets the units
*
* @param integer the new units
*/
function setUnits($iNewUnits){
$this->iUnits = $iNewUnits;
}
/**
* Inserts the time period 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->time_period_table (time_unit_id, units) " .
"VALUES ($this->iTimeUnitID, $this->iUnits)");
if ($result) {
//set the current primary key
$this->iId = $sql->insert_id();
return true;
}
return false;
}
return false;
}
/**
* Update the time period 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->time_period_table SET " .
"time_unit_id = $this->iTimeUnitID, " .
"units = $this->iUnits " .
"WHERE id = $this->iId";
$result = $sql->query($sQuery);
if ($result) {
return true;
}
return false;
}
return false;
}
/**
* Delete the current time period 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->time_period_table WHERE id = $this->iId");
if ($result) {
$this->iId = -1;
return true;
}
return false;
}
return false;
}
/**
* Static function. Given a primary key will create
* a TimePeriod object and populate it with the corresponding
* database values
*
* @return TimePeriod populated TimePeriod object on success, false otherwise
*/
function & get($iTimePeriodID) {
global $default;
$sql = $default->db;
$sql->query("SELECT * FROM $default->time_period_table WHERE id = $iTimePeriodID");
if ($sql->next_record()) {
$oTimePeriod = & new TimePeriod($sql->f("time_unit_id"), $sql->f("units"));
$oTimePeriod->iId = $iTimePeriodID;
return $oTimePeriod;
}
return false;
}
/**
* Static function
* Get a list of TimePeriod objects
*
* @param String Where clause (optional)
* @return Array array of TimePeriod objects, false otherwise
*/
function getList($sWhereClause = null) {
global $default;
$aTimePeriodArray = array();
$sql = $default->db;
$result = $sql->query("SELECT * FROM $default->time_period_table " . (isset($sWhereClause) ? " WHERE " . $sWhereClause : ""));
if ($result) {
$iCount = 0;
while ($sql->next_record()) {
$oTimePeriod = & TimePeriod::get($sql->f("id"));
$aTimePeriodArray[$iCount++] = $oTimePeriod;
}
return $aTimePeriodArray;
}
return false;
}
}