Skip to content

Commit d18ebca

Browse files
frankmayerfrankmayer
committed
- Extended the delete() test a bit to be more accurate.
- Fixed some typos - Made overall documentation easier to read Signed-off-by: Frank Mayer <frank@frankmayer.net>
1 parent 65a0b0e commit d18ebca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1406
-1433
lines changed

‎docs/classes/triagens.ArangoDb.Autoloader.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,9 @@ <h2>Handle loading of an unknown class</h2>
121121
<pre>load(string $className) : void</pre>
122122
<div class="labels"><span class="label">Static</span></div>
123123
<div class="row collapse"><div class="detail-description">
124-
<div class="long_description"><p>This will only handle class from its own namespace and ignore all others.
125-
This allows multiple autoloaders to be used in a nested fashion.</p></div>
124+
<div class="long_description"><p>This will only handle class from its own namespace and ignore all others.</p>
125+
126+
<p>This allows multiple autoloaders to be used in a nested fashion.</p></div>
126127
<h3>Parameters</h3>
127128
<div class="subelement argument">
128129
<h4>$className</h4>
@@ -169,7 +170,7 @@ <h2>Class file extension</h2>
169170
<div class="row"><footer class="span12">
170171
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
171172
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
172-
generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
173+
generated on 2012-10-29T15:55:44+02:00.<br></footer></div>
173174
</div>
174175
</body>
175176
</html>

‎docs/classes/triagens.ArangoDb.BindVars.html

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@
6161
<li class="method public "><a href="#method_get" title="get :: Get the value of a bind variable with a specific name"><span class="description">Get the value of a bind variable with a specific name</span><pre>get()</pre></a></li>
6262
<li class="method public "><a href="#method_getAll" title="getAll :: Get all registered bind variables"><span class="description">Get all registered bind variables</span><pre>getAll()</pre></a></li>
6363
<li class="method public "><a href="#method_getCount" title="getCount :: Get the number of bind variables registered"><span class="description">Get the number of bind variables registered</span><pre>getCount()</pre></a></li>
64-
<li class="method public "><a href="#method_set" title="set :: Set the value of a single bind variable or set all bind variables at once
65-
This will also validate the bind values."><span class="description">Set the value of a single bind variable or set all bind variables at once
66-
This will also validate the bind values.</span><pre>set()</pre></a></li>
64+
<li class="method public "><a href="#method_set" title="set :: Set the value of a single bind variable or set all bind variables at once"><span class="description">Set the value of a single bind variable or set all bind variables at once</span><pre>set()</pre></a></li>
6765
</ul>
6866
</li>
6967
<li class="nav-header">
@@ -138,12 +136,13 @@ <h3>Returns</h3>
138136
</div></div>
139137
</div>
140138
<a id="method_set"></a><div class="element clickable method public method_set" data-toggle="collapse" data-target=".method_set .collapse">
141-
<h2>Set the value of a single bind variable or set all bind variables at once
142-
This will also validate the bind values.</h2>
139+
<h2>Set the value of a single bind variable or set all bind variables at once</h2>
143140
<pre>set(mixed $name, string $value) : void</pre>
144141
<div class="labels"></div>
145142
<div class="row collapse"><div class="detail-description">
146-
<div class="long_description"><p>Allowed value types for bind parameters are string, int,
143+
<div class="long_description"><p>This will also validate the bind values.</p>
144+
145+
<p>Allowed value types for bind parameters are string, int,
147146
double, bool and array. Arrays must not contain any other
148147
than these types.</p></div>
149148
<h3>Parameters</h3>
@@ -177,7 +176,7 @@ <h2>Current bind values</h2>
177176
<div class="row"><footer class="span12">
178177
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
179178
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
180-
generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
179+
generated on 2012-10-29T15:55:44+02:00.<br></footer></div>
181180
</div>
182181
</body>
183182
</html>

‎docs/classes/triagens.ArangoDb.ClientException.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
271271
<div class="row"><footer class="span12">
272272
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
273273
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
274-
generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
274+
generated on 2012-10-29T15:55:44+02:00.<br></footer></div>
275275
</div>
276276
</body>
277277
</html>

‎docs/classes/triagens.ArangoDb.Collection.html

Lines changed: 45 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -58,25 +58,18 @@
5858
<li class="nav-header">
5959
<i class="icon-custom icon-method"></i> Methods
6060
<ul>
61-
<li class="method public "><a href="#method___clone" title="__clone :: Clone a collection
62-
Returns the clone"><span class="description">Clone a collection
63-
Returns the clone</span><pre>__clone()</pre></a></li>
61+
<li class="method public "><a href="#method___clone" title="__clone :: Clone a collection"><span class="description">Clone a collection</span><pre>__clone()</pre></a></li>
6462
<li class="method public "><a href="#method___construct" title="__construct :: Constructs an empty collection"><span class="description">Constructs an empty collection</span><pre>__construct()</pre></a></li>
65-
<li class="method public "><a href="#method___toString" title="__toString :: Get a string representation of the collection
66-
Returns the collection as JSON-encoded string"><span class="description">Get a string representation of the collection
67-
Returns the collection as JSON-encoded string</span><pre>__toString()</pre></a></li>
63+
<li class="method public "><a href="#method___toString" title="__toString :: Get a string representation of the collection"><span class="description">Get a string representation of the collection</span><pre>__toString()</pre></a></li>
6864
<li class="method public "><a href="#method_createFromArray" title="createFromArray :: Factory method to construct a new collection"><span class="description">Factory method to construct a new collection</span><pre>createFromArray()</pre></a></li>
6965
<li class="method public "><a href="#method_getAll" title="getAll :: Get all collection attributes"><span class="description">Get all collection attributes</span><pre>getAll()</pre></a></li>
70-
<li class="method public "><a href="#method_getId" title="getId :: Get the collection id (if already known)
71-
Collection ids are generated on the server only."><span class="description">Get the collection id (if already known)
72-
Collection ids are generated on the server only.</span><pre>getId()</pre></a></li>
66+
<li class="method public "><a href="#method_getDefaultType" title="getDefaultType :: Get the default collection type"><span class="description">Get the default collection type</span><pre>getDefaultType()</pre></a></li>
67+
<li class="method public "><a href="#method_getId" title="getId :: Get the collection id (if already known)"><span class="description">Get the collection id (if already known)</span><pre>getId()</pre></a></li>
7368
<li class="method public "><a href="#method_getName" title="getName :: Get the collection name (if already known)"><span class="description">Get the collection name (if already known)</span><pre>getName()</pre></a></li>
7469
<li class="method public "><a href="#method_getType" title="getType :: Get the collection type (if already known)"><span class="description">Get the collection type (if already known)</span><pre>getType()</pre></a></li>
7570
<li class="method public "><a href="#method_getWaitForSync" title="getWaitForSync :: Get the waitForSync value (if already known)"><span class="description">Get the waitForSync value (if already known)</span><pre>getWaitForSync()</pre></a></li>
7671
<li class="method public "><a href="#method_set" title="set :: Set a collection attribute"><span class="description">Set a collection attribute</span><pre>set()</pre></a></li>
77-
<li class="method public "><a href="#method_setId" title="setId :: Set the collection id
78-
This will throw if the id of an existing collection gets updated to some other id"><span class="description">Set the collection id
79-
This will throw if the id of an existing collection gets updated to some other id</span><pre>setId()</pre></a></li>
72+
<li class="method public "><a href="#method_setId" title="setId :: Set the collection id"><span class="description">Set the collection id</span><pre>setId()</pre></a></li>
8073
<li class="method public "><a href="#method_setName" title="setName :: Set the collection name"><span class="description">Set the collection name</span><pre>setName()</pre></a></li>
8174
<li class="method public "><a href="#method_setType" title="setType :: Set the collection type."><span class="description">Set the collection type.</span><pre>setType()</pre></a></li>
8275
<li class="method public "><a href="#method_setWaitForSync" title="setWaitForSync :: Set the waitForSync value"><span class="description">Set the waitForSync value</span><pre>setWaitForSync()</pre></a></li>
@@ -104,6 +97,8 @@
10497
<li class="constant "><a href="#constant_ENTRY_TYPE" title="ENTRY_TYPE :: Collection type index"><span class="description">Collection type index</span><pre>ENTRY_TYPE</pre></a></li>
10598
<li class="constant "><a href="#constant_ENTRY_WAIT_SYNC" title="ENTRY_WAIT_SYNC :: Collection 'waitForSync' index"><span class="description">Collection 'waitForSync' index</span><pre>ENTRY_WAIT_SYNC</pre></a></li>
10699
<li class="constant "><a href="#constant_OPTION_PROPERTIES" title="OPTION_PROPERTIES :: properties option"><span class="description">properties option</span><pre>OPTION_PROPERTIES</pre></a></li>
100+
<li class="constant "><a href="#constant_TYPE_DOCUMENT" title="TYPE_DOCUMENT :: document collection type"><span class="description">document collection type</span><pre>TYPE_DOCUMENT</pre></a></li>
101+
<li class="constant "><a href="#constant_TYPE_EDGE" title="TYPE_EDGE :: edge collection type"><span class="description">edge collection type</span><pre>TYPE_EDGE</pre></a></li>
107102
</ul>
108103
</li>
109104
</ul>
@@ -132,11 +127,10 @@
132127
<h3>
133128
<i class="icon-custom icon-method"></i> Methods</h3>
134129
<a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
135-
<h2>Clone a collection
136-
Returns the clone</h2>
130+
<h2>Clone a collection</h2>
137131
<pre>__clone() : void</pre>
138132
<div class="labels"></div>
139-
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
133+
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>Returns the clone</p></div></div></div>
140134
</div>
141135
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
142136
<h2>Constructs an empty collection</h2>
@@ -145,12 +139,11 @@ <h2>Constructs an empty collection</h2>
145139
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
146140
</div>
147141
<a id="method___toString"></a><div class="element clickable method public method___toString" data-toggle="collapse" data-target=".method___toString .collapse">
148-
<h2>Get a string representation of the collection
149-
Returns the collection as JSON-encoded string</h2>
142+
<h2>Get a string representation of the collection</h2>
150143
<pre>__toString() : string</pre>
151144
<div class="labels"></div>
152145
<div class="row collapse"><div class="detail-description">
153-
<div class="long_description"></div>
146+
<div class="long_description"><p>Returns the collection as JSON-encoded string</p></div>
154147
<h3>Returns</h3>
155148
<div class="subelement response">
156149
<code>string</code>- JSON-encoded collection</div>
@@ -189,14 +182,26 @@ <h3>Returns</h3>
189182
<code>array</code>- array of all collection attributes</div>
190183
</div></div>
191184
</div>
185+
<a id="method_getDefaultType"></a><div class="element clickable method public method_getDefaultType" data-toggle="collapse" data-target=".method_getDefaultType .collapse">
186+
<h2>Get the default collection type</h2>
187+
<pre>getDefaultType() : string</pre>
188+
<div class="labels"><span class="label">Static</span></div>
189+
<div class="row collapse"><div class="detail-description">
190+
<div class="long_description"></div>
191+
<h3>Returns</h3>
192+
<div class="subelement response">
193+
<code>string</code>- name</div>
194+
</div></div>
195+
</div>
192196
<a id="method_getId"></a><div class="element clickable method public method_getId" data-toggle="collapse" data-target=".method_getId .collapse">
193-
<h2>Get the collection id (if already known)
194-
Collection ids are generated on the server only.</h2>
197+
<h2>Get the collection id (if already known)</h2>
195198
<pre>getId() : mixed</pre>
196199
<div class="labels"></div>
197200
<div class="row collapse"><div class="detail-description">
198-
<div class="long_description"><p>Collection ids are numeric but might be
199-
bigger than PHP_INT_MAX. To reliably store a collection id elsewhere, a PHP string should be used</p></div>
201+
<div class="long_description"><p>Collection ids are generated on the server only.</p>
202+
203+
<p>Collection ids are numeric but might be bigger than PHP_INT_MAX.
204+
To reliably store a collection id elsewhere, a PHP string should be used</p></div>
200205
<h3>Returns</h3>
201206
<div class="subelement response">
202207
<code>mixed</code>- collection id, might be NULL if collection does not yet have an id</div>
@@ -240,8 +245,9 @@ <h2>Set a collection attribute</h2>
240245
<pre>set(string $key, mixed $value) : void</pre>
241246
<div class="labels"></div>
242247
<div class="row collapse"><div class="detail-description">
243-
<div class="long_description"><p>The key (attribute name) must be a string.
244-
This will validate the value of the attribute and might throw an
248+
<div class="long_description"><p>The key (attribute name) must be a string.</p>
249+
250+
<p>This will validate the value of the attribute and might throw an
245251
exception if the value is invalid.</p></div>
246252
<h3>Parameters</h3>
247253
<div class="subelement argument">
@@ -264,12 +270,11 @@ <h3>Exceptions</h3>
264270
</div></div>
265271
</div>
266272
<a id="method_setId"></a><div class="element clickable method public method_setId" data-toggle="collapse" data-target=".method_setId .collapse">
267-
<h2>Set the collection id
268-
This will throw if the id of an existing collection gets updated to some other id</h2>
273+
<h2>Set the collection id</h2>
269274
<pre>setId(mixed $id) : void</pre>
270275
<div class="labels"></div>
271276
<div class="row collapse"><div class="detail-description">
272-
<div class="long_description"></div>
277+
<div class="long_description"><p>This will throw if the id of an existing collection gets updated to some other id</p></div>
273278
<h3>Parameters</h3>
274279
<div class="subelement argument">
275280
<h4>$id</h4>
@@ -420,14 +425,26 @@ <h2>properties option</h2>
420425
<div class="labels"></div>
421426
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
422427
</div>
428+
<a id="constant_TYPE_DOCUMENT"> </a><div class="element clickable constant constant_TYPE_DOCUMENT" data-toggle="collapse" data-target=".constant_TYPE_DOCUMENT .collapse">
429+
<h2>document collection type</h2>
430+
<pre>TYPE_DOCUMENT </pre>
431+
<div class="labels"></div>
432+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
433+
</div>
434+
<a id="constant_TYPE_EDGE"> </a><div class="element clickable constant constant_TYPE_EDGE" data-toggle="collapse" data-target=".constant_TYPE_EDGE .collapse">
435+
<h2>edge collection type</h2>
436+
<pre>TYPE_EDGE </pre>
437+
<div class="labels"></div>
438+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
439+
</div>
423440
</div>
424441
</div>
425442
</div>
426443
</div>
427444
<div class="row"><footer class="span12">
428445
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
429446
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
430-
generated on 2012-10-28T21:56:52+02:00.<br></footer></div>
447+
generated on 2012-10-29T15:55:44+02:00.<br></footer></div>
431448
</div>
432449
</body>
433450
</html>

0 commit comments

Comments
 (0)