TimePeriod.inc
3.28 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
<?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 extends KTEntity {
/**
* 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;
}
function _fieldValues () {
return array(
'time_unit_id' => $this->iTimeUnitID,
'units' => $this->iUnits
);
}
function _table () {
global $default;
return $default->time_period_table;
}
/**
* 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(array("SELECT * FROM $default->time_period_table WHERE id = ?", $iTimePeriodID));/*ok*/
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) {
return KTEntityUtil::getList(TimePeriod::_table(), 'TimePeriod', $sWhereClause);
}
}