lib.PicoPluginInterface.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
  5. <meta charset="utf-8"/>
  6. <title>Pico 1.0 API Documentation</title>
  7. <meta name="author" content=""/>
  8. <meta name="description" content=""/>
  9. <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
  10. <link href="../css/font-awesome.min.css" rel="stylesheet">
  11. <link href="../css/prism.css" rel="stylesheet" media="all"/>
  12. <link href="../css/template.css" rel="stylesheet" media="all"/>
  13. <!--[if lt IE 9]>
  14. <script src="../js/html5.js"></script>
  15. <![endif]-->
  16. <script src="../js/jquery-1.11.0.min.js"></script>
  17. <script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
  18. <script src="../js/bootstrap.min.js"></script>
  19. <script src="../js/jquery.smooth-scroll.js"></script>
  20. <script src="../js/prism.min.js"></script>
  21. <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
  22. <script type="text/javascript">
  23. function loadExternalCodeSnippets() {
  24. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
  25. var src = pre.getAttribute('data-src');
  26. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  27. var language = 'php';
  28. var code = document.createElement('code');
  29. code.className = 'language-' + language;
  30. pre.textContent = '';
  31. code.textContent = 'Loading…';
  32. pre.appendChild(code);
  33. var xhr = new XMLHttpRequest();
  34. xhr.open('GET', src, true);
  35. xhr.onreadystatechange = function () {
  36. if (xhr.readyState == 4) {
  37. if (xhr.status < 400 && xhr.responseText) {
  38. code.textContent = xhr.responseText;
  39. Prism.highlightElement(code);
  40. }
  41. else if (xhr.status >= 400) {
  42. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  43. }
  44. else {
  45. code.textContent = '✖ Error: File does not exist or is empty';
  46. }
  47. }
  48. };
  49. xhr.send(null);
  50. });
  51. }
  52. $(document).ready(function(){
  53. loadExternalCodeSnippets();
  54. });
  55. $('#source-view').on('shown', function () {
  56. loadExternalCodeSnippets();
  57. })
  58. </script>
  59. <link rel="shortcut icon" href="../images/favicon.ico"/>
  60. <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
  61. <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
  62. <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
  63. </head>
  64. <body>
  65. <div class="navbar navbar-fixed-top">
  66. <div class="navbar-inner">
  67. <div class="container">
  68. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
  69. <i class="icon-ellipsis-vertical"></i>
  70. </a>
  71. <a class="brand" href="../index.html">Pico 1.0 API Documentation</a>
  72. <div class="nav-collapse">
  73. <ul class="nav pull-right">
  74. <li class="dropdown" id="charts-menu">
  75. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  76. Charts <b class="caret"></b>
  77. </a>
  78. <ul class="dropdown-menu">
  79. <li>
  80. <a href="../graphs/class.html">
  81. <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
  82. </a>
  83. </li>
  84. </ul>
  85. </li>
  86. <li class="dropdown" id="reports-menu">
  87. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  88. Reports <b class="caret"></b>
  89. </a>
  90. <ul class="dropdown-menu">
  91. <li>
  92. <a href="../reports/errors.html">
  93. <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">19</span>
  94. </a>
  95. </li>
  96. <li>
  97. <a href="../reports/markers.html">
  98. <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</span>
  99. </a>
  100. </li>
  101. <li>
  102. <a href="../reports/deprecated.html">
  103. <i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
  104. </a>
  105. </li>
  106. </ul>
  107. </li>
  108. </ul>
  109. </div>
  110. </div>
  111. </div>
  112. <!--<div class="go_to_top">-->
  113. <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
  114. <!--</div>-->
  115. </div>
  116. <div id="___" class="container-fluid">
  117. <section class="row-fluid">
  118. <div class="span2 sidebar">
  119. <div class="accordion" style="margin-bottom: 0">
  120. <div class="accordion-group">
  121. <div class="accordion-heading">
  122. <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1984319524"></a>
  123. <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
  124. </div>
  125. <div id="namespace-1984319524" class="accordion-body collapse in">
  126. <div class="accordion-inner">
  127. <ul>
  128. <li class="interface"><a href="../classes/PicoPluginInterface.html">PicoPluginInterface</a></li>
  129. <li class="class"><a href="../classes/AbstractPicoPlugin.html">AbstractPicoPlugin</a></li>
  130. <li class="class"><a href="../classes/DummyPlugin.html">DummyPlugin</a></li>
  131. <li class="class"><a href="../classes/Pico.html">Pico</a></li>
  132. </ul>
  133. </div>
  134. </div>
  135. </div>
  136. </div>
  137. </div>
  138. </section>
  139. <section class="row-fluid">
  140. <div class="span10 offset2">
  141. <div class="row-fluid">
  142. <div class="span8 content file">
  143. <nav>
  144. </nav>
  145. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
  146. <h1><small>lib</small>PicoPluginInterface.php</h1>
  147. <p><em></em></p>
  148. <h2>Interfaces</h2>
  149. <table class="table table-hover">
  150. <tr>
  151. <td><a href="../classes/PicoPluginInterface.html">PicoPluginInterface</a></td>
  152. <td><em>Common interface for Pico plugins</em></td>
  153. </tr>
  154. </table>
  155. </div>
  156. <aside class="span4 detailsbar">
  157. <dl>
  158. <dt>Package</dt>
  159. <dd><div class="namespace-wrapper">\Default</div></dd>
  160. </dl>
  161. <h2>Tags</h2>
  162. <table class="table table-condensed">
  163. <tr><td colspan="2"><em>None found</em></td></tr>
  164. </table>
  165. </aside>
  166. </div>
  167. </div>
  168. </section>
  169. <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
  170. <div class="modal-header">
  171. <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
  172. <h3 id="source-view-label"></h3>
  173. </div>
  174. <div class="modal-body">
  175. <pre data-src="../files/lib/PicoPluginInterface.php.txt" class="language-php line-numbers"></pre>
  176. </div>
  177. </div>
  178. <footer class="row-fluid">
  179. <section class="span10 offset2">
  180. <section class="row-fluid">
  181. <section class="span10 offset1">
  182. <section class="row-fluid footer-sections">
  183. <section class="span4">
  184. <h1><i class="icon-code"></i></h1>
  185. <div>
  186. <ul>
  187. </ul>
  188. </div>
  189. </section>
  190. <section class="span4">
  191. <h1><i class="icon-bar-chart"></i></h1>
  192. <div>
  193. <ul>
  194. <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
  195. </ul>
  196. </div>
  197. </section>
  198. <section class="span4">
  199. <h1><i class="icon-pushpin"></i></h1>
  200. <div>
  201. <ul>
  202. <li><a href="../reports/errors.html">Errors</a></li>
  203. <li><a href="../reports/markers.html">Markers</a></li>
  204. </ul>
  205. </div>
  206. </section>
  207. </section>
  208. </section>
  209. </section>
  210. <section class="row-fluid">
  211. <section class="span10 offset1">
  212. <hr />
  213. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
  214. on November 3rd, 2015 at 16:05.
  215. </section>
  216. </section>
  217. </section>
  218. </footer>
  219. </div>
  220. </body>
  221. </html>