CacheRecordList.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 CacheRecordList</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 CacheRecordList</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">
<p class="implements">
Implements interfaces:
<ul>
<li><a href="../BizSystem/iSessionObject.html">iSessionObject</a></li> </ul>
</p>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList implements the cache for BizDataObj</p>
<p class="notes">
Located in <a class="field" href="_BizDataObj_php.html">/BizDataObj.php</a> (line <span class="field">1502</span>)
</p>
<pre></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="#$EOF" title="details" class="var-name">$EOF</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_BizObjName" title="details" class="var-name">$m_BizObjName</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_Cursor" title="details" class="var-name">$m_Cursor</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_RowCount" title="details" class="var-name">$m_RowCount</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_RowIDMap" title="details" class="var-name">$m_RowIDMap</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$m_SqlRecordList" title="details" class="var-name">$m_SqlRecordList</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">CacheRecordList</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">mixed</span> <span class="var-name">$bizObjName</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#AppendRecord" title="details" class="method-name">AppendRecord</a>
(<span class="var-type">array</span> <span class="var-name">&$record</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#DeleteRecord" title="details" class="method-name">DeleteRecord</a>
(<span class="var-type">mixed</span> <span class="var-name">$id</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#GetRecord" title="details" class="method-name">GetRecord</a>
()
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#GetRowCount" title="details" class="method-name">GetRowCount</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#GetSessionVars" title="details" class="method-name">GetSessionVars</a>
(<span class="var-type">mixed</span> <span class="var-name">$sessCtxt</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#HasRecord" title="details" class="method-name">HasRecord</a>
(<span class="var-type">mixed</span> <span class="var-name">&$record</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#InsertRecord" title="details" class="method-name">InsertRecord</a>
(<span class="var-type">array</span> <span class="var-name">&$record</span>, [<span class="var-type">boolean</span> <span class="var-name">$before</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#MoveCursor" title="details" class="method-name">MoveCursor</a>
(<span class="var-type">integer</span> <span class="var-name">$i</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetCursor" title="details" class="method-name">SetCursor</a>
(<span class="var-type">integer</span> <span class="var-name">$pos</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetSessionVars" title="details" class="method-name">SetSessionVars</a>
(<span class="var-type">mixed</span> <span class="var-name">$sessCtxt</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#UpdateRecord" title="details" class="method-name">UpdateRecord</a>
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">array</span> <span class="var-name">&$record</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$EOF" id="$EOF"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$EOF</span>
= <span class="var-default"> true</span> (line <span class="line-number">1509</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$m_BizObjName" id="$m_BizObjName"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_BizObjName</span>
(line <span class="line-number">1504</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_Cursor" id="$m_Cursor"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_Cursor</span>
= <span class="var-default"> -1</span> (line <span class="line-number">1506</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_RowCount" id="$m_RowCount"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_RowCount</span>
= <span class="var-default"> 0</span> (line <span class="line-number">1507</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_RowIDMap" id="$m_RowIDMap"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_RowIDMap</span>
= <span class="var-default">array()</span> (line <span class="line-number">1508</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$m_SqlRecordList" id="$m_SqlRecordList"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$m_SqlRecordList</span>
= <span class="var-default">array()</span> (line <span class="line-number">1505</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</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">1511</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">CacheRecordList</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">mixed</span> <span class="var-name">$bizObjName</span>)
</div>
</div>
<a name="methodAppendRecord" id="AppendRecord"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">AppendRecord</span> (line <span class="line-number">1564</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::AppendRecord() - Append a new record into the cache</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">
AppendRecord
</span>
(<span class="var-type">array</span> <span class="var-name">&$record</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$record</span> </li>
</ul>
</div>
<a name="methodDeleteRecord" id="DeleteRecord"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">DeleteRecord</span> (line <span class="line-number">1645</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::DeleteRecord() - Delete the current record from cache</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">
DeleteRecord
</span>
(<span class="var-type">mixed</span> <span class="var-name">$id</span>)
</div>
</div>
<a name="methodGetRecord" id="GetRecord"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">GetRecord</span> (line <span class="line-number">1540</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::GetRecord() - get the record on the current cursor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
GetRecord
</span>
()
</div>
</div>
<a name="methodGetRowCount" id="GetRowCount"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">GetRowCount</span> (line <span class="line-number">1668</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::GetRowCount() - Get the number of row in the cache</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">integer</span>
<span class="method-name">
GetRowCount
</span>
()
</div>
</div>
<a name="methodGetSessionVars" id="GetSessionVars"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">GetSessionVars</span> (line <span class="line-number">1516</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
GetSessionVars
</span>
(<span class="var-type">mixed</span> <span class="var-name">$sessCtxt</span>)
</div>
</div>
<a name="methodHasRecord" id="HasRecord"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">HasRecord</span> (line <span class="line-number">1550</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::HasRecord() - check if cache has a record whose Id is same as the Id of the input array</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
HasRecord
</span>
(<span class="var-type">mixed</span> <span class="var-name">&$record</span>)
</div>
</div>
<a name="methodInsertRecord" id="InsertRecord"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">InsertRecord</span> (line <span class="line-number">1610</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::InsertRecord() - Insert a record into the cache</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">
InsertRecord
</span>
(<span class="var-type">array</span> <span class="var-name">&$record</span>, [<span class="var-type">boolean</span> <span class="var-name">$before</span> = <span class="var-default">true</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$record</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$before</span> </li>
</ul>
</div>
<a name="methodMoveCursor" id="MoveCursor"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">MoveCursor</span> (line <span class="line-number">1695</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::MoveCursor() - Move cursor of the cache</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
MoveCursor
</span>
(<span class="var-type">integer</span> <span class="var-name">$i</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$i</span><span class="var-description">: steps moved - can be minus number</span> </li>
</ul>
</div>
<a name="methodSetCursor" id="SetCursor"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">SetCursor</span> (line <span class="line-number">1676</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::SetCursor() - Set the cache cursor to specific position</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">
SetCursor
</span>
(<span class="var-type">integer</span> <span class="var-name">$pos</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$pos</span> </li>
</ul>
</div>
<a name="methodSetSessionVars" id="SetSessionVars"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">SetSessionVars</span> (line <span class="line-number">1526</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
SetSessionVars
</span>
(<span class="var-type">mixed</span> <span class="var-name">$sessCtxt</span>)
</div>
</div>
<a name="methodUpdateRecord" id="UpdateRecord"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">UpdateRecord</span> (line <span class="line-number">1592</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CacheRecordList::UpdateRecord() - Append a new record into the cache</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">
UpdateRecord
</span>
(<span class="var-type">string</span> <span class="var-name">$id</span>, <span class="var-type">array</span> <span class="var-name">&$record</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$id</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$record</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 26 Oct 2005 07:44:43 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
Other Development Tools Scripts:
