WebSVN – SmartDukaan – Blame – /trunk/MobileHotIndia/app/Plugin/Mongodb/docs/mongodb/mongodb-models-datasources/MongodbSource.html

Rev	Author	Line No.	Line
15403	manish.sha	1	`<?xml version="1.0" encoding="iso-8859-1"?>`
		2	`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">`
		3	`<html xmlns="http://www.w3.org/1999/xhtml">`
		4	`<head>`
		5	`<!-- template designed by Marco Von Ballmoos -->`
		6	`<title>Docs For Class MongodbSource</title>`
		7	`<link rel="stylesheet" href="../../media/stylesheet.css" />`
		8	`<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>`
		9	`</head>`
		10	`<body>`
		11	`<div class="page-body">`
		12	`<h2 class="class-name">Class MongodbSource</h2>`
		13
		14	`<a name="sec-description"></a>`
		15	`<div class="info-box">`
		16	`<div class="info-box-title">Description</div>`
		17	`<div class="nav-bar">`
		18	`<span class="disabled">Description</span> \|`
		19	`<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)`
		20	`\| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)`
		21
		22	`</div>`
		23	`<div class="info-box-body">`
		24	`<!-- ========== Info from phpDoc block ========= -->`
		25	`<p class="short-description">MongoDB Source</p>`
		26	`<p class="notes">`
		27	`Located in <a class="field" href="_datasources---mongodb_source.php.html">/datasources/mongodb_source.php</a> (line <span class="field">35</span>)`
		28	`</p>`
		29
		30
		31	`<pre>DboSource`
		32	`\|`
		33	`--MongodbSource</pre>`
		34
		35	`</div>`
		36	`</div>`
		37
		38
		39
		40	`<a name="sec-var-summary"></a>`
		41	`<div class="info-box">`
		42	`<div class="info-box-title"><span>Variable Summary</span></div>`
		43	`<div class="nav-bar">`
		44	`<a href="#sec-description">Description</a> \|`
		45	`<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)`
		46	`\|`
		47	`<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)`
		48
		49	`</div>`
		50	`<div class="info-box-body">`
		51	`<div class="var-summary">`
		52	`<div class="var-title">`
		53	`<span class="var-type">array</span>`
		54	`<a href="#$columns" title="details" class="var-name">$columns</a>`
		55	`</div>`
		56	`<div class="var-title">`
		57	`<span class="var-type">boolean</span>`
		58	`<a href="#$connected" title="details" class="var-name">$connected</a>`
		59	`</div>`
		60	`<div class="var-title">`
		61	`<span class="var-type">array</span>`
		62	`<a href="#$_baseConfig" title="details" class="var-name">$_baseConfig</a>`
		63	`</div>`
		64	`<div class="var-title">`
		65	`<span class="var-type">resource</span>`
		66	`<a href="#$_db" title="details" class="var-name">$_db</a>`
		67	`</div>`
		68	`<div class="var-title">`
		69	`<span class="var-type">array</span>`
		70	`<a href="#$_defaultSchema" title="details" class="var-name">$_defaultSchema</a>`
		71	`</div>`
		72	`<div class="var-title">`
		73	`<span class="var-type">string</span>`
		74	`<a href="#$_driverVersion" title="details" class="var-name">$_driverVersion</a>`
		75	`</div>`
		76	`<div class="var-title">`
		77	`<span class="var-type">mixed</span>`
		78	`<a href="#$_startTime" title="details" class="var-name">$_startTime</a>`
		79	`</div>`
		80	`</div>`
		81	`</div>`
		82	`</div>`
		83
		84	`<a name="sec-method-summary"></a>`
		85	`<div class="info-box">`
		86	`<div class="info-box-title"><span>Method Summary</span></div>`
		87	`<div class="nav-bar">`
		88	`<a href="#sec-description">Description</a> \|`
		89	`<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)`
		90
		91	`\|`
		92	`<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)`
		93	`</div>`
		94	`<div class="info-box-body">`
		95	`<div class="method-summary">`
		96
		97	`<div class="method-definition">`
		98	`<span class="method-result">void</span>`
		99	`<a href="#__construct" title="details" class="method-name">__construct</a>`
		100	`([<span class="var-type">array</span> <span class="var-name">$config</span> = <span class="var-default">array()</span>], [<span class="var-type">bool</span> <span class="var-name">$autoConnect</span> = <span class="var-default">false</span>])`
		101	`</div>`
		102
		103	`<div class="method-definition">`
		104	`<span class="method-result">void</span>`
		105	`<a href="#__destruct" title="details" class="method-name">__destruct</a>`
		106	`()`
		107	`</div>`
		108
		109	`<div class="method-definition">`
		110	`<span class="method-result">void</span>`
		111	`<a href="#begin" title="details" class="method-name">begin</a>`
		112	`()`
		113	`</div>`
		114
		115	`<div class="method-definition">`
		116	`<span class="method-result">array</span>`
		117	`<a href="#calculate" title="details" class="method-name">calculate</a>`
		118	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		119	`</div>`
		120
		121	`<div class="method-definition">`
		122	`<span class="method-result">boolean</span>`
		123	`<a href="#close" title="details" class="method-name">close</a>`
		124	`()`
		125	`</div>`
		126
		127	`<div class="method-definition">`
		128	`<span class="method-result">void</span>`
		129	`<a href="#commit" title="details" class="method-name">commit</a>`
		130	`()`
		131	`</div>`
		132
		133	`<div class="method-definition">`
		134	`<span class="method-result">boolean</span>`
		135	`<a href="#connect" title="details" class="method-name">connect</a>`
		136	`()`
		137	`</div>`
		138
		139	`<div class="method-definition">`
		140	`<span class="method-result">boolean</span>`
		141	`<a href="#create" title="details" class="method-name">create</a>`
		142	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		143	`</div>`
		144
		145	`<div class="method-definition">`
		146	`<span class="method-result">void</span>`
		147	`<a href="#createConnectionName" title="details" class="method-name">createConnectionName</a>`
		148	`(<span class="var-type">array</span> <span class="var-name">$config</span>, <span class="var-type">string</span> <span class="var-name">$version</span>)`
		149	`</div>`
		150
		151	`<div class="method-definition">`
		152	`<span class="method-result">void</span>`
		153	`<a href="#createSchema" title="details" class="method-name">createSchema</a>`
		154	`(<span class="var-type">mixed</span> <span class="var-name">$schema</span>, [<span class="var-type">mixed</span> <span class="var-name">$tableName</span> = <span class="var-default">null</span>])`
		155	`</div>`
		156
		157	`<div class="method-definition">`
		158	`<span class="method-result">boolean</span>`
		159	`<a href="#delete" title="details" class="method-name">delete</a>`
		160	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		161	`</div>`
		162
		163	`<div class="method-definition">`
		164	`<span class="method-result">void</span>`
		165	`<a href="#deriveSchemaFromData" title="details" class="method-name">deriveSchemaFromData</a>`
		166	`(<span class="var-type">mixed</span> <span class="var-name">$Model</span>, [<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">array()</span>])`
		167	`</div>`
		168
		169	`<div class="method-definition">`
		170	`<span class="method-result">array</span>`
		171	`<a href="#describe" title="details" class="method-name">describe</a>`
		172	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type"></span> <span class="var-name">$field</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		173	`</div>`
		174
		175	`<div class="method-definition">`
		176	`<span class="method-result">boolean</span>`
		177	`<a href="#disconnect" title="details" class="method-name">disconnect</a>`
		178	`()`
		179	`</div>`
		180
		181	`<div class="method-definition">`
		182	`<span class="method-result">void</span>`
		183	`<a href="#distinct" title="details" class="method-name">distinct</a>`
		184	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$keys</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		185	`</div>`
		186
		187	`<div class="method-definition">`
		188	`<span class="method-result">void</span>`
		189	`<a href="#dropSchema" title="details" class="method-name">dropSchema</a>`
		190	`(<span class="var-type">mixed</span> <span class="var-name">$schema</span>, [<span class="var-type">mixed</span> <span class="var-name">$tableName</span> = <span class="var-default">null</span>])`
		191	`</div>`
		192
		193	`<div class="method-definition">`
		194	`<span class="method-result">void</span>`
		195	`<a href="#ensureIndex" title="details" class="method-name">ensureIndex</a>`
		196	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$keys</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		197	`</div>`
		198
		199	`<div class="method-definition">`
		200	`<span class="method-result">void</span>`
		201	`<a href="#execute" title="details" class="method-name">execute</a>`
		202	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])`
		203	`</div>`
		204
		205	`<div class="method-definition">`
		206	`<span class="method-result">mixed</span>`
		207	`<a href="#getMongoCollection" title="details" class="method-name">getMongoCollection</a>`
		208	`(<span class="var-type"></span> <span class="var-name">&$Model</span>)`
		209	`</div>`
		210
		211	`<div class="method-definition">`
		212	`<span class="method-result">mixed</span>`
		213	`<a href="#getMongoDb" title="details" class="method-name">getMongoDb</a>`
		214	`()`
		215	`</div>`
		216
		217	`<div class="method-definition">`
		218	`<span class="method-result">void</span>`
		219	`<a href="#group" title="details" class="method-name">group</a>`
		220	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		221	`</div>`
		222
		223	`<div class="method-definition">`
		224	`<span class="method-result">void</span>`
		225	`<a href="#insertMulti" title="details" class="method-name">insertMulti</a>`
		226	`(<span class="var-type">string</span> <span class="var-name">$table</span>, <span class="var-type">string</span> <span class="var-name">$fields</span>, <span class="var-type">array</span> <span class="var-name">$values</span>)`
		227	`</div>`
		228
		229	`<div class="method-definition">`
		230	`<span class="method-result">boolean</span>`
		231	`<a href="#isConnected" title="details" class="method-name">isConnected</a>`
		232	`()`
		233	`</div>`
		234
		235	`<div class="method-definition">`
		236	`<span class="method-result">void</span>`
		237	`<a href="#isInterfaceSupported" title="details" class="method-name">isInterfaceSupported</a>`
		238	`(<span class="var-type">mixed</span> <span class="var-name">$interface</span>)`
		239	`</div>`
		240
		241	`<div class="method-definition">`
		242	`<span class="method-result">array</span>`
		243	`<a href="#listSources" title="details" class="method-name">listSources</a>`
		244	`([<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">null</span>])`
		245	`</div>`
		246
		247	`<div class="method-definition">`
		248	`<span class="method-result">void</span>`
		249	`<a href="#logQuery" title="details" class="method-name">logQuery</a>`
		250	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$args</span> = <span class="var-default">array()</span>])`
		251	`</div>`
		252
		253	`<div class="method-definition">`
		254	`<span class="method-result">mixed</span>`
		255	`<a href="#mapReduce" title="details" class="method-name">mapReduce</a>`
		256	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">integer</span> <span class="var-name">$timeout</span> = <span class="var-default">null</span>])`
		257	`</div>`
		258
		259	`<div class="method-definition">`
		260	`<span class="method-result">string</span>`
		261	`<a href="#name" title="details" class="method-name">name</a>`
		262	`(<span class="var-type">string</span> <span class="var-name">$name</span>)`
		263	`</div>`
		264
		265	`<div class="method-definition">`
		266	`<span class="method-result">void</span>`
		267	`<a href="#query" title="details" class="method-name">query</a>`
		268	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])`
		269	`</div>`
		270
		271	`<div class="method-definition">`
		272	`<span class="method-result">array</span>`
		273	`<a href="#read" title="details" class="method-name">read</a>`
		274	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$query</span> = <span class="var-default">array()</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		275	`</div>`
		276
		277	`<div class="method-definition">`
		278	`<span class="method-result">void</span>`
		279	`<a href="#rollback" title="details" class="method-name">rollback</a>`
		280	`()`
		281	`</div>`
		282
		283	`<div class="method-definition">`
		284	`<span class="method-result">boolean</span>`
		285	`<a href="#setTimeout" title="details" class="method-name">setTimeout</a>`
		286	`(<span class="var-type">int</span> <span class="var-name">$ms</span>)`
		287	`</div>`
		288
		289	`<div class="method-definition">`
		290	`<span class="method-result">boolean</span>`
		291	`<a href="#truncate" title="details" class="method-name">truncate</a>`
		292	`(<span class="var-type">mixed</span> <span class="var-name">$table</span>)`
		293	`</div>`
		294
		295	`<div class="method-definition">`
		296	`<span class="method-result">boolean</span>`
		297	`<a href="#update" title="details" class="method-name">update</a>`
		298	(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)
		299	`</div>`
		300
		301	`<div class="method-definition">`
		302	`<span class="method-result">boolean</span>`
		303	`<a href="#updateAll" title="details" class="method-name">updateAll</a>`
		304	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		305	`</div>`
		306
		307	`<div class="method-definition">`
		308	`<span class="method-result">mixed</span>`
		309	`<a href="#value" title="details" class="method-name">value</a>`
		310	`(<span class="var-type">mixed</span> <span class="var-name">$data</span>, [<span class="var-type">string</span> <span class="var-name">$column</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$read</span> = <span class="var-default">true</span>])`
		311	`</div>`
		312
		313	`<div class="method-definition">`
		314	`<span class="method-result">void</span>`
		315	`<a href="#_convertId" title="details" class="method-name">_convertId</a>`
		316	`(<span class="var-type"></span> <span class="var-name">&$mixed</span>, [<span class="var-type">bool</span> <span class="var-name">$conditions</span> = <span class="var-default">false</span>], <span class="var-type">mixed</span> <span class="var-name">$mixed</span>)`
		317	`</div>`
		318
		319	`<div class="method-definition">`
		320	`<span class="method-result">void</span>`
		321	`<a href="#_prepareLogQuery" title="details" class="method-name">_prepareLogQuery</a>`
		322	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		323	`</div>`
		324
		325	`<div class="method-definition">`
		326	`<span class="method-result">void</span>`
		327	`<a href="#_setEmptyValues" title="details" class="method-name">_setEmptyValues</a>`
		328	`(<span class="var-type"></span> <span class="var-name">&$data</span>, [<span class="var-type">array</span> <span class="var-name">$integers</span> = <span class="var-default">array('limit', 'offset')</span>], <span class="var-type">mixed</span> <span class="var-name">$data</span>)`
		329	`</div>`
		330
		331	`<div class="method-definition">`
		332	`<span class="method-result">array</span>`
		333	`<a href="#_stringify" title="details" class="method-name">_stringify</a>`
		334	`([<span class="var-type"></span> <span class="var-name">&$args</span> = <span class="var-default">array()</span>], [<span class="var-type">int</span> <span class="var-name">$level</span> = <span class="var-default">0</span>], <span class="var-type">array</span> <span class="var-name">$args</span>)`
		335	`</div>`
		336
		337	`<div class="method-definition">`
		338	`<span class="method-result">void</span>`
		339	`<a href="#_stripAlias" title="details" class="method-name">_stripAlias</a>`
		340	([<span class="var-type"></span> <span class="var-name">&$args</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'Model'</span>], [<span class="var-type">bool</span> <span class="var-name">$recurse</span> = <span class="var-default">true</span>], [<span class="var-type">string</span> <span class="var-name">$check</span> = <span class="var-default">'key'</span>], <span class="var-type">array</span> <span class="var-name">$args</span>)
		341	`</div>`
		342	`</div>`
		343	`</div>`
		344	`</div>`
		345
		346	`<a name="sec-vars"></a>`
		347	`<div class="info-box">`
		348	`<div class="info-box-title">Variables</div>`
		349	`<div class="nav-bar">`
		350	`<a href="#sec-description">Description</a> \|`
		351	`<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)`
		352
		353
		354	`\|`
		355	`<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)`
		356
		357	`</div>`
		358	`<div class="info-box-body">`
		359
		360	`<a name="var$columns" id="$columns"><!-- --></A>`
		361	`<div class="evenrow">`
		362
		363	`<div class="var-header">`
		364	`<span class="var-title">`
		365	`<span class="var-type">array</span>`
		366	`<span class="var-name">$columns</span>`
		367	= <span class="var-default">array(<br /> 'boolean' => array('name' => 'boolean'),'string'=>array('name'=>'varchar'),'text'=>array('name'=>'text'),'integer'=>array('name'=>'integer','format'=>null,'formatter'=>'intval'),'float'=>array('name'=>'float','format'=>null,'formatter'=>'floatval'),'datetime'=>array('name'=>'datetime','format'=>null,'formatter'=>'MongodbDateFormatter'),'timestamp'=>array('name'=>'timestamp','format'=>null,'formatter'=>'MongodbDateFormatter'),'time'=>array('name'=>'time','format'=>null,'formatter'=>'MongodbDateFormatter'),'date'=>array('name'=>'date','format'=>null,'formatter'=>'MongodbDateFormatter'),)</span> (line <span class="line-number">101</span>)
		368	`</span>`
		369	`</div>`
		370
		371	`<!-- ========== Info from phpDoc block ========= -->`
		372	`<p class="short-description">column definition</p>`
		373	`<ul class="tags">`
		374	`<li><span class="field">access:</span> public</li>`
		375	`</ul>`
		376
		377
		378
		379
		380
		381	`</div>`
		382	`<a name="var$connected" id="$connected"><!-- --></A>`
		383	`<div class="oddrow">`
		384
		385	`<div class="var-header">`
		386	`<span class="var-title">`
		387	`<span class="var-type">boolean</span>`
		388	`<span class="var-name">$connected</span>`
		389	`= <span class="var-default"> null</span> (line <span class="line-number">47</span>)`
		390	`</span>`
		391	`</div>`
		392
		393	`<!-- ========== Info from phpDoc block ========= -->`
		394	`<p class="short-description">Are we connected to the DataSource?</p>`
		395	`<p class="description"><p>true - yes null - haven't tried yet false - nope, and we can't connect</p></p>`
		396	`<ul class="tags">`
		397	`<li><span class="field">access:</span> public</li>`
		398	`</ul>`
		399
		400
		401
		402
		403
		404	`</div>`
		405	`<a name="var$_baseConfig" id="$_baseConfig"><!-- --></A>`
		406	`<div class="evenrow">`
		407
		408	`<div class="var-header">`
		409	`<span class="var-title">`
		410	`<span class="var-type">array</span>`
		411	`<span class="var-name">$_baseConfig</span>`
		412	`= <span class="var-default">array(<br /> 'set_string_id' => true,<br /> 'persistent' => true,<br /> 'host' => 'localhost',<br /> 'database' => '',<br /> 'port' => '27017',<br /> 'login' => '',<br /> 'password' => ''<br /> )</span> (line <span class="line-number">86</span>)`
		413	`</span>`
		414	`</div>`
		415
		416	`<!-- ========== Info from phpDoc block ========= -->`
		417	`<p class="short-description">Base Config</p>`
		418	`<p class="description"><p>set_string_id: true: In read() method, convert MongoId object to string and set it to array 'id'. false: not convert and set.</p></p>`
		419	`<ul class="tags">`
		420	`<li><span class="field">access:</span> public</li>`
		421	`</ul>`
		422
		423
		424
		425
		426
		427	`</div>`
		428	`<a name="var$_db" id="$_db"><!-- --></A>`
		429	`<div class="oddrow">`
		430
		431	`<div class="var-header">`
		432	`<span class="var-title">`
		433	`<span class="var-type">resource</span>`
		434	`<span class="var-name">$_db</span>`
		435	`= <span class="var-default"> null</span> (line <span class="line-number">55</span>)`
		436	`</span>`
		437	`</div>`
		438
		439	`<!-- ========== Info from phpDoc block ========= -->`
		440	`<p class="short-description">Database Instance</p>`
		441	`<ul class="tags">`
		442	`<li><span class="field">access:</span> protected</li>`
		443	`</ul>`
		444
		445
		446
		447
		448
		449	`</div>`
		450	`<a name="var$_defaultSchema" id="$_defaultSchema"><!-- --></A>`
		451	`<div class="evenrow">`
		452
		453	`<div class="var-header">`
		454	`<span class="var-title">`
		455	`<span class="var-type">array</span>`
		456	`<span class="var-name">$_defaultSchema</span>`
		457	`= <span class="var-default">array(<br /> '_id' => array('type' => 'string', 'length' => 24, 'key' => 'primary'),'created'=>array('type'=>'datetime','default'=>null))</span> (line <span class="line-number">119</span>)`
		458	`</span>`
		459	`</div>`
		460
		461	`<!-- ========== Info from phpDoc block ========= -->`
		462	`<p class="short-description">Default schema for the mongo models</p>`
		463	`<ul class="tags">`
		464	`<li><span class="field">access:</span> protected</li>`
		465	`</ul>`
		466
		467
		468
		469
		470
		471	`</div>`
		472	`<a name="var$_driverVersion" id="$_driverVersion"><!-- --></A>`
		473	`<div class="oddrow">`
		474
		475	`<div class="var-header">`
		476	`<span class="var-title">`
		477	`<span class="var-type">string</span>`
		478	`<span class="var-name">$_driverVersion</span>`
		479	`= <span class="var-default"> Mongo::VERSION</span> (line <span class="line-number">63</span>)`
		480	`</span>`
		481	`</div>`
		482
		483	`<!-- ========== Info from phpDoc block ========= -->`
		484	`<p class="short-description">Mongo Driver Version</p>`
		485	`<ul class="tags">`
		486	`<li><span class="field">access:</span> protected</li>`
		487	`</ul>`
		488
		489
		490
		491
		492
		493	`</div>`
		494	`<a name="var$_startTime" id="$_startTime"><!-- --></A>`
		495	`<div class="evenrow">`
		496
		497	`<div class="var-header">`
		498	`<span class="var-title">`
		499	`<span class="var-type">mixed</span>`
		500	`<span class="var-name">$_startTime</span>`
		501	`= <span class="var-default"> null</span> (line <span class="line-number">73</span>)`
		502	`</span>`
		503	`</div>`
		504
		505	`<!-- ========== Info from phpDoc block ========= -->`
		506	`<p class="short-description">startTime property</p>`
		507	`<p class="description"><p>If debugging is enabled, stores the (micro)time the current query started</p></p>`
		508	`<ul class="tags">`
		509	`<li><span class="field">var:</span> null</li>`
		510	`<li><span class="field">access:</span> protected</li>`
		511	`</ul>`
		512
		513
		514
		515
		516
		517	`</div>`
		518
		519	`</div>`
		520	`</div>`
		521
		522	`<a name="sec-methods"></a>`
		523	`<div class="info-box">`
		524	`<div class="info-box-title">Methods</div>`
		525	`<div class="nav-bar">`
		526	`<a href="#sec-description">Description</a> \|`
		527	`<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)`
		528	`<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)`
		529
		530	`</div>`
		531	`<div class="info-box-body">`
		532	`<A NAME='method_detail'></A>`
		533	`<a name="method__construct" id="__construct"><!-- --></a>`
		534	`<div class="oddrow">`
		535
		536	`<div class="method-header">`
		537	`<span class="method-title">Constructor __construct</span> (line <span class="line-number">134</span>)`
		538	`</div>`
		539
		540	`<!-- ========== Info from phpDoc block ========= -->`
		541	`<p class="short-description">construct method</p>`
		542	`<p class="description"><p>By default don't try to connect until you need to</p></p>`
		543	`<ul class="tags">`
		544	`<li><span class="field">access:</span> public</li>`
		545	`</ul>`
		546
		547	`<div class="method-signature">`
		548	`<span class="method-result">void</span>`
		549	`<span class="method-name">`
		550	`__construct`
		551	`</span>`
		552	`([<span class="var-type">array</span> <span class="var-name">$config</span> = <span class="var-default">array()</span>], [<span class="var-type">bool</span> <span class="var-name">$autoConnect</span> = <span class="var-default">false</span>])`
		553	`</div>`
		554
		555	`<ul class="parameters">`
		556	`<li>`
		557	`<span class="var-type">array</span>`
		558	`<span class="var-name">$config</span><span class="var-description">: Configuration array</span> </li>`
		559	`<li>`
		560	`<span class="var-type">bool</span>`
		561	`<span class="var-name">$autoConnect</span><span class="var-description">: false</span> </li>`
		562	`</ul>`
		563
		564
		565	`</div>`
		566	`<a name="method__destruct" id="__destruct"><!-- --></a>`
		567	`<div class="evenrow">`
		568
		569	`<div class="method-header">`
		570	`<span class="method-title">Destructor __destruct</span> (line <span class="line-number">143</span>)`
		571	`</div>`
		572
		573	`<!-- ========== Info from phpDoc block ========= -->`
		574	`<p class="short-description">Destruct</p>`
		575	`<ul class="tags">`
		576	`<li><span class="field">access:</span> public</li>`
		577	`</ul>`
		578
		579	`<div class="method-signature">`
		580	`<span class="method-result">void</span>`
		581	`<span class="method-name">`
		582	`__destruct`
		583	`</span>`
		584	`()`
		585	`</div>`
		586
		587
		588
		589	`</div>`
		590	`<a name="methodbegin" id="begin"><!-- --></a>`
		591	`<div class="oddrow">`
		592
		593	`<div class="method-header">`
		594	`<span class="method-title">begin</span> (line <span class="line-number">411</span>)`
		595	`</div>`
		596
		597	`<!-- ========== Info from phpDoc block ========= -->`
		598	`<p class="short-description">begin method</p>`
		599	`<p class="description"><p>Mongo doesn't support transactions</p></p>`
		600	`<ul class="tags">`
		601	`<li><span class="field">access:</span> public</li>`
		602	`</ul>`
		603
		604	`<div class="method-signature">`
		605	`<span class="method-result">void</span>`
		606	`<span class="method-name">`
		607	`begin`
		608	`</span>`
		609	`()`
		610	`</div>`
		611
		612
		613
		614	`</div>`
		615	`<a name="methodcalculate" id="calculate"><!-- --></a>`
		616	`<div class="evenrow">`
		617
		618	`<div class="method-header">`
		619	`<span class="method-title">calculate</span> (line <span class="line-number">422</span>)`
		620	`</div>`
		621
		622	`<!-- ========== Info from phpDoc block ========= -->`
		623	`<p class="short-description">Calculate</p>`
		624	`<ul class="tags">`
		625	`<li><span class="field">access:</span> public</li>`
		626	`</ul>`
		627
		628	`<div class="method-signature">`
		629	`<span class="method-result">array</span>`
		630	`<span class="method-name">`
		631	`calculate`
		632	`</span>`
		633	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		634	`</div>`
		635
		636	`<ul class="parameters">`
		637	`<li>`
		638	`<span class="var-type">Model</span>`
		639	`<span class="var-name">$Model</span> </li>`
		640	`<li>`
		641	`<span class="var-type"></span>`
		642	`<span class="var-name">&$Model</span> </li>`
		643	`</ul>`
		644
		645
		646	`</div>`
		647	`<a name="methodclose" id="close"><!-- --></a>`
		648	`<div class="oddrow">`
		649
		650	`<div class="method-header">`
		651	`<span class="method-title">close</span> (line <span class="line-number">332</span>)`
		652	`</div>`
		653
		654	`<!-- ========== Info from phpDoc block ========= -->`
		655	`<p class="short-description">Close database connection</p>`
		656	`<ul class="tags">`
		657	`<li><span class="field">return:</span> Connected</li>`
		658	`<li><span class="field">access:</span> public</li>`
		659	`</ul>`
		660
		661	`<div class="method-signature">`
		662	`<span class="method-result">boolean</span>`
		663	`<span class="method-name">`
		664	`close`
		665	`</span>`
		666	`()`
		667	`</div>`
		668
		669
		670
		671	`</div>`
		672	`<a name="methodcommit" id="commit"><!-- --></a>`
		673	`<div class="evenrow">`
		674
		675	`<div class="method-header">`
		676	`<span class="method-title">commit</span> (line <span class="line-number">157</span>)`
		677	`</div>`
		678
		679	`<!-- ========== Info from phpDoc block ========= -->`
		680	`<p class="short-description">commit method</p>`
		681	`<p class="description"><p>MongoDB doesn't support transactions</p></p>`
		682	`<ul class="tags">`
		683	`<li><span class="field">access:</span> public</li>`
		684	`</ul>`
		685
		686	`<div class="method-signature">`
		687	`<span class="method-result">void</span>`
		688	`<span class="method-name">`
		689	`commit`
		690	`</span>`
		691	`()`
		692	`</div>`
		693
		694
		695
		696	`</div>`
		697	`<a name="methodconnect" id="connect"><!-- --></a>`
		698	`<div class="oddrow">`
		699
		700	`<div class="method-header">`
		701	`<span class="method-title">connect</span> (line <span class="line-number">172</span>)`
		702	`</div>`
		703
		704	`<!-- ========== Info from phpDoc block ========= -->`
		705	`<p class="short-description">Connect to the database</p>`
		706	`<p class="description"><p>If using 1.0.2 or above use the mongodb:// format to connect The connect syntax changed in version 1.0.2 - so check for that too</p><p>If authentication information in present then authenticate the connection</p></p>`
		707	`<ul class="tags">`
		708	`<li><span class="field">return:</span> Connected</li>`
		709	`<li><span class="field">access:</span> public</li>`
		710	`</ul>`
		711
		712	`<div class="method-signature">`
		713	`<span class="method-result">boolean</span>`
		714	`<span class="method-name">`
		715	`connect`
		716	`</span>`
		717	`()`
		718	`</div>`
		719
		720
		721
		722	`</div>`
		723	`<a name="methodcreate" id="create"><!-- --></a>`
		724	`<div class="evenrow">`
		725
		726	`<div class="method-header">`
		727	`<span class="method-title">create</span> (line <span class="line-number">447</span>)`
		728	`</div>`
		729
		730	`<!-- ========== Info from phpDoc block ========= -->`
		731	`<p class="short-description">Create Data</p>`
		732	`<ul class="tags">`
		733	`<li><span class="field">return:</span> Insert result</li>`
		734	`<li><span class="field">access:</span> public</li>`
		735	`</ul>`
		736
		737	`<div class="method-signature">`
		738	`<span class="method-result">boolean</span>`
		739	`<span class="method-name">`
		740	`create`
		741	`</span>`
		742	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		743	`</div>`
		744
		745	`<ul class="parameters">`
		746	`<li>`
		747	`<span class="var-type">Model</span>`
		748	`<span class="var-name">$Model</span><span class="var-description">: Model Instance</span> </li>`
		749	`<li>`
		750	`<span class="var-type">array</span>`
		751	`<span class="var-name">$fields</span><span class="var-description">: Field data</span> </li>`
		752	`<li>`
		753	`<span class="var-type">array</span>`
		754	`<span class="var-name">$values</span><span class="var-description">: Save data</span> </li>`
		755	`<li>`
		756	`<span class="var-type"></span>`
		757	`<span class="var-name">&$Model</span> </li>`
		758	`</ul>`
		759
		760
		761	`</div>`
		762	`<a name="methodcreateConnectionName" id="createConnectionName"><!-- --></a>`
		763	`<div class="oddrow">`
		764
		765	`<div class="method-header">`
		766	`<span class="method-title">createConnectionName</span> (line <span class="line-number">210</span>)`
		767	`</div>`
		768
		769	`<!-- ========== Info from phpDoc block ========= -->`
		770	`<p class="short-description">create connection name.</p>`
		771	`<ul class="tags">`
		772	`<li><span class="field">access:</span> public</li>`
		773	`</ul>`
		774
		775	`<div class="method-signature">`
		776	`<span class="method-result">void</span>`
		777	`<span class="method-name">`
		778	`createConnectionName`
		779	`</span>`
		780	`(<span class="var-type">array</span> <span class="var-name">$config</span>, <span class="var-type">string</span> <span class="var-name">$version</span>)`
		781	`</div>`
		782
		783	`<ul class="parameters">`
		784	`<li>`
		785	`<span class="var-type">array</span>`
		786	`<span class="var-name">$config</span> </li>`
		787	`<li>`
		788	`<span class="var-type">string</span>`
		789	`<span class="var-name">$version</span><span class="var-description">: version of MongoDriver</span> </li>`
		790	`</ul>`
		791
		792
		793	`</div>`
		794	`<a name="methodcreateSchema" id="createSchema"><!-- --></a>`
		795	`<div class="evenrow">`
		796
		797	`<div class="method-header">`
		798	`<span class="method-title">createSchema</span> (line <span class="line-number">497</span>)`
		799	`</div>`
		800
		801	`<!-- ========== Info from phpDoc block ========= -->`
		802	`<p class="short-description">createSchema method</p>`
		803	`<p class="description"><p>Mongo no care for creating schema. Mongo work with no schema.</p></p>`
		804	`<ul class="tags">`
		805	`<li><span class="field">access:</span> public</li>`
		806	`</ul>`
		807
		808	`<div class="method-signature">`
		809	`<span class="method-result">void</span>`
		810	`<span class="method-name">`
		811	`createSchema`
		812	`</span>`
		813	`(<span class="var-type">mixed</span> <span class="var-name">$schema</span>, [<span class="var-type">mixed</span> <span class="var-name">$tableName</span> = <span class="var-default">null</span>])`
		814	`</div>`
		815
		816	`<ul class="parameters">`
		817	`<li>`
		818	`<span class="var-type">mixed</span>`
		819	`<span class="var-name">$schema</span> </li>`
		820	`<li>`
		821	`<span class="var-type">mixed</span>`
		822	`<span class="var-name">$tableName</span><span class="var-description">: null</span> </li>`
		823	`</ul>`
		824
		825
		826	`</div>`
		827	`<a name="methoddelete" id="delete"><!-- --></a>`
		828	`<div class="oddrow">`
		829
		830	`<div class="method-header">`
		831	`<span class="method-title">delete</span> (line <span class="line-number">851</span>)`
		832	`</div>`
		833
		834	`<!-- ========== Info from phpDoc block ========= -->`
		835	`<p class="short-description">Delete Data</p>`
		836	`<p class="description"><p>For deleteAll(true, false) calls - conditions will arrive here as true - account for that and convert to an empty array For deleteAll(array('some conditions')) calls - conditions will arrive here as: array( Alias._id => array(1, 2, 3, ...) )</p><p>This format won't be understood by mongodb, it'll find 0 rows. convert to:</p><p>array( Alias._id => array('$in' => array(1, 2, 3, ...)) )</p></p>`
		837	`<ul class="tags">`
		838	`<li><span class="field">return:</span> Update result</li>`
		839	`<li><span class="field">TODO:</span> bench remove() v drop. if it's faster to drop - just drop the collection taking into account existing indexes (recreate just the indexes)</li>`
		840	`<li><span class="field">access:</span> public</li>`
		841	`</ul>`
		842
		843	`<div class="method-signature">`
		844	`<span class="method-result">boolean</span>`
		845	`<span class="method-name">`
		846	`delete`
		847	`</span>`
		848	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		849	`</div>`
		850
		851	`<ul class="parameters">`
		852	`<li>`
		853	`<span class="var-type">Model</span>`
		854	`<span class="var-name">$Model</span><span class="var-description">: Model Instance</span> </li>`
		855	`<li>`
		856	`<span class="var-type">array</span>`
		857	`<span class="var-name">$conditions</span> </li>`
		858	`<li>`
		859	`<span class="var-type"></span>`
		860	`<span class="var-name">&$Model</span> </li>`
		861	`</ul>`
		862
		863
		864	`</div>`
		865	`<a name="methodderiveSchemaFromData" id="deriveSchemaFromData"><!-- --></a>`
		866	`<div class="evenrow">`
		867
		868	`<div class="method-header">`
		869	`<span class="method-title">deriveSchemaFromData</span> (line <span class="line-number">804</span>)`
		870	`</div>`
		871
		872	`<!-- ========== Info from phpDoc block ========= -->`
		873	`<p class="short-description">deriveSchemaFromData method</p>`
		874	`<ul class="tags">`
		875	`<li><span class="field">access:</span> public</li>`
		876	`</ul>`
		877
		878	`<div class="method-signature">`
		879	`<span class="method-result">void</span>`
		880	`<span class="method-name">`
		881	`deriveSchemaFromData`
		882	`</span>`
		883	`(<span class="var-type">mixed</span> <span class="var-name">$Model</span>, [<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">array()</span>])`
		884	`</div>`
		885
		886	`<ul class="parameters">`
		887	`<li>`
		888	`<span class="var-type">mixed</span>`
		889	`<span class="var-name">$Model</span> </li>`
		890	`<li>`
		891	`<span class="var-type">array</span>`
		892	`<span class="var-name">$data</span><span class="var-description">: array()</span> </li>`
		893	`</ul>`
		894
		895
		896	`</div>`
		897	`<a name="methoddescribe" id="describe"><!-- --></a>`
		898	`<div class="oddrow">`
		899
		900	`<div class="method-header">`
		901	`<span class="method-title">describe</span> (line <span class="line-number">386</span>)`
		902	`</div>`
		903
		904	`<!-- ========== Info from phpDoc block ========= -->`
		905	`<p class="short-description">Describe</p>`
		906	`<p class="description"><p>Automatically bind the schemaless behavior if there is no explicit mongo schema. When called, if there is model data it will be used to derive a schema. a row is plucked out of the db and the data obtained used to derive the schema.</p></p>`
		907	`<ul class="tags">`
		908	`<li><span class="field">return:</span> if model instance has mongoSchema, return it.</li>`
		909	`<li><span class="field">access:</span> public</li>`
		910	`</ul>`
		911
		912	`<div class="method-signature">`
		913	`<span class="method-result">array</span>`
		914	`<span class="method-name">`
		915	`describe`
		916	`</span>`
		917	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type"></span> <span class="var-name">$field</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		918	`</div>`
		919
		920	`<ul class="parameters">`
		921	`<li>`
		922	`<span class="var-type">Model</span>`
		923	`<span class="var-name">$Model</span> </li>`
		924	`<li>`
		925	`<span class="var-type"></span>`
		926	`<span class="var-name">&$Model</span> </li>`
		927	`<li>`
		928	`<span class="var-type"></span>`
		929	`<span class="var-name">$field</span> </li>`
		930	`</ul>`
		931
		932
		933	`</div>`
		934	`<a name="methoddisconnect" id="disconnect"><!-- --></a>`
		935	`<div class="evenrow">`
		936
		937	`<div class="method-header">`
		938	`<span class="method-title">disconnect</span> (line <span class="line-number">342</span>)`
		939	`</div>`
		940
		941	`<!-- ========== Info from phpDoc block ========= -->`
		942	`<p class="short-description">Disconnect from the database</p>`
		943	`<ul class="tags">`
		944	`<li><span class="field">return:</span> Connected</li>`
		945	`<li><span class="field">access:</span> public</li>`
		946	`</ul>`
		947
		948	`<div class="method-signature">`
		949	`<span class="method-result">boolean</span>`
		950	`<span class="method-name">`
		951	`disconnect`
		952	`</span>`
		953	`()`
		954	`</div>`
		955
		956
		957
		958	`</div>`
		959	`<a name="methoddistinct" id="distinct"><!-- --></a>`
		960	`<div class="oddrow">`
		961
		962	`<div class="method-header">`
		963	`<span class="method-title">distinct</span> (line <span class="line-number">550</span>)`
		964	`</div>`
		965
		966	`<!-- ========== Info from phpDoc block ========= -->`
		967	`<p class="short-description">distinct method</p>`
		968	`<ul class="tags">`
		969	`<li><span class="field">access:</span> public</li>`
		970	`</ul>`
		971
		972	`<div class="method-signature">`
		973	`<span class="method-result">void</span>`
		974	`<span class="method-name">`
		975	`distinct`
		976	`</span>`
		977	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$keys</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		978	`</div>`
		979
		980	`<ul class="parameters">`
		981	`<li>`
		982	`<span class="var-type">mixed</span>`
		983	`<span class="var-name">$Model</span> </li>`
		984	`<li>`
		985	`<span class="var-type">array</span>`
		986	`<span class="var-name">$keys</span><span class="var-description">: array()</span> </li>`
		987	`<li>`
		988	`<span class="var-type">array</span>`
		989	`<span class="var-name">$params</span><span class="var-description">: array()</span> </li>`
		990	`<li>`
		991	`<span class="var-type"></span>`
		992	`<span class="var-name">&$Model</span> </li>`
		993	`</ul>`
		994
		995
		996	`</div>`
		997	`<a name="methoddropSchema" id="dropSchema"><!-- --></a>`
		998	`<div class="evenrow">`
		999
		1000	`<div class="method-header">`
		1001	`<span class="method-title">dropSchema</span> (line <span class="line-number">511</span>)`
		1002	`</div>`
		1003
		1004	`<!-- ========== Info from phpDoc block ========= -->`
		1005	`<p class="short-description">dropSchema method</p>`
		1006	`<p class="description"><p>Return a command to drop each table</p></p>`
		1007	`<ul class="tags">`
		1008	`<li><span class="field">access:</span> public</li>`
		1009	`</ul>`
		1010
		1011	`<div class="method-signature">`
		1012	`<span class="method-result">void</span>`
		1013	`<span class="method-name">`
		1014	`dropSchema`
		1015	`</span>`
		1016	`(<span class="var-type">mixed</span> <span class="var-name">$schema</span>, [<span class="var-type">mixed</span> <span class="var-name">$tableName</span> = <span class="var-default">null</span>])`
		1017	`</div>`
		1018
		1019	`<ul class="parameters">`
		1020	`<li>`
		1021	`<span class="var-type">mixed</span>`
		1022	`<span class="var-name">$schema</span> </li>`
		1023	`<li>`
		1024	`<span class="var-type">mixed</span>`
		1025	`<span class="var-name">$tableName</span><span class="var-description">: null</span> </li>`
		1026	`</ul>`
		1027
		1028
		1029	`</div>`
		1030	`<a name="methodensureIndex" id="ensureIndex"><!-- --></a>`
		1031	`<div class="oddrow">`
		1032
		1033	`<div class="method-header">`
		1034	`<span class="method-title">ensureIndex</span> (line <span class="line-number">635</span>)`
		1035	`</div>`
		1036
		1037	`<!-- ========== Info from phpDoc block ========= -->`
		1038	`<p class="short-description">ensureIndex method</p>`
		1039	`<ul class="tags">`
		1040	`<li><span class="field">access:</span> public</li>`
		1041	`</ul>`
		1042
		1043	`<div class="method-signature">`
		1044	`<span class="method-result">void</span>`
		1045	`<span class="method-name">`
		1046	`ensureIndex`
		1047	`</span>`
		1048	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$keys</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		1049	`</div>`
		1050
		1051	`<ul class="parameters">`
		1052	`<li>`
		1053	`<span class="var-type">mixed</span>`
		1054	`<span class="var-name">$Model</span> </li>`
		1055	`<li>`
		1056	`<span class="var-type">array</span>`
		1057	`<span class="var-name">$keys</span><span class="var-description">: array()</span> </li>`
		1058	`<li>`
		1059	`<span class="var-type">array</span>`
		1060	`<span class="var-name">$params</span><span class="var-description">: array()</span> </li>`
		1061	`<li>`
		1062	`<span class="var-type"></span>`
		1063	`<span class="var-name">&$Model</span> </li>`
		1064	`</ul>`
		1065
		1066
		1067	`</div>`
		1068	`<a name="methodexecute" id="execute"><!-- --></a>`
		1069	`<div class="evenrow">`
		1070
		1071	`<div class="method-header">`
		1072	`<span class="method-title">execute</span> (line <span class="line-number">1142</span>)`
		1073	`</div>`
		1074
		1075	`<!-- ========== Info from phpDoc block ========= -->`
		1076	`<p class="short-description">execute method</p>`
		1077	`<p class="description"><p>If there is no query or the query is true, execute has probably been called as part of a db-agnostic process which does not have a mongo equivalent, don't do anything.</p></p>`
		1078	`<ul class="tags">`
		1079	`<li><span class="field">access:</span> public</li>`
		1080	`</ul>`
		1081
		1082	`<div class="method-signature">`
		1083	`<span class="method-result">void</span>`
		1084	`<span class="method-name">`
		1085	`execute`
		1086	`</span>`
		1087	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])`
		1088	`</div>`
		1089
		1090	`<ul class="parameters">`
		1091	`<li>`
		1092	`<span class="var-type">mixed</span>`
		1093	`<span class="var-name">$query</span> </li>`
		1094	`<li>`
		1095	`<span class="var-type">array</span>`
		1096	`<span class="var-name">$params</span><span class="var-description">: array()</span> </li>`
		1097	`</ul>`
		1098
		1099
		1100	`</div>`
		1101	`<a name="methodgetMongoCollection" id="getMongoCollection"><!-- --></a>`
		1102	`<div class="oddrow">`
		1103
		1104	`<div class="method-header">`
		1105	`<span class="method-title">getMongoCollection</span> (line <span class="line-number">297</span>)`
		1106	`</div>`
		1107
		1108	`<!-- ========== Info from phpDoc block ========= -->`
		1109	`<p class="short-description">get MongoDB Collection Object</p>`
		1110	`<ul class="tags">`
		1111	`<li><span class="field">return:</span> MongoDB Collection Object</li>`
		1112	`<li><span class="field">access:</span> public</li>`
		1113	`</ul>`
		1114
		1115	`<div class="method-signature">`
		1116	`<span class="method-result">mixed</span>`
		1117	`<span class="method-name">`
		1118	`getMongoCollection`
		1119	`</span>`
		1120	`(<span class="var-type"></span> <span class="var-name">&$Model</span>)`
		1121	`</div>`
		1122
		1123	`<ul class="parameters">`
		1124	`<li>`
		1125	`<span class="var-type"></span>`
		1126	`<span class="var-name">&$Model</span> </li>`
		1127	`</ul>`
		1128
		1129
		1130	`</div>`
		1131	`<a name="methodgetMongoDb" id="getMongoDb"><!-- --></a>`
		1132	`<div class="evenrow">`
		1133
		1134	`<div class="method-header">`
		1135	`<span class="method-title">getMongoDb</span> (line <span class="line-number">284</span>)`
		1136	`</div>`
		1137
		1138	`<!-- ========== Info from phpDoc block ========= -->`
		1139	`<p class="short-description">get MongoDB Object</p>`
		1140	`<ul class="tags">`
		1141	`<li><span class="field">return:</span> MongoDB Object</li>`
		1142	`<li><span class="field">access:</span> public</li>`
		1143	`</ul>`
		1144
		1145	`<div class="method-signature">`
		1146	`<span class="method-result">mixed</span>`
		1147	`<span class="method-name">`
		1148	`getMongoDb`
		1149	`</span>`
		1150	`()`
		1151	`</div>`
		1152
		1153
		1154
		1155	`</div>`
		1156	`<a name="methodgroup" id="group"><!-- --></a>`
		1157	`<div class="oddrow">`
		1158
		1159	`<div class="method-header">`
		1160	`<span class="method-title">group</span> (line <span class="line-number">596</span>)`
		1161	`</div>`
		1162
		1163	`<!-- ========== Info from phpDoc block ========= -->`
		1164	`<p class="short-description">group method</p>`
		1165	`<ul class="tags">`
		1166	`<li><span class="field">access:</span> public</li>`
		1167	`</ul>`
		1168
		1169	`<div class="method-signature">`
		1170	`<span class="method-result">void</span>`
		1171	`<span class="method-name">`
		1172	`group`
		1173	`</span>`
		1174	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>], <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		1175	`</div>`
		1176
		1177	`<ul class="parameters">`
		1178	`<li>`
		1179	`<span class="var-type">mixed</span>`
		1180	`<span class="var-name">$Model</span> </li>`
		1181	`<li>`
		1182	`<span class="var-type">array</span>`
		1183	<span class="var-name">$params</span><span class="var-description">: <p>array() Set params same as MongoCollection::group() key,initial, reduce, options(conditions, finalize)</p><p>Ex. $params = array( 'key' => array('field' => true), 'initial' => array('csum' => 0), 'reduce' => 'function(obj, prev){prev.csum += 1;}', 'options' => array( 'condition' => array('age' => array('$gt' => 20)), 'finalize' => array(), ), );</p></span> </li>
		1184	`<li>`
		1185	`<span class="var-type"></span>`
		1186	`<span class="var-name">&$Model</span> </li>`
		1187	`</ul>`
		1188
		1189
		1190	`</div>`
		1191	`<a name="methodinsertMulti" id="insertMulti"><!-- --></a>`
		1192	`<div class="evenrow">`
		1193
		1194	`<div class="method-header">`
		1195	`<span class="method-title">insertMulti</span> (line <span class="line-number">238</span>)`
		1196	`</div>`
		1197
		1198	`<!-- ========== Info from phpDoc block ========= -->`
		1199	`<p class="short-description">Inserts multiple values into a table</p>`
		1200	`<ul class="tags">`
		1201	`<li><span class="field">access:</span> public</li>`
		1202	`</ul>`
		1203
		1204	`<div class="method-signature">`
		1205	`<span class="method-result">void</span>`
		1206	`<span class="method-name">`
		1207	`insertMulti`
		1208	`</span>`
		1209	`(<span class="var-type">string</span> <span class="var-name">$table</span>, <span class="var-type">string</span> <span class="var-name">$fields</span>, <span class="var-type">array</span> <span class="var-name">$values</span>)`
		1210	`</div>`
		1211
		1212	`<ul class="parameters">`
		1213	`<li>`
		1214	`<span class="var-type">string</span>`
		1215	`<span class="var-name">$table</span> </li>`
		1216	`<li>`
		1217	`<span class="var-type">string</span>`
		1218	`<span class="var-name">$fields</span> </li>`
		1219	`<li>`
		1220	`<span class="var-type">array</span>`
		1221	`<span class="var-name">$values</span> </li>`
		1222	`</ul>`
		1223
		1224
		1225	`</div>`
		1226	`<a name="methodisConnected" id="isConnected"><!-- --></a>`
		1227	`<div class="oddrow">`
		1228
		1229	`<div class="method-header">`
		1230	`<span class="method-title">isConnected</span> (line <span class="line-number">271</span>)`
		1231	`</div>`
		1232
		1233	`<!-- ========== Info from phpDoc block ========= -->`
		1234	`<p class="short-description">check connection to the database</p>`
		1235	`<ul class="tags">`
		1236	`<li><span class="field">return:</span> Connected</li>`
		1237	`<li><span class="field">access:</span> public</li>`
		1238	`</ul>`
		1239
		1240	`<div class="method-signature">`
		1241	`<span class="method-result">boolean</span>`
		1242	`<span class="method-name">`
		1243	`isConnected`
		1244	`</span>`
		1245	`()`
		1246	`</div>`
		1247
		1248
		1249
		1250	`</div>`
		1251	`<a name="methodisInterfaceSupported" id="isInterfaceSupported"><!-- --></a>`
		1252	`<div class="evenrow">`
		1253
		1254	`<div class="method-header">`
		1255	`<span class="method-title">isInterfaceSupported</span> (line <span class="line-number">319</span>)`
		1256	`</div>`
		1257
		1258	`<!-- ========== Info from phpDoc block ========= -->`
		1259	`<p class="short-description">isInterfaceSupported method</p>`
		1260	`<p class="description"><p>listSources is infact supported, however: cake expects it to return a complete list of all possible sources in the selected db - the possible list of collections is infinte, so it's faster and simpler to tell cake that the interface is /not/ supported so it assumes that <insert name of your table here> exist</p></p>`
		1261	`<ul class="tags">`
		1262	`<li><span class="field">access:</span> public</li>`
		1263	`</ul>`
		1264
		1265	`<div class="method-signature">`
		1266	`<span class="method-result">void</span>`
		1267	`<span class="method-name">`
		1268	`isInterfaceSupported`
		1269	`</span>`
		1270	`(<span class="var-type">mixed</span> <span class="var-name">$interface</span>)`
		1271	`</div>`
		1272
		1273	`<ul class="parameters">`
		1274	`<li>`
		1275	`<span class="var-type">mixed</span>`
		1276	`<span class="var-name">$interface</span> </li>`
		1277	`</ul>`
		1278
		1279
		1280	`</div>`
		1281	`<a name="methodlistSources" id="listSources"><!-- --></a>`
		1282	`<div class="oddrow">`
		1283
		1284	`<div class="method-header">`
		1285	`<span class="method-title">listSources</span> (line <span class="line-number">358</span>)`
		1286	`</div>`
		1287
		1288	`<!-- ========== Info from phpDoc block ========= -->`
		1289	`<p class="short-description">Get list of available Collections</p>`
		1290	`<ul class="tags">`
		1291	`<li><span class="field">return:</span> Collections</li>`
		1292	`<li><span class="field">access:</span> public</li>`
		1293	`</ul>`
		1294
		1295	`<div class="method-signature">`
		1296	`<span class="method-result">array</span>`
		1297	`<span class="method-name">`
		1298	`listSources`
		1299	`</span>`
		1300	`([<span class="var-type">array</span> <span class="var-name">$data</span> = <span class="var-default">null</span>])`
		1301	`</div>`
		1302
		1303	`<ul class="parameters">`
		1304	`<li>`
		1305	`<span class="var-type">array</span>`
		1306	`<span class="var-name">$data</span> </li>`
		1307	`</ul>`
		1308
		1309
		1310	`</div>`
		1311	`<a name="methodlogQuery" id="logQuery"><!-- --></a>`
		1312	`<div class="evenrow">`
		1313
		1314	`<div class="method-header">`
		1315	`<span class="method-title">logQuery</span> (line <span class="line-number">1241</span>)`
		1316	`</div>`
		1317
		1318	`<!-- ========== Info from phpDoc block ========= -->`
		1319	`<p class="short-description">logQuery method</p>`
		1320	`<p class="description"><p>Set timers, errors and refer to the parent If there are arguments passed - inject them into the query Show MongoIds in a copy-and-paste-into-mongo format</p></p>`
		1321	`<ul class="tags">`
		1322	`<li><span class="field">access:</span> public</li>`
		1323	`</ul>`
		1324
		1325	`<div class="method-signature">`
		1326	`<span class="method-result">void</span>`
		1327	`<span class="method-name">`
		1328	`logQuery`
		1329	`</span>`
		1330	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$args</span> = <span class="var-default">array()</span>])`
		1331	`</div>`
		1332
		1333	`<ul class="parameters">`
		1334	`<li>`
		1335	`<span class="var-type">mixed</span>`
		1336	`<span class="var-name">$query</span> </li>`
		1337	`<li>`
		1338	`<span class="var-type">array</span>`
		1339	`<span class="var-name">$args</span><span class="var-description">: array()</span> </li>`
		1340	`</ul>`
		1341
		1342
		1343	`</div>`
		1344	`<a name="methodmapReduce" id="mapReduce"><!-- --></a>`
		1345	`<div class="oddrow">`
		1346
		1347	`<div class="method-header">`
		1348	`<span class="method-title">mapReduce</span> (line <span class="line-number">1094</span>)`
		1349	`</div>`
		1350
		1351	`<!-- ========== Info from phpDoc block ========= -->`
		1352	`<p class="short-description">mapReduce</p>`
		1353	`<ul class="tags">`
		1354	`<li><span class="field">return:</span> false or array</li>`
		1355	`<li><span class="field">access:</span> public</li>`
		1356	`</ul>`
		1357
		1358	`<div class="method-signature">`
		1359	`<span class="method-result">mixed</span>`
		1360	`<span class="method-name">`
		1361	`mapReduce`
		1362	`</span>`
		1363	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">integer</span> <span class="var-name">$timeout</span> = <span class="var-default">null</span>])`
		1364	`</div>`
		1365
		1366	`<ul class="parameters">`
		1367	`<li>`
		1368	`<span class="var-type">mixed</span>`
		1369	`<span class="var-name">$query</span> </li>`
		1370	`<li>`
		1371	`<span class="var-type">integer</span>`
		1372	`<span class="var-name">$timeout</span><span class="var-description">: (milli second)</span> </li>`
		1373	`</ul>`
		1374
		1375
		1376	`</div>`
		1377	`<a name="methodname" id="name"><!-- --></a>`
		1378	`<div class="evenrow">`
		1379
		1380	`<div class="method-header">`
		1381	`<span class="method-title">name</span> (line <span class="line-number">434</span>)`
		1382	`</div>`
		1383
		1384	`<!-- ========== Info from phpDoc block ========= -->`
		1385	`<p class="short-description">Quotes identifiers.</p>`
		1386	`<p class="description"><p>MongoDb does not need identifiers quoted, so this method simply returns the identifier.</p></p>`
		1387	`<ul class="tags">`
		1388	`<li><span class="field">return:</span> The quoted identifier.</li>`
		1389	`<li><span class="field">access:</span> public</li>`
		1390	`</ul>`
		1391
		1392	`<div class="method-signature">`
		1393	`<span class="method-result">string</span>`
		1394	`<span class="method-name">`
		1395	`name`
		1396	`</span>`
		1397	`(<span class="var-type">string</span> <span class="var-name">$name</span>)`
		1398	`</div>`
		1399
		1400	`<ul class="parameters">`
		1401	`<li>`
		1402	`<span class="var-type">string</span>`
		1403	`<span class="var-name">$name</span><span class="var-description">: The identifier to quote.</span> </li>`
		1404	`</ul>`
		1405
		1406
		1407	`</div>`
		1408	`<a name="methodquery" id="query"><!-- --></a>`
		1409	`<div class="oddrow">`
		1410
		1411	`<div class="method-header">`
		1412	`<span class="method-title">query</span> (line <span class="line-number">1067</span>)`
		1413	`</div>`
		1414
		1415	`<!-- ========== Info from phpDoc block ========= -->`
		1416	`<p class="short-description">query method If call getMongoDb() from model, this method call getMongoDb().</p>`
		1417	`<ul class="tags">`
		1418	`<li><span class="field">access:</span> public</li>`
		1419	`</ul>`
		1420
		1421	`<div class="method-signature">`
		1422	`<span class="method-result">void</span>`
		1423	`<span class="method-name">`
		1424	`query`
		1425	`</span>`
		1426	`(<span class="var-type">mixed</span> <span class="var-name">$query</span>, [<span class="var-type">array</span> <span class="var-name">$params</span> = <span class="var-default">array()</span>])`
		1427	`</div>`
		1428
		1429	`<ul class="parameters">`
		1430	`<li>`
		1431	`<span class="var-type">mixed</span>`
		1432	`<span class="var-name">$query</span> </li>`
		1433	`<li>`
		1434	`<span class="var-type">array</span>`
		1435	`<span class="var-name">$params</span><span class="var-description">: array()</span> </li>`
		1436	`</ul>`
		1437
		1438
		1439	`</div>`
		1440	`<a name="methodread" id="read"><!-- --></a>`
		1441	`<div class="evenrow">`
		1442
		1443	`<div class="method-header">`
		1444	`<span class="method-title">read</span> (line <span class="line-number">908</span>)`
		1445	`</div>`
		1446
		1447	`<!-- ========== Info from phpDoc block ========= -->`
		1448	`<p class="short-description">Read Data</p>`
		1449	`<p class="description"><p>For deleteAll(true) calls - the conditions will arrive here as true - account for that and switch to an empty array</p></p>`
		1450	`<ul class="tags">`
		1451	`<li><span class="field">return:</span> Results</li>`
		1452	`<li><span class="field">access:</span> public</li>`
		1453	`</ul>`
		1454
		1455	`<div class="method-signature">`
		1456	`<span class="method-result">array</span>`
		1457	`<span class="method-name">`
		1458	`read`
		1459	`</span>`
		1460	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$query</span> = <span class="var-default">array()</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		1461	`</div>`
		1462
		1463	`<ul class="parameters">`
		1464	`<li>`
		1465	`<span class="var-type">Model</span>`
		1466	`<span class="var-name">$Model</span><span class="var-description">: Model Instance</span> </li>`
		1467	`<li>`
		1468	`<span class="var-type">array</span>`
		1469	`<span class="var-name">$query</span><span class="var-description">: Query data</span> </li>`
		1470	`<li>`
		1471	`<span class="var-type"></span>`
		1472	`<span class="var-name">&$Model</span> </li>`
		1473	`</ul>`
		1474
		1475
		1476	`</div>`
		1477	`<a name="methodrollback" id="rollback"><!-- --></a>`
		1478	`<div class="oddrow">`
		1479
		1480	`<div class="method-header">`
		1481	`<span class="method-title">rollback</span> (line <span class="line-number">1039</span>)`
		1482	`</div>`
		1483
		1484	`<!-- ========== Info from phpDoc block ========= -->`
		1485	`<p class="short-description">rollback method</p>`
		1486	`<p class="description"><p>MongoDB doesn't support transactions</p></p>`
		1487	`<ul class="tags">`
		1488	`<li><span class="field">access:</span> public</li>`
		1489	`</ul>`
		1490
		1491	`<div class="method-signature">`
		1492	`<span class="method-result">void</span>`
		1493	`<span class="method-name">`
		1494	`rollback`
		1495	`</span>`
		1496	`()`
		1497	`</div>`
		1498
		1499
		1500
		1501	`</div>`
		1502	`<a name="methodsetTimeout" id="setTimeout"><!-- --></a>`
		1503	`<div class="evenrow">`
		1504
		1505	`<div class="method-header">`
		1506	`<span class="method-title">setTimeout</span> (line <span class="line-number">1222</span>)`
		1507	`</div>`
		1508
		1509	`<!-- ========== Info from phpDoc block ========= -->`
		1510	`<p class="short-description">setTimeout Method</p>`
		1511	`<p class="description"><p>Sets the MongoCursor timeout so long queries (like map / reduce) can run at will. Expressed in milliseconds, for an infinite timeout, set to -1</p></p>`
		1512	`<ul class="tags">`
		1513	`<li><span class="field">access:</span> public</li>`
		1514	`</ul>`
		1515
		1516	`<div class="method-signature">`
		1517	`<span class="method-result">boolean</span>`
		1518	`<span class="method-name">`
		1519	`setTimeout`
		1520	`</span>`
		1521	`(<span class="var-type">int</span> <span class="var-name">$ms</span>)`
		1522	`</div>`
		1523
		1524	`<ul class="parameters">`
		1525	`<li>`
		1526	`<span class="var-type">int</span>`
		1527	`<span class="var-name">$ms</span> </li>`
		1528	`</ul>`
		1529
		1530
		1531	`</div>`
		1532	`<a name="methodtruncate" id="truncate"><!-- --></a>`
		1533	`<div class="oddrow">`
		1534
		1535	`<div class="method-header">`
		1536	`<span class="method-title">truncate</span> (line <span class="line-number">1050</span>)`
		1537	`</div>`
		1538
		1539	`<!-- ========== Info from phpDoc block ========= -->`
		1540	`<p class="short-description">Deletes all the records in a table</p>`
		1541	`<ul class="tags">`
		1542	`<li><span class="field">access:</span> public</li>`
		1543	`</ul>`
		1544
		1545	`<div class="method-signature">`
		1546	`<span class="method-result">boolean</span>`
		1547	`<span class="method-name">`
		1548	`truncate`
		1549	`</span>`
		1550	`(<span class="var-type">mixed</span> <span class="var-name">$table</span>)`
		1551	`</div>`
		1552
		1553	`<ul class="parameters">`
		1554	`<li>`
		1555	`<span class="var-type">mixed</span>`
		1556	`<span class="var-name">$table</span><span class="var-description">: A string or model class representing the table to be truncated</span> </li>`
		1557	`</ul>`
		1558
		1559
		1560	`</div>`
		1561	`<a name="methodupdate" id="update"><!-- --></a>`
		1562	`<div class="evenrow">`
		1563
		1564	`<div class="method-header">`
		1565	`<span class="method-title">update</span> (line <span class="line-number">677</span>)`
		1566	`</div>`
		1567
		1568	`<!-- ========== Info from phpDoc block ========= -->`
		1569	`<p class="short-description">Update Data</p>`
		1570	`<p class="description"><p>This method uses $set operator automatically with MongoCollection::update(). If you don't want to use $set operator, you can chose any one as follw. <ol><li>Set TRUE in Model::mongoNoSetOperator property.</li><li>Set a mongodb operator in a key of save data as follow.`
		1571	`Model->save(array('_id' => $id, '$inc' => array('count' => 1)));`
		1572	`Don't use Model::mongoSchema property,`
		1573	`CakePHP delete '$inc' data in Model::Save().</li><li>Set a Mongo operator in Model::mongoNoSetOperator property.`
		1574	`Model->mongoNoSetOperator = '$inc';`
		1575	`Model->save(array('_id' => $id, array('count' => 1)));</li></ol></p></p>`
		1576	`<ul class="tags">`
		1577	`<li><span class="field">return:</span> Update result</li>`
		1578	`<li><span class="field">access:</span> public</li>`
		1579	`</ul>`
		1580
		1581	`<div class="method-signature">`
		1582	`<span class="method-result">boolean</span>`
		1583	`<span class="method-name">`
		1584	`update`
		1585	`</span>`
		1586	(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$values</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)
		1587	`</div>`
		1588
		1589	`<ul class="parameters">`
		1590	`<li>`
		1591	`<span class="var-type">Model</span>`
		1592	`<span class="var-name">$Model</span><span class="var-description">: Model Instance</span> </li>`
		1593	`<li>`
		1594	`<span class="var-type">array</span>`
		1595	`<span class="var-name">$fields</span><span class="var-description">: Field data</span> </li>`
		1596	`<li>`
		1597	`<span class="var-type">array</span>`
		1598	`<span class="var-name">$values</span><span class="var-description">: Save data</span> </li>`
		1599	`<li>`
		1600	`<span class="var-type"></span>`
		1601	`<span class="var-name">&$Model</span> </li>`
		1602	`<li>`
		1603	`<span class="var-type"></span>`
		1604	`<span class="var-name">$conditions</span> </li>`
		1605	`</ul>`
		1606
		1607
		1608	`</div>`
		1609	`<a name="methodupdateAll" id="updateAll"><!-- --></a>`
		1610	`<div class="oddrow">`
		1611
		1612	`<div class="method-header">`
		1613	`<span class="method-title">updateAll</span> (line <span class="line-number">768</span>)`
		1614	`</div>`
		1615
		1616	`<!-- ========== Info from phpDoc block ========= -->`
		1617	`<p class="short-description">Update multiple Record</p>`
		1618	`<ul class="tags">`
		1619	`<li><span class="field">return:</span> Update result</li>`
		1620	`<li><span class="field">access:</span> public</li>`
		1621	`</ul>`
		1622
		1623	`<div class="method-signature">`
		1624	`<span class="method-result">boolean</span>`
		1625	`<span class="method-name">`
		1626	`updateAll`
		1627	`</span>`
		1628	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, [<span class="var-type">array</span> <span class="var-name">$fields</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$conditions</span> = <span class="var-default">null</span>], <span class="var-type">Model</span> <span class="var-name">$Model</span>)`
		1629	`</div>`
		1630
		1631	`<ul class="parameters">`
		1632	`<li>`
		1633	`<span class="var-type">Model</span>`
		1634	`<span class="var-name">$Model</span><span class="var-description">: Model Instance</span> </li>`
		1635	`<li>`
		1636	`<span class="var-type">array</span>`
		1637	`<span class="var-name">$fields</span><span class="var-description">: Field data</span> </li>`
		1638	`<li>`
		1639	`<span class="var-type">array</span>`
		1640	`<span class="var-name">$conditions</span> </li>`
		1641	`<li>`
		1642	`<span class="var-type"></span>`
		1643	`<span class="var-name">&$Model</span> </li>`
		1644	`</ul>`
		1645
		1646
		1647	`</div>`
		1648	`<a name="methodvalue" id="value"><!-- --></a>`
		1649	`<div class="evenrow">`
		1650
		1651	`<div class="method-header">`
		1652	`<span class="method-title">value</span> (line <span class="line-number">1123</span>)`
		1653	`</div>`
		1654
		1655	`<!-- ========== Info from phpDoc block ========= -->`
		1656	`<p class="short-description">Prepares a value, or an array of values for database queries by quoting and escaping them.</p>`
		1657	`<ul class="tags">`
		1658	`<li><span class="field">return:</span> Prepared value or array of values.</li>`
		1659	`<li><span class="field">access:</span> public</li>`
		1660	`</ul>`
		1661
		1662	`<div class="method-signature">`
		1663	`<span class="method-result">mixed</span>`
		1664	`<span class="method-name">`
		1665	`value`
		1666	`</span>`
		1667	`(<span class="var-type">mixed</span> <span class="var-name">$data</span>, [<span class="var-type">string</span> <span class="var-name">$column</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$read</span> = <span class="var-default">true</span>])`
		1668	`</div>`
		1669
		1670	`<ul class="parameters">`
		1671	`<li>`
		1672	`<span class="var-type">mixed</span>`
		1673	`<span class="var-name">$data</span><span class="var-description">: A value or an array of values to prepare.</span> </li>`
		1674	`<li>`
		1675	`<span class="var-type">string</span>`
		1676	`<span class="var-name">$column</span><span class="var-description">: The column into which this data will be inserted</span> </li>`
		1677	`<li>`
		1678	`<span class="var-type">boolean</span>`
		1679	`<span class="var-name">$read</span><span class="var-description">: Value to be used in READ or WRITE context</span> </li>`
		1680	`</ul>`
		1681
		1682
		1683	`</div>`
		1684	`<a name="method_convertId" id="_convertId"><!-- --></a>`
		1685	`<div class="oddrow">`
		1686
		1687	`<div class="method-header">`
		1688	`<span class="method-title">_convertId</span> (line <span class="line-number">1271</span>)`
		1689	`</div>`
		1690
		1691	`<!-- ========== Info from phpDoc block ========= -->`
		1692	`<p class="short-description">convertId method</p>`
		1693	`<p class="description"><p>$conditions is used to determine if it should try to auto correct _id => array() queries it only appies to conditions, hence the param name</p></p>`
		1694	`<ul class="tags">`
		1695	`<li><span class="field">access:</span> protected</li>`
		1696	`</ul>`
		1697
		1698	`<div class="method-signature">`
		1699	`<span class="method-result">void</span>`
		1700	`<span class="method-name">`
		1701	`_convertId`
		1702	`</span>`
		1703	`(<span class="var-type"></span> <span class="var-name">&$mixed</span>, [<span class="var-type">bool</span> <span class="var-name">$conditions</span> = <span class="var-default">false</span>], <span class="var-type">mixed</span> <span class="var-name">$mixed</span>)`
		1704	`</div>`
		1705
		1706	`<ul class="parameters">`
		1707	`<li>`
		1708	`<span class="var-type">mixed</span>`
		1709	`<span class="var-name">$mixed</span> </li>`
		1710	`<li>`
		1711	`<span class="var-type">bool</span>`
		1712	`<span class="var-name">$conditions</span><span class="var-description">: false</span> </li>`
		1713	`<li>`
		1714	`<span class="var-type"></span>`
		1715	`<span class="var-name">&$mixed</span> </li>`
		1716	`</ul>`
		1717
		1718
		1719	`</div>`
		1720	`<a name="method_prepareLogQuery" id="_prepareLogQuery"><!-- --></a>`
		1721	`<div class="evenrow">`
		1722
		1723	`<div class="method-header">`
		1724	`<span class="method-title">_prepareLogQuery</span> (line <span class="line-number">1200</span>)`
		1725	`</div>`
		1726
		1727	`<!-- ========== Info from phpDoc block ========= -->`
		1728	`<p class="short-description">prepareLogQuery method</p>`
		1729	`<p class="description"><p>Any prep work to log a query</p></p>`
		1730	`<ul class="tags">`
		1731	`<li><span class="field">access:</span> protected</li>`
		1732	`</ul>`
		1733
		1734	`<div class="method-signature">`
		1735	`<span class="method-result">void</span>`
		1736	`<span class="method-name">`
		1737	`_prepareLogQuery`
		1738	`</span>`
		1739	`(<span class="var-type"></span> <span class="var-name">&$Model</span>, <span class="var-type">mixed</span> <span class="var-name">$Model</span>)`
		1740	`</div>`
		1741
		1742	`<ul class="parameters">`
		1743	`<li>`
		1744	`<span class="var-type">mixed</span>`
		1745	`<span class="var-name">$Model</span> </li>`
		1746	`<li>`
		1747	`<span class="var-type"></span>`
		1748	`<span class="var-name">&$Model</span> </li>`
		1749	`</ul>`
		1750
		1751
		1752	`</div>`
		1753	`<a name="method_setEmptyValues" id="_setEmptyValues"><!-- --></a>`
		1754	`<div class="oddrow">`
		1755
		1756	`<div class="method-header">`
		1757	`<span class="method-title">_setEmptyValues</span> (line <span class="line-number">1176</span>)`
		1758	`</div>`
		1759
		1760	`<!-- ========== Info from phpDoc block ========= -->`
		1761	`<p class="short-description">Set empty values, arrays or integers, for the variables Mongo uses</p>`
		1762	`<ul class="tags">`
		1763	`<li><span class="field">access:</span> protected</li>`
		1764	`</ul>`
		1765
		1766	`<div class="method-signature">`
		1767	`<span class="method-result">void</span>`
		1768	`<span class="method-name">`
		1769	`_setEmptyValues`
		1770	`</span>`
		1771	`(<span class="var-type"></span> <span class="var-name">&$data</span>, [<span class="var-type">array</span> <span class="var-name">$integers</span> = <span class="var-default">array('limit', 'offset')</span>], <span class="var-type">mixed</span> <span class="var-name">$data</span>)`
		1772	`</div>`
		1773
		1774	`<ul class="parameters">`
		1775	`<li>`
		1776	`<span class="var-type">mixed</span>`
		1777	`<span class="var-name">$data</span> </li>`
		1778	`<li>`
		1779	`<span class="var-type">array</span>`
		1780	`<span class="var-name">$integers</span><span class="var-description">: array('limit', 'offset')</span> </li>`
		1781	`<li>`
		1782	`<span class="var-type"></span>`
		1783	`<span class="var-name">&$data</span> </li>`
		1784	`</ul>`
		1785
		1786
		1787	`</div>`
		1788	`<a name="method_stringify" id="_stringify"><!-- --></a>`
		1789	`<div class="evenrow">`
		1790
		1791	`<div class="method-header">`
		1792	`<span class="method-title">_stringify</span> (line <span class="line-number">1299</span>)`
		1793	`</div>`
		1794
		1795	`<!-- ========== Info from phpDoc block ========= -->`
		1796	`<p class="short-description">stringify method</p>`
		1797	`<p class="description"><p>Takes an array of args as an input and returns an array of json-encoded strings. Takes care of any objects the arrays might be holding (MongoID);</p></p>`
		1798	`<ul class="tags">`
		1799	`<li><span class="field">access:</span> protected</li>`
		1800	`</ul>`
		1801
		1802	`<div class="method-signature">`
		1803	`<span class="method-result">array</span>`
		1804	`<span class="method-name">`
		1805	`_stringify`
		1806	`</span>`
		1807	`([<span class="var-type"></span> <span class="var-name">&$args</span> = <span class="var-default">array()</span>], [<span class="var-type">int</span> <span class="var-name">$level</span> = <span class="var-default">0</span>], <span class="var-type">array</span> <span class="var-name">$args</span>)`
		1808	`</div>`
		1809
		1810	`<ul class="parameters">`
		1811	`<li>`
		1812	`<span class="var-type">array</span>`
		1813	`<span class="var-name">$args</span><span class="var-description">: array()</span> </li>`
		1814	`<li>`
		1815	`<span class="var-type">int</span>`
		1816	`<span class="var-name">$level</span><span class="var-description">: 0 internal recursion counter</span> </li>`
		1817	`<li>`
		1818	`<span class="var-type"></span>`
		1819	`<span class="var-name">&$args</span> </li>`
		1820	`</ul>`
		1821
		1822
		1823	`</div>`
		1824	`<a name="method_stripAlias" id="_stripAlias"><!-- --></a>`
		1825	`<div class="oddrow">`
		1826
		1827	`<div class="method-header">`
		1828	`<span class="method-title">_stripAlias</span> (line <span class="line-number">1339</span>)`
		1829	`</div>`
		1830
		1831	`<!-- ========== Info from phpDoc block ========= -->`
		1832	`<p class="short-description">Convert automatically array('Model.field' => 'foo') to array('field' => 'foo')</p>`
		1833	`<p class="description"><p>This introduces the limitation that you can't have a (nested) field with the same name as the model But it's a small price to pay to be able to use other behaviors/functionality with mongoDB</p></p>`
		1834	`<ul class="tags">`
		1835	`<li><span class="field">access:</span> protected</li>`
		1836	`</ul>`
		1837
		1838	`<div class="method-signature">`
		1839	`<span class="method-result">void</span>`
		1840	`<span class="method-name">`
		1841	`_stripAlias`
		1842	`</span>`
		1843	([<span class="var-type"></span> <span class="var-name">&$args</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span> <span class="var-name">$alias</span> = <span class="var-default">'Model'</span>], [<span class="var-type">bool</span> <span class="var-name">$recurse</span> = <span class="var-default">true</span>], [<span class="var-type">string</span> <span class="var-name">$check</span> = <span class="var-default">'key'</span>], <span class="var-type">array</span> <span class="var-name">$args</span>)
		1844	`</div>`
		1845
		1846	`<ul class="parameters">`
		1847	`<li>`
		1848	`<span class="var-type">array</span>`
		1849	`<span class="var-name">$args</span><span class="var-description">: array()</span> </li>`
		1850	`<li>`
		1851	`<span class="var-type">string</span>`
		1852	`<span class="var-name">$alias</span><span class="var-description">: 'Model'</span> </li>`
		1853	`<li>`
		1854	`<span class="var-type">bool</span>`
		1855	`<span class="var-name">$recurse</span><span class="var-description">: true</span> </li>`
		1856	`<li>`
		1857	`<span class="var-type">string</span>`
		1858	`<span class="var-name">$check</span><span class="var-description">: 'key', 'value' or 'both'</span> </li>`
		1859	`<li>`
		1860	`<span class="var-type"></span>`
		1861	`<span class="var-name">&$args</span> </li>`
		1862	`</ul>`
		1863
		1864
		1865	`</div>`
		1866
		1867	`</div>`
		1868	`</div>`
		1869
		1870
		1871	`<p class="notes" id="credit">`
		1872	`Documentation generated on Tue, 26 Jul 2011 01:09:01 +0900 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>`
		1873	`</p>`
		1874	`</div></body>`
		1875	`</html>`

Subversion Repositories SmartDukaan

(root)/trunk/MobileHotIndia/app/Plugin/Mongodb/docs/mongodb/mongodb-models-datasources/MongodbSource.html – Rev 15403