DummyPlugin.html 97 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710
  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-73830220"></a>
  123. <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
  124. </div>
  125. <div id="namespace-73830220" 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 class">
  143. <nav>
  144. <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
  145. </nav>
  146. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
  147. <h1><small>\</small>DummyPlugin</h1>
  148. <p><em>Pico dummy plugin - a template for plugins</em></p>
  149. <p>You're a plugin developer? This template may be helpful :-)
  150. Simply remove the events you don't need and add your own logic.</p>
  151. <section id="summary">
  152. <h2>Summary</h2>
  153. <section class="row-fluid heading">
  154. <section class="span4">
  155. <a href="#methods">Methods</a>
  156. </section>
  157. <section class="span4">
  158. <a href="#properties">Properties</a>
  159. </section>
  160. <section class="span4">
  161. <a href="#constants">Constants</a>
  162. </section>
  163. </section>
  164. <section class="row-fluid public">
  165. <section class="span4">
  166. <a href="../classes/AbstractPicoPlugin.html#method___construct" class="">__construct()</a><br />
  167. <a href="../classes/AbstractPicoPlugin.html#method_handleEvent" class="">handleEvent()</a><br />
  168. <a href="../classes/AbstractPicoPlugin.html#method_setEnabled" class="">setEnabled()</a><br />
  169. <a href="../classes/AbstractPicoPlugin.html#method_isEnabled" class="">isEnabled()</a><br />
  170. <a href="../classes/AbstractPicoPlugin.html#method_isStatusChanged" class="">isStatusChanged()</a><br />
  171. <a href="../classes/AbstractPicoPlugin.html#method_getPico" class="">getPico()</a><br />
  172. <a href="../classes/AbstractPicoPlugin.html#method___call" class="">__call()</a><br />
  173. <a href="../classes/AbstractPicoPlugin.html#method_getDependencies" class="">getDependencies()</a><br />
  174. <a href="../classes/AbstractPicoPlugin.html#method_getDependants" class="">getDependants()</a><br />
  175. <a href="../classes/DummyPlugin.html#method_onPluginsLoaded" class="">onPluginsLoaded()</a><br />
  176. <a href="../classes/DummyPlugin.html#method_onConfigLoaded" class="">onConfigLoaded()</a><br />
  177. <a href="../classes/DummyPlugin.html#method_onRequestUrl" class="">onRequestUrl()</a><br />
  178. <a href="../classes/DummyPlugin.html#method_onRequestFile" class="">onRequestFile()</a><br />
  179. <a href="../classes/DummyPlugin.html#method_onContentLoading" class="">onContentLoading()</a><br />
  180. <a href="../classes/DummyPlugin.html#method_onContentLoaded" class="">onContentLoaded()</a><br />
  181. <a href="../classes/DummyPlugin.html#method_on404ContentLoading" class="">on404ContentLoading()</a><br />
  182. <a href="../classes/DummyPlugin.html#method_on404ContentLoaded" class="">on404ContentLoaded()</a><br />
  183. <a href="../classes/DummyPlugin.html#method_onMetaHeaders" class="">onMetaHeaders()</a><br />
  184. <a href="../classes/DummyPlugin.html#method_onMetaParsing" class="">onMetaParsing()</a><br />
  185. <a href="../classes/DummyPlugin.html#method_onMetaParsed" class="">onMetaParsed()</a><br />
  186. <a href="../classes/DummyPlugin.html#method_onContentParsing" class="">onContentParsing()</a><br />
  187. <a href="../classes/DummyPlugin.html#method_prepareFileContent" class="">prepareFileContent()</a><br />
  188. <a href="../classes/DummyPlugin.html#method_onContentParsed" class="">onContentParsed()</a><br />
  189. <a href="../classes/DummyPlugin.html#method_onPagesLoading" class="">onPagesLoading()</a><br />
  190. <a href="../classes/DummyPlugin.html#method_onSinglePageLoaded" class="">onSinglePageLoaded()</a><br />
  191. <a href="../classes/DummyPlugin.html#method_onPagesLoaded" class="">onPagesLoaded()</a><br />
  192. <a href="../classes/DummyPlugin.html#method_onTwigRegistration" class="">onTwigRegistration()</a><br />
  193. <a href="../classes/DummyPlugin.html#method_onPageRendering" class="">onPageRendering()</a><br />
  194. <a href="../classes/DummyPlugin.html#method_onPageRendered" class="">onPageRendered()</a><br />
  195. </section>
  196. <section class="span4">
  197. <em>No public properties found</em>
  198. </section>
  199. <section class="span4">
  200. <em>No constants found</em>
  201. </section>
  202. </section>
  203. <section class="row-fluid protected">
  204. <section class="span4">
  205. <a href="../classes/AbstractPicoPlugin.html#method_checkDependencies" class="">checkDependencies()</a><br />
  206. <a href="../classes/AbstractPicoPlugin.html#method_checkDependants" class="">checkDependants()</a><br />
  207. </section>
  208. <section class="span4">
  209. <a href="../classes/DummyPlugin.html#property_enabled" class="">$enabled</a><br />
  210. <a href="../classes/AbstractPicoPlugin.html#property_statusChanged" class="">$statusChanged</a><br />
  211. <a href="../classes/DummyPlugin.html#property_dependsOn" class="">$dependsOn</a><br />
  212. </section>
  213. <section class="span4">
  214. <em>N/A</em>
  215. </section>
  216. </section>
  217. <section class="row-fluid private">
  218. <section class="span4">
  219. <em>No private methods found</em>
  220. </section>
  221. <section class="span4">
  222. <a href="../classes/AbstractPicoPlugin.html#property_pico" class="">$pico</a><br />
  223. <a href="../classes/AbstractPicoPlugin.html#property_dependants" class="">$dependants</a><br />
  224. </section>
  225. <section class="span4">
  226. <em>N/A</em>
  227. </section>
  228. </section>
  229. </section>
  230. </div>
  231. <aside class="span4 detailsbar">
  232. <dl>
  233. <dt>File</dt>
  234. <dd><a href="../files/plugins.DummyPlugin.html"><div class="path-wrapper">plugins/DummyPlugin.php</div></a></dd>
  235. <dt>Package</dt>
  236. <dd><div class="namespace-wrapper">Default</div></dd>
  237. <dt>Class hierarchy</dt>
  238. <dd class="hierarchy">
  239. <div class="namespace-wrapper"><a href="../classes/AbstractPicoPlugin.html">\AbstractPicoPlugin</a></div>
  240. <div class="namespace-wrapper">\DummyPlugin</div>
  241. </dd>
  242. <dt>See also</dt>
  243. <dd><a href="http://picocms.org"><span class="namespace-wrapper">http://picocms.org</span></a></dd>
  244. </dl>
  245. <h2>Tags</h2>
  246. <table class="table table-condensed">
  247. <tr>
  248. <th>
  249. author
  250. </th>
  251. <td>
  252. <p>Daniel Rudolf</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <th>
  257. license
  258. </th>
  259. <td>
  260. <p><a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></p>
  261. </td>
  262. </tr>
  263. <tr>
  264. <th>
  265. version
  266. </th>
  267. <td>
  268. </td>
  269. </tr>
  270. </table>
  271. </aside>
  272. </div>
  273. <a id="properties" name="properties"></a>
  274. <div class="row-fluid">
  275. <div class="span8 content class">
  276. <h2>Properties</h2>
  277. </div>
  278. <aside class="span4 detailsbar"></aside>
  279. </div>
  280. <div class="row-fluid">
  281. <div class="span8 content class">
  282. <a id="property_enabled" name="property_enabled" class="anchor"></a>
  283. <article class="property">
  284. <h3 class="protected ">$enabled</h3>
  285. <pre class="signature">$enabled : boolean</pre>
  286. <p><em>This plugin is enabled by default?</em></p>
  287. <h4>Type</h4>
  288. boolean
  289. </article>
  290. </div>
  291. <aside class="span4 detailsbar">
  292. <h1><i class="icon-arrow-down"></i></h1>
  293. <dl>
  294. <dt>See also</dt>
  295. <dd><a href="../classes/AbstractPicoPlugin.html#property_enabled"><span class="namespace-wrapper">\AbstractPicoPlugin::enabled</span></a></dd>
  296. </dl>
  297. <h2>Tags</h2>
  298. <table class="table table-condensed">
  299. <tr><td colspan="2"><em>None found</em></td></tr>
  300. </table>
  301. </aside>
  302. </div>
  303. <div class="row-fluid">
  304. <div class="span8 content class">
  305. <a id="property_statusChanged" name="property_statusChanged" class="anchor"></a>
  306. <article class="property">
  307. <h3 class="protected ">$statusChanged</h3>
  308. <pre class="signature">$statusChanged : boolean</pre>
  309. <p><em>Boolean indicating if this plugin was ever enabled/disabled manually</em></p>
  310. <h4>Type</h4>
  311. boolean
  312. </article>
  313. </div>
  314. <aside class="span4 detailsbar">
  315. <h1><i class="icon-arrow-down"></i></h1>
  316. <dl>
  317. <dt>Inherited from</dt>
  318. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  319. <dt>See also</dt>
  320. <dd><a href="../classes/PicoPluginInterface.html#method_isStatusChanged"><span class="namespace-wrapper">\PicoPluginInterface::isStatusChanged()</span></a></dd>
  321. </dl>
  322. <h2>Tags</h2>
  323. <table class="table table-condensed">
  324. <tr><td colspan="2"><em>None found</em></td></tr>
  325. </table>
  326. </aside>
  327. </div>
  328. <div class="row-fluid">
  329. <div class="span8 content class">
  330. <a id="property_dependsOn" name="property_dependsOn" class="anchor"></a>
  331. <article class="property">
  332. <h3 class="protected ">$dependsOn</h3>
  333. <pre class="signature">$dependsOn : array&lt;mixed,string&gt;</pre>
  334. <p><em>This plugin depends on .</em></p>
  335. <p>..</p>
  336. <h4>Type</h4>
  337. array&lt;mixed,string&gt;
  338. </article>
  339. </div>
  340. <aside class="span4 detailsbar">
  341. <h1><i class="icon-arrow-down"></i></h1>
  342. <dl>
  343. <dt>See also</dt>
  344. <dd><a href="../classes/AbstractPicoPlugin.html#property_dependsOn"><span class="namespace-wrapper">\AbstractPicoPlugin::dependsOn</span></a></dd>
  345. </dl>
  346. <h2>Tags</h2>
  347. <table class="table table-condensed">
  348. <tr><td colspan="2"><em>None found</em></td></tr>
  349. </table>
  350. </aside>
  351. </div>
  352. <div class="row-fluid">
  353. <div class="span8 content class">
  354. <a id="property_pico" name="property_pico" class="anchor"></a>
  355. <article class="property">
  356. <h3 class="private ">$pico</h3>
  357. <pre class="signature">$pico : \Pico</pre>
  358. <p><em>Current instance of Pico</em></p>
  359. <h4>Type</h4>
  360. <a href="../classes/Pico.html">\Pico</a>
  361. </article>
  362. </div>
  363. <aside class="span4 detailsbar">
  364. <h1><i class="icon-arrow-down"></i></h1>
  365. <dl>
  366. <dt>Inherited from</dt>
  367. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  368. <dt>See also</dt>
  369. <dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
  370. </dl>
  371. <h2>Tags</h2>
  372. <table class="table table-condensed">
  373. <tr><td colspan="2"><em>None found</em></td></tr>
  374. </table>
  375. </aside>
  376. </div>
  377. <div class="row-fluid">
  378. <div class="span8 content class">
  379. <a id="property_dependants" name="property_dependants" class="anchor"></a>
  380. <article class="property">
  381. <h3 class="private ">$dependants</h3>
  382. <pre class="signature">$dependants : array&lt;mixed,object&gt;</pre>
  383. <p><em>List of plugin which depend on this plugin</em></p>
  384. <h4>Type</h4>
  385. array&lt;mixed,object&gt;
  386. </article>
  387. </div>
  388. <aside class="span4 detailsbar">
  389. <h1><i class="icon-arrow-down"></i></h1>
  390. <dl>
  391. <dt>Inherited from</dt>
  392. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  393. <dt>See also</dt>
  394. <dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependants"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependants()</span></a></dd>
  395. <dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
  396. </dl>
  397. <h2>Tags</h2>
  398. <table class="table table-condensed">
  399. <tr><td colspan="2"><em>None found</em></td></tr>
  400. </table>
  401. </aside>
  402. </div>
  403. <a id="methods" name="methods"></a>
  404. <div class="row-fluid">
  405. <div class="span8 content class"><h2>Methods</h2></div>
  406. <aside class="span4 detailsbar"></aside>
  407. </div>
  408. <div class="row-fluid">
  409. <div class="span8 content class">
  410. <a id="method___construct" name="method___construct" class="anchor"></a>
  411. <article class="method">
  412. <h3 class="public ">__construct()</h3>
  413. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  414. <pre class="signature" style="margin-right: 54px;">__construct(\Pico <span class="argument">$pico</span>) </pre>
  415. <p><em>Constructs a new instance of a Pico plugin</em></p>
  416. <h4>Parameters</h4>
  417. <table class="table table-condensed table-hover">
  418. <tr>
  419. <td><a href="../classes/Pico.html">\Pico</a></td>
  420. <td>$pico </td>
  421. <td><p>current instance of Pico</p></td>
  422. </tr>
  423. </table>
  424. </article>
  425. </div>
  426. <aside class="span4 detailsbar">
  427. <h1><i class="icon-arrow-down"></i></h1>
  428. <dl>
  429. <dt>Inherited from</dt>
  430. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  431. <dt>See also</dt>
  432. <dd><a href="../classes/PicoPluginInterface.html#method___construct"><span class="namespace-wrapper">\PicoPluginInterface::__construct()</span></a></dd>
  433. </dl>
  434. <h2>Tags</h2>
  435. <table class="table table-condensed">
  436. <tr><td colspan="2"><em>None found</em></td></tr>
  437. </table>
  438. </aside>
  439. </div>
  440. <div class="row-fluid">
  441. <div class="span8 content class">
  442. <a id="method_handleEvent" name="method_handleEvent" class="anchor"></a>
  443. <article class="method">
  444. <h3 class="public ">handleEvent()</h3>
  445. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  446. <pre class="signature" style="margin-right: 54px;">handleEvent(string <span class="argument">$eventName</span>, array <span class="argument">$params</span>) : void</pre>
  447. <p><em>Handles a event that was triggered by Pico</em></p>
  448. <h4>Parameters</h4>
  449. <table class="table table-condensed table-hover">
  450. <tr>
  451. <td>string</td>
  452. <td>$eventName </td>
  453. <td><p>name of the triggered event</p></td>
  454. </tr>
  455. <tr>
  456. <td>array</td>
  457. <td>$params </td>
  458. <td><p>passed parameters</p></td>
  459. </tr>
  460. </table>
  461. </article>
  462. </div>
  463. <aside class="span4 detailsbar">
  464. <h1><i class="icon-arrow-down"></i></h1>
  465. <dl>
  466. <dt>Inherited from</dt>
  467. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  468. <dt>See also</dt>
  469. <dd><a href="../classes/PicoPluginInterface.html#method_handleEvent"><span class="namespace-wrapper">\PicoPluginInterface::handleEvent()</span></a></dd>
  470. </dl>
  471. <h2>Tags</h2>
  472. <table class="table table-condensed">
  473. <tr><td colspan="2"><em>None found</em></td></tr>
  474. </table>
  475. </aside>
  476. </div>
  477. <div class="row-fluid">
  478. <div class="span8 content class">
  479. <a id="method_setEnabled" name="method_setEnabled" class="anchor"></a>
  480. <article class="method">
  481. <h3 class="public ">setEnabled()</h3>
  482. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  483. <pre class="signature" style="margin-right: 54px;">setEnabled(boolean <span class="argument">$enabled</span>, boolean <span class="argument">$recursive = true</span>, boolean <span class="argument">$auto = false</span>) : void</pre>
  484. <p><em>Enables or disables this plugin</em></p>
  485. <h4>Parameters</h4>
  486. <table class="table table-condensed table-hover">
  487. <tr>
  488. <td>boolean</td>
  489. <td>$enabled </td>
  490. <td><p>enable (true) or disable (false) this plugin</p></td>
  491. </tr>
  492. <tr>
  493. <td>boolean</td>
  494. <td>$recursive </td>
  495. <td><p>when true, enable or disable recursively
  496. In other words, if you enable a plugin, all required plugins are
  497. enabled, too. When disabling a plugin, all depending plugins are
  498. disabled likewise. Recursive operations are only performed as long
  499. as a plugin wasn't enabled/disabled manually. This parameter is
  500. optional and defaults to true.</p></td>
  501. </tr>
  502. <tr>
  503. <td>boolean</td>
  504. <td>$auto </td>
  505. <td><p>enable or disable to fulfill a dependency
  506. This parameter is optional and defaults to false.</p></td>
  507. </tr>
  508. </table>
  509. </article>
  510. </div>
  511. <aside class="span4 detailsbar">
  512. <h1><i class="icon-arrow-down"></i></h1>
  513. <dl>
  514. <dt>Inherited from</dt>
  515. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  516. <dt>See also</dt>
  517. <dd><a href="../classes/PicoPluginInterface.html#method_setEnabled"><span class="namespace-wrapper">\PicoPluginInterface::setEnabled()</span></a></dd>
  518. </dl>
  519. <h2>Tags</h2>
  520. <table class="table table-condensed">
  521. <tr><td colspan="2"><em>None found</em></td></tr>
  522. </table>
  523. </aside>
  524. </div>
  525. <div class="row-fluid">
  526. <div class="span8 content class">
  527. <a id="method_isEnabled" name="method_isEnabled" class="anchor"></a>
  528. <article class="method">
  529. <h3 class="public ">isEnabled()</h3>
  530. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  531. <pre class="signature" style="margin-right: 54px;">isEnabled() : boolean</pre>
  532. <p><em>Returns true if this plugin is enabled, false otherwise</em></p>
  533. <h4>Returns</h4>
  534. boolean
  535. &mdash; <p>plugin is enabled (true) or disabled (false)</p>
  536. </article>
  537. </div>
  538. <aside class="span4 detailsbar">
  539. <h1><i class="icon-arrow-down"></i></h1>
  540. <dl>
  541. <dt>Inherited from</dt>
  542. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  543. <dt>See also</dt>
  544. <dd><a href="../classes/PicoPluginInterface.html#method_isEnabled"><span class="namespace-wrapper">\PicoPluginInterface::isEnabled()</span></a></dd>
  545. </dl>
  546. <h2>Tags</h2>
  547. <table class="table table-condensed">
  548. <tr><td colspan="2"><em>None found</em></td></tr>
  549. </table>
  550. </aside>
  551. </div>
  552. <div class="row-fluid">
  553. <div class="span8 content class">
  554. <a id="method_isStatusChanged" name="method_isStatusChanged" class="anchor"></a>
  555. <article class="method">
  556. <h3 class="public ">isStatusChanged()</h3>
  557. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  558. <pre class="signature" style="margin-right: 54px;">isStatusChanged() : boolean</pre>
  559. <p><em>Returns true if the plugin was ever enabled/disabled manually</em></p>
  560. <h4>Returns</h4>
  561. boolean
  562. &mdash; <p>plugin is in its default state (true), false otherwise</p>
  563. </article>
  564. </div>
  565. <aside class="span4 detailsbar">
  566. <h1><i class="icon-arrow-down"></i></h1>
  567. <dl>
  568. <dt>Inherited from</dt>
  569. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  570. <dt>See also</dt>
  571. <dd><a href="../classes/PicoPluginInterface.html#method_isStatusChanged"><span class="namespace-wrapper">\PicoPluginInterface::isStatusChanged()</span></a></dd>
  572. </dl>
  573. <h2>Tags</h2>
  574. <table class="table table-condensed">
  575. <tr><td colspan="2"><em>None found</em></td></tr>
  576. </table>
  577. </aside>
  578. </div>
  579. <div class="row-fluid">
  580. <div class="span8 content class">
  581. <a id="method_getPico" name="method_getPico" class="anchor"></a>
  582. <article class="method">
  583. <h3 class="public ">getPico()</h3>
  584. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  585. <pre class="signature" style="margin-right: 54px;">getPico() : \Pico</pre>
  586. <p><em>Returns the plugins instance of Pico</em></p>
  587. <h4>Returns</h4>
  588. <a href="../classes/Pico.html">\Pico</a>
  589. &mdash; <p>the plugins instance of Pico</p>
  590. </article>
  591. </div>
  592. <aside class="span4 detailsbar">
  593. <h1><i class="icon-arrow-down"></i></h1>
  594. <dl>
  595. <dt>Inherited from</dt>
  596. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  597. <dt>See also</dt>
  598. <dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
  599. </dl>
  600. <h2>Tags</h2>
  601. <table class="table table-condensed">
  602. <tr><td colspan="2"><em>None found</em></td></tr>
  603. </table>
  604. </aside>
  605. </div>
  606. <div class="row-fluid">
  607. <div class="span8 content class">
  608. <a id="method___call" name="method___call" class="anchor"></a>
  609. <article class="method">
  610. <h3 class="public ">__call()</h3>
  611. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  612. <pre class="signature" style="margin-right: 54px;">__call(string <span class="argument">$methodName</span>, array <span class="argument">$params</span>) : mixed</pre>
  613. <p><em>Passes all not satisfiable method calls to Pico</em></p>
  614. <h4>Parameters</h4>
  615. <table class="table table-condensed table-hover">
  616. <tr>
  617. <td>string</td>
  618. <td>$methodName </td>
  619. <td><p>name of the method to call</p></td>
  620. </tr>
  621. <tr>
  622. <td>array</td>
  623. <td>$params </td>
  624. <td><p>parameters to pass</p></td>
  625. </tr>
  626. </table>
  627. <h4>Returns</h4>
  628. mixed
  629. &mdash; <p>return value of the called method</p>
  630. </article>
  631. </div>
  632. <aside class="span4 detailsbar">
  633. <h1><i class="icon-arrow-down"></i></h1>
  634. <dl>
  635. <dt>Inherited from</dt>
  636. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  637. <dt>See also</dt>
  638. <dd><a href="../classes/Pico.html"><span class="namespace-wrapper">\Pico</span></a></dd>
  639. </dl>
  640. <h2>Tags</h2>
  641. <table class="table table-condensed">
  642. <tr><td colspan="2"><em>None found</em></td></tr>
  643. </table>
  644. </aside>
  645. </div>
  646. <div class="row-fluid">
  647. <div class="span8 content class">
  648. <a id="method_getDependencies" name="method_getDependencies" class="anchor"></a>
  649. <article class="method">
  650. <h3 class="public ">getDependencies()</h3>
  651. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  652. <pre class="signature" style="margin-right: 54px;">getDependencies() : array&lt;mixed,string&gt;</pre>
  653. <p><em>Returns a list of names of plugins required by this plugin</em></p>
  654. <h4>Returns</h4>
  655. array&lt;mixed,string&gt;
  656. &mdash; <p>required plugins</p>
  657. </article>
  658. </div>
  659. <aside class="span4 detailsbar">
  660. <h1><i class="icon-arrow-down"></i></h1>
  661. <dl>
  662. <dt>Inherited from</dt>
  663. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  664. <dt>See also</dt>
  665. <dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
  666. </dl>
  667. <h2>Tags</h2>
  668. <table class="table table-condensed">
  669. <tr><td colspan="2"><em>None found</em></td></tr>
  670. </table>
  671. </aside>
  672. </div>
  673. <div class="row-fluid">
  674. <div class="span8 content class">
  675. <a id="method_getDependants" name="method_getDependants" class="anchor"></a>
  676. <article class="method">
  677. <h3 class="public ">getDependants()</h3>
  678. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  679. <pre class="signature" style="margin-right: 54px;">getDependants() : array&lt;mixed,object&gt;</pre>
  680. <p><em>Returns a list of plugins which depend on this plugin</em></p>
  681. <h4>Returns</h4>
  682. array&lt;mixed,object&gt;
  683. &mdash; <p>dependant plugins</p>
  684. </article>
  685. </div>
  686. <aside class="span4 detailsbar">
  687. <h1><i class="icon-arrow-down"></i></h1>
  688. <dl>
  689. <dt>Inherited from</dt>
  690. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  691. <dt>See also</dt>
  692. <dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
  693. </dl>
  694. <h2>Tags</h2>
  695. <table class="table table-condensed">
  696. <tr><td colspan="2"><em>None found</em></td></tr>
  697. </table>
  698. </aside>
  699. </div>
  700. <div class="row-fluid">
  701. <div class="span8 content class">
  702. <a id="method_onPluginsLoaded" name="method_onPluginsLoaded" class="anchor"></a>
  703. <article class="method">
  704. <h3 class="public ">onPluginsLoaded()</h3>
  705. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  706. <pre class="signature" style="margin-right: 54px;">onPluginsLoaded( <span class="argument">$plugins</span>) : void</pre>
  707. <p><em>Triggered after Pico has loaded all available plugins</em></p>
  708. <p>This event is triggered nevertheless the plugin is enabled or not.
  709. It is NOT guaranteed that plugin dependencies are fulfilled!</p>
  710. <h4>Parameters</h4>
  711. <table class="table table-condensed table-hover">
  712. <tr>
  713. <td></td>
  714. <td>$plugins </td>
  715. <td></td>
  716. </tr>
  717. </table>
  718. </article>
  719. </div>
  720. <aside class="span4 detailsbar">
  721. <h1><i class="icon-arrow-down"></i></h1>
  722. <dl>
  723. <dt>See also</dt>
  724. <dd><a href="../classes/Pico.html#method_getPlugin"><span class="namespace-wrapper">\Pico::getPlugin()</span></a></dd>
  725. <dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
  726. </dl>
  727. <h2>Tags</h2>
  728. <table class="table table-condensed">
  729. <tr><td colspan="2"><em>None found</em></td></tr>
  730. </table>
  731. </aside>
  732. </div>
  733. <div class="row-fluid">
  734. <div class="span8 content class">
  735. <a id="method_onConfigLoaded" name="method_onConfigLoaded" class="anchor"></a>
  736. <article class="method">
  737. <h3 class="public ">onConfigLoaded()</h3>
  738. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  739. <pre class="signature" style="margin-right: 54px;">onConfigLoaded( <span class="argument">$config</span>) : void</pre>
  740. <p><em>Triggered after Pico has read its configuration</em></p>
  741. <h4>Parameters</h4>
  742. <table class="table table-condensed table-hover">
  743. <tr>
  744. <td></td>
  745. <td>$config </td>
  746. <td></td>
  747. </tr>
  748. </table>
  749. </article>
  750. </div>
  751. <aside class="span4 detailsbar">
  752. <h1><i class="icon-arrow-down"></i></h1>
  753. <dl>
  754. <dt>See also</dt>
  755. <dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
  756. </dl>
  757. <h2>Tags</h2>
  758. <table class="table table-condensed">
  759. <tr><td colspan="2"><em>None found</em></td></tr>
  760. </table>
  761. </aside>
  762. </div>
  763. <div class="row-fluid">
  764. <div class="span8 content class">
  765. <a id="method_onRequestUrl" name="method_onRequestUrl" class="anchor"></a>
  766. <article class="method">
  767. <h3 class="public ">onRequestUrl()</h3>
  768. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  769. <pre class="signature" style="margin-right: 54px;">onRequestUrl( <span class="argument">$url</span>) : void</pre>
  770. <p><em>Triggered after Pico has evaluated the request URL</em></p>
  771. <h4>Parameters</h4>
  772. <table class="table table-condensed table-hover">
  773. <tr>
  774. <td></td>
  775. <td>$url </td>
  776. <td></td>
  777. </tr>
  778. </table>
  779. </article>
  780. </div>
  781. <aside class="span4 detailsbar">
  782. <h1><i class="icon-arrow-down"></i></h1>
  783. <dl>
  784. <dt>See also</dt>
  785. <dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
  786. </dl>
  787. <h2>Tags</h2>
  788. <table class="table table-condensed">
  789. <tr><td colspan="2"><em>None found</em></td></tr>
  790. </table>
  791. </aside>
  792. </div>
  793. <div class="row-fluid">
  794. <div class="span8 content class">
  795. <a id="method_onRequestFile" name="method_onRequestFile" class="anchor"></a>
  796. <article class="method">
  797. <h3 class="public ">onRequestFile()</h3>
  798. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  799. <pre class="signature" style="margin-right: 54px;">onRequestFile( <span class="argument">$file</span>) : void</pre>
  800. <p><em>Triggered after Pico has discovered the content file to serve</em></p>
  801. <h4>Parameters</h4>
  802. <table class="table table-condensed table-hover">
  803. <tr>
  804. <td></td>
  805. <td>$file </td>
  806. <td></td>
  807. </tr>
  808. </table>
  809. </article>
  810. </div>
  811. <aside class="span4 detailsbar">
  812. <h1><i class="icon-arrow-down"></i></h1>
  813. <dl>
  814. <dt>See also</dt>
  815. <dd><a href="../classes/Pico.html#method_getBaseUrl"><span class="namespace-wrapper">\Pico::getBaseUrl()</span></a></dd>
  816. <dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
  817. </dl>
  818. <h2>Tags</h2>
  819. <table class="table table-condensed">
  820. <tr><td colspan="2"><em>None found</em></td></tr>
  821. </table>
  822. </aside>
  823. </div>
  824. <div class="row-fluid">
  825. <div class="span8 content class">
  826. <a id="method_onContentLoading" name="method_onContentLoading" class="anchor"></a>
  827. <article class="method">
  828. <h3 class="public ">onContentLoading()</h3>
  829. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  830. <pre class="signature" style="margin-right: 54px;">onContentLoading( <span class="argument">$file</span>) : void</pre>
  831. <p><em>Triggered before Pico reads the contents of the file to serve</em></p>
  832. <h4>Parameters</h4>
  833. <table class="table table-condensed table-hover">
  834. <tr>
  835. <td></td>
  836. <td>$file </td>
  837. <td></td>
  838. </tr>
  839. </table>
  840. </article>
  841. </div>
  842. <aside class="span4 detailsbar">
  843. <h1><i class="icon-arrow-down"></i></h1>
  844. <dl>
  845. <dt>See also</dt>
  846. <dd><a href="../classes/Pico.html#method_loadFileContent"><span class="namespace-wrapper">\Pico::loadFileContent()</span></a></dd>
  847. <dd><a href="../classes/DummyPlugin.html#method_onContentLoaded"><span class="namespace-wrapper">\DummyPlugin::onContentLoaded()</span></a></dd>
  848. </dl>
  849. <h2>Tags</h2>
  850. <table class="table table-condensed">
  851. <tr><td colspan="2"><em>None found</em></td></tr>
  852. </table>
  853. </aside>
  854. </div>
  855. <div class="row-fluid">
  856. <div class="span8 content class">
  857. <a id="method_onContentLoaded" name="method_onContentLoaded" class="anchor"></a>
  858. <article class="method">
  859. <h3 class="public ">onContentLoaded()</h3>
  860. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  861. <pre class="signature" style="margin-right: 54px;">onContentLoaded( <span class="argument">$rawContent</span>) : void</pre>
  862. <p><em>Triggered after Pico has read the contents of the file to serve</em></p>
  863. <h4>Parameters</h4>
  864. <table class="table table-condensed table-hover">
  865. <tr>
  866. <td></td>
  867. <td>$rawContent </td>
  868. <td></td>
  869. </tr>
  870. </table>
  871. </article>
  872. </div>
  873. <aside class="span4 detailsbar">
  874. <h1><i class="icon-arrow-down"></i></h1>
  875. <dl>
  876. <dt>See also</dt>
  877. <dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
  878. </dl>
  879. <h2>Tags</h2>
  880. <table class="table table-condensed">
  881. <tr><td colspan="2"><em>None found</em></td></tr>
  882. </table>
  883. </aside>
  884. </div>
  885. <div class="row-fluid">
  886. <div class="span8 content class">
  887. <a id="method_on404ContentLoading" name="method_on404ContentLoading" class="anchor"></a>
  888. <article class="method">
  889. <h3 class="public ">on404ContentLoading()</h3>
  890. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  891. <pre class="signature" style="margin-right: 54px;">on404ContentLoading( <span class="argument">$file</span>) : void</pre>
  892. <p><em>Triggered before Pico reads the contents of a 404 file</em></p>
  893. <h4>Parameters</h4>
  894. <table class="table table-condensed table-hover">
  895. <tr>
  896. <td></td>
  897. <td>$file </td>
  898. <td></td>
  899. </tr>
  900. </table>
  901. </article>
  902. </div>
  903. <aside class="span4 detailsbar">
  904. <h1><i class="icon-arrow-down"></i></h1>
  905. <dl>
  906. <dt>See also</dt>
  907. <dd><a href="../classes/Pico.html#method_load404Content"><span class="namespace-wrapper">\Pico::load404Content()</span></a></dd>
  908. <dd><a href="../classes/DummyPlugin.html#method_on404ContentLoaded"><span class="namespace-wrapper">\DummyPlugin::on404ContentLoaded()</span></a></dd>
  909. </dl>
  910. <h2>Tags</h2>
  911. <table class="table table-condensed">
  912. <tr><td colspan="2"><em>None found</em></td></tr>
  913. </table>
  914. </aside>
  915. </div>
  916. <div class="row-fluid">
  917. <div class="span8 content class">
  918. <a id="method_on404ContentLoaded" name="method_on404ContentLoaded" class="anchor"></a>
  919. <article class="method">
  920. <h3 class="public ">on404ContentLoaded()</h3>
  921. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  922. <pre class="signature" style="margin-right: 54px;">on404ContentLoaded( <span class="argument">$rawContent</span>) : void</pre>
  923. <p><em>Triggered after Pico has read the contents of the 404 file</em></p>
  924. <h4>Parameters</h4>
  925. <table class="table table-condensed table-hover">
  926. <tr>
  927. <td></td>
  928. <td>$rawContent </td>
  929. <td></td>
  930. </tr>
  931. </table>
  932. </article>
  933. </div>
  934. <aside class="span4 detailsbar">
  935. <h1><i class="icon-arrow-down"></i></h1>
  936. <dl>
  937. <dt>See also</dt>
  938. <dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
  939. </dl>
  940. <h2>Tags</h2>
  941. <table class="table table-condensed">
  942. <tr><td colspan="2"><em>None found</em></td></tr>
  943. </table>
  944. </aside>
  945. </div>
  946. <div class="row-fluid">
  947. <div class="span8 content class">
  948. <a id="method_onMetaHeaders" name="method_onMetaHeaders" class="anchor"></a>
  949. <article class="method">
  950. <h3 class="public ">onMetaHeaders()</h3>
  951. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  952. <pre class="signature" style="margin-right: 54px;">onMetaHeaders( <span class="argument">$headers</span>) : void</pre>
  953. <p><em>Triggered when Pico reads its known meta header fields</em></p>
  954. <h4>Parameters</h4>
  955. <table class="table table-condensed table-hover">
  956. <tr>
  957. <td></td>
  958. <td>$headers </td>
  959. <td></td>
  960. </tr>
  961. </table>
  962. </article>
  963. </div>
  964. <aside class="span4 detailsbar">
  965. <h1><i class="icon-arrow-down"></i></h1>
  966. <dl>
  967. <dt>See also</dt>
  968. <dd><a href="../classes/Pico.html#method_getMetaHeaders"><span class="namespace-wrapper">\Pico::getMetaHeaders()</span></a></dd>
  969. </dl>
  970. <h2>Tags</h2>
  971. <table class="table table-condensed">
  972. <tr><td colspan="2"><em>None found</em></td></tr>
  973. </table>
  974. </aside>
  975. </div>
  976. <div class="row-fluid">
  977. <div class="span8 content class">
  978. <a id="method_onMetaParsing" name="method_onMetaParsing" class="anchor"></a>
  979. <article class="method">
  980. <h3 class="public ">onMetaParsing()</h3>
  981. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  982. <pre class="signature" style="margin-right: 54px;">onMetaParsing( <span class="argument">$rawContent</span>, <span class="argument">$headers</span>) : void</pre>
  983. <p><em>Triggered before Pico parses the meta header</em></p>
  984. <h4>Parameters</h4>
  985. <table class="table table-condensed table-hover">
  986. <tr>
  987. <td></td>
  988. <td>$rawContent </td>
  989. <td></td>
  990. </tr>
  991. <tr>
  992. <td></td>
  993. <td>$headers </td>
  994. <td></td>
  995. </tr>
  996. </table>
  997. </article>
  998. </div>
  999. <aside class="span4 detailsbar">
  1000. <h1><i class="icon-arrow-down"></i></h1>
  1001. <dl>
  1002. <dt>See also</dt>
  1003. <dd><a href="../classes/Pico.html#method_parseFileMeta"><span class="namespace-wrapper">\Pico::parseFileMeta()</span></a></dd>
  1004. <dd><a href="../classes/DummyPlugin.html#method_onMetaParsed"><span class="namespace-wrapper">\DummyPlugin::onMetaParsed()</span></a></dd>
  1005. </dl>
  1006. <h2>Tags</h2>
  1007. <table class="table table-condensed">
  1008. <tr><td colspan="2"><em>None found</em></td></tr>
  1009. </table>
  1010. </aside>
  1011. </div>
  1012. <div class="row-fluid">
  1013. <div class="span8 content class">
  1014. <a id="method_onMetaParsed" name="method_onMetaParsed" class="anchor"></a>
  1015. <article class="method">
  1016. <h3 class="public ">onMetaParsed()</h3>
  1017. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1018. <pre class="signature" style="margin-right: 54px;">onMetaParsed( <span class="argument">$meta</span>) : void</pre>
  1019. <p><em>Triggered after Pico has parsed the meta header</em></p>
  1020. <h4>Parameters</h4>
  1021. <table class="table table-condensed table-hover">
  1022. <tr>
  1023. <td></td>
  1024. <td>$meta </td>
  1025. <td></td>
  1026. </tr>
  1027. </table>
  1028. </article>
  1029. </div>
  1030. <aside class="span4 detailsbar">
  1031. <h1><i class="icon-arrow-down"></i></h1>
  1032. <dl>
  1033. <dt>See also</dt>
  1034. <dd><a href="../classes/Pico.html#method_getFileMeta"><span class="namespace-wrapper">\Pico::getFileMeta()</span></a></dd>
  1035. </dl>
  1036. <h2>Tags</h2>
  1037. <table class="table table-condensed">
  1038. <tr><td colspan="2"><em>None found</em></td></tr>
  1039. </table>
  1040. </aside>
  1041. </div>
  1042. <div class="row-fluid">
  1043. <div class="span8 content class">
  1044. <a id="method_onContentParsing" name="method_onContentParsing" class="anchor"></a>
  1045. <article class="method">
  1046. <h3 class="public ">onContentParsing()</h3>
  1047. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1048. <pre class="signature" style="margin-right: 54px;">onContentParsing( <span class="argument">$rawContent</span>) : void</pre>
  1049. <p><em>Triggered before Pico parses the pages content</em></p>
  1050. <h4>Parameters</h4>
  1051. <table class="table table-condensed table-hover">
  1052. <tr>
  1053. <td></td>
  1054. <td>$rawContent </td>
  1055. <td></td>
  1056. </tr>
  1057. </table>
  1058. </article>
  1059. </div>
  1060. <aside class="span4 detailsbar">
  1061. <h1><i class="icon-arrow-down"></i></h1>
  1062. <dl>
  1063. <dt>See also</dt>
  1064. <dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
  1065. <dd><a href="../classes/DummyPlugin.html#method_prepareFileContent"><span class="namespace-wrapper">\DummyPlugin::prepareFileContent()</span></a></dd>
  1066. <dd><a href="../classes/DummyPlugin.html#method_onContentParsed"><span class="namespace-wrapper">\DummyPlugin::onContentParsed()</span></a></dd>
  1067. </dl>
  1068. <h2>Tags</h2>
  1069. <table class="table table-condensed">
  1070. <tr><td colspan="2"><em>None found</em></td></tr>
  1071. </table>
  1072. </aside>
  1073. </div>
  1074. <div class="row-fluid">
  1075. <div class="span8 content class">
  1076. <a id="method_prepareFileContent" name="method_prepareFileContent" class="anchor"></a>
  1077. <article class="method">
  1078. <h3 class="public ">prepareFileContent()</h3>
  1079. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1080. <pre class="signature" style="margin-right: 54px;">prepareFileContent( <span class="argument">$content</span>) : void</pre>
  1081. <p><em>Triggered after Pico has prepared the raw file contents for parsing</em></p>
  1082. <h4>Parameters</h4>
  1083. <table class="table table-condensed table-hover">
  1084. <tr>
  1085. <td></td>
  1086. <td>$content </td>
  1087. <td></td>
  1088. </tr>
  1089. </table>
  1090. </article>
  1091. </div>
  1092. <aside class="span4 detailsbar">
  1093. <h1><i class="icon-arrow-down"></i></h1>
  1094. <dl>
  1095. <dt>See also</dt>
  1096. <dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
  1097. <dd><a href="../classes/DummyPlugin.html#method_onContentParsed"><span class="namespace-wrapper">\DummyPlugin::onContentParsed()</span></a></dd>
  1098. </dl>
  1099. <h2>Tags</h2>
  1100. <table class="table table-condensed">
  1101. <tr><td colspan="2"><em>None found</em></td></tr>
  1102. </table>
  1103. </aside>
  1104. </div>
  1105. <div class="row-fluid">
  1106. <div class="span8 content class">
  1107. <a id="method_onContentParsed" name="method_onContentParsed" class="anchor"></a>
  1108. <article class="method">
  1109. <h3 class="public ">onContentParsed()</h3>
  1110. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1111. <pre class="signature" style="margin-right: 54px;">onContentParsed( <span class="argument">$content</span>) : void</pre>
  1112. <p><em>Triggered after Pico has parsed the contents of the file to serve</em></p>
  1113. <h4>Parameters</h4>
  1114. <table class="table table-condensed table-hover">
  1115. <tr>
  1116. <td></td>
  1117. <td>$content </td>
  1118. <td></td>
  1119. </tr>
  1120. </table>
  1121. </article>
  1122. </div>
  1123. <aside class="span4 detailsbar">
  1124. <h1><i class="icon-arrow-down"></i></h1>
  1125. <dl>
  1126. <dt>See also</dt>
  1127. <dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
  1128. </dl>
  1129. <h2>Tags</h2>
  1130. <table class="table table-condensed">
  1131. <tr><td colspan="2"><em>None found</em></td></tr>
  1132. </table>
  1133. </aside>
  1134. </div>
  1135. <div class="row-fluid">
  1136. <div class="span8 content class">
  1137. <a id="method_onPagesLoading" name="method_onPagesLoading" class="anchor"></a>
  1138. <article class="method">
  1139. <h3 class="public ">onPagesLoading()</h3>
  1140. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1141. <pre class="signature" style="margin-right: 54px;">onPagesLoading() : void</pre>
  1142. <p><em>Triggered before Pico reads all known pages</em></p>
  1143. </article>
  1144. </div>
  1145. <aside class="span4 detailsbar">
  1146. <h1><i class="icon-arrow-down"></i></h1>
  1147. <dl>
  1148. <dt>See also</dt>
  1149. <dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
  1150. <dd><a href="../classes/DummyPlugin.html#method_onSinglePageLoaded"><span class="namespace-wrapper">\DummyPlugin::onSinglePageLoaded()</span></a></dd>
  1151. <dd><a href="../classes/DummyPlugin.html#method_onPagesLoaded"><span class="namespace-wrapper">\DummyPlugin::onPagesLoaded()</span></a></dd>
  1152. </dl>
  1153. <h2>Tags</h2>
  1154. <table class="table table-condensed">
  1155. <tr><td colspan="2"><em>None found</em></td></tr>
  1156. </table>
  1157. </aside>
  1158. </div>
  1159. <div class="row-fluid">
  1160. <div class="span8 content class">
  1161. <a id="method_onSinglePageLoaded" name="method_onSinglePageLoaded" class="anchor"></a>
  1162. <article class="method">
  1163. <h3 class="public ">onSinglePageLoaded()</h3>
  1164. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1165. <pre class="signature" style="margin-right: 54px;">onSinglePageLoaded( <span class="argument">$pageData</span>) : void</pre>
  1166. <p><em>Triggered when Pico reads a single page from the list of all known pages</em></p>
  1167. <p>The <code>$pageData</code> parameter consists of the following values:</p>
  1168. <pre>
  1169. +----------------+--------+------------------------------------------+
  1170. | Array key | Type | Description |
  1171. +----------------+--------+------------------------------------------+
  1172. | id | string | relative path to the content file |
  1173. | url | string | URL to the page |
  1174. | title | string | title of the page (YAML header) |
  1175. | description | string | description of the page (YAML header) |
  1176. | author | string | author of the page (YAML header) |
  1177. | time | string | timestamp derived from the Date header |
  1178. | date | string | date of the page (YAML header) |
  1179. | date_formatted | string | formatted date of the page |
  1180. | raw_content | string | raw, not yet parsed contents of the page |
  1181. | meta | string | parsed meta data of the page |
  1182. +----------------+--------+------------------------------------------+
  1183. </pre>
  1184. <h4>Parameters</h4>
  1185. <table class="table table-condensed table-hover">
  1186. <tr>
  1187. <td></td>
  1188. <td>$pageData </td>
  1189. <td></td>
  1190. </tr>
  1191. </table>
  1192. </article>
  1193. </div>
  1194. <aside class="span4 detailsbar">
  1195. <h1><i class="icon-arrow-down"></i></h1>
  1196. <dl>
  1197. <dt>See also</dt>
  1198. <dd><a href="../classes/DummyPlugin.html#method_onPagesLoaded"><span class="namespace-wrapper">\DummyPlugin::onPagesLoaded()</span></a></dd>
  1199. </dl>
  1200. <h2>Tags</h2>
  1201. <table class="table table-condensed">
  1202. <tr><td colspan="2"><em>None found</em></td></tr>
  1203. </table>
  1204. </aside>
  1205. </div>
  1206. <div class="row-fluid">
  1207. <div class="span8 content class">
  1208. <a id="method_onPagesLoaded" name="method_onPagesLoaded" class="anchor"></a>
  1209. <article class="method">
  1210. <h3 class="public ">onPagesLoaded()</h3>
  1211. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1212. <pre class="signature" style="margin-right: 54px;">onPagesLoaded( <span class="argument">$pages</span>, <span class="argument">$currentPage</span>, <span class="argument">$previousPage</span>, <span class="argument">$nextPage</span>) : void</pre>
  1213. <p><em>Triggered after Pico has read all known pages</em></p>
  1214. <p>See <a href="/classes/DummyPlugin.html#method_onSinglePageLoaded">DummyPlugin::onSinglePageLoaded()</a> for details about the
  1215. structure of the page data.</p>
  1216. <h4>Parameters</h4>
  1217. <table class="table table-condensed table-hover">
  1218. <tr>
  1219. <td></td>
  1220. <td>$pages </td>
  1221. <td></td>
  1222. </tr>
  1223. <tr>
  1224. <td></td>
  1225. <td>$currentPage </td>
  1226. <td></td>
  1227. </tr>
  1228. <tr>
  1229. <td></td>
  1230. <td>$previousPage </td>
  1231. <td></td>
  1232. </tr>
  1233. <tr>
  1234. <td></td>
  1235. <td>$nextPage </td>
  1236. <td></td>
  1237. </tr>
  1238. </table>
  1239. </article>
  1240. </div>
  1241. <aside class="span4 detailsbar">
  1242. <h1><i class="icon-arrow-down"></i></h1>
  1243. <dl>
  1244. <dt>See also</dt>
  1245. <dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
  1246. <dd><a href="../classes/Pico.html#method_getCurrentPage"><span class="namespace-wrapper">\Pico::getCurrentPage()</span></a></dd>
  1247. <dd><a href="../classes/Pico.html#method_getPreviousPage"><span class="namespace-wrapper">\Pico::getPreviousPage()</span></a></dd>
  1248. <dd><a href="../classes/Pico.html#method_getNextPage"><span class="namespace-wrapper">\Pico::getNextPage()</span></a></dd>
  1249. </dl>
  1250. <h2>Tags</h2>
  1251. <table class="table table-condensed">
  1252. <tr><td colspan="2"><em>None found</em></td></tr>
  1253. </table>
  1254. </aside>
  1255. </div>
  1256. <div class="row-fluid">
  1257. <div class="span8 content class">
  1258. <a id="method_onTwigRegistration" name="method_onTwigRegistration" class="anchor"></a>
  1259. <article class="method">
  1260. <h3 class="public ">onTwigRegistration()</h3>
  1261. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1262. <pre class="signature" style="margin-right: 54px;">onTwigRegistration() : void</pre>
  1263. <p><em>Triggered before Pico registers the twig template engine</em></p>
  1264. </article>
  1265. </div>
  1266. <aside class="span4 detailsbar">
  1267. <h1><i class="icon-arrow-down"></i></h1>
  1268. <dl>
  1269. </dl>
  1270. <h2>Tags</h2>
  1271. <table class="table table-condensed">
  1272. <tr><td colspan="2"><em>None found</em></td></tr>
  1273. </table>
  1274. </aside>
  1275. </div>
  1276. <div class="row-fluid">
  1277. <div class="span8 content class">
  1278. <a id="method_onPageRendering" name="method_onPageRendering" class="anchor"></a>
  1279. <article class="method">
  1280. <h3 class="public ">onPageRendering()</h3>
  1281. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1282. <pre class="signature" style="margin-right: 54px;">onPageRendering( <span class="argument">$twig</span>, <span class="argument">$twigVariables</span>, <span class="argument">$templateName</span>) : void</pre>
  1283. <p><em>Triggered before Pico renders the page</em></p>
  1284. <h4>Parameters</h4>
  1285. <table class="table table-condensed table-hover">
  1286. <tr>
  1287. <td></td>
  1288. <td>$twig </td>
  1289. <td></td>
  1290. </tr>
  1291. <tr>
  1292. <td></td>
  1293. <td>$twigVariables </td>
  1294. <td></td>
  1295. </tr>
  1296. <tr>
  1297. <td></td>
  1298. <td>$templateName </td>
  1299. <td></td>
  1300. </tr>
  1301. </table>
  1302. </article>
  1303. </div>
  1304. <aside class="span4 detailsbar">
  1305. <h1><i class="icon-arrow-down"></i></h1>
  1306. <dl>
  1307. <dt>See also</dt>
  1308. <dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
  1309. <dd><a href="../classes/DummyPlugin.html#method_onPageRendered"><span class="namespace-wrapper">\DummyPlugin::onPageRendered()</span></a></dd>
  1310. </dl>
  1311. <h2>Tags</h2>
  1312. <table class="table table-condensed">
  1313. <tr><td colspan="2"><em>None found</em></td></tr>
  1314. </table>
  1315. </aside>
  1316. </div>
  1317. <div class="row-fluid">
  1318. <div class="span8 content class">
  1319. <a id="method_onPageRendered" name="method_onPageRendered" class="anchor"></a>
  1320. <article class="method">
  1321. <h3 class="public ">onPageRendered()</h3>
  1322. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1323. <pre class="signature" style="margin-right: 54px;">onPageRendered( <span class="argument">$output</span>) : void</pre>
  1324. <p><em>Triggered after Pico has rendered the page</em></p>
  1325. <h4>Parameters</h4>
  1326. <table class="table table-condensed table-hover">
  1327. <tr>
  1328. <td></td>
  1329. <td>$output </td>
  1330. <td></td>
  1331. </tr>
  1332. </table>
  1333. </article>
  1334. </div>
  1335. <aside class="span4 detailsbar">
  1336. <h1><i class="icon-arrow-down"></i></h1>
  1337. <dl>
  1338. </dl>
  1339. <h2>Tags</h2>
  1340. <table class="table table-condensed">
  1341. <tr><td colspan="2"><em>None found</em></td></tr>
  1342. </table>
  1343. </aside>
  1344. </div>
  1345. <div class="row-fluid">
  1346. <div class="span8 content class">
  1347. <a id="method_checkDependencies" name="method_checkDependencies" class="anchor"></a>
  1348. <article class="method">
  1349. <h3 class="protected ">checkDependencies()</h3>
  1350. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1351. <pre class="signature" style="margin-right: 54px;">checkDependencies(boolean <span class="argument">$recursive</span>) : void</pre>
  1352. <p><em>Enables all plugins which this plugin depends on</em></p>
  1353. <h4>Parameters</h4>
  1354. <table class="table table-condensed table-hover">
  1355. <tr>
  1356. <td>boolean</td>
  1357. <td>$recursive </td>
  1358. <td><p>enable required plugins automatically</p></td>
  1359. </tr>
  1360. </table>
  1361. <h4>Throws</h4>
  1362. <dl>
  1363. <dt>\RuntimeException</dt>
  1364. <dd><p>thrown when a dependency fails</p></dd>
  1365. </dl>
  1366. </article>
  1367. </div>
  1368. <aside class="span4 detailsbar">
  1369. <h1><i class="icon-arrow-down"></i></h1>
  1370. <dl>
  1371. <dt>Inherited from</dt>
  1372. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  1373. <dt>See also</dt>
  1374. <dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
  1375. </dl>
  1376. <h2>Tags</h2>
  1377. <table class="table table-condensed">
  1378. <tr><td colspan="2"><em>None found</em></td></tr>
  1379. </table>
  1380. </aside>
  1381. </div>
  1382. <div class="row-fluid">
  1383. <div class="span8 content class">
  1384. <a id="method_checkDependants" name="method_checkDependants" class="anchor"></a>
  1385. <article class="method">
  1386. <h3 class="protected ">checkDependants()</h3>
  1387. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  1388. <pre class="signature" style="margin-right: 54px;">checkDependants(boolean <span class="argument">$recursive</span>) : void</pre>
  1389. <p><em>Disables all plugins which depend on this plugin</em></p>
  1390. <h4>Parameters</h4>
  1391. <table class="table table-condensed table-hover">
  1392. <tr>
  1393. <td>boolean</td>
  1394. <td>$recursive </td>
  1395. <td><p>disabled dependant plugins automatically</p></td>
  1396. </tr>
  1397. </table>
  1398. <h4>Throws</h4>
  1399. <dl>
  1400. <dt>\RuntimeException</dt>
  1401. <dd><p>thrown when a dependency fails</p></dd>
  1402. </dl>
  1403. </article>
  1404. </div>
  1405. <aside class="span4 detailsbar">
  1406. <h1><i class="icon-arrow-down"></i></h1>
  1407. <dl>
  1408. <dt>Inherited from</dt>
  1409. <dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
  1410. <dt>See also</dt>
  1411. <dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
  1412. </dl>
  1413. <h2>Tags</h2>
  1414. <table class="table table-condensed">
  1415. <tr><td colspan="2"><em>None found</em></td></tr>
  1416. </table>
  1417. </aside>
  1418. </div>
  1419. </div>
  1420. </section>
  1421. <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
  1422. <div class="modal-header">
  1423. <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
  1424. <h3 id="source-view-label">DummyPlugin.php</h3>
  1425. </div>
  1426. <div class="modal-body">
  1427. <pre data-src="../files/plugins/DummyPlugin.php.txt" class="language-php line-numbers"></pre>
  1428. </div>
  1429. </div>
  1430. <footer class="row-fluid">
  1431. <section class="span10 offset2">
  1432. <section class="row-fluid">
  1433. <section class="span10 offset1">
  1434. <section class="row-fluid footer-sections">
  1435. <section class="span4">
  1436. <h1><i class="icon-code"></i></h1>
  1437. <div>
  1438. <ul>
  1439. </ul>
  1440. </div>
  1441. </section>
  1442. <section class="span4">
  1443. <h1><i class="icon-bar-chart"></i></h1>
  1444. <div>
  1445. <ul>
  1446. <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
  1447. </ul>
  1448. </div>
  1449. </section>
  1450. <section class="span4">
  1451. <h1><i class="icon-pushpin"></i></h1>
  1452. <div>
  1453. <ul>
  1454. <li><a href="../reports/errors.html">Errors</a></li>
  1455. <li><a href="../reports/markers.html">Markers</a></li>
  1456. </ul>
  1457. </div>
  1458. </section>
  1459. </section>
  1460. </section>
  1461. </section>
  1462. <section class="row-fluid">
  1463. <section class="span10 offset1">
  1464. <hr />
  1465. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
  1466. on November 3rd, 2015 at 16:05.
  1467. </section>
  1468. </section>
  1469. </section>
  1470. </footer>
  1471. </div>
  1472. </body>
  1473. </html>