Browser.inc
4.35 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
<?php
/**
* $Id$
*
* Contains document browsing business logic.
*
* 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.browse
*/
require_once("$default->fileSystemRoot/lib/security/Permission.inc");
require_once("$default->fileSystemRoot/lib/users/User.inc");
require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc");
require_once("$default->fileSystemRoot/lib/foldermanagement/Folder.inc");
require_once("Criteria.inc");
class Browser {
/**
* The point we're browsing from
*/
var $sBrowseStart;
/**
* The criteria to sort the browse results by- maps the database field to display name and lookup table
*/
var $aSortCriteria;
/**
* The field to sort the browse results by
*/
var $sSortField;
/**
* The direction to sort the results in
*/
var $sSortDirection;
var $aOptions = array();
/**
* Constructs a new Browser instance
*
* @param string the field to sort by
* @param string the direction to sort in
* @param array the sort criteria
*/
function Browser($sNewSortField, $sNewSortDirection, $aNewSortCriteria = array()) {
// default sort criteria
if (count($aNewSortCriteria) == 0) {
$aNewSortCriteria = array();
$aQuery = array("SELECT criteria_id FROM browse_criteria ORDER BY precedence", array()); /*ok*/
$aSelectedCriteriaIDs = DBUtil::getResultArrayKey($aQuery, 'criteria_id');
foreach ($aSelectedCriteriaIDs as $iID) {
$oCriterion =& Criteria::getCriterionByNumber($iID);
$aNewSortCriteria[$oCriterion->getName()] =& $oCriterion;
}
}
$this->aSortCriteria =& $aNewSortCriteria;
$this->sSortField = $sNewSortField;
$this->sSortDirection = $sNewSortDirection;
}
/**
* Returns the browse start point
*/
function getBrowseStart() {
return $this->$sBrowseStart;
}
/**
* Set the browse start point
*/
function setBrowseStart($aNewBrowseStart) {
$this->$sBrowseStart = $aNewBrowseStart;
}
/**
* Returns the document sort criteria
*/
function getSortCriteria() {
return $this->aSortCriteria;
}
/**
* Set the document sort criteria
*/
function setSortCriteria($aNewSortCriteria) {
$this->aSortCriteria = $aNewSortCriteria;
}
/**
* Return the current sort field
*/
function getSortField() {
return $this->sSortField;
}
/**
* Set the current sort field
*/
function setSortField($sNewSortField) {
$this->sSortField = $sNewSortField;
}
/**
* Return the current sort direction
*/
function getSortDirection() {
return $this->sSortDirection;
}
/**
* Set the current sort direction
*/
function setSortDirection($sNewSortDirection) {
$this->sSortDirection = $sNewSortDirection;
}
function setOptions($aOptions) {
$this->aOptions = array_merge($this->aOptions, $aOptions);
foreach (array_keys($this->aSortCriteria) as $sKey) {
$oCriteria =& $this->aSortCriteria[$sKey];
$oCriteria->setOptions($aOptions);
}
}
function getOptions() {
return $this->aOptions;
}
function columns() {
return count($this->aSortCriteria);
}
/**
* [Abstract] Browse the documents
*
* @return array documentCollections and documents
*/
function browse() {
}
}
?>