Browser.inc
3.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
<?php
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");
/**
*
* $Id$
*
* Contains document browsing business logic.
*
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
*
* @package lib.browse
*/
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;
/**
* Constructs a new Browse 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 ( "name" => array ("display" => "Title"),
"filename" => array ("display" => "Filename"),
"creator_id" => array ("display" => "Creator",
"lookup" => array ("lookupTable" => "users",
"lookupField" => "name")),
"modified" => array ("display" => "Modified"),
"document_type_id" => array ("display" => "Document Type",
"lookup" => array ("lookupTable" => "document_types_lookup",
"lookupField" => "name")) );
}
$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;
}
/**
* [Abstract] Browse the documents by folder
*
* @return array folders and documents
*/
function browse() {
}
}