diff options
Diffstat (limited to 'management-interface/lib/api/classWeb_1_1Pingback.html')
| -rw-r--r-- | management-interface/lib/api/classWeb_1_1Pingback.html | 223 |
1 files changed, 223 insertions, 0 deletions
diff --git a/management-interface/lib/api/classWeb_1_1Pingback.html b/management-interface/lib/api/classWeb_1_1Pingback.html new file mode 100644 index 0000000..fc507ac --- /dev/null +++ b/management-interface/lib/api/classWeb_1_1Pingback.html @@ -0,0 +1,223 @@ +<!-- 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: Web\Pingback 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><b>Web</b></li><li class="navelem"><a class="el" href="classWeb_1_1Pingback.html">Pingback</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classWeb_1_1Pingback-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Web\Pingback Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Pingback 1.0 protocol (client and server) implementation. + <a href="classWeb_1_1Pingback.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 Web\Pingback:</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="classWeb_1_1Pingback.png" usemap="#Web\Pingback_map" alt=""/> + <map id="Web\Pingback_map" name="Web\Pingback_map"> +<area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,93,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:a4f3e716efc390ad3cd8ff19f47e9a307"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a4f3e716efc390ad3cd8ff19f47e9a307">inspect</a> ($source)</td></tr> +<tr class="separator:a4f3e716efc390ad3cd8ff19f47e9a307"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af700ac46f413f956e03ff02486017522"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#af700ac46f413f956e03ff02486017522">listen</a> ($func, $path=NULL)</td></tr> +<tr class="separator:af700ac46f413f956e03ff02486017522"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a715f7bb28b60996f0b650f7da5ce6d6b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a715f7bb28b60996f0b650f7da5ce6d6b">log</a> ()</td></tr> +<tr class="separator:a715f7bb28b60996f0b650f7da5ce6d6b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adf25b31bdd06f1e2b1af5a12d331875a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#adf25b31bdd06f1e2b1af5a12d331875a">__construct</a> ()</td></tr> +<tr class="separator:adf25b31bdd06f1e2b1af5a12d331875a"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a8373d41e900456d5fb3da13db24cf74c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a8373d41e900456d5fb3da13db24cf74c">enabled</a> ($url)</td></tr> +<tr class="separator:a8373d41e900456d5fb3da13db24cf74c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a1f2651602d405d12d62d9eece289992e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f2651602d405d12d62d9eece289992e"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a1f2651602d405d12d62d9eece289992e">$log</a></td></tr> +<tr class="memdesc:a1f2651602d405d12d62d9eece289992e"><td class="mdescLeft"> </td><td class="mdescRight">Transaction history. <br/></td></tr> +<tr class="separator:a1f2651602d405d12d62d9eece289992e"><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>Pingback 1.0 protocol (client and server) implementation. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="adf25b31bdd06f1e2b1af5a12d331875a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Web\Pingback::__construct </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Instantiate class </p> +<dl class="section return"><dt>Returns</dt><dd>object </dd></dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a8373d41e900456d5fb3da13db24cf74c"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">Web\Pingback::enabled </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$url</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Return TRUE if URL points to a pingback-enabled resource </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">$url</td><td></td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a4f3e716efc390ad3cd8ff19f47e9a307"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Web\Pingback::inspect </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$source</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Load local page contents, parse HTML anchor tags, find permalinks, and send XML-RPC calls to corresponding pingback servers </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">$source</td><td>string </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af700ac46f413f956e03ff02486017522"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Web\Pingback::listen </td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname"><em>$func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>$path</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Receive ping, check if local page is pingback-enabled, verify source contents, and return XML-RPC response </p> +<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">$func</td><td>callback </td></tr> + <tr><td class="paramname">$path</td><td>string </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="a715f7bb28b60996f0b650f7da5ce6d6b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">Web\Pingback::log </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return transaction history </p> +<dl class="section return"><dt>Returns</dt><dd>string </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>web/pingback.php</li> +</ul> +</div><!-- contents --> |