225 lines
7.6 KiB
HTML
225 lines
7.6 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_RelatedSet</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_RelatedSet</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">Portal description class. Contains all the information about a specific set of related records defined by a portal on a layout.</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_FileMaker---RelatedSet.php.html">/FileMaker/RelatedSet.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_RelatedSet</span>
|
|
<a href="#FileMaker_RelatedSet" title="details" class="method-name">FileMaker_RelatedSet</a>
|
|
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
|
<a href="#getField" title="details" class="method-name">&getField</a>
|
|
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
|
</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">string</span>
|
|
<a href="#getName" title="details" class="method-name">getName</a>
|
|
()
|
|
</div>
|
|
<div class="method-definition">
|
|
<span class="method-result">array</span>
|
|
<a href="#listFields" title="details" class="method-name">listFields</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_RelatedSet" id="FileMaker_RelatedSet"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">Constructor FileMaker_RelatedSet</span> (line <span class="line-number">45</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Portal constructor.</p>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">FileMaker_RelatedSet</span>
|
|
<span class="method-name">
|
|
FileMaker_RelatedSet
|
|
</span>
|
|
(<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span> <span class="var-name">&$layout</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type"><a href="../FileMaker/FileMaker_Layout.html">FileMaker_Layout</a></span>
|
|
<span class="var-name">&$layout</span><span class="var-description">: FileMaker_Layout object that this portal is on.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetField" id="getField"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getField</span> (line <span class="line-number">79</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns a FileMaker_Field object that describes the specified field.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Field object, if successful. Otherwise, an Error object.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result"><a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a>|<a href="../FileMaker/FileMaker_Error.html">FileMaker_Error</a></span>
|
|
<span class="method-name">
|
|
&getField
|
|
</span>
|
|
(<span class="var-type">string</span> <span class="var-name">$fieldName</span>)
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<span class="var-name">$fieldName</span><span class="var-description">: Name of field.</span> </li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodgetFields" id="getFields"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getFields</span> (line <span class="line-number">90</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns an associative array with the names of all fields as keys and FileMaker_Field objects as the array values.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Array of <a href="../FileMaker/FileMaker_Field.html">FileMaker_Field</a> objects.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">array</span>
|
|
<span class="method-name">
|
|
&getFields
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodgetName" id="getName"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">getName</span> (line <span class="line-number">56</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns the name of the related table from which this portal displays related records.</p>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> Name of related table for this portal.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
getName
|
|
</span>
|
|
()
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<a name="methodlistFields" id="listFields"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<span class="method-title">listFields</span> (line <span class="line-number">66</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">Returns an array of the names of all fields in this portal.</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">
|
|
listFields
|
|
</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> |