joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions
pickles/docs/PICKLES/Model.html
Josh Sherman 5f78540770 Updated internal documentation.
2010-11-27 21:43:43 -05:00

934 lines
No EOL
28 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Model</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Model</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Model Class</p>
<p class="description"><p>This is a parent class that all PICKLES data models should be extending. When using the class as designed, objects will function as active record pattern objects.</p></p>
<p class="notes">
Located in <a class="field" href="_classes---Model.php.html">/classes/Model.php</a> (line <span class="field">25</span>)
</p>
<pre><a href="../PICKLES/Object.html">Object</a>
|
--Model</pre>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$collection" title="details" class="var-name">$collection</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$conditions" title="details" class="var-name">$conditions</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$datasource" title="details" class="var-name">$datasource</a>
</div>
<div class="var-title">
<span class="var-type">boolean</span>
<a href="#$delayed" title="details" class="var-name">$delayed</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$fields" title="details" class="var-name">$fields</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$group" title="details" class="var-name">$group</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$having" title="details" class="var-name">$having</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$hints" title="details" class="var-name">$hints</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$id" title="details" class="var-name">$id</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$joins" title="details" class="var-name">$joins</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$limit" title="details" class="var-name">$limit</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$offset" title="details" class="var-name">$offset</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$order" title="details" class="var-name">$order</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$record" title="details" class="var-name">$record</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$records" title="details" class="var-name">$records</a>
</div>
<div class="var-title">
<span class="var-type">array</span>
<a href="#$results" title="details" class="var-name">$results</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$table" title="details" class="var-name">$table</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Model</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#commit" title="details" class="method-name">commit</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#count" title="details" class="method-name">count</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#delete" title="details" class="method-name">delete</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#end" title="details" class="method-name">end</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#first" title="details" class="method-name">first</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#last" title="details" class="method-name">last</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#next" title="details" class="method-name">next</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#prev" title="details" class="method-name">prev</a>
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#reset" title="details" class="method-name">reset</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#unescape" title="details" class="method-name">unescape</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$collection" id="$collection"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$collection</span>
= <span class="var-default"> false</span> (line <span class="line-number">103</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Collection Name</p>
<p class="description"><p>For compatibility with the naming conventions used by MongoDB, the collection name can be specified. If the collection name is set, it will set the table name value to it and proceed as normal.</p></p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$conditions" id="$conditions"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$conditions</span>
= <span class="var-default"> false</span> (line <span class="line-number">127</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Conditions</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$datasource" id="$datasource"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$datasource</span>
(line <span class="line-number">59</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Datasource</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$delayed" id="$delayed"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$delayed</span>
= <span class="var-default"> false</span> (line <span class="line-number">67</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delayed Insert</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$fields" id="$fields"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$fields</span>
= <span class="var-default"> '*'</span> (line <span class="line-number">75</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Field List</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$group" id="$group"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$group</span>
= <span class="var-default"> false</span> (line <span class="line-number">135</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Group</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$having" id="$having"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$having</span>
= <span class="var-default"> false</span> (line <span class="line-number">143</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Having</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$hints" id="$hints"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$hints</span>
= <span class="var-default"> false</span> (line <span class="line-number">119</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">[Index] Hints</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$id" id="$id"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$id</span>
= <span class="var-default"> 'id'</span> (line <span class="line-number">91</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID Column</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$joins" id="$joins"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$joins</span>
= <span class="var-default"> false</span> (line <span class="line-number">111</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Joins</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$limit" id="$limit"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$limit</span>
= <span class="var-default"> false</span> (line <span class="line-number">159</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Limit</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$offset" id="$offset"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$offset</span>
= <span class="var-default"> false</span> (line <span class="line-number">167</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Offset</p>
<ul class="tags">
<li><span class="field">var:</span> (string or array)</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$order" id="$order"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$order</span>
= <span class="var-default"> false</span> (line <span class="line-number">151</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Order</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$record" id="$record"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$record</span>
= <span class="var-default"> null</span> (line <span class="line-number">190</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Record</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$records" id="$records"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$records</span>
= <span class="var-default"> null</span> (line <span class="line-number">197</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Records</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$results" id="$results"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>
<span class="var-name">$results</span>
= <span class="var-default"> null</span> (line <span class="line-number">175</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Query Results</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$table</span>
= <span class="var-default"> false</span> (line <span class="line-number">83</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Table Name</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$config">Object::$config</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PICKLES/Object.html#var$instances">Object::$instances</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">221</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<p class="description"><p>Creates a new (empty) object or creates the record set from the passed arguments. The record and records arrays are populated as well as the count variable.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Model</span>
<span class="method-name">
__construct
</span>
([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$type_or_parameters</span><span class="var-description">: optional type of query or parameters</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$parameters</span><span class="var-description">: optional data to create a query from</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodcommit" id="commit"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">commit</span> (line <span class="line-number">776</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Commit</p>
<p class="description"><p>Inserts or updates a record in the database.</p></p>
<ul class="tags">
<li><span class="field">return:</span> results of the query</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
commit
</span>
()
</div>
</div>
<a name="methodcount" id="count"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">count</span> (line <span class="line-number">658</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Count Records</p>
<p class="description"><p>Counts the records</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
count
</span>
()
</div>
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">delete</span> (line <span class="line-number">827</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete Record</p>
<p class="description"><p>Deletes the current record from the database</p></p>
<ul class="tags">
<li><span class="field">return:</span> status of the query</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
delete
</span>
()
</div>
</div>
<a name="methodend" id="end"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">end</span> (line <span class="line-number">740</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">End Record</p>
<p class="description"><p>Set the pointer to the last element of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and end() worked)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
end
</span>
()
</div>
</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">first</span> (line <span class="line-number">728</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">First Record</p>
<p class="description"><p>Alias of reset(). &quot;first&quot; is more intuitive to me, but reset stays in line with the built in PHP functions.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and could be reset)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
first
</span>
()
</div>
</div>
<a name="methodlast" id="last"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">last</span> (line <span class="line-number">760</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Last Record</p>
<p class="description"><p>Alias of end(). &quot;last&quot; is more intuitive to me, but end stays in line with the built in PHP functions.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and end() worked)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
last
</span>
()
</div>
</div>
<a name="methodnext" id="next"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">next</span> (line <span class="line-number">670</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Next Record</p>
<p class="description"><p>Increment the record array to the next member of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not there was next element</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
next
</span>
()
</div>
</div>
<a name="methodprev" id="prev"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">prev</span> (line <span class="line-number">689</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Previous Record</p>
<p class="description"><p>Decrement the record array to the next member of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not there was previous element</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
prev
</span>
()
</div>
</div>
<a name="methodreset" id="reset"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">reset</span> (line <span class="line-number">708</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reset Record</p>
<p class="description"><p>Set the pointer to the first element of the record set.</p></p>
<ul class="tags">
<li><span class="field">return:</span> whether or not records is an array (and could be reset)</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
reset
</span>
()
</div>
</div>
<a name="methodunescape" id="unescape"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">unescape</span> (line <span class="line-number">875</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Unescape String</p>
<p class="description"><p>Assuming magic quotes is turned on, strips slashes from the string</p></p>
<ul class="tags">
<li><span class="field">return:</span> unescaped string</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
unescape
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: string to be unescaped</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PICKLES/Object.html">Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../PICKLES/Object.html#method__construct">Object::__construct()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#methodgetInstance">Object::getInstance()</a></span><br>
<span class="method-name"><a href="../PICKLES/Object.html#method__destruct">Object::__destruct()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 27 Nov 2010 21:43:42 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in a new issue View git blame Copy permalink