Permalink
Browse files

Changes in docblocks

  • Loading branch information...
1 parent 198b283 commit 3fc53befa11dd1dccfe303722751fafd58f0012e @jasny committed Jan 1, 2013
Showing with 383 additions and 362 deletions.
  1. +33 −26 docs/class-Jasny.MySQL.DB.html
  2. +332 −325 docs/source-class-Jasny.MySQL.DB.html
  3. +18 −11 src/Jasny/MySQL/DB.php
@@ -129,15 +129,18 @@
<b>Namespace:</b> <a href="namespace-Jasny.html">Jasny</a>\<a href="namespace-Jasny.MySQL.html">MySQL</a><br />
- <b>Package:</b> DB<br />
+ <b>Package:</b> DB-MySQL<br />
+ <b>License:</b>
+ <a href="https://raw.github.com/jasny/DB-MySQL/master/LICENSE">MIT</a><br />
<b>Author:</b>
- Arnold Daniels<br />
+ Arnold Daniels &lt;<a
+href="mailto:arnold&#64;jasny.net">arnold&#64;<!---->jasny.net</a>&gt;<br />
<b>Example:</b>
<br />
new DB($host, $user, $pwd, $dbname);<br />
$result = DB::conn()-&gt;query("SELECT * FROM foo WHERE id = ?", $id);<br />
- <b>Located at</b> <a href="source-class-Jasny.MySQL.DB.html#12-334" title="Go to source code">Jasny/MySQL/DB.php</a><br />
+ <b>Located at</b> <a href="source-class-Jasny.MySQL.DB.html#17-341" title="Go to source code">Jasny/MySQL/DB.php</a><br />
</div>
@@ -155,7 +158,7 @@
<td class="name"><div>
<a class="anchor" href="#_conn">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#39-55" title="Go to source code">conn</a>( )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#44-60" title="Go to source code">conn</a>( )</code>
<div class="description short">
@@ -192,7 +195,7 @@
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#57-72" title="Go to source code">__construct</a>( <span>string <var>$host</var></span>, <span>string <var>$username</var></span>, <span>string <var>$passwd</var></span>, <span>string <var>$dbname</var></span>, <span>integer <var>$port</var> = <span class="php-keyword1">null</span></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#62-77" title="Go to source code">__construct</a>( <span>string <var>$host</var></span>, <span>string <var>$username</var></span>, <span>string <var>$passwd</var></span>, <span>string <var>$dbname</var></span>, <span>integer <var>$port</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
@@ -209,15 +212,15 @@
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$host</var></dt>
- <dd><code>string</code><br>$host</dd>
+ <dd><code>string</code><br>$host MySQL hostname</dd>
<dt><var>$username</var></dt>
- <dd><code>string</code><br>$username</dd>
+ <dd><code>string</code><br>$username MySQL username</dd>
<dt><var>$passwd</var></dt>
- <dd><code>string</code><br>$passwd</dd>
+ <dd><code>string</code><br>$passwd User's password</dd>
<dt><var>$dbname</var></dt>
- <dd><code>string</code><br>$dbname</dd>
+ <dd><code>string</code><br>$dbname Database name</dd>
<dt><var>$port</var></dt>
- <dd><code>integer</code><br>$port</dd>
+ <dd><code>integer</code><br>$port MySQL port</dd>
</dl></div>
@@ -231,28 +234,32 @@
<td class="attributes"><code>
public
-
+ boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_close">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#74-81" title="Go to source code">close</a>( )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#79-88" title="Go to source code">close</a>( )</code>
<div class="description short">
-<p>Closes a previously opened database connection</p>
+<p>Closes a previously opened database connection.</p>
</div>
<div class="description detailed hidden">
-<p>Closes a previously opened database connection</p>
+<p>Closes a previously opened database connection.</p>
+ <h4>Returns</h4>
+ <div class="list">
+ <code>boolean</code><br />
+ </div>
@@ -273,7 +280,7 @@
<td class="name"><div>
<a class="anchor" href="#_query">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#83-101" title="Go to source code">query</a>( <span>string <var>$query</var></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#90-108" title="Go to source code">query</a>( <span>string <var>$query</var></span> )</code>
<div class="description short">
@@ -292,7 +299,7 @@
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$query</var></dt>
- <dd><code>string</code><br>$query</dd>
+ <dd><code>string</code><br>$query SQL Query</dd>
</dl></div>
<h4>Returns</h4>
@@ -325,7 +332,7 @@
<td class="name"><div>
<a class="anchor" href="#_fetchAll">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#104-140" title="Go to source code">fetchAll</a>( <span>string|mysqli_result <var>$query</var></span>, <span>integer|string <var>$resulttype</var> = MYSQLI_ASSOC</span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#111-147" title="Go to source code">fetchAll</a>( <span>string|mysqli_result <var>$query</var></span>, <span>integer|string <var>$resulttype</var> = MYSQLI_ASSOC</span> )</code>
<div class="description short">
@@ -379,7 +386,7 @@
<td class="name"><div>
<a class="anchor" href="#_fetchOne">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#142-165" title="Go to source code">fetchOne</a>( <span>string|mysqli_result <var>$query</var></span>, <span>integer|string <var>$resulttype</var> = MYSQLI_ASSOC</span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#149-172" title="Go to source code">fetchOne</a>( <span>string|mysqli_result <var>$query</var></span>, <span>integer|string <var>$resulttype</var> = MYSQLI_ASSOC</span> )</code>
<div class="description short">
@@ -432,7 +439,7 @@
<td class="name"><div>
<a class="anchor" href="#_fetchColumn">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#167-189" title="Go to source code">fetchColumn</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#174-196" title="Go to source code">fetchColumn</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
<div class="description short">
@@ -479,7 +486,7 @@
<td class="name"><div>
<a class="anchor" href="#_fetchPairs">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#191-212" title="Go to source code">fetchPairs</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#198-219" title="Go to source code">fetchPairs</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
<div class="description short">
@@ -528,7 +535,7 @@
<td class="name"><div>
<a class="anchor" href="#_fetchValue">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#214-232" title="Go to source code">fetchValue</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#221-239" title="Go to source code">fetchValue</a>( <span>string|mysqli_result <var>$query</var></span> )</code>
<div class="description short">
@@ -575,7 +582,7 @@
<td class="name"><div>
<a class="anchor" href="#_save">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#235-275" title="Go to source code">save</a>( <span>string <var>$table</var></span>, <span>array <var>$values</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$update</var> = <span class="php-keyword1">true</span></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#242-282" title="Go to source code">save</a>( <span>string <var>$table</var></span>, <span>array <var>$values</var> = <span class="php-keyword1">array</span>()</span>, <span>boolean <var>$update</var> = <span class="php-keyword1">true</span></span> )</code>
<div class="description short">
@@ -629,7 +636,7 @@
<td class="name"><div>
<a class="anchor" href="#_quote">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#278-293" title="Go to source code">quote</a>( <span>mixed <var>$value</var></span>, <span>string <var>$empty</var> = <span class="php-quote">'NULL'</span></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#285-300" title="Go to source code">quote</a>( <span>mixed <var>$value</var></span>, <span>string <var>$empty</var> = <span class="php-quote">'NULL'</span></span> )</code>
<div class="description short">
@@ -673,7 +680,7 @@
<td class="name"><div>
<a class="anchor" href="#_backquote">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#295-304" title="Go to source code">backquote</a>( <span>string <var>$field</var></span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#302-311" title="Go to source code">backquote</a>( <span>string <var>$field</var></span> )</code>
<div class="description short">
@@ -715,7 +722,7 @@
<td class="name"><div>
<a class="anchor" href="#_bind">#</a>
- <code><a href="source-class-Jasny.MySQL.DB.html#306-333" title="Go to source code">bind</a>( <span>string <var>$query</var></span>, <span>mixed <var>$params</var> = <span class="php-keyword1">array</span>()</span> )</code>
+ <code><a href="source-class-Jasny.MySQL.DB.html#313-340" title="Go to source code">bind</a>( <span>string <var>$query</var></span>, <span>mixed <var>$params</var> = <span class="php-keyword1">array</span>()</span> )</code>
<div class="description short">
@@ -816,7 +823,7 @@
<td class="attributes"><code>boolean</code></td>
<td class="name"><code>
- <a href="source-class-Jasny.MySQL.DB.html#25-30" title="Go to source code"><b>SKIP_EXISTING</b></a>
+ <a href="source-class-Jasny.MySQL.DB.html#30-35" title="Go to source code"><b>SKIP_EXISTING</b></a>
</code></td>
<td class="value"><code><span class="php-keyword1">false</span></code></td>
<td class="description"><div>
Oops, something went wrong.

0 comments on commit 3fc53be

Please sign in to comment.