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();
  98
  99         HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
 100
 101         if ( $this->checkDebugPost()) {
 102
 103
 104
 105             $_POST  = $_GET;
 106             //DB_DAtaObject::debuglevel(1);
 107             return $this->post($tab);
 108         }
 109
 110         $this->checkDebug();
 111
 112         PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 113
 114         $tab = array_shift(explode('/', $tab));
 115         $x = $this->dataObject($tab);
 116
 117         $_columns = !empty($_REQUEST['_columns']) ? explode(',', $_REQUEST['_columns']) : false;
 118
 119         if (isset( $_REQUEST['lookup'] ) && is_array($_REQUEST['lookup'] )) { // single fetch based on key/value pairs
 120              $this->selectSingle($x, $_REQUEST['lookup'],$_REQUEST);
 121              // actually exits.
 122         }
 123
 124
 125         // single fetch (use '0' to fetch an empty object..)
 126         if (isset($_REQUEST['_id']) && is_numeric($_REQUEST['_id'])) {
 127
 128              $this->selectSingle($x, $_REQUEST['_id'],$_REQUEST);
 129              // actually exits.
 130         }
 131
 132         // Depricated...
 133
 134
 135         if (isset($_REQUEST['_delete'])) {
 136             $this->jerr("DELETE by GET has been removed - update the code to use POST");
 137             /*
 138
 139             $keys = $x->keys();
 140             if (empty($keys) ) {
 141                 $this->jerr('no key');
 142             }
 143
 144             $this->key = $keys[0];
 145
 146
 147             // do we really delete stuff!?!?!?
 148             return $this->delete($x,$_REQUEST);
 149             */
 150         }
 151
 152
 153         // Depricated...
 154
 155         if (isset($_REQUEST['_toggleActive'])) {
 156             // do we really delete stuff!?!?!?
 157             if (!$this->hasPerm("Core.Staff", 'E'))  {
 158                 $this->jerr("PERMISSION DENIED (ta)");
 159             }
 160             $clean = create_function('$v', 'return (int)$v;');
 161             $bits = array_map($clean, explode(',', $_REQUEST['_toggleActive']));
 162             if (in_array($this->authUser->id, $bits) && $this->authUser->active) {
 163                 $this->jerr("you can not disable yourself");
 164             }
 165             $x->query('UPDATE Person SET active = !active WHERE id IN (' .implode(',', $bits).')');
 166             $this->addEvent("USERTOGGLE", false, implode(',', $bits));
 167             $this->jok("Updated");
 168
 169         }
 170        //DB_DataObject::debugLevel(1);
 171
 172
 173         // sets map and countWhat
 174         $this->loadMap($x, array(
 175                     'columns' => $_columns,
 176                     'distinct' => empty($_REQUEST['_distinct']) ? false:  $_REQUEST['_distinct'],
 177                     'exclude' => empty($_REQUEST['_exclude_columns']) ? false:  explode(',', $_REQUEST['_exclude_columns'])
 178             ));
 179
 180
 181         $this->setFilters($x,$_REQUEST);
 182
 183         if (!$this->checkPerm($x,'S', $_REQUEST))  {
 184             $this->jerr("PERMISSION DENIED (g)");
 185         }
 186
 187          //print_r($x);
 188         // build join if req.
 189           //DB_DataObject::debugLevel(1);
 190        //   var_dump($this->countWhat);
 191         $total = $x->count($this->countWhat);
 192         // sorting..
 193       //
 194         //var_dump($total);exit;
 195         $this->applySort($x);
 196
 197         $fake_limit = false;
 198
 199         if (!empty($_REQUEST['_distinct']) && $total < 400) {
 200             $fake_limit  = true;
 201         }
 202
 203         if (!$fake_limit) {
 204
 205             $x->limit(
 206                 empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 207                 min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 208             );
 209         }
 210         $queryObj = clone($x);
 211         //DB_DataObject::debuglevel(1);
 212
 213         $this->sessionState(0);
 214         $res = $x->find();
 215         $this->sessionState(1);
 216
 217         if (false === $res) {
 218             $this->jerr($x->_lastError->toString());
 219
 220         }
 221
 222
 223
 224         $ret = array();
 225
 226         // ---------------- THESE ARE DEPRICATED.. they should be moved to the model...
 227
 228
 229         if (!empty($_REQUEST['query']['add_blank'])) {
 230             $ret[] = array( 'id' => 0, 'name' => '----');
 231             $total+=1;
 232         }
 233
 234         $rooar = method_exists($x, 'toRooArray');
 235         $_columnsf = $_columns  ? array_flip($_columns) : false;
 236         while ($x->fetch()) {
 237             //print_R($x);exit;
 238             $add = $rooar  ? $x->toRooArray($_REQUEST) : $x->toArray();
 239             if ($add === false) {
 240                 continue;
 241             }
 242             $ret[] =  !$_columns ? $add : array_intersect_key($add, $_columnsf);
 243         }
 244
 245         if ($fake_limit) {
 246             $ret = array_slice($ret,
 247                    empty($_REQUEST['start']) ? 0 : (int)$_REQUEST['start'],
 248                     min(empty($_REQUEST['limit']) ? 25 : (int)$_REQUEST['limit'], 10000)
 249             );
 250
 251         }
 252
 253
 254         $extra = false;
 255         if (method_exists($queryObj ,'postListExtra')) {
 256             $extra = $queryObj->postListExtra($_REQUEST, $this);
 257         }
 258
 259
 260         // filter results, and add any data that is needed...
 261         if (method_exists($x,'postListFilter')) {
 262             $ret = $x->postListFilter($ret, $this->authUser, $_REQUEST);
 263         }
 264
 265
 266
 267         if (!empty($_REQUEST['csvCols']) && !empty($_REQUEST['csvTitles']) ) {
 268
 269
 270             $this->toCsv($ret, $_REQUEST['csvCols'], $_REQUEST['csvTitles'],
 271                         empty($_REQUEST['csvFilename']) ? '' : $_REQUEST['csvFilename']
 272                          );
 273
 274
 275
 276         }
 277         //die("DONE?");
 278
 279         //if ($x->tableName() == 'Documents_Tracking') {
 280         //    $ret = $this->replaceSubject(&$ret, 'doc_id_subject');
 281        // }
 282
 283
 284
 285         if (!empty($_REQUEST['_requestMeta']) &&  count($ret)) {
 286             $meta = $this->meta($x, $ret);
 287             if ($meta) {
 288                 $extra['metaData'] = $meta;
 289             }
 290         }
 291         // this make take some time...
 292         $this->sessionState(0);
 293        // echo "<PRE>"; print_r($ret);
 294         $this->jdata($ret, max(count($ret), $total), $extra );
 295
 296
 297     }
 298 }