1181 lines
No EOL
35 KiB
HTML
1181 lines
No EOL
35 KiB
HTML
<?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>Object
|
|
|
|
|
--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">object</span>
|
|
<a href="#$cache" title="details" class="var-name">$cache</a>
|
|
</div>
|
|
<div class="var-title">
|
|
<span class="var-type">array</span>
|
|
<a href="#$columns" title="details" class="var-name">$columns</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">object</span>
|
|
<a href="#$db" title="details" class="var-name">$db</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">boolean</span>
|
|
<a href="#$ignore" title="details" class="var-name">$ignore</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">string</span>
|
|
<a href="#$priority" title="details" class="var-name">$priority</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">boolean</span>
|
|
<a href="#$replace" title="details" class="var-name">$replace</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 class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<a href="#$use_cache" title="details" class="var-name">$use_cache</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> <span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <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">void</span>
|
|
<a href="#execute" title="details" class="method-name">execute</a>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <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="#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">boolean</span>
|
|
<a href="#shuffle" title="details" class="method-name">shuffle</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">boolean</span>
|
|
<a href="#sort" title="details" class="method-name">sort</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$index</span>, [<span class="var-type">string</span> <span class="var-name">$order</span> = <span class="var-default">'ASC'</span>])
|
|
</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> <span class="var-name">$value</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">mixed</span>
|
|
<a href="#walk" title="details" class="method-name">walk</a>
|
|
()
|
|
</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$cache" id="$cache"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$cache</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">62</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Cache Object</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$columns" id="$columns"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">array</span>
|
|
<span class="var-name">$columns</span>
|
|
= <span class="var-default">array(<br /> 'id' => 'id',<br /> 'created_at' => 'created_at',<br /> 'created_id' => 'created_id',<br /> 'updated_at' => 'updated_at',<br /> 'updated_id' => 'updated_id',<br /> 'deleted_at' => 'deleted_at',<br /> 'deleted_id' => 'deleted_id',<br /> 'is_deleted' => 'is_deleted',<br /> )</span> (line <span class="line-number">45</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Columns</p>
|
|
<p class="description"><p>Mapping of key columns for the table</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$conditions" id="$conditions"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<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">168</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="evenrow">
|
|
|
|
<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">94</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$db" id="$db"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">object</span>
|
|
<span class="var-name">$db</span>
|
|
= <span class="var-default"> null</span> (line <span class="line-number">35</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Database Object</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">112</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">136</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">176</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">184</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">160</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$ignore" id="$ignore"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$ignore</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">120</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Ignore Unique Index</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">152</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">200</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">208</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">192</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$priority" id="$priority"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$priority</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">104</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Insert Priority</p>
|
|
<p class="description"><p>Defaults to false (normal priority) but can be set to "low" or "high"</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<a name="var$record" id="$record"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<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">231</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="evenrow">
|
|
|
|
<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">238</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$replace" id="$replace"><!-- --></A>
|
|
<div class="oddrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$replace</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">128</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Replace instead of Insert/Update?</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</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">216</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">144</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>
|
|
<a name="var$use_cache" id="$use_cache"><!-- --></A>
|
|
<div class="evenrow">
|
|
|
|
<div class="var-header">
|
|
<span class="var-title">
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$use_cache</span>
|
|
= <span class="var-default"> false</span> (line <span class="line-number">70</span>)
|
|
</span>
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Whether or not to use cache</p>
|
|
<ul class="tags">
|
|
<li><span class="field">access:</span> protected</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor __construct</span> (line <span class="line-number">299</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Constructor</p>
|
|
<p class="description"><p>Creates a new (empty) object or populates the record set.</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> <span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <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>
|
|
|
|
|
|
</div>
|
|
<a name="methodcommit" id="commit"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">commit</span> (line <span class="line-number">1009</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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">count</span> (line <span class="line-number">837</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="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">delete</span> (line <span class="line-number">1182</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="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">end</span> (line <span class="line-number">947</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="methodexecute" id="execute"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">execute</span> (line <span class="line-number">345</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Execute</p>
|
|
<p class="description"><p>Potentially populates the record set from the passed arguments.</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">
|
|
execute
|
|
</span>
|
|
([<span class="var-type">mixed</span> <span class="var-name">$type_or_parameters</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <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>
|
|
|
|
|
|
</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">935</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">First Record</p>
|
|
<p class="description"><p>Alias of reset(). "first" 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">967</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Last Record</p>
|
|
<p class="description"><p>Alias of end(). "last" 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">877</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">896</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">915</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="methodshuffle" id="shuffle"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">shuffle</span> (line <span class="line-number">865</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Shuffle Records</p>
|
|
<p class="description"><p>Sorts the records in a pseudo-random order.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> true</li>
|
|
<li><span class="field">todo:</span> Implement this method</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
shuffle
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodsort" id="sort"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">sort</span> (line <span class="line-number">852</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Sort Records</p>
|
|
<p class="description"><p>Sorts the records by the specified index in the specified order.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> true</li>
|
|
<li><span class="field">todo:</span> Implement this method</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">boolean</span>
|
|
<span class="method-name">
|
|
sort
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$index</span>, [<span class="var-type">string</span> <span class="var-name">$order</span> = <span class="var-default">'ASC'</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$index</span><span class="var-description">: the index to be sorted on</span> </li>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$order</span><span class="var-description">: the direction to order</span> </li>
|
|
</ul>
|
|
|
|
|
|
</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">1275</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> <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>
|
|
<a name="methodwalk" id="walk"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">walk</span> (line <span class="line-number">981</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Walk Records</p>
|
|
<p class="description"><p>Returns the current record and advances to the next. Built to allow for simplified code when looping through a record set.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> either an array of the current record or false</li>
|
|
<li><span class="field">todo:</span> Does not currently support "indexed" or "list" return types</li>
|
|
<li><span class="field">access:</span> public</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">mixed</span>
|
|
<span class="method-name">
|
|
walk
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Sun, 14 Oct 2012 14:02:18 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |