We use cookies to ensure you get the best experience on our website
ホーム エクスプローラ ヘルプ
登録 サインイン
0ct0pu5
/
Pico
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki
ツリー: 3d17797b45
ブランチ タグ
Pico
/
phpDoc
/
master
/
classes
/
Pico.html

Pico.html 133 KB
履歴 Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4.     <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    5. 

  5.     <meta charset="utf-8"/>
    6. 

  6.     <title>Pico 1.0 API Documentation</title>
    7. 

  7.     <meta name="author" content=""/>
    8. 

  8.     <meta name="description" content=""/>
    9. 

  9. 

  10.     <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
    11. 

  11.     <link href="../css/font-awesome.min.css" rel="stylesheet">
    12. 

  12.     <link href="../css/prism.css" rel="stylesheet" media="all"/>
    13. 

  13.     <link href="../css/template.css" rel="stylesheet" media="all"/>
    14. 

  14.     
    15. 

  15.     <!--[if lt IE 9]>
    16. 

  16.     <script src="../js/html5.js"></script>
    17. 

  17.     <![endif]-->
    18. 

  18.     <script src="../js/jquery-1.11.0.min.js"></script>
    19. 

  19.     <script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
    20. 

  20.     <script src="../js/bootstrap.min.js"></script>
    21. 

  21.     <script src="../js/jquery.smooth-scroll.js"></script>
    22. 

  22.     <script src="../js/prism.min.js"></script>
    23. 

  23.     <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
    24. 

  24.     <script type="text/javascript">
    25. 

  25.     function loadExternalCodeSnippets() {
    26. 

  26.         Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
    27. 

  27.             var src = pre.getAttribute('data-src');
    28. 

  28.             var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
    29. 

  29.             var language = 'php';
    30. 

  30. 

  31.             var code = document.createElement('code');
    32. 

  32.             code.className = 'language-' + language;
    33. 

  33. 

  34.             pre.textContent = '';
    35. 

  35. 

  36.             code.textContent = 'Loading…';
    37. 

  37. 

  38.             pre.appendChild(code);
    39. 

  39. 

  40.             var xhr = new XMLHttpRequest();
    41. 

  41. 

  42.             xhr.open('GET', src, true);
    43. 

  43. 

  44.             xhr.onreadystatechange = function () {
    45. 

  45.                 if (xhr.readyState == 4) {
    46. 

  46. 

  47.                     if (xhr.status < 400 && xhr.responseText) {
    48. 

  48.                         code.textContent = xhr.responseText;
    49. 

  49. 

  50.                         Prism.highlightElement(code);
    51. 

  51.                     }
    52. 

  52.                     else if (xhr.status >= 400) {
    53. 

  53.                         code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
    54. 

  54.                     }
    55. 

  55.                     else {
    56. 

  56.                         code.textContent = '✖ Error: File does not exist or is empty';
    57. 

  57.                     }
    58. 

  58.                 }
    59. 

  59.             };
    60. 

  60. 

  61.             xhr.send(null);
    62. 

  62.         });
    63. 

  63.     }
    64. 

  64. 

  65.     $(document).ready(function(){
    66. 

  66.         loadExternalCodeSnippets();
    67. 

  67.     });
    68. 

  68.     $('#source-view').on('shown', function () {
    69. 

  69.         loadExternalCodeSnippets();
    70. 

  70.     })
    71. 

  71. </script>
    72. 

  72. 

  73.     <link rel="shortcut icon" href="../images/favicon.ico"/>
    74. 

  74.     <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
    75. 

  75.     <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
    76. 

  76.     <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
    77. 

  77. </head>
    78. 

  78. <body>
    79. 

  79. 

  80. <div class="navbar navbar-fixed-top">
    81. 

  81.     <div class="navbar-inner">
    82. 

  82.         <div class="container">
    83. 

  83.             <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
    84. 

  84.                 <i class="icon-ellipsis-vertical"></i>
    85. 

  85.             </a>
    86. 

  86.             <a class="brand" href="../index.html">Pico 1.0 API Documentation</a>
    87. 

  87. 

  88.             <div class="nav-collapse">
    89. 

  89.                 <ul class="nav pull-right">
    90. 

  90.                                         <li class="dropdown" id="charts-menu">
    91. 

  91.                         <a href="#" class="dropdown-toggle" data-toggle="dropdown">
    92. 

  92.                             Charts <b class="caret"></b>
    93. 

  93.                         </a>
    94. 

  94.                         <ul class="dropdown-menu">
    95. 

  95.                             <li>
    96. 

  96.                                 <a href="../graphs/class.html">
    97. 

  97.                                     <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
    98. 

  98.                                 </a>
    99. 

  99.                             </li>
    100. 

  100.                         </ul>
    101. 

  101.                     </li>
    102. 

  102.                     <li class="dropdown" id="reports-menu">
    103. 

  103.                         <a href="#" class="dropdown-toggle" data-toggle="dropdown">
    104. 

  104.                             Reports <b class="caret"></b>
    105. 

  105.                         </a>
    106. 

  106.                         <ul class="dropdown-menu">
    107. 

  107.                             <li>
    108. 

  108.                                 <a href="../reports/errors.html">
    109. 

  109.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">19</span>
    110. 

  110.                                 </a>
    111. 

  111.                             </li>
    112. 

  112.                             <li>
    113. 

  113.                                 <a href="../reports/markers.html">
    114. 

  114.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">1</span>
    115. 

  115.                                 </a>
    116. 

  116.                             </li>
    117. 

  117.                             <li>
    118. 

  118.                                 <a href="../reports/deprecated.html">
    119. 

  119.                                                                                                             <i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
    120. 

  120.                                 </a>
    121. 

  121.                             </li>
    122. 

  122.                         </ul>
    123. 

  123.                     </li>
    124. 

  124.                 </ul>
    125. 

  125.             </div>
    126. 

  126.         </div>
    127. 

  127.     </div>
    128. 

  128.     <!--<div class="go_to_top">-->
    129. 

  129.     <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
    130. 

  130.     <!--</div>-->
    131. 

  131. </div>
    132. 

  132. 

  133. <div id="___" class="container-fluid">
    134. 

  134.         <section class="row-fluid">
    135. 

  135.         <div class="span2 sidebar">
    136. 

  136.                                 <div class="accordion" style="margin-bottom: 0">
    137. 

  137.         <div class="accordion-group">
    138. 

  138.             <div class="accordion-heading">
    139. 

  139.                                     <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1354212884"></a>
    140. 

  140.                                 <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
    141. 

  141.             </div>
    142. 

  142.             <div id="namespace-1354212884" class="accordion-body collapse in">
    143. 

  143.                 <div class="accordion-inner">
    144. 

  144. 

  145.                     
    146. 

  146.                     <ul>
    147. 

  147.                                                     <li class="interface"><a href="../classes/PicoPluginInterface.html">PicoPluginInterface</a></li>
    148. 

  148.                                                                                                     <li class="class"><a href="../classes/AbstractPicoPlugin.html">AbstractPicoPlugin</a></li>
    149. 

  149.                                                     <li class="class"><a href="../classes/DummyPlugin.html">DummyPlugin</a></li>
    150. 

  150.                                                     <li class="class"><a href="../classes/Pico.html">Pico</a></li>
    151. 

  151.                                             </ul>
    152. 

  152.                 </div>
    153. 

  153.             </div>
    154. 

  154.         </div>
    155. 

  155.     </div>
    156. 

  156. 

  157.         </div>
    158. 

  158.     </section>
    159. 

  159.     <section class="row-fluid">
    160. 

  160.         <div class="span10 offset2">
    161. 

  161.             <div class="row-fluid">
    162. 

  162.                 <div class="span8 content class">
    163. 

  163.                     <nav>
    164. 

  164.                                                 <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
    165. 

  165.                                             </nav>
    166. 

  166.                     <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
    167. 

  167. 

  168.                     <h1><small>\</small>Pico</h1>
    169. 

  169.                     <p><em>Pico</em></p>
    170. 

  170.                     <p>Pico is a stupidly simple, blazing fast, flat file CMS.</p>
    171. 

  171. <ul>
    172. 

  172. <li>Stupidly Simple: Picos makes creating and maintaining a
    173. 

  173. website as simple as editing text files.</li>
    174. 

  174. <li>Blazing Fast: Pico is seriously lightweight and doesn't
    175. 

  175. use a database, making it super fast.</li>
    176. 

  176. <li>No Database: Pico is a &quot;flat file&quot; CMS, meaning no
    177. 

  177. database woes, no MySQL queries, nothing.</li>
    178. 

  178. <li>Markdown Formatting: Edit your website in your favourite
    179. 

  179. text editor using simple Markdown formatting.</li>
    180. 

  180. <li>Twig Templates: Pico uses the Twig templating engine,
    181. 

  181. for powerful and flexible themes.</li>
    182. 

  182. <li>Open Source: Pico is completely free and open source,
    183. 

  183. released under the MIT license.
    184. 

  184. See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
    185. 

  185. </ul>
    186. 

  186.                     
    187. 

  187.                                         
    188. 

  188.                     <section id="summary">
    189. 

  189.                         <h2>Summary</h2>
    190. 

  190.                         <section class="row-fluid heading">
    191. 

  191.                             <section class="span4">
    192. 

  192.                                 <a href="#methods">Methods</a>
    193. 

  193.                             </section>
    194. 

  194.                             <section class="span4">
    195. 

  195.                                 <a href="#properties">Properties</a>
    196. 

  196.                             </section>
    197. 

  197.                             <section class="span4">
    198. 

  198.                                 <a href="#constants">Constants</a>
    199. 

  199.                             </section>
    200. 

  200.                         </section>
    201. 

  201.                         <section class="row-fluid public">
    202. 

  202.                             <section class="span4">
    203. 

  203.                                                                     <a href="../classes/Pico.html#method___construct" class="">__construct()</a><br />
    204. 

  204.                                                                     <a href="../classes/Pico.html#method_getRootDir" class="">getRootDir()</a><br />
    205. 

  205.                                                                     <a href="../classes/Pico.html#method_getConfigDir" class="">getConfigDir()</a><br />
    206. 

  206.                                                                     <a href="../classes/Pico.html#method_getPluginsDir" class="">getPluginsDir()</a><br />
    207. 

  207.                                                                     <a href="../classes/Pico.html#method_getThemesDir" class="">getThemesDir()</a><br />
    208. 

  208.                                                                     <a href="../classes/Pico.html#method_run" class="">run()</a><br />
    209. 

  209.                                                                     <a href="../classes/Pico.html#method_getPlugin" class="">getPlugin()</a><br />
    210. 

  210.                                                                     <a href="../classes/Pico.html#method_getPlugins" class="">getPlugins()</a><br />
    211. 

  211.                                                                     <a href="../classes/Pico.html#method_setConfig" class="">setConfig()</a><br />
    212. 

  212.                                                                     <a href="../classes/Pico.html#method_getConfig" class="">getConfig()</a><br />
    213. 

  213.                                                                     <a href="../classes/Pico.html#method_getRequestUrl" class="">getRequestUrl()</a><br />
    214. 

  214.                                                                     <a href="../classes/Pico.html#method_getRequestFile" class="">getRequestFile()</a><br />
    215. 

  215.                                                                     <a href="../classes/Pico.html#method_loadFileContent" class="">loadFileContent()</a><br />
    216. 

  216.                                                                     <a href="../classes/Pico.html#method_load404Content" class="">load404Content()</a><br />
    217. 

  217.                                                                     <a href="../classes/Pico.html#method_getRawContent" class="">getRawContent()</a><br />
    218. 

  218.                                                                     <a href="../classes/Pico.html#method_getMetaHeaders" class="">getMetaHeaders()</a><br />
    219. 

  219.                                                                     <a href="../classes/Pico.html#method_parseFileMeta" class="">parseFileMeta()</a><br />
    220. 

  220.                                                                     <a href="../classes/Pico.html#method_getFileMeta" class="">getFileMeta()</a><br />
    221. 

  221.                                                                     <a href="../classes/Pico.html#method_prepareFileContent" class="">prepareFileContent()</a><br />
    222. 

  222.                                                                     <a href="../classes/Pico.html#method_parseFileContent" class="">parseFileContent()</a><br />
    223. 

  223.                                                                     <a href="../classes/Pico.html#method_getFileContent" class="">getFileContent()</a><br />
    224. 

  224.                                                                     <a href="../classes/Pico.html#method_getPages" class="">getPages()</a><br />
    225. 

  225.                                                                     <a href="../classes/Pico.html#method_getCurrentPage" class="">getCurrentPage()</a><br />
    226. 

  226.                                                                     <a href="../classes/Pico.html#method_getPreviousPage" class="">getPreviousPage()</a><br />
    227. 

  227.                                                                     <a href="../classes/Pico.html#method_getNextPage" class="">getNextPage()</a><br />
    228. 

  228.                                                                     <a href="../classes/Pico.html#method_getTwig" class="">getTwig()</a><br />
    229. 

  229.                                                                     <a href="../classes/Pico.html#method_getBaseUrl" class="">getBaseUrl()</a><br />
    230. 

  230.                                                                     <a href="../classes/Pico.html#method_isUrlRewritingEnabled" class="">isUrlRewritingEnabled()</a><br />
    231. 

  231.                                                                     <a href="../classes/Pico.html#method_getPageUrl" class="">getPageUrl()</a><br />
    232. 

  232.                                                             </section>
    233. 

  233.                             <section class="span4">
    234. 

  234.                                                                     <em>No public properties found</em>
    235. 

  235.                                                             </section>
    236. 

  236.                             <section class="span4">
    237. 

  237.                                                                     <a href="../classes/Pico.html#constant_SORT_ASC" class="">SORT_ASC</a><br />
    238. 

  238.                                                                     <a href="../classes/Pico.html#constant_SORT_DESC" class="">SORT_DESC</a><br />
    239. 

  239.                                                                     <a href="../classes/Pico.html#constant_SORT_NONE" class="">SORT_NONE</a><br />
    240. 

  240.                                                             </section>
    241. 

  241.                         </section>
    242. 

  242.                         <section class="row-fluid protected">
    243. 

  243.                             <section class="span4">
    244. 

  244.                                                                     <a href="../classes/Pico.html#method_loadPlugins" class="">loadPlugins()</a><br />
    245. 

  245.                                                                     <a href="../classes/Pico.html#method_loadConfig" class="">loadConfig()</a><br />
    246. 

  246.                                                                     <a href="../classes/Pico.html#method_evaluateRequestUrl" class="">evaluateRequestUrl()</a><br />
    247. 

  247.                                                                     <a href="../classes/Pico.html#method_discoverRequestFile" class="">discoverRequestFile()</a><br />
    248. 

  248.                                                                     <a href="../classes/Pico.html#method_readPages" class="">readPages()</a><br />
    249. 

  249.                                                                     <a href="../classes/Pico.html#method_sortPages" class="">sortPages()</a><br />
    250. 

  250.                                                                     <a href="../classes/Pico.html#method_discoverCurrentPage" class="">discoverCurrentPage()</a><br />
    251. 

  251.                                                                     <a href="../classes/Pico.html#method_registerTwig" class="">registerTwig()</a><br />
    252. 

  252.                                                                     <a href="../classes/Pico.html#method_getTwigVariables" class="">getTwigVariables()</a><br />
    253. 

  253.                                                                     <a href="../classes/Pico.html#method_getFiles" class="">getFiles()</a><br />
    254. 

  254.                                                                     <a href="../classes/Pico.html#method_getAbsolutePath" class="">getAbsolutePath()</a><br />
    255. 

  255.                                                                     <a href="../classes/Pico.html#method_triggerEvent" class="">triggerEvent()</a><br />
    256. 

  256.                                                             </section>
    257. 

  257.                             <section class="span4">
    258. 

  258.                                                                     <a href="../classes/Pico.html#property_rootDir" class="">$rootDir</a><br />
    259. 

  259.                                                                     <a href="../classes/Pico.html#property_configDir" class="">$configDir</a><br />
    260. 

  260.                                                                     <a href="../classes/Pico.html#property_pluginsDir" class="">$pluginsDir</a><br />
    261. 

  261.                                                                     <a href="../classes/Pico.html#property_themesDir" class="">$themesDir</a><br />
    262. 

  262.                                                                     <a href="../classes/Pico.html#property_locked" class="">$locked</a><br />
    263. 

  263.                                                                     <a href="../classes/Pico.html#property_plugins" class="">$plugins</a><br />
    264. 

  264.                                                                     <a href="../classes/Pico.html#property_config" class="">$config</a><br />
    265. 

  265.                                                                     <a href="../classes/Pico.html#property_requestUrl" class="">$requestUrl</a><br />
    266. 

  266.                                                                     <a href="../classes/Pico.html#property_requestFile" class="">$requestFile</a><br />
    267. 

  267.                                                                     <a href="../classes/Pico.html#property_rawContent" class="">$rawContent</a><br />
    268. 

  268.                                                                     <a href="../classes/Pico.html#property_meta" class="">$meta</a><br />
    269. 

  269.                                                                     <a href="../classes/Pico.html#property_content" class="">$content</a><br />
    270. 

  270.                                                                     <a href="../classes/Pico.html#property_pages" class="">$pages</a><br />
    271. 

  271.                                                                     <a href="../classes/Pico.html#property_currentPage" class="">$currentPage</a><br />
    272. 

  272.                                                                     <a href="../classes/Pico.html#property_previousPage" class="">$previousPage</a><br />
    273. 

  273.                                                                     <a href="../classes/Pico.html#property_nextPage" class="">$nextPage</a><br />
    274. 

  274.                                                                     <a href="../classes/Pico.html#property_twig" class="">$twig</a><br />
    275. 

  275.                                                                     <a href="../classes/Pico.html#property_twigVariables" class="">$twigVariables</a><br />
    276. 

  276.                                                             </section>
    277. 

  277.                             <section class="span4">
    278. 

  278.                                 <em>N/A</em>
    279. 

  279.                             </section>
    280. 

  280.                         </section>
    281. 

  281.                         <section class="row-fluid private">
    282. 

  282.                             <section class="span4">
    283. 

  283.                                                                     <em>No private methods found</em>
    284. 

  284.                                                             </section>
    285. 

  285.                             <section class="span4">
    286. 

  286.                                                                     <em>No private properties found</em>
    287. 

  287.                                                             </section>
    288. 

  288.                             <section class="span4">
    289. 

  289.                                 <em>N/A</em>
    290. 

  290.                             </section>
    291. 

  291.                         </section>
    292. 

  292.                     </section>
    293. 

  293.                 </div>
    294. 

  294.                 <aside class="span4 detailsbar">
    295. 

  295.                                         
    296. 

  296.                     
    297. 

  297.                     <dl>
    298. 

  298.                         <dt>File</dt>
    299. 

  299.                             <dd><a href="../files/lib.Pico.html"><div class="path-wrapper">lib/Pico.php</div></a></dd>
    300. 

  300.                                                 <dt>Package</dt>
    301. 

  301.                             <dd><div class="namespace-wrapper">Default</div></dd>
    302. 

  302.                                                 <dt>Class hierarchy</dt>
    303. 

  303.                             <dd class="hierarchy">
    304. 

  304.                                                                                                                                                                     <div class="namespace-wrapper">\Pico</div>
    305. 

  305.                             </dd>
    306. 

  306. 

  307.                         
    308. 

  308.                         
    309. 

  309.                         
    310. 

  310.                                                                             <dt>See also</dt>
    311. 

  311.                                                                                         <dd><a href="&lt;http://picocms.org&gt;"><span class="namespace-wrapper">&lt;http://picocms.org&gt;</span></a></dd>
    312. 

  312.                                                     
    313. 

  313.                                                                         </dl>
    314. 

  314.                     <h2>Tags</h2>
    315. 

  315.                     <table class="table table-condensed">
    316. 

  316.                                             <tr>
    317. 

  317.                             <th>
    318. 

  318.                                 author
    319. 

  319.                             </th>
    320. 

  320.                             <td>
    321. 

  321.                                                                     <p>Gilbert Pellegrom</p>
    322. 

  322.                                                                     <p>Daniel Rudolf</p>
    323. 

  323.                                                             </td>
    324. 

  324.                         </tr>
    325. 

  325.                                             <tr>
    326. 

  326.                             <th>
    327. 

  327.                                 license
    328. 

  328.                             </th>
    329. 

  329.                             <td>
    330. 

  330.                                                                     <p>The MIT License <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></p>
    331. 

  331.                                                             </td>
    332. 

  332.                         </tr>
    333. 

  333.                                             <tr>
    334. 

  334.                             <th>
    335. 

  335.                                 version
    336. 

  336.                             </th>
    337. 

  337.                             <td>
    338. 

  338.                                                                     
    339. 

  339.                                                             </td>
    340. 

  340.                         </tr>
    341. 

  341.                                         </table>
    342. 

  342.                 </aside>
    343. 

  343.             </div>
    344. 

  344. 

  345.                                     <a id="constants" name="constants"></a>
    346. 

  346.             <div class="row-fluid">
    347. 

  347.                 <div class="span8 content class">
    348. 

  348.                     <h2>Constants</h2>
    349. 

  349.                 </div>
    350. 

  350.                 <aside class="span4 detailsbar"></aside>
    351. 

  351.             </div>
    352. 

  352. 

  353.                                 <div class="row-fluid">
    354. 

  354.         <div class="span8 content class">
    355. 

  355.             <a id="constant_SORT_ASC" name="constant_SORT_ASC" class="anchor"></a>
    356. 

  356.             <article id="constant_SORT_ASC" class="constant">
    357. 

  357.                 <h3 class="">SORT_ASC</h3>
    358. 

  358.                 <pre class="signature">SORT_ASC</pre>
    359. 

  359.                 <p><em>Sort files in alphabetical ascending order</em></p>
    360. 

  360.                 
    361. 

  361.             </article>
    362. 

  362.         </div>
    363. 

  363.         <aside class="span4 detailsbar">
    364. 

  364.             <h1><i class="icon-arrow-down"></i></h1>
    365. 

  365.                         <dl>
    366. 

  366.                                                                                             <dt>See also</dt>
    367. 

  367.                                                                 <dd><a href="../classes/Pico.html#method_getFiles"><span class="namespace-wrapper">\Pico::getFiles()</span></a></dd>
    368. 

  368.                                                                 </dl>
    369. 

  369.             <h2>Tags</h2>
    370. 

  370.             <table class="table table-condensed">
    371. 

  371.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    372. 

  372.                             </table>
    373. 

  373.         </aside>
    374. 

  374.     </div>
    375. 

  375. 

  376.                                     <div class="row-fluid">
    377. 

  377.         <div class="span8 content class">
    378. 

  378.             <a id="constant_SORT_DESC" name="constant_SORT_DESC" class="anchor"></a>
    379. 

  379.             <article id="constant_SORT_DESC" class="constant">
    380. 

  380.                 <h3 class="">SORT_DESC</h3>
    381. 

  381.                 <pre class="signature">SORT_DESC</pre>
    382. 

  382.                 <p><em>Sort files in alphabetical descending order</em></p>
    383. 

  383.                 
    384. 

  384.             </article>
    385. 

  385.         </div>
    386. 

  386.         <aside class="span4 detailsbar">
    387. 

  387.             <h1><i class="icon-arrow-down"></i></h1>
    388. 

  388.                         <dl>
    389. 

  389.                                                                                             <dt>See also</dt>
    390. 

  390.                                                                 <dd><a href="../classes/Pico.html#method_getFiles"><span class="namespace-wrapper">\Pico::getFiles()</span></a></dd>
    391. 

  391.                                                                 </dl>
    392. 

  392.             <h2>Tags</h2>
    393. 

  393.             <table class="table table-condensed">
    394. 

  394.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    395. 

  395.                             </table>
    396. 

  396.         </aside>
    397. 

  397.     </div>
    398. 

  398. 

  399.                                     <div class="row-fluid">
    400. 

  400.         <div class="span8 content class">
    401. 

  401.             <a id="constant_SORT_NONE" name="constant_SORT_NONE" class="anchor"></a>
    402. 

  402.             <article id="constant_SORT_NONE" class="constant">
    403. 

  403.                 <h3 class="">SORT_NONE</h3>
    404. 

  404.                 <pre class="signature">SORT_NONE</pre>
    405. 

  405.                 <p><em>Don&#039;t sort files</em></p>
    406. 

  406.                 
    407. 

  407.             </article>
    408. 

  408.         </div>
    409. 

  409.         <aside class="span4 detailsbar">
    410. 

  410.             <h1><i class="icon-arrow-down"></i></h1>
    411. 

  411.                         <dl>
    412. 

  412.                                                                                             <dt>See also</dt>
    413. 

  413.                                                                 <dd><a href="../classes/Pico.html#method_getFiles"><span class="namespace-wrapper">\Pico::getFiles()</span></a></dd>
    414. 

  414.                                                                 </dl>
    415. 

  415.             <h2>Tags</h2>
    416. 

  416.             <table class="table table-condensed">
    417. 

  417.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    418. 

  418.                             </table>
    419. 

  419.         </aside>
    420. 

  420.     </div>
    421. 

  421. 

  422.                             
    423. 

  423.                                     <a id="properties" name="properties"></a>
    424. 

  424.             <div class="row-fluid">
    425. 

  425.                 <div class="span8 content class">
    426. 

  426.                     <h2>Properties</h2>
    427. 

  427.                 </div>
    428. 

  428.                 <aside class="span4 detailsbar"></aside>
    429. 

  429.             </div>
    430. 

  430. 

  431.                                                     <div class="row-fluid">
    432. 

  432.         <div class="span8 content class">
    433. 

  433.             <a id="property_rootDir" name="property_rootDir" class="anchor"></a>
    434. 

  434.             <article class="property">
    435. 

  435.                 <h3 class="protected ">$rootDir</h3>
    436. 

  436.                 <pre class="signature">$rootDir : string</pre>
    437. 

  437.                 <p><em>Root directory of this Pico instance</em></p>
    438. 

  438.                 
    439. 

  439. 

  440.                                 <h4>Type</h4>
    441. 

  441.                 string
    442. 

  442.                                             </article>
    443. 

  443.         </div>
    444. 

  444.         <aside class="span4 detailsbar">
    445. 

  445.             <h1><i class="icon-arrow-down"></i></h1>
    446. 

  446.                         <dl>
    447. 

  447.                                                                             <dt>See also</dt>
    448. 

  448.                                                                 <dd><a href="../classes/Pico.html#method_getRootDir"><span class="namespace-wrapper">\Pico::getRootDir()</span></a></dd>
    449. 

  449.                                                                 </dl>
    450. 

  450.             <h2>Tags</h2>
    451. 

  451.             <table class="table table-condensed">
    452. 

  452.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    453. 

  453.                             </table>
    454. 

  454.         </aside>
    455. 

  455.     </div>
    456. 

  456. 

  457.                                     <div class="row-fluid">
    458. 

  458.         <div class="span8 content class">
    459. 

  459.             <a id="property_configDir" name="property_configDir" class="anchor"></a>
    460. 

  460.             <article class="property">
    461. 

  461.                 <h3 class="protected ">$configDir</h3>
    462. 

  462.                 <pre class="signature">$configDir : string</pre>
    463. 

  463.                 <p><em>Config directory of this Pico instance</em></p>
    464. 

  464.                 
    465. 

  465. 

  466.                                 <h4>Type</h4>
    467. 

  467.                 string
    468. 

  468.                                             </article>
    469. 

  469.         </div>
    470. 

  470.         <aside class="span4 detailsbar">
    471. 

  471.             <h1><i class="icon-arrow-down"></i></h1>
    472. 

  472.                         <dl>
    473. 

  473.                                                                             <dt>See also</dt>
    474. 

  474.                                                                 <dd><a href="../classes/Pico.html#method_getConfigDir"><span class="namespace-wrapper">\Pico::getConfigDir()</span></a></dd>
    475. 

  475.                                                                 </dl>
    476. 

  476.             <h2>Tags</h2>
    477. 

  477.             <table class="table table-condensed">
    478. 

  478.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    479. 

  479.                             </table>
    480. 

  480.         </aside>
    481. 

  481.     </div>
    482. 

  482. 

  483.                                     <div class="row-fluid">
    484. 

  484.         <div class="span8 content class">
    485. 

  485.             <a id="property_pluginsDir" name="property_pluginsDir" class="anchor"></a>
    486. 

  486.             <article class="property">
    487. 

  487.                 <h3 class="protected ">$pluginsDir</h3>
    488. 

  488.                 <pre class="signature">$pluginsDir : string</pre>
    489. 

  489.                 <p><em>Plugins directory of this Pico instance</em></p>
    490. 

  490.                 
    491. 

  491. 

  492.                                 <h4>Type</h4>
    493. 

  493.                 string
    494. 

  494.                                             </article>
    495. 

  495.         </div>
    496. 

  496.         <aside class="span4 detailsbar">
    497. 

  497.             <h1><i class="icon-arrow-down"></i></h1>
    498. 

  498.                         <dl>
    499. 

  499.                                                                             <dt>See also</dt>
    500. 

  500.                                                                 <dd><a href="../classes/Pico.html#method_getPluginsDir"><span class="namespace-wrapper">\Pico::getPluginsDir()</span></a></dd>
    501. 

  501.                                                                 </dl>
    502. 

  502.             <h2>Tags</h2>
    503. 

  503.             <table class="table table-condensed">
    504. 

  504.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    505. 

  505.                             </table>
    506. 

  506.         </aside>
    507. 

  507.     </div>
    508. 

  508. 

  509.                                     <div class="row-fluid">
    510. 

  510.         <div class="span8 content class">
    511. 

  511.             <a id="property_themesDir" name="property_themesDir" class="anchor"></a>
    512. 

  512.             <article class="property">
    513. 

  513.                 <h3 class="protected ">$themesDir</h3>
    514. 

  514.                 <pre class="signature">$themesDir : string</pre>
    515. 

  515.                 <p><em>Themes directory of this Pico instance</em></p>
    516. 

  516.                 
    517. 

  517. 

  518.                                 <h4>Type</h4>
    519. 

  519.                 string
    520. 

  520.                                             </article>
    521. 

  521.         </div>
    522. 

  522.         <aside class="span4 detailsbar">
    523. 

  523.             <h1><i class="icon-arrow-down"></i></h1>
    524. 

  524.                         <dl>
    525. 

  525.                                                                             <dt>See also</dt>
    526. 

  526.                                                                 <dd><a href="../classes/Pico.html#method_getThemesDir"><span class="namespace-wrapper">\Pico::getThemesDir()</span></a></dd>
    527. 

  527.                                                                 </dl>
    528. 

  528.             <h2>Tags</h2>
    529. 

  529.             <table class="table table-condensed">
    530. 

  530.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    531. 

  531.                             </table>
    532. 

  532.         </aside>
    533. 

  533.     </div>
    534. 

  534. 

  535.                                     <div class="row-fluid">
    536. 

  536.         <div class="span8 content class">
    537. 

  537.             <a id="property_locked" name="property_locked" class="anchor"></a>
    538. 

  538.             <article class="property">
    539. 

  539.                 <h3 class="protected ">$locked</h3>
    540. 

  540.                 <pre class="signature">$locked : boolean</pre>
    541. 

  541.                 <p><em>Boolean indicating whether Picos processing started yet</em></p>
    542. 

  542.                 
    543. 

  543. 

  544.                                 <h4>Type</h4>
    545. 

  545.                 boolean
    546. 

  546.                                             </article>
    547. 

  547.         </div>
    548. 

  548.         <aside class="span4 detailsbar">
    549. 

  549.             <h1><i class="icon-arrow-down"></i></h1>
    550. 

  550.                         <dl>
    551. 

  551.                                                             </dl>
    552. 

  552.             <h2>Tags</h2>
    553. 

  553.             <table class="table table-condensed">
    554. 

  554.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    555. 

  555.                             </table>
    556. 

  556.         </aside>
    557. 

  557.     </div>
    558. 

  558. 

  559.                                     <div class="row-fluid">
    560. 

  560.         <div class="span8 content class">
    561. 

  561.             <a id="property_plugins" name="property_plugins" class="anchor"></a>
    562. 

  562.             <article class="property">
    563. 

  563.                 <h3 class="protected ">$plugins</h3>
    564. 

  564.                 <pre class="signature">$plugins : array&lt;mixed,object&gt;|null</pre>
    565. 

  565.                 <p><em>List of loaded plugins</em></p>
    566. 

  566.                 
    567. 

  567. 

  568.                                 <h4>Type</h4>
    569. 

  569.                 array&lt;mixed,object&gt;|null
    570. 

  570.                                             </article>
    571. 

  571.         </div>
    572. 

  572.         <aside class="span4 detailsbar">
    573. 

  573.             <h1><i class="icon-arrow-down"></i></h1>
    574. 

  574.                         <dl>
    575. 

  575.                                                                             <dt>See also</dt>
    576. 

  576.                                                                 <dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
    577. 

  577.                                                                 </dl>
    578. 

  578.             <h2>Tags</h2>
    579. 

  579.             <table class="table table-condensed">
    580. 

  580.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    581. 

  581.                             </table>
    582. 

  582.         </aside>
    583. 

  583.     </div>
    584. 

  584. 

  585.                                     <div class="row-fluid">
    586. 

  586.         <div class="span8 content class">
    587. 

  587.             <a id="property_config" name="property_config" class="anchor"></a>
    588. 

  588.             <article class="property">
    589. 

  589.                 <h3 class="protected ">$config</h3>
    590. 

  590.                 <pre class="signature">$config : array&lt;mixed,mixed&gt;|null</pre>
    591. 

  591.                 <p><em>Current configuration of this Pico instance</em></p>
    592. 

  592.                 
    593. 

  593. 

  594.                                 <h4>Type</h4>
    595. 

  595.                 array&lt;mixed,mixed&gt;|null
    596. 

  596.                                             </article>
    597. 

  597.         </div>
    598. 

  598.         <aside class="span4 detailsbar">
    599. 

  599.             <h1><i class="icon-arrow-down"></i></h1>
    600. 

  600.                         <dl>
    601. 

  601.                                                                             <dt>See also</dt>
    602. 

  602.                                                                 <dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
    603. 

  603.                                                                 </dl>
    604. 

  604.             <h2>Tags</h2>
    605. 

  605.             <table class="table table-condensed">
    606. 

  606.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    607. 

  607.                             </table>
    608. 

  608.         </aside>
    609. 

  609.     </div>
    610. 

  610. 

  611.                                     <div class="row-fluid">
    612. 

  612.         <div class="span8 content class">
    613. 

  613.             <a id="property_requestUrl" name="property_requestUrl" class="anchor"></a>
    614. 

  614.             <article class="property">
    615. 

  615.                 <h3 class="protected ">$requestUrl</h3>
    616. 

  616.                 <pre class="signature">$requestUrl : string|null</pre>
    617. 

  617.                 <p><em>Part of the URL describing the requested contents</em></p>
    618. 

  618.                 
    619. 

  619. 

  620.                                 <h4>Type</h4>
    621. 

  621.                 string|null
    622. 

  622.                                             </article>
    623. 

  623.         </div>
    624. 

  624.         <aside class="span4 detailsbar">
    625. 

  625.             <h1><i class="icon-arrow-down"></i></h1>
    626. 

  626.                         <dl>
    627. 

  627.                                                                             <dt>See also</dt>
    628. 

  628.                                                                 <dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
    629. 

  629.                                                                 </dl>
    630. 

  630.             <h2>Tags</h2>
    631. 

  631.             <table class="table table-condensed">
    632. 

  632.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    633. 

  633.                             </table>
    634. 

  634.         </aside>
    635. 

  635.     </div>
    636. 

  636. 

  637.                                     <div class="row-fluid">
    638. 

  638.         <div class="span8 content class">
    639. 

  639.             <a id="property_requestFile" name="property_requestFile" class="anchor"></a>
    640. 

  640.             <article class="property">
    641. 

  641.                 <h3 class="protected ">$requestFile</h3>
    642. 

  642.                 <pre class="signature">$requestFile : string|null</pre>
    643. 

  643.                 <p><em>Absolute path to the content file being served</em></p>
    644. 

  644.                 
    645. 

  645. 

  646.                                 <h4>Type</h4>
    647. 

  647.                 string|null
    648. 

  648.                                             </article>
    649. 

  649.         </div>
    650. 

  650.         <aside class="span4 detailsbar">
    651. 

  651.             <h1><i class="icon-arrow-down"></i></h1>
    652. 

  652.                         <dl>
    653. 

  653.                                                                             <dt>See also</dt>
    654. 

  654.                                                                 <dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
    655. 

  655.                                                                 </dl>
    656. 

  656.             <h2>Tags</h2>
    657. 

  657.             <table class="table table-condensed">
    658. 

  658.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    659. 

  659.                             </table>
    660. 

  660.         </aside>
    661. 

  661.     </div>
    662. 

  662. 

  663.                                     <div class="row-fluid">
    664. 

  664.         <div class="span8 content class">
    665. 

  665.             <a id="property_rawContent" name="property_rawContent" class="anchor"></a>
    666. 

  666.             <article class="property">
    667. 

  667.                 <h3 class="protected ">$rawContent</h3>
    668. 

  668.                 <pre class="signature">$rawContent : string|null</pre>
    669. 

  669.                 <p><em>Raw, not yet parsed contents to serve</em></p>
    670. 

  670.                 
    671. 

  671. 

  672.                                 <h4>Type</h4>
    673. 

  673.                 string|null
    674. 

  674.                                             </article>
    675. 

  675.         </div>
    676. 

  676.         <aside class="span4 detailsbar">
    677. 

  677.             <h1><i class="icon-arrow-down"></i></h1>
    678. 

  678.                         <dl>
    679. 

  679.                                                                             <dt>See also</dt>
    680. 

  680.                                                                 <dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
    681. 

  681.                                                                 </dl>
    682. 

  682.             <h2>Tags</h2>
    683. 

  683.             <table class="table table-condensed">
    684. 

  684.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    685. 

  685.                             </table>
    686. 

  686.         </aside>
    687. 

  687.     </div>
    688. 

  688. 

  689.                                     <div class="row-fluid">
    690. 

  690.         <div class="span8 content class">
    691. 

  691.             <a id="property_meta" name="property_meta" class="anchor"></a>
    692. 

  692.             <article class="property">
    693. 

  693.                 <h3 class="protected ">$meta</h3>
    694. 

  694.                 <pre class="signature">$meta : array&lt;mixed,string&gt;|null</pre>
    695. 

  695.                 <p><em>Meta data of the page to serve</em></p>
    696. 

  696.                 
    697. 

  697. 

  698.                                 <h4>Type</h4>
    699. 

  699.                 array&lt;mixed,string&gt;|null
    700. 

  700.                                             </article>
    701. 

  701.         </div>
    702. 

  702.         <aside class="span4 detailsbar">
    703. 

  703.             <h1><i class="icon-arrow-down"></i></h1>
    704. 

  704.                         <dl>
    705. 

  705.                                                                             <dt>See also</dt>
    706. 

  706.                                                                 <dd><a href="../classes/Pico.html#method_getFileMeta"><span class="namespace-wrapper">\Pico::getFileMeta()</span></a></dd>
    707. 

  707.                                                                 </dl>
    708. 

  708.             <h2>Tags</h2>
    709. 

  709.             <table class="table table-condensed">
    710. 

  710.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    711. 

  711.                             </table>
    712. 

  712.         </aside>
    713. 

  713.     </div>
    714. 

  714. 

  715.                                     <div class="row-fluid">
    716. 

  716.         <div class="span8 content class">
    717. 

  717.             <a id="property_content" name="property_content" class="anchor"></a>
    718. 

  718.             <article class="property">
    719. 

  719.                 <h3 class="protected ">$content</h3>
    720. 

  720.                 <pre class="signature">$content : string|null</pre>
    721. 

  721.                 <p><em>Parsed content being served</em></p>
    722. 

  722.                 
    723. 

  723. 

  724.                                 <h4>Type</h4>
    725. 

  725.                 string|null
    726. 

  726.                                             </article>
    727. 

  727.         </div>
    728. 

  728.         <aside class="span4 detailsbar">
    729. 

  729.             <h1><i class="icon-arrow-down"></i></h1>
    730. 

  730.                         <dl>
    731. 

  731.                                                                             <dt>See also</dt>
    732. 

  732.                                                                 <dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
    733. 

  733.                                                                 </dl>
    734. 

  734.             <h2>Tags</h2>
    735. 

  735.             <table class="table table-condensed">
    736. 

  736.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    737. 

  737.                             </table>
    738. 

  738.         </aside>
    739. 

  739.     </div>
    740. 

  740. 

  741.                                     <div class="row-fluid">
    742. 

  742.         <div class="span8 content class">
    743. 

  743.             <a id="property_pages" name="property_pages" class="anchor"></a>
    744. 

  744.             <article class="property">
    745. 

  745.                 <h3 class="protected ">$pages</h3>
    746. 

  746.                 <pre class="signature">$pages : array&lt;mixed,array&gt;|null</pre>
    747. 

  747.                 <p><em>List of known pages</em></p>
    748. 

  748.                 
    749. 

  749. 

  750.                                 <h4>Type</h4>
    751. 

  751.                 array&lt;mixed,array&gt;|null
    752. 

  752.                                             </article>
    753. 

  753.         </div>
    754. 

  754.         <aside class="span4 detailsbar">
    755. 

  755.             <h1><i class="icon-arrow-down"></i></h1>
    756. 

  756.                         <dl>
    757. 

  757.                                                                             <dt>See also</dt>
    758. 

  758.                                                                 <dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
    759. 

  759.                                                                 </dl>
    760. 

  760.             <h2>Tags</h2>
    761. 

  761.             <table class="table table-condensed">
    762. 

  762.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    763. 

  763.                             </table>
    764. 

  764.         </aside>
    765. 

  765.     </div>
    766. 

  766. 

  767.                                     <div class="row-fluid">
    768. 

  768.         <div class="span8 content class">
    769. 

  769.             <a id="property_currentPage" name="property_currentPage" class="anchor"></a>
    770. 

  770.             <article class="property">
    771. 

  771.                 <h3 class="protected ">$currentPage</h3>
    772. 

  772.                 <pre class="signature">$currentPage : array|null</pre>
    773. 

  773.                 <p><em>Data of the page being served</em></p>
    774. 

  774.                 
    775. 

  775. 

  776.                                 <h4>Type</h4>
    777. 

  777.                 array|null
    778. 

  778.                                             </article>
    779. 

  779.         </div>
    780. 

  780.         <aside class="span4 detailsbar">
    781. 

  781.             <h1><i class="icon-arrow-down"></i></h1>
    782. 

  782.                         <dl>
    783. 

  783.                                                                             <dt>See also</dt>
    784. 

  784.                                                                 <dd><a href="../classes/Pico.html#method_getCurrentPage"><span class="namespace-wrapper">\Pico::getCurrentPage()</span></a></dd>
    785. 

  785.                                                                 </dl>
    786. 

  786.             <h2>Tags</h2>
    787. 

  787.             <table class="table table-condensed">
    788. 

  788.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    789. 

  789.                             </table>
    790. 

  790.         </aside>
    791. 

  791.     </div>
    792. 

  792. 

  793.                                     <div class="row-fluid">
    794. 

  794.         <div class="span8 content class">
    795. 

  795.             <a id="property_previousPage" name="property_previousPage" class="anchor"></a>
    796. 

  796.             <article class="property">
    797. 

  797.                 <h3 class="protected ">$previousPage</h3>
    798. 

  798.                 <pre class="signature">$previousPage : array|null</pre>
    799. 

  799.                 <p><em>Data of the previous page relative to the page being served</em></p>
    800. 

  800.                 
    801. 

  801. 

  802.                                 <h4>Type</h4>
    803. 

  803.                 array|null
    804. 

  804.                                             </article>
    805. 

  805.         </div>
    806. 

  806.         <aside class="span4 detailsbar">
    807. 

  807.             <h1><i class="icon-arrow-down"></i></h1>
    808. 

  808.                         <dl>
    809. 

  809.                                                                             <dt>See also</dt>
    810. 

  810.                                                                 <dd><a href="../classes/Pico.html#method_getPreviousPage"><span class="namespace-wrapper">\Pico::getPreviousPage()</span></a></dd>
    811. 

  811.                                                                 </dl>
    812. 

  812.             <h2>Tags</h2>
    813. 

  813.             <table class="table table-condensed">
    814. 

  814.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    815. 

  815.                             </table>
    816. 

  816.         </aside>
    817. 

  817.     </div>
    818. 

  818. 

  819.                                     <div class="row-fluid">
    820. 

  820.         <div class="span8 content class">
    821. 

  821.             <a id="property_nextPage" name="property_nextPage" class="anchor"></a>
    822. 

  822.             <article class="property">
    823. 

  823.                 <h3 class="protected ">$nextPage</h3>
    824. 

  824.                 <pre class="signature">$nextPage : array|null</pre>
    825. 

  825.                 <p><em>Data of the next page relative to the page being served</em></p>
    826. 

  826.                 
    827. 

  827. 

  828.                                 <h4>Type</h4>
    829. 

  829.                 array|null
    830. 

  830.                                             </article>
    831. 

  831.         </div>
    832. 

  832.         <aside class="span4 detailsbar">
    833. 

  833.             <h1><i class="icon-arrow-down"></i></h1>
    834. 

  834.                         <dl>
    835. 

  835.                                                                             <dt>See also</dt>
    836. 

  836.                                                                 <dd><a href="../classes/Pico.html#method_getNextPage"><span class="namespace-wrapper">\Pico::getNextPage()</span></a></dd>
    837. 

  837.                                                                 </dl>
    838. 

  838.             <h2>Tags</h2>
    839. 

  839.             <table class="table table-condensed">
    840. 

  840.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    841. 

  841.                             </table>
    842. 

  842.         </aside>
    843. 

  843.     </div>
    844. 

  844. 

  845.                                     <div class="row-fluid">
    846. 

  846.         <div class="span8 content class">
    847. 

  847.             <a id="property_twig" name="property_twig" class="anchor"></a>
    848. 

  848.             <article class="property">
    849. 

  849.                 <h3 class="protected ">$twig</h3>
    850. 

  850.                 <pre class="signature">$twig : \Twig_Environment|null</pre>
    851. 

  851.                 <p><em>Twig instance used for template parsing</em></p>
    852. 

  852.                 
    853. 

  853. 

  854.                                 <h4>Type</h4>
    855. 

  855.                 \Twig_Environment|null
    856. 

  856.                                             </article>
    857. 

  857.         </div>
    858. 

  858.         <aside class="span4 detailsbar">
    859. 

  859.             <h1><i class="icon-arrow-down"></i></h1>
    860. 

  860.                         <dl>
    861. 

  861.                                                                             <dt>See also</dt>
    862. 

  862.                                                                 <dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
    863. 

  863.                                                                 </dl>
    864. 

  864.             <h2>Tags</h2>
    865. 

  865.             <table class="table table-condensed">
    866. 

  866.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    867. 

  867.                             </table>
    868. 

  868.         </aside>
    869. 

  869.     </div>
    870. 

  870. 

  871.                                     <div class="row-fluid">
    872. 

  872.         <div class="span8 content class">
    873. 

  873.             <a id="property_twigVariables" name="property_twigVariables" class="anchor"></a>
    874. 

  874.             <article class="property">
    875. 

  875.                 <h3 class="protected ">$twigVariables</h3>
    876. 

  876.                 <pre class="signature">$twigVariables : array&lt;mixed,mixed&gt;|null</pre>
    877. 

  877.                 <p><em>Variables passed to the twig template</em></p>
    878. 

  878.                 
    879. 

  879. 

  880.                                 <h4>Type</h4>
    881. 

  881.                 array&lt;mixed,mixed&gt;|null
    882. 

  882.                                             </article>
    883. 

  883.         </div>
    884. 

  884.         <aside class="span4 detailsbar">
    885. 

  885.             <h1><i class="icon-arrow-down"></i></h1>
    886. 

  886.                         <dl>
    887. 

  887.                                                                             <dt>See also</dt>
    888. 

  888.                                                                 <dd><a href=""><span class="namespace-wrapper">\Pico::getTwigVariables</span></a></dd>
    889. 

  889.                                                                 </dl>
    890. 

  890.             <h2>Tags</h2>
    891. 

  891.             <table class="table table-condensed">
    892. 

  892.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    893. 

  893.                             </table>
    894. 

  894.         </aside>
    895. 

  895.     </div>
    896. 

  896. 

  897.                                             
    898. 

  898.                                     <a id="methods" name="methods"></a>
    899. 

  899.             <div class="row-fluid">
    900. 

  900.                 <div class="span8 content class"><h2>Methods</h2></div>
    901. 

  901.                 <aside class="span4 detailsbar"></aside>
    902. 

  902.             </div>
    903. 

  903. 

  904.                                     <div class="row-fluid">
    905. 

  905.         <div class="span8 content class">
    906. 

  906.             <a id="method___construct" name="method___construct" class="anchor"></a>
    907. 

  907.             <article class="method">
    908. 

  908.                 <h3 class="public ">__construct()</h3>
    909. 

  909.                 <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>
    910. 

  910.                 <pre class="signature" style="margin-right: 54px;">__construct(string  <span class="argument">$rootDir</span>, string  <span class="argument">$configDir</span>, string  <span class="argument">$pluginsDir</span>, string  <span class="argument">$themesDir</span>) </pre>
    911. 

  911.                 <p><em>Constructs a new Pico instance</em></p>
    912. 

  912.                 <p>To carry out all the processing in Pico, call <a href="/classes/Pico.html#method_run">Pico::run()</a>.</p>
    913. 

  913. 

  914.                                     <h4>Parameters</h4>
    915. 

  915.                     <table class="table table-condensed table-hover">
    916. 

  916.                                                     <tr>
    917. 

  917.                                 <td>string</td>
    918. 

  918.                                 <td>$rootDir </td>
    919. 

  919.                                 <td><p>root directory of this Pico instance</p></td>
    920. 

  920.                             </tr>
    921. 

  921.                                                     <tr>
    922. 

  922.                                 <td>string</td>
    923. 

  923.                                 <td>$configDir </td>
    924. 

  924.                                 <td><p>config directory of this Pico instance</p></td>
    925. 

  925.                             </tr>
    926. 

  926.                                                     <tr>
    927. 

  927.                                 <td>string</td>
    928. 

  928.                                 <td>$pluginsDir </td>
    929. 

  929.                                 <td><p>plugins directory of this Pico instance</p></td>
    930. 

  930.                             </tr>
    931. 

  931.                                                     <tr>
    932. 

  932.                                 <td>string</td>
    933. 

  933.                                 <td>$themesDir </td>
    934. 

  934.                                 <td><p>themes directory of this Pico instance</p></td>
    935. 

  935.                             </tr>
    936. 

  936.                                             </table>
    937. 

  937.                 
    938. 

  938.                 
    939. 

  939.                 				
    940. 

  940.                             </article>
    941. 

  941.         </div>
    942. 

  942.         <aside class="span4 detailsbar">
    943. 

  943.             <h1><i class="icon-arrow-down"></i></h1>
    944. 

  944.                                                             <dl>
    945. 

  945.                                                                             </dl>
    946. 

  946.             <h2>Tags</h2>
    947. 

  947.             <table class="table table-condensed">
    948. 

  948.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    949. 

  949.                             </table>
    950. 

  950.         </aside>
    951. 

  951.     </div>
    952. 

  952. 

  953.                                     <div class="row-fluid">
    954. 

  954.         <div class="span8 content class">
    955. 

  955.             <a id="method_getRootDir" name="method_getRootDir" class="anchor"></a>
    956. 

  956.             <article class="method">
    957. 

  957.                 <h3 class="public ">getRootDir()</h3>
    958. 

  958.                 <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>
    959. 

  959.                 <pre class="signature" style="margin-right: 54px;">getRootDir() : string</pre>
    960. 

  960.                 <p><em>Returns the root directory of this Pico instance</em></p>
    961. 

  961.                 
    962. 

  962. 

  963.                 
    964. 

  964.                 
    965. 

  965.                                     <h4>Returns</h4>
    966. 

  966.                     string
    967. 

  967.                                             &mdash; <p>root directory path</p>
    968. 

  968.                                     				
    969. 

  969.                             </article>
    970. 

  970.         </div>
    971. 

  971.         <aside class="span4 detailsbar">
    972. 

  972.             <h1><i class="icon-arrow-down"></i></h1>
    973. 

  973.                                                             <dl>
    974. 

  974.                                                                             </dl>
    975. 

  975.             <h2>Tags</h2>
    976. 

  976.             <table class="table table-condensed">
    977. 

  977.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    978. 

  978.                             </table>
    979. 

  979.         </aside>
    980. 

  980.     </div>
    981. 

  981. 

  982.                                     <div class="row-fluid">
    983. 

  983.         <div class="span8 content class">
    984. 

  984.             <a id="method_getConfigDir" name="method_getConfigDir" class="anchor"></a>
    985. 

  985.             <article class="method">
    986. 

  986.                 <h3 class="public ">getConfigDir()</h3>
    987. 

  987.                 <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>
    988. 

  988.                 <pre class="signature" style="margin-right: 54px;">getConfigDir() : string</pre>
    989. 

  989.                 <p><em>Returns the config directory of this Pico instance</em></p>
    990. 

  990.                 
    991. 

  991. 

  992.                 
    993. 

  993.                 
    994. 

  994.                                     <h4>Returns</h4>
    995. 

  995.                     string
    996. 

  996.                                             &mdash; <p>config directory path</p>
    997. 

  997.                                     				
    998. 

  998.                             </article>
    999. 

  999.         </div>
    1000. 

  1000.         <aside class="span4 detailsbar">
    1001. 

  1001.             <h1><i class="icon-arrow-down"></i></h1>
    1002. 

  1002.                                                             <dl>
    1003. 

  1003.                                                                             </dl>
    1004. 

  1004.             <h2>Tags</h2>
    1005. 

  1005.             <table class="table table-condensed">
    1006. 

  1006.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1007. 

  1007.                             </table>
    1008. 

  1008.         </aside>
    1009. 

  1009.     </div>
    1010. 

  1010. 

  1011.                                     <div class="row-fluid">
    1012. 

  1012.         <div class="span8 content class">
    1013. 

  1013.             <a id="method_getPluginsDir" name="method_getPluginsDir" class="anchor"></a>
    1014. 

  1014.             <article class="method">
    1015. 

  1015.                 <h3 class="public ">getPluginsDir()</h3>
    1016. 

  1016.                 <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>
    1017. 

  1017.                 <pre class="signature" style="margin-right: 54px;">getPluginsDir() : string</pre>
    1018. 

  1018.                 <p><em>Returns the plugins directory of this Pico instance</em></p>
    1019. 

  1019.                 
    1020. 

  1020. 

  1021.                 
    1022. 

  1022.                 
    1023. 

  1023.                                     <h4>Returns</h4>
    1024. 

  1024.                     string
    1025. 

  1025.                                             &mdash; <p>plugins directory path</p>
    1026. 

  1026.                                     				
    1027. 

  1027.                             </article>
    1028. 

  1028.         </div>
    1029. 

  1029.         <aside class="span4 detailsbar">
    1030. 

  1030.             <h1><i class="icon-arrow-down"></i></h1>
    1031. 

  1031.                                                             <dl>
    1032. 

  1032.                                                                             </dl>
    1033. 

  1033.             <h2>Tags</h2>
    1034. 

  1034.             <table class="table table-condensed">
    1035. 

  1035.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1036. 

  1036.                             </table>
    1037. 

  1037.         </aside>
    1038. 

  1038.     </div>
    1039. 

  1039. 

  1040.                                     <div class="row-fluid">
    1041. 

  1041.         <div class="span8 content class">
    1042. 

  1042.             <a id="method_getThemesDir" name="method_getThemesDir" class="anchor"></a>
    1043. 

  1043.             <article class="method">
    1044. 

  1044.                 <h3 class="public ">getThemesDir()</h3>
    1045. 

  1045.                 <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>
    1046. 

  1046.                 <pre class="signature" style="margin-right: 54px;">getThemesDir() : string</pre>
    1047. 

  1047.                 <p><em>Returns the themes directory of this Pico instance</em></p>
    1048. 

  1048.                 
    1049. 

  1049. 

  1050.                 
    1051. 

  1051.                 
    1052. 

  1052.                                     <h4>Returns</h4>
    1053. 

  1053.                     string
    1054. 

  1054.                                             &mdash; <p>themes directory path</p>
    1055. 

  1055.                                     				
    1056. 

  1056.                             </article>
    1057. 

  1057.         </div>
    1058. 

  1058.         <aside class="span4 detailsbar">
    1059. 

  1059.             <h1><i class="icon-arrow-down"></i></h1>
    1060. 

  1060.                                                             <dl>
    1061. 

  1061.                                                                             </dl>
    1062. 

  1062.             <h2>Tags</h2>
    1063. 

  1063.             <table class="table table-condensed">
    1064. 

  1064.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1065. 

  1065.                             </table>
    1066. 

  1066.         </aside>
    1067. 

  1067.     </div>
    1068. 

  1068. 

  1069.                                     <div class="row-fluid">
    1070. 

  1070.         <div class="span8 content class">
    1071. 

  1071.             <a id="method_run" name="method_run" class="anchor"></a>
    1072. 

  1072.             <article class="method">
    1073. 

  1073.                 <h3 class="public ">run()</h3>
    1074. 

  1074.                 <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>
    1075. 

  1075.                 <pre class="signature" style="margin-right: 54px;">run() : string</pre>
    1076. 

  1076.                 <p><em>Runs this Pico instance</em></p>
    1077. 

  1077.                 <p>Loads plugins, evaluates the config file, does URL routing, parses
    1078. 

  1078. meta headers, processes Markdown, does Twig processing and returns
    1079. 

  1079. the rendered contents.</p>
    1080. 

  1080. 

  1081.                 
    1082. 

  1082.                 
    1083. 

  1083.                                     <h4>Returns</h4>
    1084. 

  1084.                     string
    1085. 

  1085.                                             &mdash; <p>rendered Pico contents</p>
    1086. 

  1086.                                     				
    1087. 

  1087.                             </article>
    1088. 

  1088.         </div>
    1089. 

  1089.         <aside class="span4 detailsbar">
    1090. 

  1090.             <h1><i class="icon-arrow-down"></i></h1>
    1091. 

  1091.                                                             <dl>
    1092. 

  1092.                                                                             </dl>
    1093. 

  1093.             <h2>Tags</h2>
    1094. 

  1094.             <table class="table table-condensed">
    1095. 

  1095.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1096. 

  1096.                             </table>
    1097. 

  1097.         </aside>
    1098. 

  1098.     </div>
    1099. 

  1099. 

  1100.                                     <div class="row-fluid">
    1101. 

  1101.         <div class="span8 content class">
    1102. 

  1102.             <a id="method_getPlugin" name="method_getPlugin" class="anchor"></a>
    1103. 

  1103.             <article class="method">
    1104. 

  1104.                 <h3 class="public ">getPlugin()</h3>
    1105. 

  1105.                 <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>
    1106. 

  1106.                 <pre class="signature" style="margin-right: 54px;">getPlugin(string  <span class="argument">$pluginName</span>) : object</pre>
    1107. 

  1107.                 <p><em>Returns the instance of a named plugin</em></p>
    1108. 

  1108.                 <p>Plugins SHOULD implement <a href="/classes/PicoPluginInterface.html">PicoPluginInterface</a>, but you MUST NOT
    1109. 

  1109. rely on it. For more information see <a href="/classes/PicoPluginInterface.html">PicoPluginInterface</a>.</p>
    1110. 

  1110. 

  1111.                                     <h4>Parameters</h4>
    1112. 

  1112.                     <table class="table table-condensed table-hover">
    1113. 

  1113.                                                     <tr>
    1114. 

  1114.                                 <td>string</td>
    1115. 

  1115.                                 <td>$pluginName </td>
    1116. 

  1116.                                 <td><p>name of the plugin</p></td>
    1117. 

  1117.                             </tr>
    1118. 

  1118.                                             </table>
    1119. 

  1119.                 
    1120. 

  1120.                                     <h4>Throws</h4>
    1121. 

  1121.                     <dl>
    1122. 

  1122.                                                     <dt>\RuntimeException</dt>
    1123. 

  1123.                             <dd><p>thrown when the plugin wasn't found</p></dd>
    1124. 

  1124.                                                                     </dl>
    1125. 

  1125.                 
    1126. 

  1126.                                     <h4>Returns</h4>
    1127. 

  1127.                     object
    1128. 

  1128.                                             &mdash; <p>instance of the plugin</p>
    1129. 

  1129.                                     				
    1130. 

  1130.                             </article>
    1131. 

  1131.         </div>
    1132. 

  1132.         <aside class="span4 detailsbar">
    1133. 

  1133.             <h1><i class="icon-arrow-down"></i></h1>
    1134. 

  1134.                                                             <dl>
    1135. 

  1135.                                                                                             <dt>See also</dt>
    1136. 

  1136.                                                                 <dd><a href="../classes/Pico.html#method_loadPlugins"><span class="namespace-wrapper">\Pico::loadPlugins()</span></a></dd>
    1137. 

  1137.                                             <dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
    1138. 

  1138.                                                                 </dl>
    1139. 

  1139.             <h2>Tags</h2>
    1140. 

  1140.             <table class="table table-condensed">
    1141. 

  1141.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1142. 

  1142.                             </table>
    1143. 

  1143.         </aside>
    1144. 

  1144.     </div>
    1145. 

  1145. 

  1146.                                     <div class="row-fluid">
    1147. 

  1147.         <div class="span8 content class">
    1148. 

  1148.             <a id="method_getPlugins" name="method_getPlugins" class="anchor"></a>
    1149. 

  1149.             <article class="method">
    1150. 

  1150.                 <h3 class="public ">getPlugins()</h3>
    1151. 

  1151.                 <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>
    1152. 

  1152.                 <pre class="signature" style="margin-right: 54px;">getPlugins() : array&lt;mixed,object&gt;|null</pre>
    1153. 

  1153.                 <p><em>Returns all loaded plugins</em></p>
    1154. 

  1154.                 
    1155. 

  1155. 

  1156.                 
    1157. 

  1157.                 
    1158. 

  1158.                                     <h4>Returns</h4>
    1159. 

  1159.                     array&lt;mixed,object&gt;|null
    1160. 

  1160.                                     				
    1161. 

  1161.                             </article>
    1162. 

  1162.         </div>
    1163. 

  1163.         <aside class="span4 detailsbar">
    1164. 

  1164.             <h1><i class="icon-arrow-down"></i></h1>
    1165. 

  1165.                                                             <dl>
    1166. 

  1166.                                                                                             <dt>See also</dt>
    1167. 

  1167.                                                                 <dd><a href="../classes/Pico.html#method_loadPlugins"><span class="namespace-wrapper">\Pico::loadPlugins()</span></a></dd>
    1168. 

  1168.                                             <dd><a href="../classes/Pico.html#method_getPlugin"><span class="namespace-wrapper">\Pico::getPlugin()</span></a></dd>
    1169. 

  1169.                                                                 </dl>
    1170. 

  1170.             <h2>Tags</h2>
    1171. 

  1171.             <table class="table table-condensed">
    1172. 

  1172.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1173. 

  1173.                             </table>
    1174. 

  1174.         </aside>
    1175. 

  1175.     </div>
    1176. 

  1176. 

  1177.                                     <div class="row-fluid">
    1178. 

  1178.         <div class="span8 content class">
    1179. 

  1179.             <a id="method_setConfig" name="method_setConfig" class="anchor"></a>
    1180. 

  1180.             <article class="method">
    1181. 

  1181.                 <h3 class="public ">setConfig()</h3>
    1182. 

  1182.                 <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>
    1183. 

  1183.                 <pre class="signature" style="margin-right: 54px;">setConfig(array&lt;mixed,mixed&gt;  <span class="argument">$config</span>) : void</pre>
    1184. 

  1184.                 <p><em>Sets Picos config before calling Pico::run()</em></p>
    1185. 

  1185.                 <p>This method allows you to modify Picos config without creating a
    1186. 

  1186. {@path &quot;config/config.php&quot;} or changing some of its variables before
    1187. 

  1187. Pico starts processing.</p>
    1188. 

  1188. <p>You can call this method between <a href="/classes/Pico.html#method___construct">Pico::__construct()</a> and
    1189. 

  1189. <a href="/classes/Pico.html#method_run">Pico::run()</a> only. Options set with this method cannot be
    1190. 

  1190. overwritten by {@path &quot;config/config.php&quot;}.</p>
    1191. 

  1191. 

  1192.                                     <h4>Parameters</h4>
    1193. 

  1193.                     <table class="table table-condensed table-hover">
    1194. 

  1194.                                                     <tr>
    1195. 

  1195.                                 <td>array&lt;mixed,mixed&gt;</td>
    1196. 

  1196.                                 <td>$config </td>
    1197. 

  1197.                                 <td><p>array with config variables</p></td>
    1198. 

  1198.                             </tr>
    1199. 

  1199.                                             </table>
    1200. 

  1200.                 
    1201. 

  1201.                                     <h4>Throws</h4>
    1202. 

  1202.                     <dl>
    1203. 

  1203.                                                     <dt>\RuntimeException</dt>
    1204. 

  1204.                             <dd><p>thrown if Pico already started processing</p></dd>
    1205. 

  1205.                                                                     </dl>
    1206. 

  1206.                 
    1207. 

  1207.                 				
    1208. 

  1208.                             </article>
    1209. 

  1209.         </div>
    1210. 

  1210.         <aside class="span4 detailsbar">
    1211. 

  1211.             <h1><i class="icon-arrow-down"></i></h1>
    1212. 

  1212.                                                             <dl>
    1213. 

  1213.                                                                                             <dt>See also</dt>
    1214. 

  1214.                                                                 <dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
    1215. 

  1215.                                             <dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
    1216. 

  1216.                                                                 </dl>
    1217. 

  1217.             <h2>Tags</h2>
    1218. 

  1218.             <table class="table table-condensed">
    1219. 

  1219.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1220. 

  1220.                             </table>
    1221. 

  1221.         </aside>
    1222. 

  1222.     </div>
    1223. 

  1223. 

  1224.                                     <div class="row-fluid">
    1225. 

  1225.         <div class="span8 content class">
    1226. 

  1226.             <a id="method_getConfig" name="method_getConfig" class="anchor"></a>
    1227. 

  1227.             <article class="method">
    1228. 

  1228.                 <h3 class="public ">getConfig()</h3>
    1229. 

  1229.                 <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>
    1230. 

  1230.                 <pre class="signature" style="margin-right: 54px;">getConfig(string  <span class="argument">$configName = null</span>) : mixed</pre>
    1231. 

  1231.                 <p><em>Returns either the value of the specified config variable or
    1232. 

  1232. the config array</em></p>
    1233. 

  1233.                 
    1234. 

  1234. 

  1235.                                     <h4>Parameters</h4>
    1236. 

  1236.                     <table class="table table-condensed table-hover">
    1237. 

  1237.                                                     <tr>
    1238. 

  1238.                                 <td>string</td>
    1239. 

  1239.                                 <td>$configName </td>
    1240. 

  1240.                                 <td><p>optional name of a config variable</p></td>
    1241. 

  1241.                             </tr>
    1242. 

  1242.                                             </table>
    1243. 

  1243.                 
    1244. 

  1244.                 
    1245. 

  1245.                                     <h4>Returns</h4>
    1246. 

  1246.                     mixed
    1247. 

  1247.                                             &mdash; <p>returns either the value of the named config
    1248. 

  1248. variable, null if the config variable doesn't exist or the config
    1249. 

  1249. array if no config name was supplied</p>
    1250. 

  1250.                                     				
    1251. 

  1251.                             </article>
    1252. 

  1252.         </div>
    1253. 

  1253.         <aside class="span4 detailsbar">
    1254. 

  1254.             <h1><i class="icon-arrow-down"></i></h1>
    1255. 

  1255.                                                             <dl>
    1256. 

  1256.                                                                                             <dt>See also</dt>
    1257. 

  1257.                                                                 <dd><a href="../classes/Pico.html#method_setConfig"><span class="namespace-wrapper">\Pico::setConfig()</span></a></dd>
    1258. 

  1258.                                             <dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
    1259. 

  1259.                                                                 </dl>
    1260. 

  1260.             <h2>Tags</h2>
    1261. 

  1261.             <table class="table table-condensed">
    1262. 

  1262.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1263. 

  1263.                             </table>
    1264. 

  1264.         </aside>
    1265. 

  1265.     </div>
    1266. 

  1266. 

  1267.                                     <div class="row-fluid">
    1268. 

  1268.         <div class="span8 content class">
    1269. 

  1269.             <a id="method_getRequestUrl" name="method_getRequestUrl" class="anchor"></a>
    1270. 

  1270.             <article class="method">
    1271. 

  1271.                 <h3 class="public ">getRequestUrl()</h3>
    1272. 

  1272.                 <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>
    1273. 

  1273.                 <pre class="signature" style="margin-right: 54px;">getRequestUrl() : string|null</pre>
    1274. 

  1274.                 <p><em>Returns the URL where a user requested the page</em></p>
    1275. 

  1275.                 
    1276. 

  1276. 

  1277.                 
    1278. 

  1278.                 
    1279. 

  1279.                                     <h4>Returns</h4>
    1280. 

  1280.                     string|null
    1281. 

  1281.                                             &mdash; <p>request URL</p>
    1282. 

  1282.                                     				
    1283. 

  1283.                             </article>
    1284. 

  1284.         </div>
    1285. 

  1285.         <aside class="span4 detailsbar">
    1286. 

  1286.             <h1><i class="icon-arrow-down"></i></h1>
    1287. 

  1287.                                                             <dl>
    1288. 

  1288.                                                                                             <dt>See also</dt>
    1289. 

  1289.                                                                 <dd><a href="../classes/Pico.html#method_evaluateRequestUrl"><span class="namespace-wrapper">\Pico::evaluateRequestUrl()</span></a></dd>
    1290. 

  1290.                                                                 </dl>
    1291. 

  1291.             <h2>Tags</h2>
    1292. 

  1292.             <table class="table table-condensed">
    1293. 

  1293.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1294. 

  1294.                             </table>
    1295. 

  1295.         </aside>
    1296. 

  1296.     </div>
    1297. 

  1297. 

  1298.                                     <div class="row-fluid">
    1299. 

  1299.         <div class="span8 content class">
    1300. 

  1300.             <a id="method_getRequestFile" name="method_getRequestFile" class="anchor"></a>
    1301. 

  1301.             <article class="method">
    1302. 

  1302.                 <h3 class="public ">getRequestFile()</h3>
    1303. 

  1303.                 <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>
    1304. 

  1304.                 <pre class="signature" style="margin-right: 54px;">getRequestFile() : string|null</pre>
    1305. 

  1305.                 <p><em>Returns the absolute path to the content file to serve</em></p>
    1306. 

  1306.                 
    1307. 

  1307. 

  1308.                 
    1309. 

  1309.                 
    1310. 

  1310.                                     <h4>Returns</h4>
    1311. 

  1311.                     string|null
    1312. 

  1312.                                             &mdash; <p>file path</p>
    1313. 

  1313.                                     				
    1314. 

  1314.                             </article>
    1315. 

  1315.         </div>
    1316. 

  1316.         <aside class="span4 detailsbar">
    1317. 

  1317.             <h1><i class="icon-arrow-down"></i></h1>
    1318. 

  1318.                                                             <dl>
    1319. 

  1319.                                                                                             <dt>See also</dt>
    1320. 

  1320.                                                                 <dd><a href="../classes/Pico.html#method_discoverRequestFile"><span class="namespace-wrapper">\Pico::discoverRequestFile()</span></a></dd>
    1321. 

  1321.                                                                 </dl>
    1322. 

  1322.             <h2>Tags</h2>
    1323. 

  1323.             <table class="table table-condensed">
    1324. 

  1324.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1325. 

  1325.                             </table>
    1326. 

  1326.         </aside>
    1327. 

  1327.     </div>
    1328. 

  1328. 

  1329.                                     <div class="row-fluid">
    1330. 

  1330.         <div class="span8 content class">
    1331. 

  1331.             <a id="method_loadFileContent" name="method_loadFileContent" class="anchor"></a>
    1332. 

  1332.             <article class="method">
    1333. 

  1333.                 <h3 class="public ">loadFileContent()</h3>
    1334. 

  1334.                 <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>
    1335. 

  1335.                 <pre class="signature" style="margin-right: 54px;">loadFileContent(string  <span class="argument">$file</span>) : string</pre>
    1336. 

  1336.                 <p><em>Returns the raw contents of a file</em></p>
    1337. 

  1337.                 
    1338. 

  1338. 

  1339.                                     <h4>Parameters</h4>
    1340. 

  1340.                     <table class="table table-condensed table-hover">
    1341. 

  1341.                                                     <tr>
    1342. 

  1342.                                 <td>string</td>
    1343. 

  1343.                                 <td>$file </td>
    1344. 

  1344.                                 <td><p>file path</p></td>
    1345. 

  1345.                             </tr>
    1346. 

  1346.                                             </table>
    1347. 

  1347.                 
    1348. 

  1348.                 
    1349. 

  1349.                                     <h4>Returns</h4>
    1350. 

  1350.                     string
    1351. 

  1351.                                             &mdash; <p>raw contents of the file</p>
    1352. 

  1352.                                     				
    1353. 

  1353.                             </article>
    1354. 

  1354.         </div>
    1355. 

  1355.         <aside class="span4 detailsbar">
    1356. 

  1356.             <h1><i class="icon-arrow-down"></i></h1>
    1357. 

  1357.                                                             <dl>
    1358. 

  1358.                                                                                             <dt>See also</dt>
    1359. 

  1359.                                                                 <dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
    1360. 

  1360.                                                                 </dl>
    1361. 

  1361.             <h2>Tags</h2>
    1362. 

  1362.             <table class="table table-condensed">
    1363. 

  1363.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1364. 

  1364.                             </table>
    1365. 

  1365.         </aside>
    1366. 

  1366.     </div>
    1367. 

  1367. 

  1368.                                     <div class="row-fluid">
    1369. 

  1369.         <div class="span8 content class">
    1370. 

  1370.             <a id="method_load404Content" name="method_load404Content" class="anchor"></a>
    1371. 

  1371.             <article class="method">
    1372. 

  1372.                 <h3 class="public ">load404Content()</h3>
    1373. 

  1373.                 <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>
    1374. 

  1374.                 <pre class="signature" style="margin-right: 54px;">load404Content(string  <span class="argument">$file</span>) : string</pre>
    1375. 

  1375.                 <p><em>Returns the raw contents of the first found 404 file when traversing
    1376. 

  1376. up from the directory the requested file is in</em></p>
    1377. 

  1377.                 
    1378. 

  1378. 

  1379.                                     <h4>Parameters</h4>
    1380. 

  1380.                     <table class="table table-condensed table-hover">
    1381. 

  1381.                                                     <tr>
    1382. 

  1382.                                 <td>string</td>
    1383. 

  1383.                                 <td>$file </td>
    1384. 

  1384.                                 <td><p>path to requested (but not existing) file</p></td>
    1385. 

  1385.                             </tr>
    1386. 

  1386.                                             </table>
    1387. 

  1387.                 
    1388. 

  1388.                                     <h4>Throws</h4>
    1389. 

  1389.                     <dl>
    1390. 

  1390.                                                     <dt>\RuntimeException</dt>
    1391. 

  1391.                             <dd><p>thrown when no suitable 404 file is found</p></dd>
    1392. 

  1392.                                                                     </dl>
    1393. 

  1393.                 
    1394. 

  1394.                                     <h4>Returns</h4>
    1395. 

  1395.                     string
    1396. 

  1396.                                             &mdash; <p>raw contents of the 404 file</p>
    1397. 

  1397.                                     				
    1398. 

  1398.                             </article>
    1399. 

  1399.         </div>
    1400. 

  1400.         <aside class="span4 detailsbar">
    1401. 

  1401.             <h1><i class="icon-arrow-down"></i></h1>
    1402. 

  1402.                                                             <dl>
    1403. 

  1403.                                                                                             <dt>See also</dt>
    1404. 

  1404.                                                                 <dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
    1405. 

  1405.                                                                 </dl>
    1406. 

  1406.             <h2>Tags</h2>
    1407. 

  1407.             <table class="table table-condensed">
    1408. 

  1408.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1409. 

  1409.                             </table>
    1410. 

  1410.         </aside>
    1411. 

  1411.     </div>
    1412. 

  1412. 

  1413.                                     <div class="row-fluid">
    1414. 

  1414.         <div class="span8 content class">
    1415. 

  1415.             <a id="method_getRawContent" name="method_getRawContent" class="anchor"></a>
    1416. 

  1416.             <article class="method">
    1417. 

  1417.                 <h3 class="public ">getRawContent()</h3>
    1418. 

  1418.                 <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>
    1419. 

  1419.                 <pre class="signature" style="margin-right: 54px;">getRawContent() : string|null</pre>
    1420. 

  1420.                 <p><em>Returns the raw contents, either of the requested or the 404 file</em></p>
    1421. 

  1421.                 
    1422. 

  1422. 

  1423.                 
    1424. 

  1424.                 
    1425. 

  1425.                                     <h4>Returns</h4>
    1426. 

  1426.                     string|null
    1427. 

  1427.                                             &mdash; <p>raw contents</p>
    1428. 

  1428.                                     				
    1429. 

  1429.                             </article>
    1430. 

  1430.         </div>
    1431. 

  1431.         <aside class="span4 detailsbar">
    1432. 

  1432.             <h1><i class="icon-arrow-down"></i></h1>
    1433. 

  1433.                                                             <dl>
    1434. 

  1434.                                                                                             <dt>See also</dt>
    1435. 

  1435.                                                                 <dd><a href="../classes/Pico.html#method_loadFileContent"><span class="namespace-wrapper">\Pico::loadFileContent()</span></a></dd>
    1436. 

  1436.                                             <dd><a href="../classes/Pico.html#method_load404Content"><span class="namespace-wrapper">\Pico::load404Content()</span></a></dd>
    1437. 

  1437.                                                                 </dl>
    1438. 

  1438.             <h2>Tags</h2>
    1439. 

  1439.             <table class="table table-condensed">
    1440. 

  1440.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1441. 

  1441.                             </table>
    1442. 

  1442.         </aside>
    1443. 

  1443.     </div>
    1444. 

  1444. 

  1445.                                     <div class="row-fluid">
    1446. 

  1446.         <div class="span8 content class">
    1447. 

  1447.             <a id="method_getMetaHeaders" name="method_getMetaHeaders" class="anchor"></a>
    1448. 

  1448.             <article class="method">
    1449. 

  1449.                 <h3 class="public ">getMetaHeaders()</h3>
    1450. 

  1450.                 <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>
    1451. 

  1451.                 <pre class="signature" style="margin-right: 54px;">getMetaHeaders() : array&lt;mixed,string&gt;</pre>
    1452. 

  1452.                 <p><em>Returns known meta headers and triggers the onMetaHeaders event</em></p>
    1453. 

  1453.                 <p>Heads up! Calling this method triggers the <code>onMetaHeaders</code> event.
    1454. 

  1454. Keep this in mind to prevent a infinite loop!</p>
    1455. 

  1455. 

  1456.                 
    1457. 

  1457.                 
    1458. 

  1458.                                     <h4>Returns</h4>
    1459. 

  1459.                     array&lt;mixed,string&gt;
    1460. 

  1460.                                             &mdash; <p>known meta headers; the array value specifies the
    1461. 

  1461. YAML key to search for, the array key is later used to access the
    1462. 

  1462. found value</p>
    1463. 

  1463.                                     				
    1464. 

  1464.                             </article>
    1465. 

  1465.         </div>
    1466. 

  1466.         <aside class="span4 detailsbar">
    1467. 

  1467.             <h1><i class="icon-arrow-down"></i></h1>
    1468. 

  1468.                                                             <dl>
    1469. 

  1469.                                                                             </dl>
    1470. 

  1470.             <h2>Tags</h2>
    1471. 

  1471.             <table class="table table-condensed">
    1472. 

  1472.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1473. 

  1473.                             </table>
    1474. 

  1474.         </aside>
    1475. 

  1475.     </div>
    1476. 

  1476. 

  1477.                                     <div class="row-fluid">
    1478. 

  1478.         <div class="span8 content class">
    1479. 

  1479.             <a id="method_parseFileMeta" name="method_parseFileMeta" class="anchor"></a>
    1480. 

  1480.             <article class="method">
    1481. 

  1481.                 <h3 class="public ">parseFileMeta()</h3>
    1482. 

  1482.                 <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>
    1483. 

  1483.                 <pre class="signature" style="margin-right: 54px;">parseFileMeta(string  <span class="argument">$rawContent</span>, array&lt;mixed,string&gt;  <span class="argument">$headers</span>) : array</pre>
    1484. 

  1484.                 <p><em>Parses the file meta from raw file contents</em></p>
    1485. 

  1485.                 <p>Meta data MUST start on the first line of the file, either opened and
    1486. 

  1486. closed by <code>---</code> or C-style block comments (deprecated). The headers are
    1487. 

  1487. parsed by the YAML component of the Symfony project, keys are lowered.
    1488. 

  1488. If you're a plugin developer, you MUST register new headers during the
    1489. 

  1489. <code>onMetaHeaders</code> event first. The implicit availability of headers is
    1490. 

  1490. for users and pure (!) theme developers ONLY.</p>
    1491. 

  1491. 

  1492.                                     <h4>Parameters</h4>
    1493. 

  1493.                     <table class="table table-condensed table-hover">
    1494. 

  1494.                                                     <tr>
    1495. 

  1495.                                 <td>string</td>
    1496. 

  1496.                                 <td>$rawContent </td>
    1497. 

  1497.                                 <td><p>the raw file contents</p></td>
    1498. 

  1498.                             </tr>
    1499. 

  1499.                                                     <tr>
    1500. 

  1500.                                 <td>array&lt;mixed,string&gt;</td>
    1501. 

  1501.                                 <td>$headers </td>
    1502. 

  1502.                                 <td><p>known meta headers</p></td>
    1503. 

  1503.                             </tr>
    1504. 

  1504.                                             </table>
    1505. 

  1505.                 
    1506. 

  1506.                 
    1507. 

  1507.                                     <h4>Returns</h4>
    1508. 

  1508.                     array
    1509. 

  1509.                                             &mdash; <p>parsed meta data</p>
    1510. 

  1510.                                     				
    1511. 

  1511.                             </article>
    1512. 

  1512.         </div>
    1513. 

  1513.         <aside class="span4 detailsbar">
    1514. 

  1514.             <h1><i class="icon-arrow-down"></i></h1>
    1515. 

  1515.                                                             <dl>
    1516. 

  1516.                                                                                             <dt>See also</dt>
    1517. 

  1517.                                                                 <dd><a href="../classes/Pico.html#method_getFileMeta"><span class="namespace-wrapper">\Pico::getFileMeta()</span></a></dd>
    1518. 

  1518.                                             <dd><a href=""><span class="namespace-wrapper">\&lt;http://symfony.com/doc/current/components/yaml/introduction.html&gt;</span></a></dd>
    1519. 

  1519.                                                                 </dl>
    1520. 

  1520.             <h2>Tags</h2>
    1521. 

  1521.             <table class="table table-condensed">
    1522. 

  1522.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1523. 

  1523.                             </table>
    1524. 

  1524.         </aside>
    1525. 

  1525.     </div>
    1526. 

  1526. 

  1527.                                     <div class="row-fluid">
    1528. 

  1528.         <div class="span8 content class">
    1529. 

  1529.             <a id="method_getFileMeta" name="method_getFileMeta" class="anchor"></a>
    1530. 

  1530.             <article class="method">
    1531. 

  1531.                 <h3 class="public ">getFileMeta()</h3>
    1532. 

  1532.                 <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>
    1533. 

  1533.                 <pre class="signature" style="margin-right: 54px;">getFileMeta() : array|null</pre>
    1534. 

  1534.                 <p><em>Returns the parsed meta data of the requested page</em></p>
    1535. 

  1535.                 
    1536. 

  1536. 

  1537.                 
    1538. 

  1538.                 
    1539. 

  1539.                                     <h4>Returns</h4>
    1540. 

  1540.                     array|null
    1541. 

  1541.                                             &mdash; <p>parsed meta data</p>
    1542. 

  1542.                                     				
    1543. 

  1543.                             </article>
    1544. 

  1544.         </div>
    1545. 

  1545.         <aside class="span4 detailsbar">
    1546. 

  1546.             <h1><i class="icon-arrow-down"></i></h1>
    1547. 

  1547.                                                             <dl>
    1548. 

  1548.                                                                                             <dt>See also</dt>
    1549. 

  1549.                                                                 <dd><a href="../classes/Pico.html#method_parseFileMeta"><span class="namespace-wrapper">\Pico::parseFileMeta()</span></a></dd>
    1550. 

  1550.                                                                 </dl>
    1551. 

  1551.             <h2>Tags</h2>
    1552. 

  1552.             <table class="table table-condensed">
    1553. 

  1553.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1554. 

  1554.                             </table>
    1555. 

  1555.         </aside>
    1556. 

  1556.     </div>
    1557. 

  1557. 

  1558.                                     <div class="row-fluid">
    1559. 

  1559.         <div class="span8 content class">
    1560. 

  1560.             <a id="method_prepareFileContent" name="method_prepareFileContent" class="anchor"></a>
    1561. 

  1561.             <article class="method">
    1562. 

  1562.                 <h3 class="public ">prepareFileContent()</h3>
    1563. 

  1563.                 <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>
    1564. 

  1564.                 <pre class="signature" style="margin-right: 54px;">prepareFileContent(string  <span class="argument">$rawContent</span>) : string</pre>
    1565. 

  1565.                 <p><em>Applies some static preparations to the raw contents of a page,
    1566. 

  1566. e.g. removing the meta header and replacing %base_url%</em></p>
    1567. 

  1567.                 
    1568. 

  1568. 

  1569.                                     <h4>Parameters</h4>
    1570. 

  1570.                     <table class="table table-condensed table-hover">
    1571. 

  1571.                                                     <tr>
    1572. 

  1572.                                 <td>string</td>
    1573. 

  1573.                                 <td>$rawContent </td>
    1574. 

  1574.                                 <td><p>raw contents of a page</p></td>
    1575. 

  1575.                             </tr>
    1576. 

  1576.                                             </table>
    1577. 

  1577.                 
    1578. 

  1578.                 
    1579. 

  1579.                                     <h4>Returns</h4>
    1580. 

  1580.                     string
    1581. 

  1581.                                             &mdash; <p>contents prepared for parsing</p>
    1582. 

  1582.                                     				
    1583. 

  1583.                             </article>
    1584. 

  1584.         </div>
    1585. 

  1585.         <aside class="span4 detailsbar">
    1586. 

  1586.             <h1><i class="icon-arrow-down"></i></h1>
    1587. 

  1587.                                                             <dl>
    1588. 

  1588.                                                                                             <dt>See also</dt>
    1589. 

  1589.                                                                 <dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
    1590. 

  1590.                                             <dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
    1591. 

  1591.                                                                 </dl>
    1592. 

  1592.             <h2>Tags</h2>
    1593. 

  1593.             <table class="table table-condensed">
    1594. 

  1594.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1595. 

  1595.                             </table>
    1596. 

  1596.         </aside>
    1597. 

  1597.     </div>
    1598. 

  1598. 

  1599.                                     <div class="row-fluid">
    1600. 

  1600.         <div class="span8 content class">
    1601. 

  1601.             <a id="method_parseFileContent" name="method_parseFileContent" class="anchor"></a>
    1602. 

  1602.             <article class="method">
    1603. 

  1603.                 <h3 class="public ">parseFileContent()</h3>
    1604. 

  1604.                 <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>
    1605. 

  1605.                 <pre class="signature" style="margin-right: 54px;">parseFileContent(string  <span class="argument">$content</span>) : string</pre>
    1606. 

  1606.                 <p><em>Parses the contents of a page using ParsedownExtra</em></p>
    1607. 

  1607.                 
    1608. 

  1608. 

  1609.                                     <h4>Parameters</h4>
    1610. 

  1610.                     <table class="table table-condensed table-hover">
    1611. 

  1611.                                                     <tr>
    1612. 

  1612.                                 <td>string</td>
    1613. 

  1613.                                 <td>$content </td>
    1614. 

  1614.                                 <td><p>raw contents of a page (Markdown)</p></td>
    1615. 

  1615.                             </tr>
    1616. 

  1616.                                             </table>
    1617. 

  1617.                 
    1618. 

  1618.                 
    1619. 

  1619.                                     <h4>Returns</h4>
    1620. 

  1620.                     string
    1621. 

  1621.                                             &mdash; <p>parsed contents (HTML)</p>
    1622. 

  1622.                                     				
    1623. 

  1623.                             </article>
    1624. 

  1624.         </div>
    1625. 

  1625.         <aside class="span4 detailsbar">
    1626. 

  1626.             <h1><i class="icon-arrow-down"></i></h1>
    1627. 

  1627.                                                             <dl>
    1628. 

  1628.                                                                                             <dt>See also</dt>
    1629. 

  1629.                                                                 <dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
    1630. 

  1630.                                             <dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
    1631. 

  1631.                                                                 </dl>
    1632. 

  1632.             <h2>Tags</h2>
    1633. 

  1633.             <table class="table table-condensed">
    1634. 

  1634.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1635. 

  1635.                             </table>
    1636. 

  1636.         </aside>
    1637. 

  1637.     </div>
    1638. 

  1638. 

  1639.                                     <div class="row-fluid">
    1640. 

  1640.         <div class="span8 content class">
    1641. 

  1641.             <a id="method_getFileContent" name="method_getFileContent" class="anchor"></a>
    1642. 

  1642.             <article class="method">
    1643. 

  1643.                 <h3 class="public ">getFileContent()</h3>
    1644. 

  1644.                 <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>
    1645. 

  1645.                 <pre class="signature" style="margin-right: 54px;">getFileContent() : string|null</pre>
    1646. 

  1646.                 <p><em>Returns the cached contents of the requested page</em></p>
    1647. 

  1647.                 
    1648. 

  1648. 

  1649.                 
    1650. 

  1650.                 
    1651. 

  1651.                                     <h4>Returns</h4>
    1652. 

  1652.                     string|null
    1653. 

  1653.                                             &mdash; <p>parsed contents</p>
    1654. 

  1654.                                     				
    1655. 

  1655.                             </article>
    1656. 

  1656.         </div>
    1657. 

  1657.         <aside class="span4 detailsbar">
    1658. 

  1658.             <h1><i class="icon-arrow-down"></i></h1>
    1659. 

  1659.                                                             <dl>
    1660. 

  1660.                                                                                             <dt>See also</dt>
    1661. 

  1661.                                                                 <dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
    1662. 

  1662.                                             <dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
    1663. 

  1663.                                                                 </dl>
    1664. 

  1664.             <h2>Tags</h2>
    1665. 

  1665.             <table class="table table-condensed">
    1666. 

  1666.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1667. 

  1667.                             </table>
    1668. 

  1668.         </aside>
    1669. 

  1669.     </div>
    1670. 

  1670. 

  1671.                                     <div class="row-fluid">
    1672. 

  1672.         <div class="span8 content class">
    1673. 

  1673.             <a id="method_getPages" name="method_getPages" class="anchor"></a>
    1674. 

  1674.             <article class="method">
    1675. 

  1675.                 <h3 class="public ">getPages()</h3>
    1676. 

  1676.                 <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>
    1677. 

  1677.                 <pre class="signature" style="margin-right: 54px;">getPages() : array|null</pre>
    1678. 

  1678.                 <p><em>Returns the list of known pages</em></p>
    1679. 

  1679.                 
    1680. 

  1680. 

  1681.                 
    1682. 

  1682.                 
    1683. 

  1683.                                     <h4>Returns</h4>
    1684. 

  1684.                     array|null
    1685. 

  1685.                                             &mdash; <p>the data of all pages</p>
    1686. 

  1686.                                     				
    1687. 

  1687.                             </article>
    1688. 

  1688.         </div>
    1689. 

  1689.         <aside class="span4 detailsbar">
    1690. 

  1690.             <h1><i class="icon-arrow-down"></i></h1>
    1691. 

  1691.                                                             <dl>
    1692. 

  1692.                                                                                             <dt>See also</dt>
    1693. 

  1693.                                                                 <dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
    1694. 

  1694.                                             <dd><a href="../classes/Pico.html#method_sortPages"><span class="namespace-wrapper">\Pico::sortPages()</span></a></dd>
    1695. 

  1695.                                                                 </dl>
    1696. 

  1696.             <h2>Tags</h2>
    1697. 

  1697.             <table class="table table-condensed">
    1698. 

  1698.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1699. 

  1699.                             </table>
    1700. 

  1700.         </aside>
    1701. 

  1701.     </div>
    1702. 

  1702. 

  1703.                                     <div class="row-fluid">
    1704. 

  1704.         <div class="span8 content class">
    1705. 

  1705.             <a id="method_getCurrentPage" name="method_getCurrentPage" class="anchor"></a>
    1706. 

  1706.             <article class="method">
    1707. 

  1707.                 <h3 class="public ">getCurrentPage()</h3>
    1708. 

  1708.                 <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>
    1709. 

  1709.                 <pre class="signature" style="margin-right: 54px;">getCurrentPage() : array|null</pre>
    1710. 

  1710.                 <p><em>Returns the data of the requested page</em></p>
    1711. 

  1711.                 
    1712. 

  1712. 

  1713.                 
    1714. 

  1714.                 
    1715. 

  1715.                                     <h4>Returns</h4>
    1716. 

  1716.                     array|null
    1717. 

  1717.                                             &mdash; <p>page data</p>
    1718. 

  1718.                                     				
    1719. 

  1719.                             </article>
    1720. 

  1720.         </div>
    1721. 

  1721.         <aside class="span4 detailsbar">
    1722. 

  1722.             <h1><i class="icon-arrow-down"></i></h1>
    1723. 

  1723.                                                             <dl>
    1724. 

  1724.                                                                                             <dt>See also</dt>
    1725. 

  1725.                                                                 <dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
    1726. 

  1726.                                                                 </dl>
    1727. 

  1727.             <h2>Tags</h2>
    1728. 

  1728.             <table class="table table-condensed">
    1729. 

  1729.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1730. 

  1730.                             </table>
    1731. 

  1731.         </aside>
    1732. 

  1732.     </div>
    1733. 

  1733. 

  1734.                                     <div class="row-fluid">
    1735. 

  1735.         <div class="span8 content class">
    1736. 

  1736.             <a id="method_getPreviousPage" name="method_getPreviousPage" class="anchor"></a>
    1737. 

  1737.             <article class="method">
    1738. 

  1738.                 <h3 class="public ">getPreviousPage()</h3>
    1739. 

  1739.                 <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>
    1740. 

  1740.                 <pre class="signature" style="margin-right: 54px;">getPreviousPage() : array|null</pre>
    1741. 

  1741.                 <p><em>Returns the data of the previous page relative to the page being served</em></p>
    1742. 

  1742.                 
    1743. 

  1743. 

  1744.                 
    1745. 

  1745.                 
    1746. 

  1746.                                     <h4>Returns</h4>
    1747. 

  1747.                     array|null
    1748. 

  1748.                                             &mdash; <p>page data</p>
    1749. 

  1749.                                     				
    1750. 

  1750.                             </article>
    1751. 

  1751.         </div>
    1752. 

  1752.         <aside class="span4 detailsbar">
    1753. 

  1753.             <h1><i class="icon-arrow-down"></i></h1>
    1754. 

  1754.                                                             <dl>
    1755. 

  1755.                                                                                             <dt>See also</dt>
    1756. 

  1756.                                                                 <dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
    1757. 

  1757.                                                                 </dl>
    1758. 

  1758.             <h2>Tags</h2>
    1759. 

  1759.             <table class="table table-condensed">
    1760. 

  1760.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1761. 

  1761.                             </table>
    1762. 

  1762.         </aside>
    1763. 

  1763.     </div>
    1764. 

  1764. 

  1765.                                     <div class="row-fluid">
    1766. 

  1766.         <div class="span8 content class">
    1767. 

  1767.             <a id="method_getNextPage" name="method_getNextPage" class="anchor"></a>
    1768. 

  1768.             <article class="method">
    1769. 

  1769.                 <h3 class="public ">getNextPage()</h3>
    1770. 

  1770.                 <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>
    1771. 

  1771.                 <pre class="signature" style="margin-right: 54px;">getNextPage() : array|null</pre>
    1772. 

  1772.                 <p><em>Returns the data of the next page relative to the page being served</em></p>
    1773. 

  1773.                 
    1774. 

  1774. 

  1775.                 
    1776. 

  1776.                 
    1777. 

  1777.                                     <h4>Returns</h4>
    1778. 

  1778.                     array|null
    1779. 

  1779.                                             &mdash; <p>page data</p>
    1780. 

  1780.                                     				
    1781. 

  1781.                             </article>
    1782. 

  1782.         </div>
    1783. 

  1783.         <aside class="span4 detailsbar">
    1784. 

  1784.             <h1><i class="icon-arrow-down"></i></h1>
    1785. 

  1785.                                                             <dl>
    1786. 

  1786.                                                                                             <dt>See also</dt>
    1787. 

  1787.                                                                 <dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
    1788. 

  1788.                                                                 </dl>
    1789. 

  1789.             <h2>Tags</h2>
    1790. 

  1790.             <table class="table table-condensed">
    1791. 

  1791.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1792. 

  1792.                             </table>
    1793. 

  1793.         </aside>
    1794. 

  1794.     </div>
    1795. 

  1795. 

  1796.                                     <div class="row-fluid">
    1797. 

  1797.         <div class="span8 content class">
    1798. 

  1798.             <a id="method_getTwig" name="method_getTwig" class="anchor"></a>
    1799. 

  1799.             <article class="method">
    1800. 

  1800.                 <h3 class="public ">getTwig()</h3>
    1801. 

  1801.                 <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>
    1802. 

  1802.                 <pre class="signature" style="margin-right: 54px;">getTwig() : \Twig_Environment|null</pre>
    1803. 

  1803.                 <p><em>Returns the twig template engine</em></p>
    1804. 

  1804.                 
    1805. 

  1805. 

  1806.                 
    1807. 

  1807.                 
    1808. 

  1808.                                     <h4>Returns</h4>
    1809. 

  1809.                     \Twig_Environment|null
    1810. 

  1810.                                             &mdash; <p>twig template engine</p>
    1811. 

  1811.                                     				
    1812. 

  1812.                             </article>
    1813. 

  1813.         </div>
    1814. 

  1814.         <aside class="span4 detailsbar">
    1815. 

  1815.             <h1><i class="icon-arrow-down"></i></h1>
    1816. 

  1816.                                                             <dl>
    1817. 

  1817.                                                                                             <dt>See also</dt>
    1818. 

  1818.                                                                 <dd><a href="../classes/Pico.html#method_registerTwig"><span class="namespace-wrapper">\Pico::registerTwig()</span></a></dd>
    1819. 

  1819.                                                                 </dl>
    1820. 

  1820.             <h2>Tags</h2>
    1821. 

  1821.             <table class="table table-condensed">
    1822. 

  1822.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1823. 

  1823.                             </table>
    1824. 

  1824.         </aside>
    1825. 

  1825.     </div>
    1826. 

  1826. 

  1827.                                     <div class="row-fluid">
    1828. 

  1828.         <div class="span8 content class">
    1829. 

  1829.             <a id="method_getBaseUrl" name="method_getBaseUrl" class="anchor"></a>
    1830. 

  1830.             <article class="method">
    1831. 

  1831.                 <h3 class="public ">getBaseUrl()</h3>
    1832. 

  1832.                 <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>
    1833. 

  1833.                 <pre class="signature" style="margin-right: 54px;">getBaseUrl() : string</pre>
    1834. 

  1834.                 <p><em>Returns the base URL of this Pico instance</em></p>
    1835. 

  1835.                 
    1836. 

  1836. 

  1837.                 
    1838. 

  1838.                 
    1839. 

  1839.                                     <h4>Returns</h4>
    1840. 

  1840.                     string
    1841. 

  1841.                                             &mdash; <p>the base url</p>
    1842. 

  1842.                                     				
    1843. 

  1843.                             </article>
    1844. 

  1844.         </div>
    1845. 

  1845.         <aside class="span4 detailsbar">
    1846. 

  1846.             <h1><i class="icon-arrow-down"></i></h1>
    1847. 

  1847.                                                             <dl>
    1848. 

  1848.                                                                             </dl>
    1849. 

  1849.             <h2>Tags</h2>
    1850. 

  1850.             <table class="table table-condensed">
    1851. 

  1851.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1852. 

  1852.                             </table>
    1853. 

  1853.         </aside>
    1854. 

  1854.     </div>
    1855. 

  1855. 

  1856.                                     <div class="row-fluid">
    1857. 

  1857.         <div class="span8 content class">
    1858. 

  1858.             <a id="method_isUrlRewritingEnabled" name="method_isUrlRewritingEnabled" class="anchor"></a>
    1859. 

  1859.             <article class="method">
    1860. 

  1860.                 <h3 class="public ">isUrlRewritingEnabled()</h3>
    1861. 

  1861.                 <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>
    1862. 

  1862.                 <pre class="signature" style="margin-right: 54px;">isUrlRewritingEnabled() : boolean</pre>
    1863. 

  1863.                 <p><em>Returns true if URL rewriting is enabled</em></p>
    1864. 

  1864.                 
    1865. 

  1865. 

  1866.                 
    1867. 

  1867.                 
    1868. 

  1868.                                     <h4>Returns</h4>
    1869. 

  1869.                     boolean
    1870. 

  1870.                                             &mdash; <p>true if URL rewriting is enabled, false otherwise</p>
    1871. 

  1871.                                     				
    1872. 

  1872.                             </article>
    1873. 

  1873.         </div>
    1874. 

  1874.         <aside class="span4 detailsbar">
    1875. 

  1875.             <h1><i class="icon-arrow-down"></i></h1>
    1876. 

  1876.                                                             <dl>
    1877. 

  1877.                                                                             </dl>
    1878. 

  1878.             <h2>Tags</h2>
    1879. 

  1879.             <table class="table table-condensed">
    1880. 

  1880.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1881. 

  1881.                             </table>
    1882. 

  1882.         </aside>
    1883. 

  1883.     </div>
    1884. 

  1884. 

  1885.                                     <div class="row-fluid">
    1886. 

  1886.         <div class="span8 content class">
    1887. 

  1887.             <a id="method_getPageUrl" name="method_getPageUrl" class="anchor"></a>
    1888. 

  1888.             <article class="method">
    1889. 

  1889.                 <h3 class="public ">getPageUrl()</h3>
    1890. 

  1890.                 <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>
    1891. 

  1891.                 <pre class="signature" style="margin-right: 54px;">getPageUrl(string  <span class="argument">$page</span>) : string</pre>
    1892. 

  1892.                 <p><em>Returns the URL to a given page</em></p>
    1893. 

  1893.                 
    1894. 

  1894. 

  1895.                                     <h4>Parameters</h4>
    1896. 

  1896.                     <table class="table table-condensed table-hover">
    1897. 

  1897.                                                     <tr>
    1898. 

  1898.                                 <td>string</td>
    1899. 

  1899.                                 <td>$page </td>
    1900. 

  1900.                                 <td><p>identifier of the page to link to</p></td>
    1901. 

  1901.                             </tr>
    1902. 

  1902.                                             </table>
    1903. 

  1903.                 
    1904. 

  1904.                 
    1905. 

  1905.                                     <h4>Returns</h4>
    1906. 

  1906.                     string
    1907. 

  1907.                                             &mdash; <p>URL</p>
    1908. 

  1908.                                     				
    1909. 

  1909.                             </article>
    1910. 

  1910.         </div>
    1911. 

  1911.         <aside class="span4 detailsbar">
    1912. 

  1912.             <h1><i class="icon-arrow-down"></i></h1>
    1913. 

  1913.                                                             <dl>
    1914. 

  1914.                                                                             </dl>
    1915. 

  1915.             <h2>Tags</h2>
    1916. 

  1916.             <table class="table table-condensed">
    1917. 

  1917.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1918. 

  1918.                             </table>
    1919. 

  1919.         </aside>
    1920. 

  1920.     </div>
    1921. 

  1921. 

  1922.                                                     <div class="row-fluid">
    1923. 

  1923.         <div class="span8 content class">
    1924. 

  1924.             <a id="method_loadPlugins" name="method_loadPlugins" class="anchor"></a>
    1925. 

  1925.             <article class="method">
    1926. 

  1926.                 <h3 class="protected ">loadPlugins()</h3>
    1927. 

  1927.                 <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>
    1928. 

  1928.                 <pre class="signature" style="margin-right: 54px;">loadPlugins() : void</pre>
    1929. 

  1929.                 <p><em>Loads plugins from Pico::$pluginsDir in alphabetical order</em></p>
    1930. 

  1930.                 <p>Plugin files may be prefixed by a number (e.g. 00-PicoDeprecated.php)
    1931. 

  1931. to indicate their processing order. You MUST NOT use prefixes between
    1932. 

  1932. 00 and 19 (reserved for built-in plugins).</p>
    1933. 

  1933. 

  1934.                 
    1935. 

  1935.                                     <h4>Throws</h4>
    1936. 

  1936.                     <dl>
    1937. 

  1937.                                                     <dt>\RuntimeException</dt>
    1938. 

  1938.                             <dd><p>thrown when a plugin couldn't be loaded</p></dd>
    1939. 

  1939.                                                                     </dl>
    1940. 

  1940.                 
    1941. 

  1941.                 				
    1942. 

  1942.                             </article>
    1943. 

  1943.         </div>
    1944. 

  1944.         <aside class="span4 detailsbar">
    1945. 

  1945.             <h1><i class="icon-arrow-down"></i></h1>
    1946. 

  1946.                                                             <dl>
    1947. 

  1947.                                                                                             <dt>See also</dt>
    1948. 

  1948.                                                                 <dd><a href="../classes/Pico.html#method_getPlugin"><span class="namespace-wrapper">\Pico::getPlugin()</span></a></dd>
    1949. 

  1949.                                             <dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
    1950. 

  1950.                                                                 </dl>
    1951. 

  1951.             <h2>Tags</h2>
    1952. 

  1952.             <table class="table table-condensed">
    1953. 

  1953.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1954. 

  1954.                             </table>
    1955. 

  1955.         </aside>
    1956. 

  1956.     </div>
    1957. 

  1957. 

  1958.                                     <div class="row-fluid">
    1959. 

  1959.         <div class="span8 content class">
    1960. 

  1960.             <a id="method_loadConfig" name="method_loadConfig" class="anchor"></a>
    1961. 

  1961.             <article class="method">
    1962. 

  1962.                 <h3 class="protected ">loadConfig()</h3>
    1963. 

  1963.                 <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>
    1964. 

  1964.                 <pre class="signature" style="margin-right: 54px;">loadConfig() : void</pre>
    1965. 

  1965.                 <p><em>Loads the config.php from Pico::$configDir</em></p>
    1966. 

  1966.                 
    1967. 

  1967. 

  1968.                 
    1969. 

  1969.                 
    1970. 

  1970.                 				
    1971. 

  1971.                             </article>
    1972. 

  1972.         </div>
    1973. 

  1973.         <aside class="span4 detailsbar">
    1974. 

  1974.             <h1><i class="icon-arrow-down"></i></h1>
    1975. 

  1975.                                                             <dl>
    1976. 

  1976.                                                                                             <dt>See also</dt>
    1977. 

  1977.                                                                 <dd><a href="../classes/Pico.html#method_setConfig"><span class="namespace-wrapper">\Pico::setConfig()</span></a></dd>
    1978. 

  1978.                                             <dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
    1979. 

  1979.                                                                 </dl>
    1980. 

  1980.             <h2>Tags</h2>
    1981. 

  1981.             <table class="table table-condensed">
    1982. 

  1982.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    1983. 

  1983.                             </table>
    1984. 

  1984.         </aside>
    1985. 

  1985.     </div>
    1986. 

  1986. 

  1987.                                     <div class="row-fluid">
    1988. 

  1988.         <div class="span8 content class">
    1989. 

  1989.             <a id="method_evaluateRequestUrl" name="method_evaluateRequestUrl" class="anchor"></a>
    1990. 

  1990.             <article class="method">
    1991. 

  1991.                 <h3 class="protected ">evaluateRequestUrl()</h3>
    1992. 

  1992.                 <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>
    1993. 

  1993.                 <pre class="signature" style="margin-right: 54px;">evaluateRequestUrl() : void</pre>
    1994. 

  1994.                 <p><em>Evaluates the requested URL</em></p>
    1995. 

  1995.                 <p>Pico 1.0 uses the <code>QUERY_STRING</code> routing method (e.g. <code>/pico/?sub/page</code>)
    1996. 

  1996. to support SEO-like URLs out-of-the-box with any webserver. You can
    1997. 

  1997. still setup URL rewriting (e.g. using <code>mod_rewrite</code> on Apache) to
    1998. 

  1998. basically remove the <code>?</code> from URLs, but your rewritten URLs must follow
    1999. 

  1999. the new <code>QUERY_STRING</code> principles. URL rewriting requires some special
    2000. 

  2000. configuration on your webserver, but this should be &quot;basic work&quot; for
    2001. 

  2001. any webmaster...</p>
    2002. 

  2002. <p>Pico 0.9 and older required Apache with <code>mod_rewrite</code> enabled, thus old
    2003. 

  2003. plugins, templates and contents may require you to enable URL rewriting
    2004. 

  2004. to work. If you're upgrading from Pico 0.9, you will probably have to
    2005. 

  2005. update your rewriting rules.</p>
    2006. 

  2006. <p>We recommend you to use the <code>link</code> filter in templates to create
    2007. 

  2007. internal links, e.g. <code>{{ "sub/page"|link }}</code> is equivalent to
    2008. 

  2008. <code>{{ base_url }}sub/page</code>. In content files you can still use the
    2009. 

  2009. <code>%base_url%</code> variable; e.g. <code>%base_url%?sub/page</code> will be automatically
    2010. 

  2010. replaced accordingly.</p>
    2011. 

  2011. 

  2012.                 
    2013. 

  2013.                 
    2014. 

  2014.                 				
    2015. 

  2015.                             </article>
    2016. 

  2016.         </div>
    2017. 

  2017.         <aside class="span4 detailsbar">
    2018. 

  2018.             <h1><i class="icon-arrow-down"></i></h1>
    2019. 

  2019.                                                             <dl>
    2020. 

  2020.                                                                                             <dt>See also</dt>
    2021. 

  2021.                                                                 <dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
    2022. 

  2022.                                                                 </dl>
    2023. 

  2023.             <h2>Tags</h2>
    2024. 

  2024.             <table class="table table-condensed">
    2025. 

  2025.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2026. 

  2026.                             </table>
    2027. 

  2027.         </aside>
    2028. 

  2028.     </div>
    2029. 

  2029. 

  2030.                                     <div class="row-fluid">
    2031. 

  2031.         <div class="span8 content class">
    2032. 

  2032.             <a id="method_discoverRequestFile" name="method_discoverRequestFile" class="anchor"></a>
    2033. 

  2033.             <article class="method">
    2034. 

  2034.                 <h3 class="protected ">discoverRequestFile()</h3>
    2035. 

  2035.                 <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>
    2036. 

  2036.                 <pre class="signature" style="margin-right: 54px;">discoverRequestFile() : void</pre>
    2037. 

  2037.                 <p><em>Uses the request URL to discover the content file to serve</em></p>
    2038. 

  2038.                 
    2039. 

  2039. 

  2040.                 
    2041. 

  2041.                 
    2042. 

  2042.                 				
    2043. 

  2043.                             </article>
    2044. 

  2044.         </div>
    2045. 

  2045.         <aside class="span4 detailsbar">
    2046. 

  2046.             <h1><i class="icon-arrow-down"></i></h1>
    2047. 

  2047.                                                             <dl>
    2048. 

  2048.                                                                                             <dt>See also</dt>
    2049. 

  2049.                                                                 <dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
    2050. 

  2050.                                                                 </dl>
    2051. 

  2051.             <h2>Tags</h2>
    2052. 

  2052.             <table class="table table-condensed">
    2053. 

  2053.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2054. 

  2054.                             </table>
    2055. 

  2055.         </aside>
    2056. 

  2056.     </div>
    2057. 

  2057. 

  2058.                                     <div class="row-fluid">
    2059. 

  2059.         <div class="span8 content class">
    2060. 

  2060.             <a id="method_readPages" name="method_readPages" class="anchor"></a>
    2061. 

  2061.             <article class="method">
    2062. 

  2062.                 <h3 class="protected ">readPages()</h3>
    2063. 

  2063.                 <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>
    2064. 

  2064.                 <pre class="signature" style="margin-right: 54px;">readPages() : void</pre>
    2065. 

  2065.                 <p><em>Reads the data of all pages known to Pico</em></p>
    2066. 

  2066.                 <p>The page data will be an array containing the following values:</p>
    2067. 

  2067. <pre>
    2068. 

  2068. +----------------+--------+------------------------------------------+
    2069. 

  2069. | Array key      | Type   | Description                              |
    2070. 

  2070. +----------------+--------+------------------------------------------+
    2071. 

  2071. | id             | string | relative path to the content file        |
    2072. 

  2072. | url            | string | URL to the page                          |
    2073. 

  2073. | title          | string | title of the page (YAML header)          |
    2074. 

  2074. | description    | string | description of the page (YAML header)    |
    2075. 

  2075. | author         | string | author of the page (YAML header)         |
    2076. 

  2076. | time           | string | timestamp derived from the Date header   |
    2077. 

  2077. | date           | string | date of the page (YAML header)           |
    2078. 

  2078. | date_formatted | string | formatted date of the page               |
    2079. 

  2079. | raw_content    | string | raw, not yet parsed contents of the page |
    2080. 

  2080. | meta           | string | parsed meta data of the page             |
    2081. 

  2081. +----------------+--------+------------------------------------------+
    2082. 

  2082. </pre>
    2083. 

  2083. 

  2084.                 
    2085. 

  2085.                 
    2086. 

  2086.                 				
    2087. 

  2087.                             </article>
    2088. 

  2088.         </div>
    2089. 

  2089.         <aside class="span4 detailsbar">
    2090. 

  2090.             <h1><i class="icon-arrow-down"></i></h1>
    2091. 

  2091.                                                             <dl>
    2092. 

  2092.                                                                                             <dt>See also</dt>
    2093. 

  2093.                                                                 <dd><a href="../classes/Pico.html#method_sortPages"><span class="namespace-wrapper">\Pico::sortPages()</span></a></dd>
    2094. 

  2094.                                             <dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
    2095. 

  2095.                                                                 </dl>
    2096. 

  2096.             <h2>Tags</h2>
    2097. 

  2097.             <table class="table table-condensed">
    2098. 

  2098.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2099. 

  2099.                             </table>
    2100. 

  2100.         </aside>
    2101. 

  2101.     </div>
    2102. 

  2102. 

  2103.                                     <div class="row-fluid">
    2104. 

  2104.         <div class="span8 content class">
    2105. 

  2105.             <a id="method_sortPages" name="method_sortPages" class="anchor"></a>
    2106. 

  2106.             <article class="method">
    2107. 

  2107.                 <h3 class="protected ">sortPages()</h3>
    2108. 

  2108.                 <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>
    2109. 

  2109.                 <pre class="signature" style="margin-right: 54px;">sortPages() : void</pre>
    2110. 

  2110.                 <p><em>Sorts all pages known to Pico</em></p>
    2111. 

  2111.                 
    2112. 

  2112. 

  2113.                 
    2114. 

  2114.                 
    2115. 

  2115.                 				
    2116. 

  2116.                             </article>
    2117. 

  2117.         </div>
    2118. 

  2118.         <aside class="span4 detailsbar">
    2119. 

  2119.             <h1><i class="icon-arrow-down"></i></h1>
    2120. 

  2120.                                                             <dl>
    2121. 

  2121.                                                                                             <dt>See also</dt>
    2122. 

  2122.                                                                 <dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
    2123. 

  2123.                                             <dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
    2124. 

  2124.                                                                 </dl>
    2125. 

  2125.             <h2>Tags</h2>
    2126. 

  2126.             <table class="table table-condensed">
    2127. 

  2127.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2128. 

  2128.                             </table>
    2129. 

  2129.         </aside>
    2130. 

  2130.     </div>
    2131. 

  2131. 

  2132.                                     <div class="row-fluid">
    2133. 

  2133.         <div class="span8 content class">
    2134. 

  2134.             <a id="method_discoverCurrentPage" name="method_discoverCurrentPage" class="anchor"></a>
    2135. 

  2135.             <article class="method">
    2136. 

  2136.                 <h3 class="protected ">discoverCurrentPage()</h3>
    2137. 

  2137.                 <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>
    2138. 

  2138.                 <pre class="signature" style="margin-right: 54px;">discoverCurrentPage() : void</pre>
    2139. 

  2139.                 <p><em>Walks through the list of known pages and discovers the requested page
    2140. 

  2140. as well as the previous and next page relative to it</em></p>
    2141. 

  2141.                 
    2142. 

  2142. 

  2143.                 
    2144. 

  2144.                 
    2145. 

  2145.                 				
    2146. 

  2146.                             </article>
    2147. 

  2147.         </div>
    2148. 

  2148.         <aside class="span4 detailsbar">
    2149. 

  2149.             <h1><i class="icon-arrow-down"></i></h1>
    2150. 

  2150.                                                             <dl>
    2151. 

  2151.                                                                                             <dt>See also</dt>
    2152. 

  2152.                                                                 <dd><a href="../classes/Pico.html#method_getCurrentPage"><span class="namespace-wrapper">\Pico::getCurrentPage()</span></a></dd>
    2153. 

  2153.                                             <dd><a href="../classes/Pico.html#method_getPreviousPage"><span class="namespace-wrapper">\Pico::getPreviousPage()</span></a></dd>
    2154. 

  2154.                                             <dd><a href="../classes/Pico.html#method_getNextPage"><span class="namespace-wrapper">\Pico::getNextPage()</span></a></dd>
    2155. 

  2155.                                                                 </dl>
    2156. 

  2156.             <h2>Tags</h2>
    2157. 

  2157.             <table class="table table-condensed">
    2158. 

  2158.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2159. 

  2159.                             </table>
    2160. 

  2160.         </aside>
    2161. 

  2161.     </div>
    2162. 

  2162. 

  2163.                                     <div class="row-fluid">
    2164. 

  2164.         <div class="span8 content class">
    2165. 

  2165.             <a id="method_registerTwig" name="method_registerTwig" class="anchor"></a>
    2166. 

  2166.             <article class="method">
    2167. 

  2167.                 <h3 class="protected ">registerTwig()</h3>
    2168. 

  2168.                 <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>
    2169. 

  2169.                 <pre class="signature" style="margin-right: 54px;">registerTwig() : void</pre>
    2170. 

  2170.                 <p><em>Registers the twig template engine</em></p>
    2171. 

  2171.                 
    2172. 

  2172. 

  2173.                 
    2174. 

  2174.                 
    2175. 

  2175.                 				
    2176. 

  2176.                             </article>
    2177. 

  2177.         </div>
    2178. 

  2178.         <aside class="span4 detailsbar">
    2179. 

  2179.             <h1><i class="icon-arrow-down"></i></h1>
    2180. 

  2180.                                                             <dl>
    2181. 

  2181.                                                                                             <dt>See also</dt>
    2182. 

  2182.                                                                 <dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
    2183. 

  2183.                                                                 </dl>
    2184. 

  2184.             <h2>Tags</h2>
    2185. 

  2185.             <table class="table table-condensed">
    2186. 

  2186.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2187. 

  2187.                             </table>
    2188. 

  2188.         </aside>
    2189. 

  2189.     </div>
    2190. 

  2190. 

  2191.                                     <div class="row-fluid">
    2192. 

  2192.         <div class="span8 content class">
    2193. 

  2193.             <a id="method_getTwigVariables" name="method_getTwigVariables" class="anchor"></a>
    2194. 

  2194.             <article class="method">
    2195. 

  2195.                 <h3 class="protected ">getTwigVariables()</h3>
    2196. 

  2196.                 <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>
    2197. 

  2197.                 <pre class="signature" style="margin-right: 54px;">getTwigVariables() : array&lt;mixed,mixed&gt;</pre>
    2198. 

  2198.                 <p><em>Returns the variables passed to the template</em></p>
    2199. 

  2199.                 <p>URLs and paths (namely <code>base_dir</code>, <code>base_url</code>, <code>theme_dir</code> and
    2200. 

  2200. <code>theme_url</code>) don't add a trailing slash for historic reasons.</p>
    2201. 

  2201. 

  2202.                 
    2203. 

  2203.                 
    2204. 

  2204.                                     <h4>Returns</h4>
    2205. 

  2205.                     array&lt;mixed,mixed&gt;
    2206. 

  2206.                                             &mdash; <p>template variables</p>
    2207. 

  2207.                                     				
    2208. 

  2208.                             </article>
    2209. 

  2209.         </div>
    2210. 

  2210.         <aside class="span4 detailsbar">
    2211. 

  2211.             <h1><i class="icon-arrow-down"></i></h1>
    2212. 

  2212.                                                             <dl>
    2213. 

  2213.                                                                             </dl>
    2214. 

  2214.             <h2>Tags</h2>
    2215. 

  2215.             <table class="table table-condensed">
    2216. 

  2216.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2217. 

  2217.                             </table>
    2218. 

  2218.         </aside>
    2219. 

  2219.     </div>
    2220. 

  2220. 

  2221.                                     <div class="row-fluid">
    2222. 

  2222.         <div class="span8 content class">
    2223. 

  2223.             <a id="method_getFiles" name="method_getFiles" class="anchor"></a>
    2224. 

  2224.             <article class="method">
    2225. 

  2225.                 <h3 class="protected ">getFiles()</h3>
    2226. 

  2226.                 <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>
    2227. 

  2227.                 <pre class="signature" style="margin-right: 54px;">getFiles(string  <span class="argument">$directory</span>, string  <span class="argument">$fileExtension = &#039;&#039;</span>, integer  <span class="argument">$order = self::SORT_ASC</span>) : array</pre>
    2228. 

  2228.                 <p><em>Recursively walks through a directory and returns all containing files
    2229. 

  2229. matching the specified file extension</em></p>
    2230. 

  2230.                 
    2231. 

  2231. 

  2232.                                     <h4>Parameters</h4>
    2233. 

  2233.                     <table class="table table-condensed table-hover">
    2234. 

  2234.                                                     <tr>
    2235. 

  2235.                                 <td>string</td>
    2236. 

  2236.                                 <td>$directory </td>
    2237. 

  2237.                                 <td><p>start directory</p></td>
    2238. 

  2238.                             </tr>
    2239. 

  2239.                                                     <tr>
    2240. 

  2240.                                 <td>string</td>
    2241. 

  2241.                                 <td>$fileExtension </td>
    2242. 

  2242.                                 <td><p>return files with the given file extension
    2243. 

  2243. only (optional)</p></td>
    2244. 

  2244.                             </tr>
    2245. 

  2245.                                                     <tr>
    2246. 

  2246.                                 <td>integer</td>
    2247. 

  2247.                                 <td>$order </td>
    2248. 

  2248.                                 <td><p>specify whether and how files should be
    2249. 

  2249. sorted; use Pico::SORT_ASC for a alphabetical ascending order (this
    2250. 

  2250. is the default behaviour), Pico::SORT_DESC for a descending order
    2251. 

  2251. or Pico::SORT_NONE to leave the result unsorted</p></td>
    2252. 

  2252.                             </tr>
    2253. 

  2253.                                             </table>
    2254. 

  2254.                 
    2255. 

  2255.                 
    2256. 

  2256.                                     <h4>Returns</h4>
    2257. 

  2257.                     array
    2258. 

  2258.                                             &mdash; <p>list of found files</p>
    2259. 

  2259.                                     				
    2260. 

  2260.                             </article>
    2261. 

  2261.         </div>
    2262. 

  2262.         <aside class="span4 detailsbar">
    2263. 

  2263.             <h1><i class="icon-arrow-down"></i></h1>
    2264. 

  2264.                                                             <dl>
    2265. 

  2265.                                                                             </dl>
    2266. 

  2266.             <h2>Tags</h2>
    2267. 

  2267.             <table class="table table-condensed">
    2268. 

  2268.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2269. 

  2269.                             </table>
    2270. 

  2270.         </aside>
    2271. 

  2271.     </div>
    2272. 

  2272. 

  2273.                                     <div class="row-fluid">
    2274. 

  2274.         <div class="span8 content class">
    2275. 

  2275.             <a id="method_getAbsolutePath" name="method_getAbsolutePath" class="anchor"></a>
    2276. 

  2276.             <article class="method">
    2277. 

  2277.                 <h3 class="protected ">getAbsolutePath()</h3>
    2278. 

  2278.                 <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>
    2279. 

  2279.                 <pre class="signature" style="margin-right: 54px;">getAbsolutePath(string  <span class="argument">$path</span>) : string</pre>
    2280. 

  2280.                 <p><em>Makes a relative path absolute to Picos root dir</em></p>
    2281. 

  2281.                 <p>This method also guarantees a trailing slash.</p>
    2282. 

  2282. 

  2283.                                     <h4>Parameters</h4>
    2284. 

  2284.                     <table class="table table-condensed table-hover">
    2285. 

  2285.                                                     <tr>
    2286. 

  2286.                                 <td>string</td>
    2287. 

  2287.                                 <td>$path </td>
    2288. 

  2288.                                 <td><p>relative or absolute path</p></td>
    2289. 

  2289.                             </tr>
    2290. 

  2290.                                             </table>
    2291. 

  2291.                 
    2292. 

  2292.                 
    2293. 

  2293.                                     <h4>Returns</h4>
    2294. 

  2294.                     string
    2295. 

  2295.                                             &mdash; <p>absolute path</p>
    2296. 

  2296.                                     				
    2297. 

  2297.                             </article>
    2298. 

  2298.         </div>
    2299. 

  2299.         <aside class="span4 detailsbar">
    2300. 

  2300.             <h1><i class="icon-arrow-down"></i></h1>
    2301. 

  2301.                                                             <dl>
    2302. 

  2302.                                                                             </dl>
    2303. 

  2303.             <h2>Tags</h2>
    2304. 

  2304.             <table class="table table-condensed">
    2305. 

  2305.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2306. 

  2306.                             </table>
    2307. 

  2307.         </aside>
    2308. 

  2308.     </div>
    2309. 

  2309. 

  2310.                                     <div class="row-fluid">
    2311. 

  2311.         <div class="span8 content class">
    2312. 

  2312.             <a id="method_triggerEvent" name="method_triggerEvent" class="anchor"></a>
    2313. 

  2313.             <article class="method">
    2314. 

  2314.                 <h3 class="protected ">triggerEvent()</h3>
    2315. 

  2315.                 <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>
    2316. 

  2316.                 <pre class="signature" style="margin-right: 54px;">triggerEvent(string  <span class="argument">$eventName</span>, array  <span class="argument">$params = array()</span>) : void</pre>
    2317. 

  2317.                 <p><em>Triggers events on plugins which implement PicoPluginInterface</em></p>
    2318. 

  2318.                 <p>Deprecated events (as used by plugins not implementing
    2319. 

  2319. \IPocPlugin) are triggered by \PicoDeprecated.</p>
    2320. 

  2320. 

  2321.                                     <h4>Parameters</h4>
    2322. 

  2322.                     <table class="table table-condensed table-hover">
    2323. 

  2323.                                                     <tr>
    2324. 

  2324.                                 <td>string</td>
    2325. 

  2325.                                 <td>$eventName </td>
    2326. 

  2326.                                 <td><p>name of the event to trigger</p></td>
    2327. 

  2327.                             </tr>
    2328. 

  2328.                                                     <tr>
    2329. 

  2329.                                 <td>array</td>
    2330. 

  2330.                                 <td>$params </td>
    2331. 

  2331.                                 <td><p>optional parameters to pass</p></td>
    2332. 

  2332.                             </tr>
    2333. 

  2333.                                             </table>
    2334. 

  2334.                 
    2335. 

  2335.                 
    2336. 

  2336.                 				
    2337. 

  2337.                             </article>
    2338. 

  2338.         </div>
    2339. 

  2339.         <aside class="span4 detailsbar">
    2340. 

  2340.             <h1><i class="icon-arrow-down"></i></h1>
    2341. 

  2341.                                                             <dl>
    2342. 

  2342.                                                                                             <dt>See also</dt>
    2343. 

  2343.                                                                 <dd><a href="../classes/PicoPluginInterface.html"><span class="namespace-wrapper">\PicoPluginInterface</span></a></dd>
    2344. 

  2344.                                             <dd><a href="../classes/AbstractPicoPlugin.html"><span class="namespace-wrapper">\AbstractPicoPlugin</span></a></dd>
    2345. 

  2345.                                             <dd><a href="../classes/DummyPlugin.html"><span class="namespace-wrapper">\DummyPlugin</span></a></dd>
    2346. 

  2346.                                                                 </dl>
    2347. 

  2347.             <h2>Tags</h2>
    2348. 

  2348.             <table class="table table-condensed">
    2349. 

  2349.                                     <tr><td colspan="2"><em>None found</em></td></tr>
    2350. 

  2350.                             </table>
    2351. 

  2351.         </aside>
    2352. 

  2352.     </div>
    2353. 

  2353. 

  2354.                                                     </div>
    2355. 

  2355.     </section>
    2356. 

  2356. 

  2357.     <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
    2358. 

  2358.         <div class="modal-header">
    2359. 

  2359.             <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
    2360. 

  2360.             <h3 id="source-view-label">Pico.php</h3>
    2361. 

  2361.         </div>
    2362. 

  2362.         <div class="modal-body">
    2363. 

  2363.             <pre data-src="../files/lib/Pico.php.txt" class="language-php line-numbers"></pre>
    2364. 

  2364.         </div>
    2365. 

  2365.     </div>
    2366. 

  2366. 

  2367.     <footer class="row-fluid">
    2368. 

  2368.         <section class="span10 offset2">
    2369. 

  2369.             <section class="row-fluid">
    2370. 

  2370.                 <section class="span10 offset1">
    2371. 

  2371.                     <section class="row-fluid footer-sections">
    2372. 

  2372.                         <section class="span4">
    2373. 

  2373.                                                         <h1><i class="icon-code"></i></h1>
    2374. 

  2374.                             <div>
    2375. 

  2375.                                 <ul>
    2376. 

  2376.                                                                     </ul>
    2377. 

  2377.                             </div>
    2378. 

  2378.                         </section>
    2379. 

  2379.                         <section class="span4">
    2380. 

  2380.                                                         <h1><i class="icon-bar-chart"></i></h1>
    2381. 

  2381.                             <div>
    2382. 

  2382.                                 <ul>
    2383. 

  2383.                                     <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
    2384. 

  2384.                                 </ul>
    2385. 

  2385.                             </div>
    2386. 

  2386.                         </section>
    2387. 

  2387.                         <section class="span4">
    2388. 

  2388.                                                         <h1><i class="icon-pushpin"></i></h1>
    2389. 

  2389.                             <div>
    2390. 

  2390.                                 <ul>
    2391. 

  2391.                                     <li><a href="../reports/errors.html">Errors</a></li>
    2392. 

  2392.                                     <li><a href="../reports/markers.html">Markers</a></li>
    2393. 

  2393.                                 </ul>
    2394. 

  2394.                             </div>
    2395. 

  2395.                         </section>
    2396. 

  2396.                     </section>
    2397. 

  2397.                 </section>
    2398. 

  2398.             </section>
    2399. 

  2399.             <section class="row-fluid">
    2400. 

  2400.                 <section class="span10 offset1">
    2401. 

  2401.                     <hr />
    2402. 

  2402.                     Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
    2403. 

  2403.                     on November 3rd, 2015 at 16:05.
    2404. 

  2404.                 </section>
    2405. 

  2405.             </section>
    2406. 

  2406.         </section>
    2407. 

  2407.     </footer>
    2408. 

  2408. </div>
    2409. 

  2409. 

  2410. </body>
    2411. 

  2411. </html>
    2412.

Contact | Legal | Takedown | Status
Self-hosted public services - About
NibbleSpot by 0ct0pu5