mongocollection.findone(3) [php man page]

MONGOCOLLECTION.FINDONE(3)						 1						MONGOCOLLECTION.FINDONE(3)

MongoCollection::findOne - Queries this collection, returning a single element

SYNOPSIS

       public array MongoCollection::findOne ([array  $query = array()], [array  $fields = array()], [array  $options = array()])

DESCRIPTION

	As  opposed  to MongoCollection.find(3), this method will return only the first result from the result set, and not a MongoCursor that can
       be iterated over.

PARAMETERS

	      o $query
		- The fields for which to search. MongoDB's query language is quite extensive. The PHP driver will in almost all  cases  pass  the
		query straight through to the server, so reading the MongoDB core docs on find is a good idea.

	      Warning

		      Please  make  sure  that	for all special query operaters (starting with $) you use single quotes so that PHP doesn't try to
		     replace "$exists" with the value of the variable $exists.

	      o $fields
		- Fields of the results to return. The array is in the format array('fieldname' => true, 'fieldname2' => true). The _id  field	is
		always returned.

	      o $options
		- This parameter is an associative array of the form array("name" => <value>, ...). Currently supported options are:

		     o "maxTimeMS"Specifies  a cumulative time limit in milliseconds for processing the operation (does not include idle time). If
		       the operation is not completed within the timeout period, a MongoExecutionTimeoutException will be thrown.

RETURN VALUES

	Returns record matching the search or NULL.

ERRORS
/EXCEPTIONS
	Throws MongoConnectionException if it cannot reach the database.

CHANGELOG

       +--------+------------------------------------+
       |Version |				     |
       |	|				     |
       |	|	     Description	     |
       |	|				     |
       +--------+------------------------------------+
       | 1.5.0	|				     |
       |	|				     |
       |	|  Added optional $options argument. |
       |	|				     |
       +--------+------------------------------------+
EXAMPLES

       Example #1

	      MongoCollection::findOne document by its id.

	      This example demonstrates how to find a single document in a collection by its id.

	      <?php

	      $articles = $mongo->my_db->articles;

	      $article = $articles->findOne(array('_id' => new MongoId('47cc67093475061e3d9536d2')));

	      ?>

       Example #2

	      MongoCollection::findOne document by some condition.

	      This example demonstrates how to find a single document in a collection by some condition and limiting the returned fields.

	      <?php

	      $users = $mongo->my_db->users;
	      $user = $users->findOne(array('username' => 'jwage'), array('password'));
	      print_r($user);

	      ?>

	      The above example will output something similar to:

	      Array
	      (
		  [_id] => MongoId Object
		      (
		      )

		  [password] => test
	      )

	       Notice how even though the document does have a username field, we limited the results to only contain the password field.

SEE ALSO 
MongoCollection.find(3), MongoCollection.insert(3), MongoDB core docs on find..
PHP Documentation Group 												MONGOCOLLECTION.FINDONE(3)

MONGOCOLLECTION.GROUP(3)						 1						  MONGOCOLLECTION.GROUP(3)

MongoCollection::group - Performs an operation similar to SQL's GROUP BY command

SYNOPSIS

       public array MongoCollection::group (mixed  $keys, array  $initial, MongoCode  $reduce, [array  $options = array()])

DESCRIPTION

PARAMETERS

	      o $keys
		-  Fields  to group by. If an array or non-code object is passed, it will be the key used to group results. 1.0.4+: If $keys is an
		instance of MongoCode, $keys will be treated as a function that returns the key to group by (see the "Passing  a  $keys  function"
		example below).

	      o $initial
		- Initial value of the aggregation counter object.

	      o $reduce
		- A function that takes two arguments (the current document and the aggregation to this point) and does the aggregation.

	      o $options
		- Optional parameters to the group command. Valid options include:

		     o "condition" Criteria for including a document in the aggregation.

		     o "finalize" Function called once per unique key that takes the final output of the reduce function.

		     o "maxTimeMS"Specifies  a cumulative time limit in milliseconds for processing the operation (does not include idle time). If
		       the operation is not completed within the timeout period, a MongoExecutionTimeoutException will be thrown.

RETURN VALUES

	Returns an array containing the result.

CHANGELOG

       +--------+----------------------------------------------+
       |Version |					       |
       |	|					       |
       |	|		  Description		       |
       |	|					       |
       +--------+----------------------------------------------+
       | 1.5.0	|					       |
       |	|					       |
       |	|	   Added "maxTimeMS" option.	       |
       |	|					       |
       |1.2.11	|					       |
       |	|					       |
       |	|  Emits E_DEPRECATED when $options is scalar. |
       |	|					       |
       +--------+----------------------------------------------+
EXAMPLES

       Example #1

	      MongoCollection.group(3) example

	       This groups documents by category and creates a list of names within that category.

	      <?php

	      $collection->insert(array("category" => "fruit", "name" => "apple"));
	      $collection->insert(array("category" => "fruit", "name" => "peach"));
	      $collection->insert(array("category" => "fruit", "name" => "banana"));
	      $collection->insert(array("category" => "veggie", "name" => "corn"));
	      $collection->insert(array("category" => "veggie", "name" => "broccoli"));

	      $keys = array("category" => 1);

	      $initial = array("items" => array());

	      $reduce = "function (obj, prev) { prev.items.push(obj.name); }";

	      $g = $collection->group($keys, $initial, $reduce);

	      echo json_encode($g['retval']);

	      ?>

	      The above example will output something similar to:

	      [{"category":"fruit","items":["apple","peach","banana"]},{"category":"veggie","items":["corn","broccoli"]}]

       Example #2

	      MongoCollection.group(3) example

	       This example doesn't use any key, so every document will be its own group. It also uses a condition: only documents that match this
	      condition will be processed by the grouping function.

	      <?php

	      $collection->save(array("a" => 2));
	      $collection->save(array("b" => 5));
	      $collection->save(array("a" => 1));

	      // use all fields
	      $keys = array();

	      // set intial values
	      $initial = array("count" => 0);

	      // JavaScript function to perform
	      $reduce = "function (obj, prev) { prev.count++; }";

	      // only use documents where the "a" field is greater than 1
	      $condition = array('condition' => array("a" => array( '$gt' => 1)));

	      $g = $collection->group($keys, $initial, $reduce, $condition);

	      var_dump($g);

	      ?>

	      The above example will output something similar to:

	      array(4) {
		["retval"]=>
		array(1) {
		  [0]=>
		  array(1) {
		    ["count"]=>
		    float(1)
		  }
		}
		["count"]=>
		float(1)
		["keys"]=>
		int(1)
		["ok"]=>
		float(1)
	      }

       Example #3

	      Passing a $keys function

	       If  you	want  to  group  by  something	other  than  a	field name, you can pass a function as the first parameter of MongoCollec-
	      tion.group(3) and it will be run against each document. The return value of the function will be used as its grouping value.

	       This example demonstrates grouping by the num field modulo 4.

	      <?php

	      $c->group(new MongoCode('function(doc) { return {mod : doc.num % 4}; }'),
		   array("count" => 0),
		   new MongoCode('function(current, total) { total.count++; }'));

	      ?>

PHP Documentation Group 												  MONGOCOLLECTION.GROUP(3)