Просмотр файла news/libraries/api/classWeb_1_1Pingback.html

Размер файла: 10.42Kb
  1. <!-- HTML header for doxygen 1.8.5-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.6"/>
  8. <title>Fat-Free Framework: Web\Pingback Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">Fat-Free Framework
  22. &#160;<span id="projectnumber">3.2.2</span>
  23. &#160;<span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
  24. </div>
  25. </td>
  26. </tr>
  27. </tbody>
  28. </table>
  29. </div>
  30. <!-- end header part -->
  31. <!-- Generated by Doxygen 1.8.6 -->
  32. <div id="nav-path" class="navpath">
  33. <ul>
  34. <li class="navelem"><b>Web</b></li><li class="navelem"><a class="el" href="classWeb_1_1Pingback.html">Pingback</a></li> </ul>
  35. </div>
  36. </div><!-- top -->
  37. <div class="header">
  38. <div class="summary">
  39. <a href="#pub-methods">Public Member Functions</a> &#124;
  40. <a href="#pro-methods">Protected Member Functions</a> &#124;
  41. <a href="#pro-attribs">Protected Attributes</a> &#124;
  42. <a href="classWeb_1_1Pingback-members.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">Web\Pingback Class Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47.  
  48. <p>Pingback 1.0 protocol (client and server) implementation.
  49. <a href="classWeb_1_1Pingback.html#details">More...</a></p>
  50. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  51. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Web\Pingback:</div>
  52. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  53. </div>
  54. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  55. <div class="center">
  56. <img src="classWeb_1_1Pingback.png" usemap="#Web\Pingback_map" alt=""/>
  57. <map id="Web\Pingback_map" name="Web\Pingback_map">
  58. <area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,93,24"/>
  59. </map>
  60. </div></div>
  61. <table class="memberdecls">
  62. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  63. Public Member Functions</h2></td></tr>
  64. <tr class="memitem:a4f3e716efc390ad3cd8ff19f47e9a307"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a4f3e716efc390ad3cd8ff19f47e9a307">inspect</a> ($source)</td></tr>
  65. <tr class="separator:a4f3e716efc390ad3cd8ff19f47e9a307"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:af700ac46f413f956e03ff02486017522"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#af700ac46f413f956e03ff02486017522">listen</a> ($func, $path=NULL)</td></tr>
  67. <tr class="separator:af700ac46f413f956e03ff02486017522"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a715f7bb28b60996f0b650f7da5ce6d6b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a715f7bb28b60996f0b650f7da5ce6d6b">log</a> ()</td></tr>
  69. <tr class="separator:a715f7bb28b60996f0b650f7da5ce6d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:adf25b31bdd06f1e2b1af5a12d331875a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#adf25b31bdd06f1e2b1af5a12d331875a">__construct</a> ()</td></tr>
  71. <tr class="separator:adf25b31bdd06f1e2b1af5a12d331875a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. </table><table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  74. Protected Member Functions</h2></td></tr>
  75. <tr class="memitem:a8373d41e900456d5fb3da13db24cf74c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a8373d41e900456d5fb3da13db24cf74c">enabled</a> ($url)</td></tr>
  76. <tr class="separator:a8373d41e900456d5fb3da13db24cf74c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. </table><table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  79. Protected Attributes</h2></td></tr>
  80. <tr class="memitem:a1f2651602d405d12d62d9eece289992e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f2651602d405d12d62d9eece289992e"></a>
  81. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWeb_1_1Pingback.html#a1f2651602d405d12d62d9eece289992e">$log</a></td></tr>
  82. <tr class="memdesc:a1f2651602d405d12d62d9eece289992e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transaction history. <br/></td></tr>
  83. <tr class="separator:a1f2651602d405d12d62d9eece289992e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  86. Additional Inherited Members</h2></td></tr>
  87. <tr class="inherit_header pub_static_methods_classPrefab"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classPrefab')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classPrefab.html">Prefab</a></td></tr>
  88. <tr class="memitem:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPrefab.html#a459ac539bc012dbdb77abe0d0ebeba76">instance</a> ()</td></tr>
  89. <tr class="separator:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table>
  91. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  92. <div class="textblock"><p>Pingback 1.0 protocol (client and server) implementation. </p>
  93. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  94. <a class="anchor" id="adf25b31bdd06f1e2b1af5a12d331875a"></a>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">Web\Pingback::__construct </td>
  100. <td>(</td>
  101. <td class="paramname"></td><td>)</td>
  102. <td></td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>Instantiate class </p>
  107. <dl class="section return"><dt>Returns</dt><dd>object </dd></dl>
  108.  
  109. </div>
  110. </div>
  111. <h2 class="groupheader">Member Function Documentation</h2>
  112. <a class="anchor" id="a8373d41e900456d5fb3da13db24cf74c"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="mlabels">
  116. <tr>
  117. <td class="mlabels-left">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">Web\Pingback::enabled </td>
  121. <td>(</td>
  122. <td class="paramtype">&#160;</td>
  123. <td class="paramname"><em>$url</em></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </td>
  128. <td class="mlabels-right">
  129. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Return TRUE if URL points to a pingback-enabled resource </p>
  134. <dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
  135. <dl class="params"><dt>Parameters</dt><dd>
  136. <table class="params">
  137. <tr><td class="paramname">$url</td><td></td></tr>
  138. </table>
  139. </dd>
  140. </dl>
  141.  
  142. </div>
  143. </div>
  144. <a class="anchor" id="a4f3e716efc390ad3cd8ff19f47e9a307"></a>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">Web\Pingback::inspect </td>
  150. <td>(</td>
  151. <td class="paramtype">&#160;</td>
  152. <td class="paramname"><em>$source</em></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>Load local page contents, parse HTML anchor tags, find permalinks, and send XML-RPC calls to corresponding pingback servers </p>
  158. <dl class="section return"><dt>Returns</dt><dd>NULL </dd></dl>
  159. <dl class="params"><dt>Parameters</dt><dd>
  160. <table class="params">
  161. <tr><td class="paramname">$source</td><td>string </td></tr>
  162. </table>
  163. </dd>
  164. </dl>
  165.  
  166. </div>
  167. </div>
  168. <a class="anchor" id="af700ac46f413f956e03ff02486017522"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">Web\Pingback::listen </td>
  174. <td>(</td>
  175. <td class="paramtype">&#160;</td>
  176. <td class="paramname"><em>$func</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">&#160;</td>
  182. <td class="paramname"><em>$path</em> = <code>NULL</code>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Receive ping, check if local page is pingback-enabled, verify source contents, and return XML-RPC response </p>
  192. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  193. <dl class="params"><dt>Parameters</dt><dd>
  194. <table class="params">
  195. <tr><td class="paramname">$func</td><td>callback </td></tr>
  196. <tr><td class="paramname">$path</td><td>string </td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200.  
  201. </div>
  202. </div>
  203. <a class="anchor" id="a715f7bb28b60996f0b650f7da5ce6d6b"></a>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">Web\Pingback::log </td>
  209. <td>(</td>
  210. <td class="paramname"></td><td>)</td>
  211. <td></td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Return transaction history </p>
  216. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  217.  
  218. </div>
  219. </div>
  220. <hr/>The documentation for this class was generated from the following file:<ul>
  221. <li>web/pingback.php</li>
  222. </ul>
  223. </div><!-- contents -->