368 lines
12 KiB
HTML
368 lines
12 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 FileMaker_Result</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 FileMaker_Result</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Result set description class. Contains all the information about a set of records returned by a command.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_FileMaker---Result.php.html">/FileMaker/Result.php</a> (line <span class="field">28</span>)
|
|
</p>
|
|
|
|
|
|
<pre></pre>
|
|
|
|
</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> |
|
|
<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">FileMaker_Result</span>
|
|
<a href="#FileMaker_Result" title="details" class="method-name">FileMaker_Result</a>
|
|
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">integer</span>
|
|
<a href="#getFetchCount" title="details" class="method-name">getFetchCount</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#getFields" title="details" class="method-name">getFields</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
|
<a href="#getFirstRecord" title="details" class="method-name">getFirstRecord</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">integer</span>
|
|
<a href="#getFoundSetCount" title="details" class="method-name">getFoundSetCount</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
|
<a href="#getLastRecord" title="details" class="method-name">getLastRecord</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
|
<a href="#getLayout" title="details" class="method-name">&getLayout</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#getRecords" title="details" class="method-name">&getRecords</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#getRelatedSets" title="details" class="method-name">getRelatedSets</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">integer</span>
|
|
<a href="#getTableRecordCount" title="details" class="method-name">getTableRecordCount</a>
|
|
()
|
|
</div>
|
|
</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-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
|
|
<a name="methodFileMaker_Result" id="FileMaker_Result"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor FileMaker_Result</span> (line <span class="line-number">44</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Result object constructor.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">FileMaker_Result</span>
|
|
<span class="method-name">
|
|
FileMaker_Result
|
|
</span>
|
|
(<span class="var-type">FileMaker_Implementation</span> <span class="var-name">&$fm</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">FileMaker_Implementation</span>
|
|
<span class="var-name">&$fm</span><span class="var-description">: FileMaker_Implementation object that this result came from.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetFetchCount" id="getFetchCount"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getFetchCount</span> (line <span class="line-number">131</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the number of records in the filtered result set.</p>
|
|
<p class="description"><p>If no range parameters were specified on the Find command, then this value is equal to the result of the <a href="../FileMaker/FileMaker_Result.html#methodgetFoundSetCount">getFoundSetCount()</a> method. It is always equal to the value of count($response-><a href="../FileMaker/FileMaker_Result.html#methodgetRecords">getRecords()</a>).</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Filtered record count.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">integer</span>
|
|
<span class="method-name">
|
|
getFetchCount
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetFields" id="getFields"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getFields</span> (line <span class="line-number">85</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns a list of the names of all fields in the records in this result set.</p>
|
|
<p class="description"><p>Only the field names are returned. If you need additional information, examine the Layout object provided by the <a href="../FileMaker/FileMaker_Result.html#methodgetLayout">getLayout()</a> method.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> List of field names as strings.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
getFields
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetFirstRecord" id="getFirstRecord"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getFirstRecord</span> (line <span class="line-number">141</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the first record in this result set.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> First record.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
|
<span class="method-name">
|
|
getFirstRecord
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetFoundSetCount" id="getFoundSetCount"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getFoundSetCount</span> (line <span class="line-number">116</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the number of records in the entire found set.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Found record count.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">integer</span>
|
|
<span class="method-name">
|
|
getFoundSetCount
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetLastRecord" id="getLastRecord"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getLastRecord</span> (line <span class="line-number">151</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the last record in this result set.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Last record.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a></span>
|
|
<span class="method-name">
|
|
getLastRecord
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetLayout" id="getLayout"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getLayout</span> (line <span class="line-number">55</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns a FileMaker_Layout object that describes the layout of this result set.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Layout object.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
|
<span class="method-name">
|
|
&getLayout
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetRecords" id="getRecords"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getRecords</span> (line <span class="line-number">70</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns an array containing each record in the result set.</p>
|
|
<p class="description"><p>Each member of the array is a FileMaker_Record object, or an instance of the alternate class you specified to use for records (see <a href="../FileMaker/FileMaker_Record.html">FileMaker_Record</a>. The array may be empty if the result set contains no records.</p></p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Record objects.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
&getRecords
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetRelatedSets" id="getRelatedSets"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getRelatedSets</span> (line <span class="line-number">96</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the names of related tables for all portals present in records in this result set.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> List of related table names as strings.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
getRelatedSets
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetTableRecordCount" id="getTableRecordCount"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getTableRecordCount</span> (line <span class="line-number">106</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the number of records in the table that was accessed.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Total record count in table.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">integer</span>
|
|
<span class="method-name">
|
|
getTableRecordCount
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
Documentation generated on Wed, 29 Jun 2011 12:31:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
|
|
</p>
|
|
</div></body>
|
|
</html> |