Location: PHPKode > projects > matsLETS > matslets-beta-1/doc/matssrc/transaction_functions/_functions---transaction.php.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>
  <title>Docs for page transaction.php</title>
  <link rel="stylesheet" href="../media/stylesheet.css" />
  <script src="../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../media/lib/tabpane.js"></script>
  <script language="javascript" type="text/javascript" src="../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
	var imgPlus = new Image();
	var imgMinus = new Image();
	imgPlus.src = "../media/images/plus.gif";
	imgMinus.src = "../media/images/minus.gif";
	
	function showNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgMinus.src;
		oTable.style.display = "block";
	}
	
	function hideNode(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
				var oImg = document.layers["img" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
				var oImg = document.all["img" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
				var oImg = document.getElementById("img" + Node);
        		break;
        }
		oImg.src = imgPlus.src;
		oTable.style.display = "none";
	}
	
	function nodeIsVisible(Node){
        switch(navigator.family){
        	case 'nn4':
        		// Nav 4.x code fork...
				var oTable = document.layers["span" + Node];
        		break;
        	case 'ie4':
        		// IE 4/5 code fork...
				var oTable = document.all["span" + Node];
        		break;
        	case 'gecko':
        		// Standards Compliant code fork...
				var oTable = document.getElementById("span" + Node);
        		break;
        }
		return (oTable && oTable.style.display == "block");
	}
	
	function toggleNodeVisibility(Node){
		if (nodeIsVisible(Node)){
			hideNode(Node);
		}else{
			showNode(Node);
		}
	}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" >
<h2>File: /functions/transaction.php</h2>
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ) );
</script>

<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<!-- ========== Info from phpDoc block ========= -->
<h5>Various transaction handler functions.</h5>
<div class="desc"><p>This handles creating payments and finalising them when the payment is first  suggested, all the dependent payments are worked out and he is shown the ones  he will pay.  When the payment creation is confirmed the payments are created  invisible for both parties when the confirmer of the payment chooses to  confirm, he is warned about his dependent payments, but this time from having  looked at the payments table, rather than calculating again when he confirms,  the payment is completed along with all its dependents.</p></div>
<ul>
		<li><strong>author:</strong> - Matthew Slater</li>
		<li><strong>version:</strong> - $Id: transaction.php 93 2007-12-12 17:17:24Z progga $</li>
		<li><strong>copyright:</strong> - Mary Free (hide@address.com)</li>
		<li><strong>filesource:</strong> - <a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html">Source Code for this file</a></li>
		<li><strong>license:</strong> - GNU</li>
	</ul>
<!-- =========== Used Classes =========== -->
<A NAME='classes_summary'><!-- --></A>
<h3>Classes defined in this file</h3>

<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
	<THEAD>
		<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR>
	</THEAD>
	<TBODY>
			</TBODY>
</TABLE>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">
<!-- ============ Includes DETAIL =========== -->

<h2 class="tab">Include/Require Statements</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>


</div>
<div class="tab-page" id="tabPage2">
<!-- ============ GLOBAL DETAIL =========== -->

<h2 class="tab">Global Variables</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script>

</div>
<div class="tab-page" id="tabPage3">
<!-- ============ CONSTANT DETAIL =========== -->

<A NAME='constant_detail'></A>
<h2 class="tab">Constants</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage3" ) );</script>

</div>
<div class="tab-page" id="tabPage4">
<!-- ============ FUNCTION DETAIL =========== -->

<h2 class="tab">Functions</h2>

<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage4" ) );</script>

<a name="functioncalculateAutopayment" id="functioncalculateAutopayment"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">calculateAutopayment</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a106">106</a></span>)
 </h4> 
<h4><i>void</i> <strong>calculateAutopayment(
 $data,  $originalPayment)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $data</strong>: </li>
			<li><strong> $originalPayment</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="functioncalculateXtraPayments" id="functioncalculateXtraPayments"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">calculateXtraPayments</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a59">59</a></span>)
 </h4> 
<h4><i>void</i> <strong>calculateXtraPayments(
 $listOfPaymentTypes,  $from,  $to,  $amount,  $currencyId)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $listOfPaymentTypes</strong>: </li>
			<li><strong> $from</strong>: </li>
			<li><strong> $to</strong>: </li>
			<li><strong> $amount</strong>: </li>
			<li><strong> $currencyId</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="functioncheckTransactionWithinLimits" id="functioncheckTransactionWithinLimits"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">checkTransactionWithinLimits</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a131">131</a></span>)
 </h4> 
<h4><i>void</i> <strong>checkTransactionWithinLimits(
 $fromId,  $toId,  $amountInMinutes,  $currencyId)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $fromId</strong>: </li>
			<li><strong> $toId</strong>: </li>
			<li><strong> $amountInMinutes</strong>: </li>
			<li><strong> $currencyId</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="functioncreateDependentPayment" id="functioncreateDependentPayment"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">createDependentPayment</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a43">43</a></span>)
 </h4> 
<h4><i>void</i> <strong>createDependentPayment(
 $paymentDetailsArray,  $dependentOn)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $paymentDetailsArray</strong>: </li>
			<li><strong> $dependentOn</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="functiongetCurrencyLimits" id="functiongetCurrencyLimits"><!-- --></a>
<div style="background='#eeeeee'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">getCurrencyLimits</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a178">178</a></span>)
 </h4> 
<h4><i>void</i> <strong>getCurrencyLimits(
 $currId)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $currId</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
<a name="functionnotifyAboutDependentPayments" id="functionnotifyAboutDependentPayments"><!-- --></a>
<div style="background='#ffffff'">
<h4>
  <img src="../media/images/PublicMethod.gif" border="0" /> <strong class="method">notifyAboutDependentPayments</strong> (line <span class="linenumber"><a href="../__filesource/fsource_transaction_functions__functionstransaction.php.html#a25">25</a></span>)
 </h4> 
<h4><i>void</i> <strong>notifyAboutDependentPayments(
 $proposedPaymentSet)</strong></h4>

<!-- ========== Info from phpDoc block ========= -->
		<h4>Parameters</h4>
	<ul>
			<li><strong> $proposedPaymentSet</strong>: </li>
		</ul>
		
	<h4>Info</h4>
	<ul>
		</ul>
</div>
</div>
</div>
<script type="text/javascript">
//<![CDATA[

setupAllTabs();

//]]>
</script>
	<div id="credit">
		<hr />
		Documentation generated on Wed, 13 Feb 2008 16:02:04 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</div>
</body>
</html>
Return current item: matsLETS