<?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 Permutator</title>
<link rel="stylesheet" href="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 Permutator</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">Permutator</p>
<p class="description"><p>A functional class to perform tasks on each permutation of an array.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Shannon Wynter (http://fremnet.net/contact)</li>
<li><span class="field">version:</span> 0.01</li>
<li><span class="field">copyright:</span> Copyright (c) 2010, Shannon Wynter</li>
<li><span class="field">license:</span> <a href="http://opensource.org/licenses/gpl-license.php">GNU Public License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Permutator.class.php.html">/Permutator.class.php</a> (line <span class="field">12</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">Permutator</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">array</span> <span class="var-name">$source_array</span>, <span class="var-type">callback</span> <span class="var-name">$callback_function</span>, [<span class="var-type">mixed</span> <span class="var-name">$callback_argument</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">integer</span>
<a href="#factors" title="details" class="method-name">factors</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#process" title="details" class="method-name">process</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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">39</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class constructor</p>
<p class="description"><p>When calling the callback function the call is $callback_function($permutation, $callback_argument)</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Permutator</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">array</span> <span class="var-name">$source_array</span>, <span class="var-type">callback</span> <span class="var-name">$callback_function</span>, [<span class="var-type">mixed</span> <span class="var-name">$callback_argument</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$source_array</span><span class="var-description">: Array to permutate</span> </li>
<li>
<span class="var-type">callback</span>
<span class="var-name">$callback_function</span><span class="var-description">: The function to call</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$callback_argument</span><span class="var-description">: This parameter is passed to the callback function as the second argument</span> </li>
</ul>
</div>
<a name="methodfactors" id="factors"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">factors</span> (line <span class="line-number">52</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Factors</p>
<p class="description"><p>Get the number of factors</p></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">
factors
</span>
()
</div>
</div>
<a name="methodprocess" id="process"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">process</span> (line <span class="line-number">61</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Process</p>
<p class="description"><p>Begin permutating the array</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">
process
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 01 May 2010 03:02:44 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>