lib/ActiveMongo.php

   1 <?php
   2 /*
   3   +---------------------------------------------------------------------------------+
   4   | Copyright (c) 2010 ActiveMongo                                                  |
   5   +---------------------------------------------------------------------------------+
   6   | Redistribution and use in source and binary forms, with or without              |
   7   | modification, are permitted provided that the following conditions are met:     |
   8   | 1. Redistributions of source code must retain the above copyright               |
   9   |    notice, this list of conditions and the following disclaimer.                |
  10   |                                                                                 |
  11   | 2. Redistributions in binary form must reproduce the above copyright            |
  12   |    notice, this list of conditions and the following disclaimer in the          |
  13   |    documentation and/or other materials provided with the distribution.         |
  14   |                                                                                 |
  15   | 3. All advertising materials mentioning features or use of this software        |
  16   |    must display the following acknowledgement:                                  |
  17   |    This product includes software developed by César D. Rodas.                  |
  18   |                                                                                 |
  19   | 4. Neither the name of the César D. Rodas nor the                               |
  20   |    names of its contributors may be used to endorse or promote products         |
  21   |    derived from this software without specific prior written permission.        |
  22   |                                                                                 |
  23   | THIS SOFTWARE IS PROVIDED BY CÉSAR D. RODAS ''AS IS'' AND ANY                   |
  24   | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED       |
  25   | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE          |
  26   | DISCLAIMED. IN NO EVENT SHALL CÉSAR D. RODAS BE LIABLE FOR ANY                  |
  27   | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES      |
  28   | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;    |
  29   | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND     |
  30   | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT      |
  31   | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS   |
  32   | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE                     |
  33   +---------------------------------------------------------------------------------+
  34   | Authors: César Rodas <crodas@php.net>                                           |
  35   +---------------------------------------------------------------------------------+
  36 */
  37
  38 // array get_document_vars(stdobj $obj) {{{
  39 /**
  40  *  Simple hack to avoid get private and protected variables
  41  *
  42  *  @param object $obj
  43  *  @param bool   $include_id
  44  *
  45  *  @return array
  46  */
  47 function get_document_vars($obj, $include_id=true)
  48 {
  49     $document =  get_object_vars($obj);
  50     if ($include_id && $obj->getID()) {
  51         $document['_id'] = $obj->getID();
  52     }
  53     return $document;
  54 }
  55 // }}}
  56
  57 /**
  58  *  ActiveMongo
  59  *
  60  *  Simple ActiveRecord pattern built on top of MongoDB. This class
  61  *  aims to provide easy iteration, data validation before update,
  62  *  and efficient update.
  63  *
  64  *  @author César D. Rodas <crodas@php.net>
  65  *  @license PHP License
  66  *  @package ActiveMongo
  67  *  @version 1.0
  68  *
  69  */
  70 abstract class ActiveMongo implements Iterator, Countable, ArrayAccess
  71 {
  72
  73     // properties {{{
  74     /**
  75      *  Current databases objects
  76      *
  77      *  @type array
  78      */
  79     private static $_dbs;
  80     /**
  81      *  Current collections objects
  82      *
  83      *  @type array
  84      */
  85     private static $_collections;
  86     /**
  87      *  Current connection to MongoDB
  88      *
  89      *  @type MongoConnection
  90      */
  91     private static $_conn;
  92     /**
  93      *  Database name
  94      *
  95      *  @type string
  96      */
  97     private static $_db;
  98     /**
  99      *  List of events handlers
 100      *
 101      *  @type array
 102      */
 103     static private $_events = array();
 104     /**
 105      *  List of global events handlers
 106      *
 107      *  @type array
 108      */
 109     static private $_super_events = array();
 110     /**
 111      *  Host name
 112      *
 113      *  @type string
 114      */
 115     private static $_host;
 116     /**
 117      *  Current document
 118      *
 119      *  @type array
 120      */
 121     private $_current = array();
 122     /**
 123      *  Result cursor
 124      *
 125      *  @type MongoCursor
 126      */
 127     private $_cursor  = null;
 128
 129     /* {{{ Silly but useful query abstraction  */
 130     private $_query   = null;
 131     private $_sort    = null;
 132     private $_limit   = 0;
 133     private $_skip    = 0;
 134     private $_properties = null;
 135     /* }}} */
 136
 137     /**
 138      *  Current document ID
 139      *
 140      *  @type MongoID
 141      */
 142     private $_id;
 143
 144     /**
 145      *  Tell if the current object
 146      *  is cloned or not.
 147      *
 148      *  @type bool
 149      */
 150     private $_cloned = false;
 151     // }}}
 152
 153     // GET CONNECTION CONFIG {{{
 154
 155     // string getCollectionName() {{{
 156     /**
 157      *  Get Collection Name, by default the class name,
 158      *  but you it can be override at the class itself to give
 159      *  a custom name.
 160      *
 161      *  @return string Collection Name
 162      */
 163     protected function getCollectionName()
 164     {
 165         return strtolower(get_class($this));
 166     }
 167     // }}}
 168
 169     // string getDatabaseName() {{{
 170     /**
 171      *  Get Database Name, by default it is used
 172      *  the db name set by ActiveMong::connect()
 173      *
 174      *  @return string DB Name
 175      */
 176     protected function getDatabaseName()
 177     {
 178         if (is_null(self::$_db)) {
 179             throw new MongoException("There is no information about the default DB name");
 180         }
 181         return self::$_db;
 182     }
 183     // }}}
 184
 185     // void install() {{{
 186     /**
 187      *  Install.
 188      *
 189      *  This static method iterate over the classes lists,
 190      *  and execute the setup() method on every ActiveMongo
 191      *  subclass. You should do this just once.
 192      *
 193      */
 194     final public static function install()
 195     {
 196         $classes = array_reverse(get_declared_classes());
 197         foreach ($classes as $class)
 198         {
 199             if ($class == __CLASS__) {
 200                 break;
 201             }
 202             if (is_subclass_of($class, __CLASS__)) {
 203                 $obj = new $class;
 204                 $obj->setup();
 205             }
 206         }
 207     }
 208     // }}}
 209
 210     // void connection($db, $host) {{{
 211     /**
 212      *  Connect
 213      *
 214      *  This method setup parameters to connect to a MongoDB
 215      *  database. The connection is done when it is needed.
 216      *
 217      *  @param string $db   Database name
 218      *  @param string $host Host to connect
 219      *
 220      *  @return void
 221      */
 222     final public static function connect($db, $host='localhost')
 223     {
 224         self::$_host = $host;
 225         self::$_db   = $db;
 226     }
 227     // }}}
 228
 229     // MongoConnection _getConnection() {{{
 230     /**
 231      *  Get Connection
 232      *
 233      *  Get a valid database connection
 234      *
 235      *  @return MongoConnection
 236      */
 237     final protected function _getConnection()
 238     {
 239         if (is_null(self::$_conn)) {
 240             if (is_null(self::$_host)) {
 241                 self::$_host = 'localhost';
 242             }
 243             self::$_conn = new Mongo(self::$_host);
 244         }
 245         $dbname = $this->getDatabaseName();
 246         if (!isSet(self::$_dbs[$dbname])) {
 247             self::$_dbs[$dbname] = self::$_conn->selectDB($dbname);
 248         }
 249         return self::$_dbs[$dbname];
 250     }
 251     // }}}
 252
 253     // MongoCollection _getCollection() {{{
 254     /**
 255      *  Get Collection
 256      *
 257      *  Get a collection connection.
 258      *
 259      *  @return MongoCollection
 260      */
 261     final protected function _getCollection()
 262     {
 263         $colName = $this->getCollectionName();
 264         if (!isset(self::$_collections[$colName])) {
 265             self::$_collections[$colName] = self::_getConnection()->selectCollection($colName);
 266         }
 267         return self::$_collections[$colName];
 268     }
 269     // }}}
 270
 271     // }}}
 272
 273     // GET DOCUMENT TO SAVE OR UPDATE {{{
 274
 275     // bool getCurrentSubDocument(array &$document, string $parent_key, array $values, array $past_values) {{{
 276     /**
 277      *  Generate Sub-document
 278      *
 279      *  This method build the difference between the current sub-document,
 280      *  and the origin one. If there is no difference, it would do nothing,
 281      *  otherwise it would build a document containing the differences.
 282      *
 283      *  @param array  &$document    Document target
 284      *  @param string $parent_key   Parent key name
 285      *  @param array  $values       Current values
 286      *  @param array  $past_values  Original values
 287      *
 288      *  @return false
 289      */
 290     final function getCurrentSubDocument(&$document, $parent_key, Array $values, Array $past_values)
 291     {
 292         /**
 293          *  The current property is a embedded-document,
 294          *  now we're looking for differences with the
 295          *  previous value (because we're on an update).
 296          *
 297          *  It behaves exactly as getCurrentDocument,
 298          *  but this is simples (it doesn't support
 299          *  yet filters)
 300          */
 301         foreach ($values as $key => $value) {
 302             $super_key = "{$parent_key}.{$key}";
 303             if (is_array($value)) {
 304                 /**
 305                  *  Inner document detected
 306                  */
 307                 if (!isset($past_values[$key]) || !is_array($past_values[$key])) {
 308                     /**
 309                      *  We're lucky, it is a new sub-document,
 310                      *  we simple add it
 311                      */
 312                     $document['$set'][$super_key] = $value;
 313                 } else {
 314                     /**
 315                      *  This is a document like this, we need
 316                      *  to find out the differences to avoid
 317                      *  network overhead.
 318                      */
 319                     if (!$this->getCurrentSubDocument($document, $super_key, $value, $past_values[$key])) {
 320                         return false;
 321                     }
 322                 }
 323                 continue;
 324             } else if (!isset($past_values[$key]) || $past_values[$key] != $value) {
 325                 $document['$set'][$super_key] = $value;
 326             }
 327         }
 328
 329         foreach (array_diff(array_keys($past_values), array_keys($values)) as $key) {
 330             $super_key = "{$parent_key}.{$key}";
 331             $document['$unset'][$super_key] = 1;
 332         }
 333
 334         return true;
 335     }
 336     // }}}
 337
 338     // array getCurrentDocument(bool $update) {{{
 339     /**
 340      *    Get Current Document
 341      *
 342      *    Based on this object properties a new document (Array)
 343      *    is returned. If we're modifying an document, just the modified
 344      *    properties are included in this document, which uses $set,
 345      *    $unset, $pushAll and $pullAll.
 346      *
 347      *
 348      *    @param bool $update
 349      *
 350      *    @return array
 351      */
 352     final protected function getCurrentDocument($update=false, $current=false)
 353     {
 354         $document = array();
 355         $object   = get_document_vars($this);
 356
 357         if (!$current) {
 358             $current = (array)$this->_current;
 359         }
 360
 361
 362         $this->findReferences($object);
 363
 364         $this->triggerEvent('before_validate_'.($update?'update':'creation'), array(&$object));
 365         $this->triggerEvent('before_validate', array(&$object));
 366
 367         foreach ($object as $key => $value) {
 368             if (!$value) {
 369                 continue;
 370             }
 371             if ($update) {
 372                 if (is_array($value) && isset($current[$key])) {
 373                     /**
 374                      *  If the Field to update is an array, it has a different
 375                      *  behaviour other than $set and $unset. Fist, we need
 376                      *  need to check if it is an array or document, because
 377                      *  they can't be mixed.
 378                      *
 379                      */
 380                     if (!is_array($current[$key])) {
 381                         /**
 382                          *  We're lucky, the field wasn't
 383                          *  an array previously.
 384                          */
 385                         $this->runFilter($key, $value, $current[$key]);
 386                         $document['$set'][$key] = $value;
 387                         continue;
 388                     }
 389
 390                     if (!$this->getCurrentSubDocument($document, $key, $value, $current[$key])) {
 391                         throw new Exception("{$key}: Array and documents are not compatible");
 392                     }
 393                 } else if(!isset($current[$key]) || $value !== $current[$key]) {
 394                     /**
 395                      *  It is 'linear' field that has changed, or
 396                      *  has been modified.
 397                      */
 398                     $past_value = isset($current[$key]) ? $current[$key] : null;
 399                     $this->runFilter($key, $value, $past_value);
 400                     $document['$set'][$key] = $value;
 401                 }
 402             } else {
 403                 /**
 404                  *  It is a document insertation, so we
 405                  *  create the document.
 406                  */
 407                 $this->runFilter($key, $value, null);
 408                 $document[$key] = $value;
 409             }
 410         }
 411
 412         /* Updated behaves in a diff. way */
 413         if ($update) {
 414             foreach (array_diff(array_keys($this->_current), array_keys($object)) as $property) {
 415                 if ($property == '_id') {
 416                     continue;
 417                 }
 418                 $document['$unset'][$property] = 1;
 419             }
 420         }
 421
 422         if (count($document) == 0) {
 423             return array();
 424         }
 425
 426         $this->triggerEvent('after_validate_'.($update?'update':'creation'), array(&$object));
 427         $this->triggerEvent('after_validate', array(&$document));
 428
 429         return $document;
 430     }
 431     // }}}
 432
 433     // }}}
 434
 435     // EVENT HANDLERS {{{
 436
 437     // addEvent($action, $callback) {{{
 438     /**
 439      *  addEvent
 440      *
 441      */
 442     final static function addEvent($action, $callback)
 443     {
 444         if (!is_callable($callback)) {
 445             throw new Exception("Invalid callback");
 446         }
 447
 448         $class = get_called_class();
 449         if ($class == __CLASS__) {
 450             $events = & self::$_super_events;
 451         } else {
 452             $events = & self::$_events[$class];
 453         }
 454         if (!isset($events[$action])) {
 455             $events[$action] = array();
 456         }
 457         $events[$action][] = $callback;
 458         return true;
 459     }
 460     // }}}
 461
 462     // triggerEvent(string $event, Array $events_params) {{{
 463     final function triggerEvent($event, Array $events_params = array())
 464     {
 465         $events  = & self::$_events[get_class($this)][$event];
 466         $sevents = & self::$_super_events[$event];
 467
 468         if (!is_array($events_params)) {
 469             return false;
 470         }
 471
 472         /* Super-Events handler receives the ActiveMongo class name as first param */
 473         $sevents_params = array_merge(array(get_class($this)), $events_params);
 474
 475         foreach (array('events', 'sevents') as $event_type) {
 476             if (count($$event_type) > 0) {
 477                 $params = "{$event_type}_params";
 478                 foreach ($$event_type as $fnc) {
 479                     call_user_func_array($fnc, $$params);
 480                 }
 481             }
 482         }
 483
 484         /* Some natives events are allowed to be called
 485          * as methods, if they exists
 486          */
 487         switch ($event) {
 488         case 'before_create':
 489         case 'before_update':
 490         case 'before_validate':
 491         case 'before_delete':
 492         case 'after_create':
 493         case 'after_update':
 494         case 'after_validate':
 495         case 'after_delete':
 496             $fnc    = array($this, $event);
 497             $params = "events_params";
 498             if (is_callable($fnc)) {
 499                 call_user_func_array($fnc, $$params);
 500             }
 501             break;
 502         }
 503     }
 504     // }}}
 505
 506      // void runFilter(string $key, mixed &$value, mixed $past_value) {{{
 507     /**
 508      *  *Internal Method*
 509      *
 510      *  This method check if the current document property has
 511      *  a filter method, if so, call it.
 512      *
 513      *  If the filter returns false, throw an Exception.
 514      *
 515      *  @return void
 516      */
 517     protected function runFilter($key, &$value, $past_value)
 518     {
 519         $filter = array($this, "{$key}_filter");
 520         if (is_callable($filter)) {
 521             $filter = call_user_func_array($filter, array(&$value, $past_value));
 522             if ($filter===false) {
 523                 throw new ActiveMongo_FilterException("{$key} filter failed");
 524             }
 525             $this->$key = $value;
 526         }
 527     }
 528     // }}}
 529
 530     // }}}
 531
 532     // void setCursor(MongoCursor $obj) {{{
 533     /**
 534      *  Set Cursor
 535      *
 536      *  This method receive a MongoCursor and make
 537      *  it iterable.
 538      *
 539      *  @param MongoCursor $obj
 540      *
 541      *  @return void
 542      */
 543     final protected function setCursor(MongoCursor $obj)
 544     {
 545         $this->_cursor = $obj;
 546         $this->setResult($obj->getNext());
 547     }
 548     // }}}
 549
 550     // void setResult(Array $obj) {{{
 551     /**
 552      *  Set Result
 553      *
 554      *  This method takes an document and copy it
 555      *  as properties in this object.
 556      *
 557      *  @param Array $obj
 558      *
 559      *  @return void
 560      */
 561     final protected function setResult($obj)
 562     {
 563         /* Unsetting previous results, if any */
 564         foreach (array_keys(get_document_vars($this, false)) as $key) {
 565             unset($this->$key);
 566         }
 567         $this->_id = null;
 568
 569         /* Add our current resultset as our object's property */
 570         foreach ((array)$obj as $key => $value) {
 571             if ($key[0] == '$') {
 572                 continue;
 573             }
 574             $this->$key = $value;
 575         }
 576
 577         /* Save our record */
 578         $this->_current = $obj;
 579     }
 580     // }}}
 581
 582     // this find([$_id]) {{{
 583     /**
 584      *    Simple find.
 585      *
 586      *    Really simple find, which uses this object properties
 587      *    for fast filtering
 588      *
 589      *    @return object this
 590      */
 591     final function find($_id = null)
 592     {
 593         $vars = get_document_vars($this);
 594         foreach ($vars as $key => $value) {
 595             if (!$value) {
 596                 unset($vars[$key]);
 597             }
 598             $parent_class = __CLASS__;
 599             if ($value InstanceOf $parent_class) {
 600                 $this->getColumnDeference($vars, $key, $value);
 601                 unset($vars[$key]); /* delete old value */
 602             }
 603         }
 604         if ($_id != null) {
 605             if (is_array($_id)) {
 606                 $vars['_id'] = array('$in' => $_id);
 607             } else {
 608                 $vars['_id'] = $_id;
 609             }
 610         }
 611         $res  = $this->_getCollection()->find($vars);
 612         $this->setCursor($res);
 613         return $this;
 614     }
 615     // }}}
 616
 617     // void save(bool $async) {{{
 618     /**
 619      *    Save
 620      *
 621      *    This method save the current document in MongoDB. If
 622      *    we're modifying a document, a update is performed, otherwise
 623      *    the document is inserted.
 624      *
 625      *    On updates, special operations such as $set, $pushAll, $pullAll
 626      *    and $unset in order to perform efficient updates
 627      *
 628      *    @param bool $async
 629      *
 630      *    @return void
 631      */
 632     final function save($async=true)
 633     {
 634         $update   = isset($this->_id) && $this->_id InstanceOf MongoID;
 635         $conn     = $this->_getCollection();
 636         $document = $this->getCurrentDocument($update);
 637         $object   = get_document_vars($this);
 638         if (count($document) == 0) {
 639             return; /*nothing to do */
 640         }
 641
 642          /* PRE-save hook */
 643         $this->triggerEvent('before_'.($update ? 'update' : 'create'), array(&$document, $object));
 644
 645         if ($update) {
 646             $conn->update(array('_id' => $this->_id), $document, array('safe' => $async));
 647             foreach ($document as $key => $value) {
 648                 if ($key[0] == '$') {
 649                     continue;
 650                 }
 651                 $this->_current[$key] = $value;
 652             }
 653         } else {
 654             $conn->insert($document, $async);
 655             $this->_id      = $document['_id'];
 656             $this->_current = $document;
 657         }
 658
 659         $this->triggerEvent('after_'.($update ? 'update' : 'create'), array($document, $object));
 660     }
 661     // }}}
 662
 663     // bool delete() {{{
 664     /**
 665      *  Delete the current document
 666      *
 667      *  @return bool
 668      */
 669     final function delete()
 670     {
 671         if ($this->_cursor InstanceOf MongoCursor) {
 672             $document = array('_id' => $this->_id);
 673             $this->triggerEvent('before_delete', array($document));
 674             $result = $this->_getCollection()->remove($document);
 675             $this->triggerEvent('after_delete', array($document));
 676             $this->setResult(array());
 677             return $result;
 678         } else {
 679             $criteria = (array) $this->_query['query'];
 680
 681             /* remove */
 682             $this->_getCollection()->remove($criteria);
 683
 684             /* reset object */
 685             $this->reset();
 686
 687             return true;
 688         }
 689         return false;
 690     }
 691     // }}}
 692
 693     // Update {{{
 694     /**
 695      *  Multiple updates.
 696      *
 697      *  This method perform multiple updates when a given
 698      *  criteria matchs (using where).
 699      *
 700      *  By default the update is perform safely, but it can be
 701      *  changed.
 702      *
 703      *  After the operation is done, the criteria is deleted.
 704      *
 705      *  @param array $value Values to set
 706      *  @param bool  $safe  Whether or not peform the operation safely
 707      *
 708      *  @return bool
 709      *
 710      */
 711     function update(Array $value, $safe=true)
 712     {
 713         $this->_assertNotInQuery();
 714
 715         $criteria = (array) $this->_query['query'];
 716         $options  = array('multiple' => true, 'safe' => $safe);
 717
 718         /* update */
 719         $col = $this->_getCollection();
 720         $col->update($criteria, array('$set' => $value), $options);
 721
 722         /* reset object */
 723         $this->reset();
 724
 725         return true;
 726     }
 727     // }}}
 728
 729     // void drop() {{{
 730     /**
 731      *  Delete the current colleciton and all its documents
 732      *
 733      *  @return void
 734      */
 735     final static function drop()
 736     {
 737         $class = get_called_class();
 738         if ($class == __CLASS__) {
 739             return false;
 740         }
 741         $obj = new $class;
 742         return $obj->_getCollection()->drop();
 743     }
 744     // }}}
 745
 746     // int count() {{{
 747     /**
 748      *  Return the number of documents in the actual request. If
 749      *  we're not in a request, it will return 0.
 750      *
 751      *  @return int
 752      */
 753     final function count()
 754     {
 755         if ($this->valid()) {
 756             return $this->_cursor->count();
 757         }
 758         return 0;
 759     }
 760     // }}}
 761
 762     // void setup() {{{
 763     /**
 764      *  This method should contain all the indexes, and shard keys
 765      *  needed by the current collection. This try to make
 766      *  installation on development environments easier.
 767      */
 768     function setup()
 769     {
 770     }
 771     // }}}
 772
 773     // bool addIndex(array $columns, array $options) {{{
 774     /**
 775      *  addIndex
 776      *
 777      *  Create an Index in the current collection.
 778      *
 779      *  @param array $columns L ist of columns
 780      *  @param array $options Options
 781      *
 782      *  @return bool
 783      */
 784     final function addIndex($columns, $options=array())
 785     {
 786         $default_options = array(
 787             'background' => 1,
 788         );
 789
 790        foreach ($default_options as $option => $value) {
 791             if (!isset($options[$option])) {
 792                 $options[$option] = $value;
 793             }
 794         }
 795
 796         $collection = $this->_getCollection();
 797
 798         return $collection->ensureIndex($columns, $options);
 799     }
 800     // }}}
 801
 802     // string __toString() {{{
 803     /**
 804      *  To String
 805      *
 806      *  If this object is treated as a string,
 807      *  it would return its ID.
 808      *
 809      *  @return string
 810      */
 811     final function __toString()
 812     {
 813         return (string)$this->getID();
 814     }
 815     // }}}
 816
 817     // array sendCmd(array $cmd) {{{
 818     /**
 819      *  This method sends a command to the current
 820      *  database.
 821      *
 822      *  @param array $cmd Current command
 823      *
 824      *  @return array
 825      */
 826     final protected function sendCmd($cmd)
 827     {
 828         return $this->_getConnection()->command($cmd);
 829     }
 830     // }}}
 831
 832     // ITERATOR {{{
 833
 834     // void reset() {{{
 835     /**
 836      *  Reset our Object, delete the current cursor if any, and reset
 837      *  unsets the values.
 838      *
 839      *  @return void
 840      */
 841     final function reset()
 842     {
 843         $this->_properties = null;
 844         $this->_cursor  = null;
 845         $this->_query   = null;
 846         $this->_sort    = null;
 847         $this->_limit   = 0;
 848         $this->_skip    = 0;
 849         $this->setResult(array());
 850     }
 851     // }}}
 852
 853     // bool valid() {{{
 854     /**
 855      *    Valid
 856      *
 857      *    Return if we're on an iteration and if it is still valid
 858      *
 859      *    @return true
 860      */
 861     final function valid()
 862     {
 863         if (!$this->_cursor InstanceOf MongoCursor) {
 864             $this->doQuery();
 865         }
 866         return $this->_cursor InstanceOf MongoCursor && $this->_cursor->valid();
 867     }
 868     // }}}
 869
 870     // bool next() {{{
 871     /**
 872      *    Move to the next document
 873      *
 874      *    @return bool
 875      */
 876     final function next()
 877     {
 878         if ($this->_cloned) {
 879             throw new MongoException("Cloned objects can't iterate");
 880         }
 881         return $this->_cursor->next();
 882     }
 883     // }}}
 884
 885     // this current() {{{
 886     /**
 887      *    Return the current object, and load the current document
 888      *    as this object property
 889      *
 890      *    @return object
 891      */
 892     final function current()
 893     {
 894         $this->setResult($this->_cursor->current());
 895         return $this;
 896     }
 897     // }}}
 898
 899     // bool rewind() {{{
 900     /**
 901      *    Go to the first document
 902      */
 903     final function rewind()
 904     {
 905         if (!$this->_cursor InstanceOf MongoCursor) {
 906             $this->doQuery();
 907         }
 908         return $this->_cursor->rewind();
 909     }
 910     // }}}
 911
 912     // }}}
 913
 914     //  ARRAY ACCESS {{{
 915     final function offsetExists($offset)
 916     {
 917         return isset($this->$offset);
 918     }
 919
 920     final function offsetGet($offset)
 921     {
 922         return $this->$offset;
 923     }
 924
 925     final function offsetSet($offset, $value)
 926     {
 927         $this->$offset = $value;
 928     }
 929
 930     final function offsetUnset($offset)
 931     {
 932         unset($this->$offset);
 933     }
 934     // }}}
 935
 936     // REFERENCES {{{
 937
 938     // array getReference() {{{
 939     /**
 940      *  ActiveMongo extended the Mongo references, adding
 941      *  the concept of 'dynamic' requests, saving in the database
 942      *  the current query with its options (sort, limit, etc).
 943      *
 944      *  This is useful to associate a document with a given
 945      *  request. To undestand this better please see the 'reference'
 946      *  example.
 947      *
 948      *  @return array
 949      */
 950     final function getReference($dynamic=false)
 951     {
 952         if (!$this->getID() && !$dynamic) {
 953             return null;
 954         }
 955
 956         $document = array(
 957             '$ref'  => $this->getCollectionName(),
 958             '$id'   => $this->getID(),
 959             '$db'   => $this->getDatabaseName(),
 960             'class' => get_class($this),
 961         );
 962
 963         if ($dynamic && $this->_cursor InstanceOf MongoCursor) {
 964             $cursor = $this->_cursor;
 965             if (!is_callable(array($cursor, "Info"))) {
 966                 throw new Exception("Please upgrade your PECL/Mongo module to use this feature");
 967             }
 968             $document['dynamic'] = array();
 969             $query  = $cursor->Info();
 970             foreach ($query as $type => $value) {
 971                 $document['dynamic'][$type] = $value;
 972             }
 973         }
 974         return $document;
 975     }
 976     // }}}
 977
 978     // void getDocumentReferences($document, &$refs) {{{
 979     /**
 980      *  Get Current References
 981      *
 982      *  Inspect the current document trying to get any references,
 983      *  if any.
 984      *
 985      *  @param array $document   Current document
 986      *  @param array &$refs      References found in the document.
 987      *  @param array $parent_key Parent key
 988      *
 989      *  @return void
 990      */
 991     final protected function getDocumentReferences($document, &$refs, $parent_key=null)
 992     {
 993         foreach ($document as $key => $value) {
 994            if (is_array($value)) {
 995                if (MongoDBRef::isRef($value)) {
 996                    $pkey   = $parent_key;
 997                    $pkey[] = $key;
 998                    $refs[] = array('ref' => $value, 'key' => $pkey);
 999                } else {
1000                    $parent_key[] = $key;
1001                    $this->getDocumentReferences($value, $refs, $parent_key);
1002                }
1003            }
1004         }
1005     }
1006     // }}}
1007
1008     // object _deferencingCreateObject(string $class) {{{
1009     /**
1010      *  Called at deferencig time
1011      *
1012      *  Check if the given string is a class, and it is a sub class
1013      *  of ActiveMongo, if it is instance and return the object.
1014      *
1015      *  @param string $class
1016      *
1017      *  @return object
1018      */
1019     private function _deferencingCreateObject($class)
1020     {
1021         if (!is_subclass_of($class, __CLASS__)) {
1022             throw new MongoException("Fatal Error, imposible to create ActiveMongo object of {$class}");
1023         }
1024         return new $class;
1025     }
1026     // }}}
1027
1028     // void _deferencingRestoreProperty(array &$document, array $keys, mixed $req) {{{
1029     /**
1030      *  Called at deferencig time
1031      *
1032      *  This method iterates $document until it could match $keys path, and
1033      *  replace its value by $req.
1034      *
1035      *  @param array &$document Document to replace
1036      *  @param array $keys      Path of property to change
1037      *  @param mixed $req       Value to replace.
1038      *
1039      *  @return void
1040      */
1041     private function _deferencingRestoreProperty(&$document, $keys, $req)
1042     {
1043         $obj = & $document;
1044
1045         /* find the $req proper spot */
1046         foreach ($keys as $key) {
1047             $obj = & $obj[$key];
1048         }
1049
1050         $obj = $req;
1051
1052         /* Delete reference variable */
1053         unset($obj);
1054     }
1055     // }}}
1056
1057     // object _deferencingQuery($request) {{{
1058     /**
1059      *  Called at deferencig time
1060      *
1061      *  This method takes a dynamic reference and request
1062      *  it to MongoDB.
1063      *
1064      *  @param array $request Dynamic reference
1065      *
1066      *  @return this
1067      */
1068     private function _deferencingQuery($request)
1069     {
1070         $collection = $this->_getCollection();
1071         $cursor     = $collection->find($request['query'], $request['fields']);
1072         if ($request['limit'] > 0) {
1073             $cursor->limit($request['limit']);
1074         }
1075         if ($request['skip'] > 0) {
1076             $cursor->limit($request['limit']);
1077         }
1078
1079         $this->setCursor($cursor);
1080
1081         return $this;
1082     }
1083     // }}}
1084
1085     // void doDeferencing() {{{
1086     /**
1087      *  Perform a deferencing in the current document, if there is
1088      *  any reference.
1089      *
1090      *  ActiveMongo will do its best to group references queries as much
1091      *  as possible, in order to perform as less request as possible.
1092      *
1093      *  ActiveMongo doesn't rely on MongoDB references, but it can support
1094      *  it, but it is prefered to use our referencing.
1095      *
1096      *  @experimental
1097      */
1098     final function doDeferencing($refs=array())
1099     {
1100         /* Get current document */
1101         $document = get_document_vars($this);
1102
1103         if (count($refs)==0) {
1104             /* Inspect the whole document */
1105             $this->getDocumentReferences($document, $refs);
1106         }
1107
1108         $db = $this->_getConnection();
1109
1110         /* Gather information about ActiveMongo Objects
1111          * that we need to create
1112          */
1113         $classes = array();
1114         foreach ($refs as $ref) {
1115             if (!isset($ref['ref']['class'])) {
1116
1117                 /* Support MongoDBRef, we do our best to be compatible {{{ */
1118                 /* MongoDB 'normal' reference */
1119
1120                 $obj = MongoDBRef::get($db, $ref['ref']);
1121
1122                 /* Offset the current document to the right spot */
1123                 /* Very inefficient, never use it, instead use ActiveMongo References */
1124
1125                 $this->_deferencingRestoreProperty($document, $ref['key'], clone $req);
1126
1127                 /* Dirty hack, override our current document
1128                  * property with the value itself, in order to
1129                  * avoid replace a MongoDB reference by its content
1130                  */
1131                 $this->_deferencingRestoreProperty($this->_current, $ref['key'], clone $req);
1132
1133                 /* }}} */
1134
1135             } else {
1136
1137                 if (isset($ref['ref']['dynamic'])) {
1138                     /* ActiveMongo Dynamic Reference */
1139
1140                     /* Create ActiveMongo object */
1141                     $req = $this->_deferencingCreateObject($ref['ref']['class']);
1142
1143                     /* Restore saved query */
1144                     $req->_deferencingQuery($ref['ref']['dynamic']);
1145
1146                     $results = array();
1147
1148                     /* Add the result set */
1149                     foreach ($req as $result) {
1150                         $results[]  = clone $result;
1151                     }
1152
1153                     /* add  information about the current reference */
1154                     foreach ($ref['ref'] as $key => $value) {
1155                         $results[$key] = $value;
1156                     }
1157
1158                     $this->_deferencingRestoreProperty($document, $ref['key'], $results);
1159
1160                 } else {
1161                     /* ActiveMongo Reference FTW! */
1162                     $classes[$ref['ref']['class']][] = $ref;
1163                 }
1164             }
1165         }
1166
1167         /* {{{ Create needed objects to query MongoDB and replace
1168          * our references by its objects documents.
1169          */
1170         foreach ($classes as $class => $refs) {
1171             $req = $this->_deferencingCreateObject($class);
1172
1173             /* Load list of IDs */
1174             $ids = array();
1175             foreach ($refs as $ref) {
1176                 $ids[] = $ref['ref']['$id'];
1177             }
1178
1179             /* Search to MongoDB once for all IDs found */
1180             $req->find($ids);
1181
1182             if ($req->count() != count($refs)) {
1183                 $total    = $req->count();
1184                 $expected = count($refs);
1185                 throw new MongoException("Dereferencing error, MongoDB replied {$total} objects, we expected {$expected}");
1186             }
1187
1188             /* Replace our references by its objects */
1189             foreach ($refs as $ref) {
1190                 $id    = $ref['ref']['$id'];
1191                 $place = $ref['key'];
1192                 $req->rewind();
1193                 while ($req->getID() != $id && $req->next());
1194
1195                 assert($req->getID() == $id);
1196
1197                 $this->_deferencingRestoreProperty($document, $place, clone $req);
1198
1199                 unset($obj);
1200             }
1201
1202             /* Release request, remember we
1203              * safely cloned it,
1204              */
1205             unset($req);
1206         }
1207         // }}}
1208
1209         /* Replace the current document by the new deferenced objects */
1210         foreach ($document as $key => $value) {
1211             $this->$key = $value;
1212         }
1213     }
1214     // }}}
1215
1216     // void getColumnDeference(&$document, $propety, ActiveMongo Obj) {{{
1217     /**
1218      *  Prepare a "selector" document to search treaing the property
1219      *  as a reference to the given ActiveMongo object.
1220      *
1221      */
1222     final function getColumnDeference(&$document, $property, ActiveMongo $obj)
1223     {
1224         $document["{$property}.\$id"] = $obj->getID();
1225     }
1226     // }}}
1227
1228     // void findReferences(&$document) {{{
1229     /**
1230      *  Check if in the current document to insert or update
1231      *  exists any references to other ActiveMongo Objects.
1232      *
1233      *  @return void
1234      */
1235     final function findReferences(&$document)
1236     {
1237         if (!is_array($document)) {
1238             return;
1239         }
1240         foreach($document as &$value) {
1241             $parent_class = __CLASS__;
1242             if (is_array($value)) {
1243                 if (MongoDBRef::isRef($value)) {
1244                     /*  If the property we're inspecting is a reference,
1245                      *  we need to remove the values, restoring the valid
1246                      *  Reference.
1247                      */
1248                     $arr = array(
1249                         '$ref'=>1, '$id'=>1, '$db'=>1, 'class'=>1, 'dynamic'=>1
1250                     );
1251                     foreach (array_keys($value) as $key) {
1252                         if (!isset($arr[$key])) {
1253                             unset($value[$key]);
1254                         }
1255                     }
1256                 } else {
1257                     $this->findReferences($value);
1258                 }
1259             } else if ($value InstanceOf $parent_class) {
1260                 $value = $value->getReference();
1261             }
1262         }
1263         /* trick: delete last var. reference */
1264         unset($value);
1265     }
1266     // }}}
1267
1268     // void __clone() {{{
1269     /**
1270      *  Cloned objects are rarely used, but ActiveMongo
1271      *  uses it to create different objects per everyrecord,
1272      *  which is used at deferencing. Therefore cloned object
1273      *  do not contains the recordset, just the actual document,
1274      *  so iterations are not allowed.
1275      *
1276      */
1277     final function __clone()
1278     {
1279         unset($this->_cursor);
1280         $this->_cloned = true;
1281     }
1282     // }}}
1283
1284     // }}}
1285
1286     // GET DOCUMENT ID {{{
1287
1288     // getID() {{{
1289     /**
1290      *  Return the current document ID. If there is
1291      *  no document it would return false.
1292      *
1293      *  @return object|false
1294      */
1295     final public function getID()
1296     {
1297         if ($this->_id instanceof MongoID) {
1298             return $this->_id;
1299         }
1300         return false;
1301     }
1302     // }}}
1303
1304     // string key() {{{
1305     /**
1306      *    Return the current key
1307      *
1308      *    @return string
1309      */
1310     final function key()
1311     {
1312         return $this->getID();
1313     }
1314     // }}}
1315
1316     // }}}
1317
1318     // Fancy (and silly) query abstraction {{{
1319
1320     // _assertNotInQuery() {{{
1321     /**
1322      *  Check if we can modify the query or not. We cannot modify
1323      *  the query if we already asked to MongoDB, in this case the
1324      *  object must be reset.
1325      *
1326      *  @return void
1327      */
1328     final private function _assertNotInQuery()
1329     {
1330         if ($this->_cursor InstanceOf MongoCursor) {
1331             throw new ActiveMongo_Exception("You cannot modify the query, please reset the object");
1332         }
1333     }
1334     // }}}
1335
1336     // doQuery() {{{
1337     /**
1338      *  Build the current request and send it to MongoDB.
1339      *
1340      *  @return this
1341      */
1342     final function doQuery()
1343     {
1344         $this->_assertNotInQuery();
1345
1346         $col = $this->_getCollection();
1347         if (count($this->_properties) > 0) {
1348             $cursor = $col->find((array)$this->_query['query'], $this->_properties);
1349         } else {
1350             $cursor = $col->find((array)$this->_query['query']);
1351         }
1352         if (is_array($this->_sort)) {
1353             $cursor->sort($this->_sort);
1354         }
1355         if ($this->_limit > 0) {
1356             $cursor->limit($this->_limit);
1357         }
1358         if ($this->_skip > 0) {
1359             $cursor->skip($this->_skip);
1360         }
1361
1362         /* Our cursor must be sent to ActiveMongo */
1363         $this->setCursor($cursor);
1364
1365         return $this;
1366     }
1367     // }}}
1368
1369     // properties($props) {{{
1370     /**
1371      *  Select 'properties' or 'columns' to be included in the document,
1372      *  by default all properties are included.
1373      *
1374      *  @param array $props
1375      *
1376      *  @return this
1377      */
1378     final function properties($props)
1379     {
1380         $this->_assertNotInQuery();
1381
1382         if (!is_array($props) && !is_string($props)) {
1383             return false;
1384         }
1385
1386         if (is_string($props)) {
1387             $props = explode(",", $props);
1388         }
1389
1390         foreach ($props as $id => $name) {
1391             $props[trim($name)] = 1;
1392             unset($props[$id]);
1393         }
1394
1395         $this->_properties = $props;
1396
1397         return $this;
1398     }
1399
1400     final function columns($properties)
1401     {
1402        return $this->properties($properties);
1403     }
1404     // }}}
1405
1406     // where($property, $value) {{{
1407     /**
1408      *  Where abstraction.
1409      *
1410      */
1411     final function where($property_str, $value=null)
1412     {
1413         $this->_assertNotInQuery();
1414
1415         if (is_array($property_str)) {
1416             if ($value != null) {
1417                 throw new ActiveMongo_Expception("Invalid parameters");
1418             }
1419             foreach ($property_str as $property => $value) {
1420                 if (is_numeric($property)) {
1421                     $property = $value;
1422                     $value    = 0;
1423                 }
1424                 $this->where($property, $value);
1425             }
1426             return $this;
1427         }
1428
1429         $column = explode(" ", trim($property_str));
1430         if (count($column) != 1 && count($column) != 2) {
1431             throw new ActiveMongo_Exception("Failed while parsing '{$property_str}'");
1432         } else if (count($column) == 2) {
1433
1434             $exp_scalar = true;
1435             switch (strtolower($column[1])) {
1436             case '>':
1437             case '$gt':
1438                 $op = '$gt';
1439                 break;
1440
1441             case '>=':
1442             case '$gte':
1443                 $op = '$gte';
1444                 break;
1445
1446             case '<':
1447             case '$lt':
1448                 $op = '$lt';
1449                 break;
1450
1451             case '<=':
1452             case '$lte':
1453                 $op = '$lte';
1454                 break;
1455
1456             case '==':
1457             case '$eq':
1458             case '=':
1459                 if (is_array($value)) {
1460                     $op = '$all';
1461                     $exp_scalar = false;
1462                 } else {
1463                     $op = '$eq';
1464                 }
1465                 break;
1466
1467             case '!=':
1468             case '<>':
1469             case '$ne':
1470                 if (is_array($value)) {
1471                     $op = '$nin';
1472                     $exp_scalar = false;
1473                 } else {
1474                     $op = '$ne';
1475                 }
1476                 break;
1477
1478             case '%':
1479             case 'mod':
1480             case '$mod':
1481                 $op = '$mod';
1482                 break;
1483
1484             case 'exists':
1485             case '$exists':
1486                 $value = true;
1487                 $op    = '$exists';
1488                 break;
1489
1490             /* regexp  */
1491             case 'regexp':
1492             case 'regex':
1493                 $value = new MongoRegex($value);
1494                 $op = NULL;
1495                 break;
1496
1497             /* arrays */
1498             case 'in':
1499             case '$in':
1500                 $exp_scalar = false;
1501                 $op = '$in';
1502                 break;
1503
1504             case '$nin':
1505             case 'nin':
1506                 $exp_scalar = false;
1507                 $op = '$nin';
1508                 break;
1509
1510
1511             /* geo operations */
1512             case 'near':
1513             case '$near':
1514                 $op = '$near';
1515                 $exp_scalar = false;
1516                 break;
1517
1518             default:
1519                 throw new ActiveMongo_Exception("Failed to parse '{$column[1]}'");
1520             }
1521
1522             if ($exp_scalar && is_array($value)) {
1523                 throw new ActiveMongo_Exception("Cannot use comparing operations with Array");
1524             } else if (!$exp_scalar && !is_array($value)) {
1525                 throw new ActiveMongo_Exception("The operation {$column[1]} expected an Array");
1526             }
1527
1528             if ($op) {
1529                 $value = array($op => $value);
1530             }
1531         } else if (is_array($value)) {
1532             $value = array('$in' => $value);
1533         }
1534
1535         $spot = & $this->_query['query'][$column[0]];
1536         if (is_array($value)) {
1537             $spot[key($value)] =  current($value);
1538         } else {
1539             /* simulate AND among same properties if
1540              * multiple values is passed for same property
1541              */
1542             if (isset($spot)) {
1543                 if (is_array($spot)) {
1544                     $spot['$all'][] = $value;
1545                 } else {
1546                     $spot = array('$all' => array($spot, $value));
1547                 }
1548             } else {
1549                 $spot =  $value;
1550             }
1551         }
1552
1553         return $this;
1554     }
1555     // }}}
1556
1557     // sort($sort_str) {{{
1558     /**
1559      *  Abstract the documents sorting.
1560      *
1561      *  @param string $sort_str List of properties to use as sorting
1562      *
1563      *  @return this
1564      */
1565     final function sort($sort_str)
1566     {
1567         $this->_assertNotInQuery();
1568
1569         $this->_sort = array();
1570         foreach ((array)explode(",", $sort_str) as $sort_part_str) {
1571             $sort_part = explode(" ", trim($sort_part_str), 2);
1572             switch(count($sort_part)) {
1573             case 1:
1574                 $sort_part[1] = 'ASC';
1575                 break;
1576             case 2:
1577                 break;
1578             default:
1579                 throw new ActiveMongo_Exception("Don't know how to parse {$sort_part_str}");
1580             }
1581
1582             switch (strtoupper($sort_part[1])) {
1583             case 'ASC':
1584                 $sort_part[1] = 1;
1585                 break;
1586             case 'DESC':
1587                 $sort_part[1] = -1;
1588                 break;
1589             default:
1590                 throw new ActiveMongo_Exception("Invalid sorting direction `{$sort_part[1]}`");
1591             }
1592             $this->_sort[ $sort_part[0] ] = $sort_part[1];
1593         }
1594
1595         return $this;
1596     }
1597     // }}}
1598
1599     // limit($limit, $skip) {{{
1600     /**
1601      *  Abstract the limitation and pagination of documents.
1602      *
1603      *  @param int $limit Number of max. documents to retrieve
1604      *  @param int $skip  Number of documents to skip
1605      *
1606      *  @return this
1607      */
1608     final function limit($limit=0, $skip=0)
1609     {
1610         $this->_assertNotInQuery();
1611
1612         if ($limit < 0 || $skip < 0) {
1613             return false;
1614         }
1615         $this->_limit = $limit;
1616         $this->_skip  = $skip;
1617
1618         return $this;
1619     }
1620     // }}}
1621
1622     // }}}
1623
1624 }
1625
1626 require_once dirname(__FILE__)."/Validators.php";
1627 require_once dirname(__FILE__)."/Exceptions.php";
1628
1629 /*
1630  * Local variables:
1631  * tab-width: 4
1632  * c-basic-offset: 4
1633  * End:
1634  * vim600: sw=4 ts=4 fdm=marker
1635  * vim<600: sw=4 ts=4
1636  */