Commit a4ff98b9 authored by Bong Cosca's avatar Bong Cosca
Browse files

Abandon .chm help format; Package the API documentation in plain HTML

parent fad7f53c

api.chm

deleted100644 → 0
−492 KiB

File deleted.

View file

api/annotated.html

0 → 100644
+82 −0
Original line number Diff line number Diff line 
<!-- 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.5"/>

<title>Fat-Free Framework: Class List</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

   &#160;<span id="projectnumber">3.1.2</span>

   &#160;<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.5 -->

</div><!-- top -->

<div class="header">

  <div class="headertitle">

<div class="title">Class List</div>  </div>

</div><!--header-->

<div class="contents">

<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">

<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">

<tr id="row_0_" class="even"><td class="entry"><img id="arr_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_')"/><img src="ftv2ns.png" alt="N" width="24" height="22" /><b>DB</b></td><td class="desc"></td></tr>

<tr id="row_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_0_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_0_')"/><img src="ftv2ns.png" alt="N" width="24" height="22" /><b>Jig</b></td><td class="desc"></td></tr>

<tr id="row_0_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Jig_1_1Mapper.html" target="_self">Mapper</a></td><td class="desc">Flat-file DB mapper </td></tr>

<tr id="row_0_0_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Jig_1_1Session.html" target="_self">Session</a></td><td class="desc">Jig-managed session handler </td></tr>

<tr id="row_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_0_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_1_')"/><img src="ftv2ns.png" alt="N" width="24" height="22" /><b>Mongo</b></td><td class="desc"></td></tr>

<tr id="row_0_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Mongo_1_1Mapper.html" target="_self">Mapper</a></td><td class="desc">MongoDB mapper </td></tr>

<tr id="row_0_1_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Mongo_1_1Session.html" target="_self">Session</a></td><td class="desc">MongoDB-managed session handler </td></tr>

<tr id="row_0_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_0_2_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('0_2_')"/><img src="ftv2ns.png" alt="N" width="24" height="22" /><b>SQL</b></td><td class="desc"></td></tr>

<tr id="row_0_2_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1SQL_1_1Mapper.html" target="_self">Mapper</a></td><td class="desc">SQL data mapper </td></tr>

<tr id="row_0_2_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1SQL_1_1Session.html" target="_self">Session</a></td><td class="desc">SQL-managed session handler </td></tr>

<tr id="row_0_3_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Cursor.html" target="_self">Cursor</a></td><td class="desc">Simple cursor implementation </td></tr>

<tr id="row_0_4_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Jig.html" target="_self">Jig</a></td><td class="desc">Flat-file DB wrapper </td></tr>

<tr id="row_0_5_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1Mongo.html" target="_self">Mongo</a></td><td class="desc">MongoDB wrapper </td></tr>

<tr id="row_0_6_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDB_1_1SQL.html" target="_self">SQL</a></td><td class="desc">PDO wrapper </td></tr>

<tr id="row_1_" class="even"><td class="entry"><img id="arr_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_')"/><img src="ftv2ns.png" alt="N" width="24" height="22" /><b>Web</b></td><td class="desc"></td></tr>

<tr id="row_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classWeb_1_1Geo.html" target="_self">Geo</a></td><td class="desc">Geo plug-in </td></tr>

<tr id="row_1_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classWeb_1_1OpenID.html" target="_self">OpenID</a></td><td class="desc">OpenID consumer </td></tr>

<tr id="row_1_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classWeb_1_1Pingback.html" target="_self">Pingback</a></td><td class="desc">Pingback 1.0 protocol (client and server) implementation </td></tr>

<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classAudit.html" target="_self">Audit</a></td><td class="desc">Data validator </td></tr>

<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classAuth.html" target="_self">Auth</a></td><td class="desc">Authorization/authentication plug-in </td></tr>

<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classBase.html" target="_self">Base</a></td><td class="desc">Base structure </td></tr>

<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classBasket.html" target="_self">Basket</a></td><td class="desc">Session-based pseudo-mapper </td></tr>

<tr id="row_6_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classBcrypt.html" target="_self">Bcrypt</a></td><td class="desc">Lightweight password hashing library </td></tr>

<tr id="row_7_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classCache.html" target="_self">Cache</a></td><td class="desc">Cache engine </td></tr>

<tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classF3.html" target="_self">F3</a></td><td class="desc">Legacy mode enabler </td></tr>

<tr id="row_9_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classImage.html" target="_self">Image</a></td><td class="desc">Image manipulation tools </td></tr>

<tr id="row_10_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classISO.html" target="_self">ISO</a></td><td class="desc">ISO language/country codes </td></tr>

<tr id="row_11_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLog.html" target="_self">Log</a></td><td class="desc">Custom logger </td></tr>

<tr id="row_12_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classMagic.html" target="_self">Magic</a></td><td class="desc">PHP magic wrapper </td></tr>

<tr id="row_13_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classMarkdown.html" target="_self">Markdown</a></td><td class="desc">Markdown-to-HTML converter </td></tr>

<tr id="row_14_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classMatrix.html" target="_self">Matrix</a></td><td class="desc">Generic array utilities </td></tr>

<tr id="row_15_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classPrefab.html" target="_self">Prefab</a></td><td class="desc">Prefab for classes with constructors and static factory methods </td></tr>

<tr id="row_16_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRegistry.html" target="_self">Registry</a></td><td class="desc">Container for singular object instances </td></tr>

<tr id="row_17_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSession.html" target="_self">Session</a></td><td class="desc">Cache-based session handler </td></tr>

<tr id="row_18_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSMTP.html" target="_self">SMTP</a></td><td class="desc">SMTP plug-in </td></tr>

<tr id="row_19_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTemplate.html" target="_self">Template</a></td><td class="desc">Template engine </td></tr>

<tr id="row_20_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTest.html" target="_self">Test</a></td><td class="desc">Unit test kit </td></tr>

<tr id="row_21_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classUTF.html" target="_self">UTF</a></td><td class="desc">Unicode string manager </td></tr>

<tr id="row_22_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classView.html" target="_self">View</a></td><td class="desc">View handler </td></tr>

<tr id="row_23_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classWeb.html" target="_self">Web</a></td><td class="desc">Wrapper for various HTTP utilities </td></tr>

</table>

</div><!-- directory -->

</div><!-- contents -->

api/bc_s.png

0 → 100644
+624 B
Loading image diff...

api/bdwn.png

0 → 100644
+139 B
Loading image diff...

api/classAudit-members.html

0 → 100644
+58 −0
Original line number Diff line number Diff line 
<!-- 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.5"/>

<title>Fat-Free Framework: Member List</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

   &#160;<span id="projectnumber">3.1.2</span>

   &#160;<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.5 -->

</div><!-- top -->

<div class="header">

  <div class="headertitle">

<div class="title">Audit Member List</div>  </div>

</div><!--header-->

<div class="contents">



<p>This is the complete list of members for <a class="el" href="classAudit.html">Audit</a>, including all inherited members.</p>

<table class="directory">

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#a4a770cba20e7000564c5fb6b5c11a20b">card</a>($id)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classAudit.html#a02ac097b7d0aecabd3240caa9f0da721">email</a>($str, $mx=TRUE)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#a1d749ab3e7722c44f637e531dd896e5d">entropy</a>($str)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classPrefab.html#a459ac539bc012dbdb77abe0d0ebeba76">instance</a>()</td><td class="entry"><a class="el" href="classPrefab.html">Prefab</a></td><td class="entry"><span class="mlabel">static</span></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#ad212e486cbfe86be9f5c11ad3910b815">ipv4</a>($addr)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classAudit.html#ab063234ba71915d238a52dc95a00d329">ipv6</a>($addr)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#a4eb6504047ce071cc445eba3d96b4f6f">isbot</a>()</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classAudit.html#a67dde47e31fc8735a5eee934025bacb1">isdesktop</a>()</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#aa816122125e18fdd26cd2a442eab7d26">ismobile</a>()</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classAudit.html#ad3a7ec3b4e409b9840568c984b210c8c">isprivate</a>($addr)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#aca7caf71d2616e348202b3d956d6fa90">ispublic</a>($addr)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr><td class="entry"><a class="el" href="classAudit.html#ae495176807f8eb67bf0594ed4093b790">isreserved</a>($addr)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#aac0692b7b6ad10d1b24f38acf3c0dc83">mod10</a>($id)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr bgcolor="#f0f0f0"><td class="entry"><b>UA_Bot</b> (defined in <a class="el" href="classAudit.html">Audit</a>)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>UA_Desktop</b> (defined in <a class="el" href="classAudit.html">Audit</a>)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr bgcolor="#f0f0f0"><td class="entry"><b>UA_Mobile</b> (defined in <a class="el" href="classAudit.html">Audit</a>)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

  <tr class="even"><td class="entry"><a class="el" href="classAudit.html#ab336b765e98d6370c23174a4e8fdcabb">url</a>($str)</td><td class="entry"><a class="el" href="classAudit.html">Audit</a></td><td class="entry"></td></tr>

</table></div><!-- contents -->