3 trait Pman_Core_RooGetTrait {
5 * GET method Roo/TABLENAME.php
7 * Generally for SELECT or Single SELECT
10 * _id=value single fetch based on primary id.
11 * can be '0' if you want to fetch a set of defaults
12 * Use in conjuntion with toRooSingleArray()
14 * lookup[key]=value single fetch based on a single key value lookup.
15 * multiple key/value can be used. eg. ontable+onid..
16 * _columns what to return.
20 * - all tables are always autojoined.
24 * _columns=a,b,c,d comma seperated list of columns.
25 * _columns_exclude=a,b,c,d comma seperated list of columns.
26 * _distinct=name a distinct column lookup. you also have to use _columns with this.
29 * colname = ... => colname = ....
30 * !colname=.... => colname != ....
31 * !colname[0]=... !colname[1]=... => colname NOT IN (.....) ** only supports main table at present..
32 * colname[0]=... colname[1]=... => colname IN (.....) ** only supports main table at present..
35 * sort=name what to sort.
36 * sort=a,b,d can support multiple columns
37 * dir=ASC what direction
38 * _multisort ={...} JSON encoded { sort : { row : direction }, order : [ row, row, row ] }
42 * limit=25 limit number
46 * csvCols[0] csvCols[1].... = .... column titles for CSV output
47 * csvTitles[0], csvTitles[1] .... = columns to use for CSV output
50 * _toggleActive !:!:!:! - this hsould not really be here..
51 * query[add_blank] - add a line in with an empty option... - not really needed???
52 * _delete = delete a list of ids element. (depricated.. this will be removed...)
55 * _post =1 = simulate a post with debuggin on.
56 * _debug_post << This is prefered, as _post may overlap with accouting posts..
58 * _debug = turn on DB_dataobject deubbing, must be admin at present..
61 * CALLS methods on dataobjects if they exist
64 * checkPerm('S' , $authuser)
65 * - can we list the stuff
66 * - return false to disallow...
67 * applySort($au, $sortcol, $direction, $array_of_columns, $multisort)
68 * -- does not support multisort at present..
69 * applyFilters($_REQUEST, $authUser, $roo)
70 * -- apply any query filters on data. and hide stuff not to be seen.
71 * -- can exit by calling $roo->jerr()
72 * postListExtra($_REQUEST) : array(extra_name => data)
73 * - add extra column data on the results (like new messages etc.)
74 * postListFilter($data, $authUser, $request) return $data
75 * - add extra data to an object
78 * toRooSingleArray($authUser, $request) : array
79 * - called on single fetch only, add or maniuplate returned array data.
80 * - is also called when _id=0 is used (for fetching a default set.)
81 * toRooArray($request) : array
82 * - called if singleArray is unavailable on single fetch.
83 * - always tried for mutiple results.
84 * toArray() - the default method if none of the others are found.
87 * - standard DataObject feature - causes all results to show all
91 * _extra_cols -- if set, then filtering by column etc. will use them.
99 HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
101 if ( $this->checkDebugPost()) {
103 return $this->post($tab);
108 PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
110 $tab = array_shift(explode('/', $tab));
111 $x = $this->dataObject($tab);
113 $_columns = !empty($_REQUEST['_columns']) ? explode(',', $_REQUEST['_columns']) : false;
115 if (isset( $_REQUEST['lookup'] ) && is_array($_REQUEST['lookup'] )) { // single fetch based on key/value pairs
116 $this->selectSingle($x, $_REQUEST['lookup'],$_REQUEST);
121 // single fetch (use '0' to fetch an empty object..)
122 if (isset($_REQUEST['_id']) && is_numeric($_REQUEST['_id'])) {
124 $this->selectSingle($x, $_REQUEST['_id'],$_REQUEST);
131 if (isset($_REQUEST['_delete'])) {
132 $this->jerr("DELETE by GET has been removed - update the code to use POST");
137 $this->jerr('no key');
140 $this->key = $keys[0];
143 // do we really delete stuff!?!?!?
144 return $this->delete($x,$_REQUEST);
151 if (isset($_REQUEST['_toggleActive'])) {
152 // do we really delete stuff!?!?!?
153 if (!$this->hasPerm("Core.Staff", 'E')) {
154 $this->jerr("PERMISSION DENIED (ta)");
156 $clean = create_function('$v', 'return (int)$v;');
157 $bits = array_map($clean, explode(',', $_REQUEST['_toggleActive']));
158 if (in_array($this->authUser->id, $bits) && $this->authUser->active) {
159 $this->jerr("you can not disable yourself");
161 $x->query('UPDATE Person SET active = !active WHERE id IN (' .implode(',', $bits).')');
162 $this->addEvent("USERTOGGLE", false, implode(',', $bits));
163 $this->jok("Updated");
166 //DB_DataObject::debugLevel(1);
169 // sets map and countWhat
170 $this->loadMap($x, array(
171 'columns' => $_columns,
172 'distinct' => empty($_REQUEST['_distinct']) ? false: $_REQUEST['_distinct'],
173 'exclude' => empty($_REQUEST['_exclude_columns']) ? false: explode(',', $_REQUEST['_exclude_columns'])
177 $this->setFilters($x,$_REQUEST);
179 if (!$this->checkPerm($x,'S', $_REQUEST)) {
180 $this->jerr("PERMISSION DENIED (g)");
184 // build join if req.
185 //DB_DataObject::debugLevel(1);
186 // var_dump($this->countWhat);
187 $total = $x->count($this->countWhat);
190 //var_dump($total);exit;
191 $this->applySort($x);
195 if (!empty($_REQUEST['_distinct']) && $total < 400) {
202 empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
203 min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
206 $queryObj = clone($x);
207 //DB_DataObject::debuglevel(1);
209 $this->sessionState(0);
211 $this->sessionState(1);
213 if (false === $res) {
214 $this->jerr($x->_lastError->toString());
222 // ---------------- THESE ARE DEPRICATED.. they should be moved to the model...
225 if (!empty($_REQUEST['query']['add_blank'])) {
226 $ret[] = array( 'id' => 0, 'name' => '----');
230 $rooar = method_exists($x, 'toRooArray');
231 $_columnsf = $_columns ? array_flip($_columns) : false;
232 while ($x->fetch()) {
234 $add = $rooar ? $x->toRooArray($_REQUEST) : $x->toArray();
235 if ($add === false) {
238 $ret[] = !$_columns ? $add : array_intersect_key($add, $_columnsf);
242 $ret = array_slice($ret,
243 empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
244 min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
251 if (method_exists($queryObj ,'postListExtra')) {
252 $extra = $queryObj->postListExtra($_REQUEST, $this);
256 // filter results, and add any data that is needed...
257 if (method_exists($x,'postListFilter')) {
258 $ret = $x->postListFilter($ret, $this->authUser, $_REQUEST);
263 if (!empty($_REQUEST['csvCols']) && !empty($_REQUEST['csvTitles']) ) {
266 $this->toCsv($ret, $_REQUEST['csvCols'], $_REQUEST['csvTitles'],
267 empty($_REQUEST['csvFilename']) ? '' : $_REQUEST['csvFilename']
275 //if ($x->tableName() == 'Documents_Tracking') {
276 // $ret = $this->replaceSubject(&$ret, 'doc_id_subject');
281 if (!empty($_REQUEST['_requestMeta']) && count($ret)) {
282 $meta = $this->meta($x, $ret);
284 $extra['metaData'] = $meta;
287 // this make take some time...
288 $this->sessionState(0);
289 // echo "<PRE>"; print_r($ret);
290 $this->jdata($ret, max(count($ret), $total), $extra );