git.roojs.org Git - Pman.Core/blob - RooGetTrait.php

   1 <?php
   2
   3 trait Pman_Core_RooGetTrait {
   4     /**
   5      * GET method   Roo/TABLENAME.php
   6      *
   7      * Generally for SELECT or Single SELECT
   8      *
   9      * 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()
  13      *
  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.
  17      *
  18      *
  19      * JOINS:
  20      *  - all tables are always autojoined.
  21      *
  22      * Search SELECT
  23      *    COLUMNS to fetch
  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.
  27      *
  28      *    WHERE (searches)
  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..
  33      *
  34      *    ORDER BY
  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 ] }
  39      *
  40      *    LIMIT
  41      *      start=0         limit start
  42      *      limit=25        limit number
  43      *
  44      *
  45      *    Simple CSV support
  46      *      csvCols[0] csvCols[1]....    = .... column titles for CSV output
  47      *      csvTitles[0], csvTitles[1] ....  = columns to use for CSV output
  48      *
  49      *  Depricated
  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...)
  53      *
  54      * DEBUGGING
  55      *  _post   =1    = simulate a post with debuggin on.
  56      *  _debug_post << This is prefered, as _post may overlap with accouting posts..
  57      *
  58      *  _debug     = turn on DB_dataobject deubbing, must be admin at present..
  59      *
  60      *
  61      * CALLS methods on dataobjects if they exist
  62      *
  63      *
  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
  76      *
  77      *
  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.
  85      *
  86      *   autoJoin($request)
  87      *                      - standard DataObject feature - causes all results to show all
  88      *                        referenced data.
  89      *
  90      * PROPERTIES:
  91      *    _extra_cols  -- if set, then filtering by column etc. will use them.
  92      *
  93
  94      */
  95     function get($tab)
  96     {
  97         $this->init(); // from pman.
  98         //DB_DataObject::debuglevel(1);
  99         HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
 100
 101
 102
 103         // debugging...
 104
 105
 106
 107         if ( $this->checkDebugPost()) {
 108
 109
 110
 111             $_POST  = $_GET;
 112             //DB_DAtaObject::debuglevel(1);
 113             return $this->post($tab);
 114         }
 115
 116         $this->checkDebug();
 117
 118         PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 119
 120         $tab = array_shift(explode('/', $tab));
 121         $x = $this->dataObject($tab);
 122
 123         $_columns = !empty($_REQUEST['_columns']) ? explode(',', $_REQUEST['_columns']) : false;
 124
 125         if (isset( $_REQUEST['lookup'] ) && is_array($_REQUEST['lookup'] )) { // single fetch based on key/value pairs
 126              $this->selectSingle($x, $_REQUEST['lookup'],$_REQUEST);
 127              // actually exits.
 128         }
 129
 130
 131         // single fetch (use '0' to fetch an empty object..)
 132         if (isset($_REQUEST['_id']) && is_numeric($_REQUEST['_id'])) {
 133
 134              $this->selectSingle($x, $_REQUEST['_id'],$_REQUEST);
 135              // actually exits.
 136         }
 137
 138         // Depricated...
 139
 140
 141         if (isset($_REQUEST['_delete'])) {
 142             $this->jerr("DELETE by GET has been removed - update the code to use POST");
 143             /*
 144
 145             $keys = $x->keys();
 146             if (empty($keys) ) {
 147                 $this->jerr('no key');
 148             }
 149
 150             $this->key = $keys[0];
 151
 152
 153             // do we really delete stuff!?!?!?
 154             return $this->delete($x,$_REQUEST);
 155             */
 156         }
 157
 158
 159         // Depricated...
 160
 161         if (isset($_REQUEST['_toggleActive'])) {
 162             // do we really delete stuff!?!?!?
 163             if (!$this->hasPerm("Core.Staff", 'E'))  {
 164                 $this->jerr("PERMISSION DENIED (ta)");
 165             }
 166             $clean = create_function('$v', 'return (int)$v;');
 167             $bits = array_map($clean, explode(',', $_REQUEST['_toggleActive']));
 168             if (in_array($this->authUser->id, $bits) && $this->authUser->active) {
 169                 $this->jerr("you can not disable yourself");
 170             }
 171             $x->query('UPDATE Person SET active = !active WHERE id IN (' .implode(',', $bits).')');
 172             $this->addEvent("USERTOGGLE", false, implode(',', $bits));
 173             $this->jok("Updated");
 174
 175         }
 176        //DB_DataObject::debugLevel(1);
 177
 178
 179         // sets map and countWhat
 180         $this->loadMap($x, array(
 181                     'columns' => $_columns,
 182                     'distinct' => empty($_REQUEST['_distinct']) ? false:  $_REQUEST['_distinct'],
 183                     'exclude' => empty($_REQUEST['_exclude_columns']) ? false:  explode(',', $_REQUEST['_exclude_columns'])
 184             ));
 185
 186
 187         $this->setFilters($x,$_REQUEST);
 188
 189         if (!$this->checkPerm($x,'S', $_REQUEST))  {
 190             $this->jerr("PERMISSION DENIED (g)");
 191         }
 192
 193          //print_r($x);
 194         // build join if req.
 195           //DB_DataObject::debugLevel(1);
 196        //   var_dump($this->countWhat);
 197         $total = $x->count($this->countWhat);
 198         // sorting..
 199       //
 200         //var_dump($total);exit;
 201         $this->applySort($x);
 202
 203         $fake_limit = false;
 204
 205         if (!empty($_REQUEST['_distinct']) && $total < 400) {
 206             $fake_limit  = true;
 207         }
 208
 209         if (!$fake_limit) {
 210
 211             $x->limit(
 212                 empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 213                 min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 214             );
 215         }
 216         $queryObj = clone($x);
 217         //DB_DataObject::debuglevel(1);
 218
 219         $this->sessionState(0);
 220         $res = $x->find();
 221         $this->sessionState(1);
 222
 223         if (false === $res) {
 224             $this->jerr($x->_lastError->toString());
 225
 226         }
 227
 228
 229
 230         $ret = array();
 231
 232         // ---------------- THESE ARE DEPRICATED.. they should be moved to the model...
 233
 234
 235         if (!empty($_REQUEST['query']['add_blank'])) {
 236             $ret[] = array( 'id' => 0, 'name' => '----');
 237             $total+=1;
 238         }
 239
 240         $rooar = method_exists($x, 'toRooArray');
 241         $_columnsf = $_columns  ? array_flip($_columns) : false;
 242         while ($x->fetch()) {
 243             //print_R($x);exit;
 244             $add = $rooar  ? $x->toRooArray($_REQUEST) : $x->toArray();
 245             if ($add === false) {
 246                 continue;
 247             }
 248             $ret[] =  !$_columns ? $add : array_intersect_key($add, $_columnsf);
 249         }
 250
 251         if ($fake_limit) {
 252             $ret = array_slice($ret,
 253                    empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 254                     min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 255             );
 256
 257         }
 258
 259
 260         $extra = false;
 261         if (method_exists($queryObj ,'postListExtra')) {
 262             $extra = $queryObj->postListExtra($_REQUEST, $this);
 263         }
 264
 265
 266         // filter results, and add any data that is needed...
 267         if (method_exists($x,'postListFilter')) {
 268             $ret = $x->postListFilter($ret, $this->authUser, $_REQUEST);
 269         }
 270
 271
 272
 273         if (!empty($_REQUEST['csvCols']) && !empty($_REQUEST['csvTitles']) ) {
 274
 275
 276             $this->toCsv($ret, $_REQUEST['csvCols'], $_REQUEST['csvTitles'],
 277                         empty($_REQUEST['csvFilename']) ? '' : $_REQUEST['csvFilename']
 278                          );
 279
 280
 281
 282         }
 283         //die("DONE?");
 284
 285         //if ($x->tableName() == 'Documents_Tracking') {
 286         //    $ret = $this->replaceSubject(&$ret, 'doc_id_subject');
 287        // }
 288
 289
 290
 291         if (!empty($_REQUEST['_requestMeta']) &&  count($ret)) {
 292             $meta = $this->meta($x, $ret);
 293             if ($meta) {
 294                 $extra['metaData'] = $meta;
 295             }
 296         }
 297         // this make take some time...
 298         $this->sessionState(0);
 299        // echo "<PRE>"; print_r($ret);
 300         $this->jdata($ret, max(count($ret), $total), $extra );
 301
 302
 303     }
 304 }