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