diff options
Diffstat (limited to 'management-interface/lib/api/classMatrix.html')
| -rw-r--r-- | management-interface/lib/api/classMatrix.html | 259 |
1 files changed, 259 insertions, 0 deletions
diff --git a/management-interface/lib/api/classMatrix.html b/management-interface/lib/api/classMatrix.html new file mode 100644 index 0000000..9959d17 --- /dev/null +++ b/management-interface/lib/api/classMatrix.html @@ -0,0 +1,259 @@ +<!-- HTML header for doxygen 1.8.5--> +<!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> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>Fat-Free Framework: Matrix Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Fat-Free Framework +  <span id="projectnumber">3.2.2</span> +  <span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classMatrix-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Matrix Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Generic array utilities. + <a href="classMatrix.html#details">More...</a></p> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Matrix:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> + <div class="center"> + <img src="classMatrix.png" usemap="#Matrix_map" alt=""/> + <map id="Matrix_map" name="Matrix_map"> +<area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,50,24"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a623673b7beac4c117a7e0714ea054392"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMatrix.html#a623673b7beac4c117a7e0714ea054392">pick</a> (array $var, $col)</td></tr> +<tr class="separator:a623673b7beac4c117a7e0714ea054392"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2a4a59eefda3cba3e2cfd4715fa051b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMatrix.html#a2a4a59eefda3cba3e2cfd4715fa051b5">transpose</a> (array &$var)</td></tr> +<tr class="separator:a2a4a59eefda3cba3e2cfd4715fa051b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3f0534af6f58b17fdaf49e045e1dea29"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMatrix.html#a3f0534af6f58b17fdaf49e045e1dea29">sort</a> (array &$var, $col, $order=SORT_ASC)</td></tr> +<tr class="separator:a3f0534af6f58b17fdaf49e045e1dea29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a541d3e87f09a2622ddf8e351565468e0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMatrix.html#a541d3e87f09a2622ddf8e351565468e0">changekey</a> (array &$var, $old, $new)</td></tr> +<tr class="separator:a541d3e87f09a2622ddf8e351565468e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aca5fe8cdc6c61133b79d0700e697491b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMatrix.html#aca5fe8cdc6c61133b79d0700e697491b">calendar</a> ($date='now', $first=0)</td></tr> +<tr class="separator:aca5fe8cdc6c61133b79d0700e697491b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_static_methods_classPrefab"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classPrefab')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classPrefab.html">Prefab</a></td></tr> +<tr class="memitem:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classPrefab.html#a459ac539bc012dbdb77abe0d0ebeba76">instance</a> ()</td></tr> +<tr class="separator:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Generic array utilities. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aca5fe8cdc6c61133b79d0700e697491b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Matrix::calendar </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$date</em> = <code>'now'</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$first</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return month calendar of specified date, with optional setting for first day of week (0 for Sunday) </p> +<dl class="section return"><dt>Returns</dt><dd>array </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$date</td><td>string </td></tr> + <tr><td class="paramname">$first</td><td>int </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a541d3e87f09a2622ddf8e351565468e0"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Matrix::changekey </td> + <td>(</td> + <td class="paramtype">array & </td> + <td class="paramname"><em>$var</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$old</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$new</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Change the key of a two-dimensional array element </p> +<dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$var</td><td>array </td></tr> + <tr><td class="paramname">$old</td><td>string </td></tr> + <tr><td class="paramname">$new</td><td>string </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a623673b7beac4c117a7e0714ea054392"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Matrix::pick </td> + <td>(</td> + <td class="paramtype">array </td> + <td class="paramname"><em>$var</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$col</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieve values from a specified column of a multi-dimensional array variable </p> +<dl class="section return"><dt>Returns</dt><dd>array </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$var</td><td>array </td></tr> + <tr><td class="paramname">$col</td><td>mixed </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a3f0534af6f58b17fdaf49e045e1dea29"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Matrix::sort </td> + <td>(</td> + <td class="paramtype">array & </td> + <td class="paramname"><em>$var</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$col</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$order</em> = <code>SORT_ASC</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Sort a multi-dimensional array variable on a specified column </p> +<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$var</td><td>array </td></tr> + <tr><td class="paramname">$col</td><td>mixed </td></tr> + <tr><td class="paramname">$order</td><td>int </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a2a4a59eefda3cba3e2cfd4715fa051b5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Matrix::transpose </td> + <td>(</td> + <td class="paramtype">array & </td> + <td class="paramname"><em>$var</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Rotate a two-dimensional array variable </p> +<dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$var</td><td>array </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>matrix.php</li> +</ul> +</div><!-- contents --> |