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

Размер файла: 13.37Kb
  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: Preview 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><!-- top -->
  33. <div class="header">
  34. <div class="summary">
  35. <a href="#pub-methods">Public Member Functions</a> &#124;
  36. <a href="#pro-methods">Protected Member Functions</a> &#124;
  37. <a href="#pro-attribs">Protected Attributes</a> &#124;
  38. <a href="classPreview-members.html">List of all members</a> </div>
  39. <div class="headertitle">
  40. <div class="title">Preview Class Reference</div> </div>
  41. </div><!--header-->
  42. <div class="contents">
  43.  
  44. <p>Lightweight template engine.
  45. <a href="classPreview.html#details">More...</a></p>
  46. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  47. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Preview:</div>
  48. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  49. </div>
  50. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  51. <div class="center">
  52. <img src="classPreview.png" usemap="#Preview_map" alt=""/>
  53. <map id="Preview_map" name="Preview_map">
  54. <area href="classView.html" title="View handler. " alt="View" shape="rect" coords="0,56,62,80"/>
  55. <area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,62,24"/>
  56. <area href="classTemplate.html" title="XML-style template engine. " alt="Template" shape="rect" coords="0,168,62,192"/>
  57. </map>
  58. </div></div>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  61. Public Member Functions</h2></td></tr>
  62. <tr class="memitem:ac1efc68a32f6586da0de6bd8e5ce9236"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPreview.html#ac1efc68a32f6586da0de6bd8e5ce9236">token</a> ($str)</td></tr>
  63. <tr class="separator:ac1efc68a32f6586da0de6bd8e5ce9236"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a6eb272bb3be69a1c63b66fe791bb8b3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPreview.html#a6eb272bb3be69a1c63b66fe791bb8b3d">resolve</a> ($str, array $hive=NULL)</td></tr>
  65. <tr class="separator:a6eb272bb3be69a1c63b66fe791bb8b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a25a8edf2ccad5d98e7f118fe78072d0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPreview.html#a25a8edf2ccad5d98e7f118fe78072d0c">render</a> ($file, $mime='text/html', array $hive=NULL, $ttl=0)</td></tr>
  67. <tr class="separator:a25a8edf2ccad5d98e7f118fe78072d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="inherit_header pub_methods_classView"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classView')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classView.html">View</a></td></tr>
  69. <tr class="memitem:a3f3e380e4794e627e7fe35d1a5fce246 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a3f3e380e4794e627e7fe35d1a5fce246">esc</a> ($arg)</td></tr>
  70. <tr class="separator:a3f3e380e4794e627e7fe35d1a5fce246 inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a94f1333c90966ff49ebbcf29a83ca1a5 inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a94f1333c90966ff49ebbcf29a83ca1a5">raw</a> ($arg)</td></tr>
  72. <tr class="separator:a94f1333c90966ff49ebbcf29a83ca1a5 inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:ad927807baa5a97b52e6bde2a4a0c48fa inherit pub_methods_classView"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#ad927807baa5a97b52e6bde2a4a0c48fa">render</a> ($file, $mime='text/html', array $hive=NULL, $ttl=0)</td></tr>
  74. <tr class="separator:ad927807baa5a97b52e6bde2a4a0c48fa inherit pub_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. </table><table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  77. Protected Member Functions</h2></td></tr>
  78. <tr class="memitem:a96cfdbd00dd1e8d7ccaf9e167cc536cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPreview.html#a96cfdbd00dd1e8d7ccaf9e167cc536cf">build</a> ($node)</td></tr>
  79. <tr class="separator:a96cfdbd00dd1e8d7ccaf9e167cc536cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="inherit_header pro_methods_classView"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classView')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classView.html">View</a></td></tr>
  81. <tr class="memitem:a2bf1b210f2fe7efcc7089579e63b37e6 inherit pro_methods_classView"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#a2bf1b210f2fe7efcc7089579e63b37e6">sandbox</a> (array $hive=NULL)</td></tr>
  82. <tr class="separator:a2bf1b210f2fe7efcc7089579e63b37e6 inherit pro_methods_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table><table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  85. Protected Attributes</h2></td></tr>
  86. <tr class="memitem:ae010f04277309e1b21b11ddd06c01455"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae010f04277309e1b21b11ddd06c01455"></a>
  87. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPreview.html#ae010f04277309e1b21b11ddd06c01455">$mime</a></td></tr>
  88. <tr class="memdesc:ae010f04277309e1b21b11ddd06c01455"><td class="mdescLeft">&#160;</td><td class="mdescRight">MIME type. <br/></td></tr>
  89. <tr class="separator:ae010f04277309e1b21b11ddd06c01455"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="inherit_header pro_attribs_classView"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classView')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classView.html">View</a></td></tr>
  91. <tr class="memitem:ad4ffe360a4edcdce1cf6abe276f1370f inherit pro_attribs_classView"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4ffe360a4edcdce1cf6abe276f1370f"></a>
  92. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classView.html#ad4ffe360a4edcdce1cf6abe276f1370f">$view</a></td></tr>
  93. <tr class="memdesc:ad4ffe360a4edcdce1cf6abe276f1370f inherit pro_attribs_classView"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template file. <br/></td></tr>
  94. <tr class="separator:ad4ffe360a4edcdce1cf6abe276f1370f inherit pro_attribs_classView"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  97. Additional Inherited Members</h2></td></tr>
  98. <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>
  99. <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>
  100. <tr class="separator:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table>
  102. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  103. <div class="textblock"><p>Lightweight template engine. </p>
  104. </div><h2 class="groupheader">Member Function Documentation</h2>
  105. <a class="anchor" id="a96cfdbd00dd1e8d7ccaf9e167cc536cf"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">Preview::build </td>
  114. <td>(</td>
  115. <td class="paramtype">&#160;</td>
  116. <td class="paramname"><em>$node</em></td><td>)</td>
  117. <td></td>
  118. </tr>
  119. </table>
  120. </td>
  121. <td class="mlabels-right">
  122. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>Assemble markup </p>
  127. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  128. <dl class="params"><dt>Parameters</dt><dd>
  129. <table class="params">
  130. <tr><td class="paramname">$node</td><td>string </td></tr>
  131. </table>
  132. </dd>
  133. </dl>
  134.  
  135. </div>
  136. </div>
  137. <a class="anchor" id="a25a8edf2ccad5d98e7f118fe78072d0c"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">Preview::render </td>
  143. <td>(</td>
  144. <td class="paramtype">&#160;</td>
  145. <td class="paramname"><em>$file</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">&#160;</td>
  151. <td class="paramname"><em>$mime</em> = <code>'text/html'</code>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">array&#160;</td>
  157. <td class="paramname"><em>$hive</em> = <code>NULL</code>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">&#160;</td>
  163. <td class="paramname"><em>$ttl</em> = <code>0</code>&#160;</td>
  164. </tr>
  165. <tr>
  166. <td></td>
  167. <td>)</td>
  168. <td></td><td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Render template </p>
  173. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  174. <dl class="params"><dt>Parameters</dt><dd>
  175. <table class="params">
  176. <tr><td class="paramname">$file</td><td>string </td></tr>
  177. <tr><td class="paramname">$mime</td><td>string </td></tr>
  178. <tr><td class="paramname">$hive</td><td>array </td></tr>
  179. <tr><td class="paramname">$ttl</td><td>int </td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183.  
  184. </div>
  185. </div>
  186. <a class="anchor" id="a6eb272bb3be69a1c63b66fe791bb8b3d"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">Preview::resolve </td>
  192. <td>(</td>
  193. <td class="paramtype">&#160;</td>
  194. <td class="paramname"><em>$str</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">array&#160;</td>
  200. <td class="paramname"><em>$hive</em> = <code>NULL</code>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Render template string </p>
  210. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  211. <dl class="params"><dt>Parameters</dt><dd>
  212. <table class="params">
  213. <tr><td class="paramname">$str</td><td>string </td></tr>
  214. <tr><td class="paramname">$hive</td><td>array </td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218.  
  219. </div>
  220. </div>
  221. <a class="anchor" id="ac1efc68a32f6586da0de6bd8e5ce9236"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">Preview::token </td>
  227. <td>(</td>
  228. <td class="paramtype">&#160;</td>
  229. <td class="paramname"><em>$str</em></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>Convert token to variable </p>
  235. <dl class="section return"><dt>Returns</dt><dd>string </dd></dl>
  236. <dl class="params"><dt>Parameters</dt><dd>
  237. <table class="params">
  238. <tr><td class="paramname">$str</td><td>string </td></tr>
  239. </table>
  240. </dd>
  241. </dl>
  242.  
  243. </div>
  244. </div>
  245. <hr/>The documentation for this class was generated from the following file:<ul>
  246. <li>base.php</li>
  247. </ul>
  248. </div><!-- contents -->