Update & move phpDocs to phpDoc/master/
This commit is contained in:
Daniel Rudolf
parent
fed2a66d90
commit
1e03e00c7b
73 changed files with 498 additions and 544 deletions
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-63882034"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1767732650"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-63882034" class="accordion-body collapse in">
|
||||
<div id="namespace-1767732650" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -363,8 +363,8 @@
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependencies"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependencies()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependencies"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependencies()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -390,8 +390,7 @@
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method___construct"><span class="namespace-wrapper">\PicoPluginInterface::__construct()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -417,8 +416,8 @@
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependants"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependants()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependants"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependants()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -663,7 +662,7 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<h3 class="public ">__call()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">__call(string <span class="argument">$methodName</span>, array <span class="argument">$params</span>) : mixed</pre>
|
||||
<p><em>Passes all not satisfiable method calls to {@link Pico}</em></p>
|
||||
<p><em>Passes all not satisfiable method calls to Pico</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
|
|
@ -690,7 +689,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html"><span class="namespace-wrapper">\Pico</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -791,7 +792,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -830,7 +833,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -887,7 +892,7 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-208930814"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1610372241"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-208930814" class="accordion-body collapse in">
|
||||
<div id="namespace-1610372241" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -209,6 +209,7 @@ Simply remove the events you don't need and add your own logic.</p>
|
|||
<a href="../classes/DummyPlugin.html#method_onContentParsing" class="">onContentParsing()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_prepareFileContent" class="">prepareFileContent()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_onContentParsed" class="">onContentParsed()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_onPagesLoading" class="">onPagesLoading()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_onSinglePageLoaded" class="">onSinglePageLoaded()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_onPagesLoaded" class="">onPagesLoaded()</a><br />
|
||||
<a href="../classes/DummyPlugin.html#method_onTwigRegistration" class="">onTwigRegistration()</a><br />
|
||||
|
|
@ -371,8 +372,8 @@ Simply remove the events you don't need and add your own logic.</p>
|
|||
<article class="property">
|
||||
<h3 class="protected ">$dependsOn</h3>
|
||||
<pre class="signature">$dependsOn : array<mixed,string></pre>
|
||||
<p><em>This plugin depends on {@link .</em></p>
|
||||
<p>..}</p>
|
||||
<p><em>This plugin depends on .</em></p>
|
||||
<p>..</p>
|
||||
|
||||
<h4>Type</h4>
|
||||
array<mixed,string>
|
||||
|
|
@ -410,8 +411,7 @@ Simply remove the events you don't need and add your own logic.</p>
|
|||
<dt>Inherited from</dt>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method___construct"><span class="namespace-wrapper">\PicoPluginInterface::__construct()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getPico"><span class="namespace-wrapper">\PicoPluginInterface::getPico()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -439,8 +439,8 @@ Simply remove the events you don't need and add your own logic.</p>
|
|||
<dt>Inherited from</dt>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependants"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependants()</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html#method_checkDependants"><span class="namespace-wrapper">\AbstractPicoPlugin::checkDependants()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -697,7 +697,7 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<h3 class="public ">__call()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">__call(string <span class="argument">$methodName</span>, array <span class="argument">$params</span>) : mixed</pre>
|
||||
<p><em>Passes all not satisfiable method calls to {@link Pico}</em></p>
|
||||
<p><em>Passes all not satisfiable method calls to Pico</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
|
|
@ -726,7 +726,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<dl>
|
||||
<dt>Inherited from</dt>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html"><span class="namespace-wrapper">\Pico</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -901,8 +903,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getBaseUrl"><span class="namespace-wrapper">\Pico::getBaseUrl()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -938,7 +939,8 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getBaseUrl"><span class="namespace-wrapper">\Pico::getBaseUrl()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -975,6 +977,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadFileContent"><span class="namespace-wrapper">\Pico::loadFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onContentLoaded"><span class="namespace-wrapper">\DummyPlugin::onContentLoaded()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1026,7 +1029,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<h3 class="public ">on404ContentLoading()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">on404ContentLoading( <span class="argument">$file</span>) : void</pre>
|
||||
<p><em>Triggered before Pico reads the contents of the 404 file</em></p>
|
||||
<p><em>Triggered before Pico reads the contents of a 404 file</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
|
|
@ -1047,6 +1050,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_load404Content"><span class="namespace-wrapper">\Pico::load404Content()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_on404ContentLoaded"><span class="namespace-wrapper">\DummyPlugin::on404ContentLoaded()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1160,6 +1164,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileMeta"><span class="namespace-wrapper">\Pico::parseFileMeta()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onMetaParsed"><span class="namespace-wrapper">\DummyPlugin::onMetaParsed()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1232,6 +1237,8 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_prepareFileContent"><span class="namespace-wrapper">\DummyPlugin::prepareFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onContentParsed"><span class="namespace-wrapper">\DummyPlugin::onContentParsed()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1268,6 +1275,7 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onContentParsed"><span class="namespace-wrapper">\DummyPlugin::onContentParsed()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1314,13 +1322,59 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method_onPagesLoading" name="method_onPagesLoading" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">onPagesLoading()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">onPagesLoading() : void</pre>
|
||||
<p><em>Triggered before Pico reads all known pages</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onSinglePageLoaded"><span class="namespace-wrapper">\DummyPlugin::onSinglePageLoaded()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onPagesLoaded"><span class="namespace-wrapper">\DummyPlugin::onPagesLoaded()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
</table>
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method_onSinglePageLoaded" name="method_onSinglePageLoaded" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">onSinglePageLoaded()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">onSinglePageLoaded( <span class="argument">$pageData</span>) : void</pre>
|
||||
<p><em>Triggered when Pico reads a single page from the list of all known pages</em></p>
|
||||
|
||||
<p>The <code>$pageData</code> parameter consists of the following values:</p>
|
||||
<pre>
|
||||
+----------------+--------+------------------------------------------+
|
||||
| Array key | Type | Description |
|
||||
+----------------+--------+------------------------------------------+
|
||||
| id | string | relative path to the content file |
|
||||
| url | string | URL to the page |
|
||||
| title | string | title of the page (YAML header) |
|
||||
| description | string | description of the page (YAML header) |
|
||||
| author | string | author of the page (YAML header) |
|
||||
| time | string | timestamp derived from the Date header |
|
||||
| date | string | date of the page (YAML header) |
|
||||
| date_formatted | string | formatted date of the page |
|
||||
| raw_content | string | raw, not yet parsed contents of the page |
|
||||
| meta | string | parsed meta data of the page |
|
||||
+----------------+--------+------------------------------------------+
|
||||
</pre>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
|
|
@ -1338,7 +1392,9 @@ It is NOT guaranteed that plugin dependencies are fulfilled!</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onPagesLoaded"><span class="namespace-wrapper">\DummyPlugin::onPagesLoaded()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1465,6 +1521,7 @@ structure of the page data.</p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html#method_onPageRendered"><span class="namespace-wrapper">\DummyPlugin::onPageRendered()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1540,7 +1597,9 @@ structure of the page data.</p>
|
|||
<dl>
|
||||
<dt>Inherited from</dt>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependencies"><span class="namespace-wrapper">\PicoPluginInterface::getDependencies()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1581,7 +1640,9 @@ structure of the page data.</p>
|
|||
<dl>
|
||||
<dt>Inherited from</dt>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><div class="path-wrapper">\AbstractPicoPlugin</div></a></dd>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_getDependants"><span class="namespace-wrapper">\PicoPluginInterface::getDependants()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1638,7 +1699,7 @@ structure of the page data.</p>
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-254219717"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1404791948"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-254219717" class="accordion-body collapse in">
|
||||
<div id="namespace-1404791948" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -444,7 +444,9 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRootDir"><span class="namespace-wrapper">\Pico::getRootDir()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -468,7 +470,9 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getConfigDir"><span class="namespace-wrapper">\Pico::getConfigDir()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -492,7 +496,9 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getPluginsDir"><span class="namespace-wrapper">\Pico::getPluginsDir()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -516,7 +522,9 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getThemesDir"><span class="namespace-wrapper">\Pico::getThemesDir()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -565,7 +573,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadPlugins"><span class="namespace-wrapper">\Pico::loadPlugins()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -591,7 +599,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -617,7 +625,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_evaluateRequestUrl"><span class="namespace-wrapper">\Pico::evaluateRequestUrl()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -643,7 +651,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_discoverRequestFile"><span class="namespace-wrapper">\Pico::discoverRequestFile()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -669,7 +677,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadFileContent"><span class="namespace-wrapper">\Pico::loadFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -695,7 +703,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileMeta"><span class="namespace-wrapper">\Pico::parseFileMeta()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getFileMeta"><span class="namespace-wrapper">\Pico::getFileMeta()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -721,8 +729,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -748,7 +755,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -774,7 +781,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getCurrentPage"><span class="namespace-wrapper">\Pico::getCurrentPage()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -800,7 +807,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPreviousPage"><span class="namespace-wrapper">\Pico::getPreviousPage()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -826,7 +833,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_discoverCurrentPage"><span class="namespace-wrapper">\Pico::discoverCurrentPage()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getNextPage"><span class="namespace-wrapper">\Pico::getNextPage()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -852,7 +859,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_registerTwig"><span class="namespace-wrapper">\Pico::registerTwig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -877,7 +884,9 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href=""><span class="namespace-wrapper">\Pico::getTwigVariables</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -900,7 +909,7 @@ See <a href="http://picocms.org/">http://picocms.org/</a> for more info.</li>
|
|||
<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>
|
||||
<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>
|
||||
<p><em>Constructs a new Pico instance</em></p>
|
||||
<p>To carry out all the processing in Pico, call the run() method.</p>
|
||||
<p>To carry out all the processing in Pico, call <a href="/classes/Pico.html#method_run">Pico::run()</a>.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
|
|
@ -1125,6 +1134,7 @@ rely on it. For more information see <a href="/classes/PicoPluginInterface.html"
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadPlugins"><span class="namespace-wrapper">\Pico::loadPlugins()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1155,6 +1165,7 @@ rely on it. For more information see <a href="/classes/PicoPluginInterface.html"
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadPlugins"><span class="namespace-wrapper">\Pico::loadPlugins()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPlugin"><span class="namespace-wrapper">\Pico::getPlugin()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1173,17 +1184,17 @@ rely on it. For more information see <a href="/classes/PicoPluginInterface.html"
|
|||
<p><em>Sets Picos config before calling Pico::run()</em></p>
|
||||
<p>This method allows you to modify Picos config without creating a
|
||||
{@path "config/config.php"} or changing some of its variables before
|
||||
Pico starts processing. It can only be called between the constructor
|
||||
call and Pico::run(). Options set with this method cannot be overwritten
|
||||
by {@path "config/config.php"}.</p>
|
||||
Pico starts processing.</p>
|
||||
<p>You can call this method between <a href="/classes/Pico.html#method___construct">Pico::__construct()</a> and
|
||||
<a href="/classes/Pico.html#method_run">Pico::run()</a> only. Options set with this method cannot be
|
||||
overwritten by {@path "config/config.php"}.</p>
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>array<mixed,mixed></td>
|
||||
<td>$config </td>
|
||||
<td><p>array with configuration variables, like
|
||||
$config in {@path "config/config.php"}</p></td>
|
||||
<td><p>array with config variables</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -1199,7 +1210,10 @@ $config in {@path "config/config.php"}</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1240,7 +1254,8 @@ array if no config name was supplied</p>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_setConfig"><span class="namespace-wrapper">\Pico::setConfig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_loadConfig"><span class="namespace-wrapper">\Pico::loadConfig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1340,7 +1355,9 @@ array if no config name was supplied</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1383,7 +1400,9 @@ up from the directory the requested file is in</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRawContent"><span class="namespace-wrapper">\Pico::getRawContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1398,7 +1417,7 @@ up from the directory the requested file is in</em></p>
|
|||
<h3 class="public ">getRawContent()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">getRawContent() : string|null</pre>
|
||||
<p><em>Returns the cached raw contents, either of the requested or the 404 file</em></p>
|
||||
<p><em>Returns the raw contents, either of the requested or the 404 file</em></p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -1414,6 +1433,7 @@ up from the directory the requested file is in</em></p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_loadFileContent"><span class="namespace-wrapper">\Pico::loadFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_load404Content"><span class="namespace-wrapper">\Pico::load404Content()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1463,7 +1483,7 @@ found value</p>
|
|||
<pre class="signature" style="margin-right: 54px;">parseFileMeta(string <span class="argument">$rawContent</span>, array<mixed,string> <span class="argument">$headers</span>) : array</pre>
|
||||
<p><em>Parses the file meta from raw file contents</em></p>
|
||||
<p>Meta data MUST start on the first line of the file, either opened and
|
||||
closed by --- or C-style block comments (deprecated). The headers are
|
||||
closed by <code>---</code> or C-style block comments (deprecated). The headers are
|
||||
parsed by the YAML component of the Symfony project, keys are lowered.
|
||||
If you're a plugin developer, you MUST register new headers during the
|
||||
<code>onMetaHeaders</code> event first. The implicit availability of headers is
|
||||
|
|
@ -1494,7 +1514,8 @@ for users and pure (!) theme developers ONLY.</p>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href=""><span class="namespace-wrapper">\<http://symfony.com/doc/current/components/yaml/introduction.html></span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getFileMeta"><span class="namespace-wrapper">\Pico::getFileMeta()</span></a></dd>
|
||||
<dd><a href=""><span class="namespace-wrapper">\<http://symfony.com/doc/current/components/yaml/introduction.html></span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1564,7 +1585,10 @@ e.g. removing the meta header and replacing %base_url%</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1601,7 +1625,10 @@ e.g. removing the meta header and replacing %base_url%</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getFileContent"><span class="namespace-wrapper">\Pico::getFileContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1631,7 +1658,8 @@ e.g. removing the meta header and replacing %base_url%</em></p>
|
|||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_prepareFileContent"><span class="namespace-wrapper">\Pico::prepareFileContent()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_parseFileContent"><span class="namespace-wrapper">\Pico::parseFileContent()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1663,6 +1691,7 @@ e.g. removing the meta header and replacing %base_url%</em></p>
|
|||
<dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_sortPages"><span class="namespace-wrapper">\Pico::sortPages()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
|
|
@ -1785,7 +1814,9 @@ e.g. removing the meta header and replacing %base_url%</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_registerTwig"><span class="namespace-wrapper">\Pico::registerTwig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1913,7 +1944,10 @@ to indicate their processing order. You MUST NOT use prefixes between
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getPlugin"><span class="namespace-wrapper">\Pico::getPlugin()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPlugins"><span class="namespace-wrapper">\Pico::getPlugins()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1939,7 +1973,10 @@ to indicate their processing order. You MUST NOT use prefixes between
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_setConfig"><span class="namespace-wrapper">\Pico::setConfig()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getConfig"><span class="namespace-wrapper">\Pico::getConfig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -1955,14 +1992,14 @@ to indicate their processing order. You MUST NOT use prefixes between
|
|||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">evaluateRequestUrl() : void</pre>
|
||||
<p><em>Evaluates the requested URL</em></p>
|
||||
<p>Pico 1.0 uses the QUERY_STRING routing method (e.g. /pico/?sub/page) to
|
||||
support SEO-like URLs out-of-the-box with any webserver. You can still
|
||||
setup URL rewriting (e.g. using mod_rewrite on Apache) to basically
|
||||
remove the <code>?</code> from URLs, but your rewritten URLs must follow the
|
||||
new QUERY_STRING principles. URL rewriting requires some special
|
||||
<p>Pico 1.0 uses the <code>QUERY_STRING</code> routing method (e.g. <code>/pico/?sub/page</code>)
|
||||
to support SEO-like URLs out-of-the-box with any webserver. You can
|
||||
still setup URL rewriting (e.g. using <code>mod_rewrite</code> on Apache) to
|
||||
basically remove the <code>?</code> from URLs, but your rewritten URLs must follow
|
||||
the new <code>QUERY_STRING</code> principles. URL rewriting requires some special
|
||||
configuration on your webserver, but this should be "basic work" for
|
||||
any webmaster...</p>
|
||||
<p>Pico 0.9 and older required Apache with mod_rewrite enabled, thus old
|
||||
<p>Pico 0.9 and older required Apache with <code>mod_rewrite</code> enabled, thus old
|
||||
plugins, templates and contents may require you to enable URL rewriting
|
||||
to work. If you're upgrading from Pico 0.9, you will probably have to
|
||||
update your rewriting rules.</p>
|
||||
|
|
@ -1980,7 +2017,9 @@ replaced accordingly.</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestUrl"><span class="namespace-wrapper">\Pico::getRequestUrl()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2006,7 +2045,9 @@ replaced accordingly.</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getRequestFile"><span class="namespace-wrapper">\Pico::getRequestFile()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2022,21 +2063,23 @@ replaced accordingly.</p>
|
|||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">readPages() : void</pre>
|
||||
<p><em>Reads the data of all pages known to Pico</em></p>
|
||||
<p>The page data will be an array containing the following values:
|
||||
+----------------+------------------------------------------+
|
||||
| Array key | Description |
|
||||
+----------------+------------------------------------------+
|
||||
| id | relative path to the content file |
|
||||
| url | URL to the page |
|
||||
| title | title of the page (YAML header) |
|
||||
| description | description of the page (YAML header) |
|
||||
| author | author of the page (YAML header) |
|
||||
| time | timestamp derived from the Date header |
|
||||
| date | date of the page (YAML header) |
|
||||
| date_formatted | formatted date of the page |
|
||||
| raw_content | raw, not yet parsed contents of the page |
|
||||
| meta | parsed meta data of the page) |
|
||||
+----------------+------------------------------------------+</p>
|
||||
<p>The page data will be an array containing the following values:</p>
|
||||
<pre>
|
||||
+----------------+--------+------------------------------------------+
|
||||
| Array key | Type | Description |
|
||||
+----------------+--------+------------------------------------------+
|
||||
| id | string | relative path to the content file |
|
||||
| url | string | URL to the page |
|
||||
| title | string | title of the page (YAML header) |
|
||||
| description | string | description of the page (YAML header) |
|
||||
| author | string | author of the page (YAML header) |
|
||||
| time | string | timestamp derived from the Date header |
|
||||
| date | string | date of the page (YAML header) |
|
||||
| date_formatted | string | formatted date of the page |
|
||||
| raw_content | string | raw, not yet parsed contents of the page |
|
||||
| meta | string | parsed meta data of the page |
|
||||
+----------------+--------+------------------------------------------+
|
||||
</pre>
|
||||
|
||||
|
||||
|
||||
|
|
@ -2046,7 +2089,10 @@ replaced accordingly.</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_sortPages"><span class="namespace-wrapper">\Pico::sortPages()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2072,7 +2118,10 @@ replaced accordingly.</p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_readPages"><span class="namespace-wrapper">\Pico::readPages()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPages"><span class="namespace-wrapper">\Pico::getPages()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2099,7 +2148,11 @@ as well as the previous and next page relative to it</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getCurrentPage"><span class="namespace-wrapper">\Pico::getCurrentPage()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getPreviousPage"><span class="namespace-wrapper">\Pico::getPreviousPage()</span></a></dd>
|
||||
<dd><a href="../classes/Pico.html#method_getNextPage"><span class="namespace-wrapper">\Pico::getNextPage()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2125,7 +2178,9 @@ as well as the previous and next page relative to it</em></p>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/Pico.html#method_getTwig"><span class="namespace-wrapper">\Pico::getTwig()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2141,8 +2196,8 @@ as well as the previous and next page relative to it</em></p>
|
|||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">getTwigVariables() : array<mixed,mixed></pre>
|
||||
<p><em>Returns the variables passed to the template</em></p>
|
||||
<p>URLs and paths (namely base_dir, base_url, theme_dir and theme_url)
|
||||
don't add a trailing slash for historic reasons.</p>
|
||||
<p>URLs and paths (namely <code>base_dir</code>, <code>base_url</code>, <code>theme_dir</code> and
|
||||
<code>theme_url</code>) don't add a trailing slash for historic reasons.</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -2259,7 +2314,7 @@ or Pico::SORT_NONE to leave the result unsorted</p></td>
|
|||
<h3 class="protected ">triggerEvent()</h3>
|
||||
<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>
|
||||
<pre class="signature" style="margin-right: 54px;">triggerEvent(string <span class="argument">$eventName</span>, array <span class="argument">$params = array()</span>) : void</pre>
|
||||
<p><em>Triggers events on plugins which implement {@link PicoPluginInterface}</em></p>
|
||||
<p><em>Triggers events on plugins which implement PicoPluginInterface</em></p>
|
||||
<p>Deprecated events (as used by plugins not implementing
|
||||
\IPocPlugin) are triggered by \PicoDeprecated.</p>
|
||||
|
||||
|
|
@ -2284,7 +2339,11 @@ or Pico::SORT_NONE to leave the result unsorted</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html"><span class="namespace-wrapper">\PicoPluginInterface</span></a></dd>
|
||||
<dd><a href="../classes/AbstractPicoPlugin.html"><span class="namespace-wrapper">\AbstractPicoPlugin</span></a></dd>
|
||||
<dd><a href="../classes/DummyPlugin.html"><span class="namespace-wrapper">\DummyPlugin</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -2341,7 +2400,7 @@ or Pico::SORT_NONE to leave the result unsorted</p></td>
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-731313356"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1692850514"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-731313356" class="accordion-body collapse in">
|
||||
<div id="namespace-1692850514" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -176,11 +176,11 @@ plugins which don't implement this interface are loaded. You can take
|
|||
advantage from this behaviour if you want to do something only when old
|
||||
plugins are loaded. Consequently the old events are never triggered when
|
||||
your plugin is implementing this interface and no old plugins are present.</p>
|
||||
<p>If you're developing a new plugin, you MUST implement PicoPluginInterface. If
|
||||
<p>If you're developing a new plugin, you MUST implement this interface. If
|
||||
you're the developer of an old plugin, it is STRONGLY RECOMMENDED to use
|
||||
the events introduced in Pico 1.0 when releasing a new version of your
|
||||
plugin. If you want to use any of the new events, you MUST implement
|
||||
PicoPluginInterface and update all other events you use.</p>
|
||||
this interface and update all other events you use.</p>
|
||||
|
||||
<section id="summary">
|
||||
<h2>Summary</h2>
|
||||
|
|
@ -389,7 +389,10 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_isEnabled"><span class="namespace-wrapper">\PicoPluginInterface::isEnabled()</span></a></dd>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_isStatusChanged"><span class="namespace-wrapper">\PicoPluginInterface::isStatusChanged()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -418,7 +421,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_setEnabled"><span class="namespace-wrapper">\PicoPluginInterface::setEnabled()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -447,7 +452,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href="../classes/PicoPluginInterface.html#method_setEnabled"><span class="namespace-wrapper">\PicoPluginInterface::setEnabled()</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -534,7 +541,9 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<dt>See also</dt>
|
||||
<dd><a href=""><span class="namespace-wrapper">\\Pico</span></a></dd>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
|
|
@ -591,7 +600,7 @@ This parameter is optional and defaults to false.</p></td>
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1376516288"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1289233036"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1376516288" class="accordion-body collapse in">
|
||||
<div id="namespace-1289233036" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -238,7 +238,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1365857737"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-309260372"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1365857737" class="accordion-body collapse in">
|
||||
<div id="namespace-309260372" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -245,7 +245,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-361571077"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-7891867"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-361571077" class="accordion-body collapse in">
|
||||
<div id="namespace-7891867" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -245,7 +245,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-551808860"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1004080455"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-551808860" class="accordion-body collapse in">
|
||||
<div id="namespace-1004080455" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -245,7 +245,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -15,44 +15,43 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
|
|||
/**
|
||||
* Current instance of Pico
|
||||
*
|
||||
* @var Pico
|
||||
* @see PicoPluginInterface::__construct()
|
||||
* @see PicoPluginInterface::getPico()
|
||||
* @var Pico
|
||||
*/
|
||||
private $pico;
|
||||
|
||||
/**
|
||||
* Boolean indicating if this plugin is enabled (true) or disabled (false)
|
||||
*
|
||||
* @var boolean
|
||||
* @see PicoPluginInterface::isEnabled()
|
||||
* @see PicoPluginInterface::setEnabled()
|
||||
* @var boolean
|
||||
*/
|
||||
protected $enabled = true;
|
||||
|
||||
/**
|
||||
* Boolean indicating if this plugin was ever enabled/disabled manually
|
||||
*
|
||||
* @var boolean
|
||||
* @see PicoPluginInterface::isStatusChanged()
|
||||
* @var boolean
|
||||
*/
|
||||
protected $statusChanged = false;
|
||||
|
||||
/**
|
||||
* List of plugins which this plugin depends on
|
||||
*
|
||||
* @var string[]
|
||||
* @see PicoPluginInterface::getDependencies()
|
||||
* @see AbstractPicoPlugin::checkDependencies()
|
||||
* @see PicoPluginInterface::getDependencies()
|
||||
* @var string[]
|
||||
*/
|
||||
protected $dependsOn = array();
|
||||
|
||||
/**
|
||||
* List of plugin which depend on this plugin
|
||||
*
|
||||
* @var object[]
|
||||
* @see PicoPluginInterface::getDependants()
|
||||
* @see AbstractPicoPlugin::checkDependants()
|
||||
* @see PicoPluginInterface::getDependants()
|
||||
* @var object[]
|
||||
*/
|
||||
private $dependants;
|
||||
|
||||
|
|
@ -129,8 +128,9 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* Passes all not satisfiable method calls to {@link Pico}
|
||||
* Passes all not satisfiable method calls to Pico
|
||||
*
|
||||
* @see Pico
|
||||
* @param string $methodName name of the method to call
|
||||
* @param array $params parameters to pass
|
||||
* @return mixed return value of the called method
|
||||
|
|
@ -150,6 +150,7 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
|
|||
/**
|
||||
* Enables all plugins which this plugin depends on
|
||||
*
|
||||
* @see PicoPluginInterface::getDependencies()
|
||||
* @param boolean $recursive enable required plugins automatically
|
||||
* @return void
|
||||
* @throws RuntimeException thrown when a dependency fails
|
||||
|
|
@ -198,6 +199,7 @@ abstract class AbstractPicoPlugin implements PicoPluginInterface
|
|||
/**
|
||||
* Disables all plugins which depend on this plugin
|
||||
*
|
||||
* @see PicoPluginInterface::getDependants()
|
||||
* @param boolean $recursive disabled dependant plugins automatically
|
||||
* @return void
|
||||
* @throws RuntimeException thrown when a dependency fails
|
||||
|
|
@ -53,6 +53,7 @@ class Pico
|
|||
/**
|
||||
* Root directory of this Pico instance
|
||||
*
|
||||
* @see Pico::getRootDir()
|
||||
* @var string
|
||||
*/
|
||||
protected $rootDir;
|
||||
|
|
@ -60,6 +61,7 @@ class Pico
|
|||
/**
|
||||
* Config directory of this Pico instance
|
||||
*
|
||||
* @see Pico::getConfigDir()
|
||||
* @var string
|
||||
*/
|
||||
protected $configDir;
|
||||
|
|
@ -67,6 +69,7 @@ class Pico
|
|||
/**
|
||||
* Plugins directory of this Pico instance
|
||||
*
|
||||
* @see Pico::getPluginsDir()
|
||||
* @var string
|
||||
*/
|
||||
protected $pluginsDir;
|
||||
|
|
@ -74,6 +77,7 @@ class Pico
|
|||
/**
|
||||
* Themes directory of this Pico instance
|
||||
*
|
||||
* @see Pico::getThemesDir()
|
||||
* @var string
|
||||
*/
|
||||
protected $themesDir;
|
||||
|
|
@ -88,7 +92,7 @@ class Pico
|
|||
/**
|
||||
* List of loaded plugins
|
||||
*
|
||||
* @see Pico::loadPlugins()
|
||||
* @see Pico::getPlugins()
|
||||
* @var object[]|null
|
||||
*/
|
||||
protected $plugins;
|
||||
|
|
@ -96,7 +100,7 @@ class Pico
|
|||
/**
|
||||
* Current configuration of this Pico instance
|
||||
*
|
||||
* @see Pico::loadConfig()
|
||||
* @see Pico::getConfig()
|
||||
* @var mixed[]|null
|
||||
*/
|
||||
protected $config;
|
||||
|
|
@ -104,7 +108,7 @@ class Pico
|
|||
/**
|
||||
* Part of the URL describing the requested contents
|
||||
*
|
||||
* @see Pico::evaluateRequestUrl()
|
||||
* @see Pico::getRequestUrl()
|
||||
* @var string|null
|
||||
*/
|
||||
protected $requestUrl;
|
||||
|
|
@ -112,7 +116,7 @@ class Pico
|
|||
/**
|
||||
* Absolute path to the content file being served
|
||||
*
|
||||
* @see Pico::discoverRequestFile()
|
||||
* @see Pico::getRequestFile()
|
||||
* @var string|null
|
||||
*/
|
||||
protected $requestFile;
|
||||
|
|
@ -120,7 +124,7 @@ class Pico
|
|||
/**
|
||||
* Raw, not yet parsed contents to serve
|
||||
*
|
||||
* @see Pico::loadFileContent()
|
||||
* @see Pico::getRawContent()
|
||||
* @var string|null
|
||||
*/
|
||||
protected $rawContent;
|
||||
|
|
@ -128,7 +132,7 @@ class Pico
|
|||
/**
|
||||
* Meta data of the page to serve
|
||||
*
|
||||
* @see Pico::parseFileMeta()
|
||||
* @see Pico::getFileMeta()
|
||||
* @var string[]|null
|
||||
*/
|
||||
protected $meta;
|
||||
|
|
@ -136,8 +140,7 @@ class Pico
|
|||
/**
|
||||
* Parsed content being served
|
||||
*
|
||||
* @see Pico::prepareFileContent()
|
||||
* @see Pico::parseFileContent()
|
||||
* @see Pico::getFileContent()
|
||||
* @var string|null
|
||||
*/
|
||||
protected $content;
|
||||
|
|
@ -145,7 +148,7 @@ class Pico
|
|||
/**
|
||||
* List of known pages
|
||||
*
|
||||
* @see Pico::readPages()
|
||||
* @see Pico::getPages()
|
||||
* @var array[]|null
|
||||
*/
|
||||
protected $pages;
|
||||
|
|
@ -153,7 +156,7 @@ class Pico
|
|||
/**
|
||||
* Data of the page being served
|
||||
*
|
||||
* @see Pico::discoverCurrentPage()
|
||||
* @see Pico::getCurrentPage()
|
||||
* @var array|null
|
||||
*/
|
||||
protected $currentPage;
|
||||
|
|
@ -161,7 +164,7 @@ class Pico
|
|||
/**
|
||||
* Data of the previous page relative to the page being served
|
||||
*
|
||||
* @see Pico::discoverCurrentPage()
|
||||
* @see Pico::getPreviousPage()
|
||||
* @var array|null
|
||||
*/
|
||||
protected $previousPage;
|
||||
|
|
@ -169,7 +172,7 @@ class Pico
|
|||
/**
|
||||
* Data of the next page relative to the page being served
|
||||
*
|
||||
* @see Pico::discoverCurrentPage()
|
||||
* @see Pico::getNextPage()
|
||||
* @var array|null
|
||||
*/
|
||||
protected $nextPage;
|
||||
|
|
@ -177,7 +180,7 @@ class Pico
|
|||
/**
|
||||
* Twig instance used for template parsing
|
||||
*
|
||||
* @see Pico::registerTwig()
|
||||
* @see Pico::getTwig()
|
||||
* @var Twig_Environment|null
|
||||
*/
|
||||
protected $twig;
|
||||
|
|
@ -185,6 +188,7 @@ class Pico
|
|||
/**
|
||||
* Variables passed to the twig template
|
||||
*
|
||||
* @see Pico::getTwigVariables
|
||||
* @var mixed[]|null
|
||||
*/
|
||||
protected $twigVariables;
|
||||
|
|
@ -192,7 +196,7 @@ class Pico
|
|||
/**
|
||||
* Constructs a new Pico instance
|
||||
*
|
||||
* To carry out all the processing in Pico, call the run() method.
|
||||
* To carry out all the processing in Pico, call {@link Pico::run()}.
|
||||
*
|
||||
* @param string $rootDir root directory of this Pico instance
|
||||
* @param string $configDir config directory of this Pico instance
|
||||
|
|
@ -355,6 +359,8 @@ class Pico
|
|||
* to indicate their processing order. You MUST NOT use prefixes between
|
||||
* 00 and 19 (reserved for built-in plugins).
|
||||
*
|
||||
* @see Pico::getPlugin()
|
||||
* @see Pico::getPlugins()
|
||||
* @return void
|
||||
* @throws RuntimeException thrown when a plugin couldn't be loaded
|
||||
*/
|
||||
|
|
@ -386,6 +392,7 @@ class Pico
|
|||
* rely on it. For more information see {@link PicoPluginInterface}.
|
||||
*
|
||||
* @see Pico::loadPlugins()
|
||||
* @see Pico::getPlugins()
|
||||
* @param string $pluginName name of the plugin
|
||||
* @return object instance of the plugin
|
||||
* @throws RuntimeException thrown when the plugin wasn't found
|
||||
|
|
@ -403,6 +410,7 @@ class Pico
|
|||
* Returns all loaded plugins
|
||||
*
|
||||
* @see Pico::loadPlugins()
|
||||
* @see Pico::getPlugin()
|
||||
* @return object[]|null
|
||||
*/
|
||||
public function getPlugins()
|
||||
|
|
@ -413,6 +421,8 @@ class Pico
|
|||
/**
|
||||
* Loads the config.php from Pico::$configDir
|
||||
*
|
||||
* @see Pico::setConfig()
|
||||
* @see Pico::getConfig()
|
||||
* @return void
|
||||
*/
|
||||
protected function loadConfig()
|
||||
|
|
@ -459,12 +469,15 @@ class Pico
|
|||
*
|
||||
* This method allows you to modify Picos config without creating a
|
||||
* {@path "config/config.php"} or changing some of its variables before
|
||||
* Pico starts processing. It can only be called between the constructor
|
||||
* call and Pico::run(). Options set with this method cannot be overwritten
|
||||
* by {@path "config/config.php"}.
|
||||
* Pico starts processing.
|
||||
*
|
||||
* @param mixed[] $config array with configuration variables, like
|
||||
* $config in {@path "config/config.php"}
|
||||
* You can call this method between {@link Pico::__construct()} and
|
||||
* {@link Pico::run()} only. Options set with this method cannot be
|
||||
* overwritten by {@path "config/config.php"}.
|
||||
*
|
||||
* @see Pico::loadConfig()
|
||||
* @see Pico::getConfig()
|
||||
* @param mixed[] $config array with config variables
|
||||
* @return void
|
||||
* @throws RuntimeException thrown if Pico already started processing
|
||||
*/
|
||||
|
|
@ -481,6 +494,7 @@ class Pico
|
|||
* Returns either the value of the specified config variable or
|
||||
* the config array
|
||||
*
|
||||
* @see Pico::setConfig()
|
||||
* @see Pico::loadConfig()
|
||||
* @param string $configName optional name of a config variable
|
||||
* @return mixed returns either the value of the named config
|
||||
|
|
@ -499,15 +513,15 @@ class Pico
|
|||
/**
|
||||
* Evaluates the requested URL
|
||||
*
|
||||
* Pico 1.0 uses the QUERY_STRING routing method (e.g. /pico/?sub/page) to
|
||||
* support SEO-like URLs out-of-the-box with any webserver. You can still
|
||||
* setup URL rewriting (e.g. using mod_rewrite on Apache) to basically
|
||||
* remove the `?` from URLs, but your rewritten URLs must follow the
|
||||
* new QUERY_STRING principles. URL rewriting requires some special
|
||||
* Pico 1.0 uses the `QUERY_STRING` routing method (e.g. `/pico/?sub/page`)
|
||||
* to support SEO-like URLs out-of-the-box with any webserver. You can
|
||||
* still setup URL rewriting (e.g. using `mod_rewrite` on Apache) to
|
||||
* basically remove the `?` from URLs, but your rewritten URLs must follow
|
||||
* the new `QUERY_STRING` principles. URL rewriting requires some special
|
||||
* configuration on your webserver, but this should be "basic work" for
|
||||
* any webmaster...
|
||||
*
|
||||
* Pico 0.9 and older required Apache with mod_rewrite enabled, thus old
|
||||
* Pico 0.9 and older required Apache with `mod_rewrite` enabled, thus old
|
||||
* plugins, templates and contents may require you to enable URL rewriting
|
||||
* to work. If you're upgrading from Pico 0.9, you will probably have to
|
||||
* update your rewriting rules.
|
||||
|
|
@ -518,6 +532,7 @@ class Pico
|
|||
* `%base_url%` variable; e.g. `%base_url%?sub/page` will be automatically
|
||||
* replaced accordingly.
|
||||
*
|
||||
* @see Pico::getRequestUrl()
|
||||
* @return void
|
||||
*/
|
||||
protected function evaluateRequestUrl()
|
||||
|
|
@ -549,6 +564,7 @@ class Pico
|
|||
/**
|
||||
* Uses the request URL to discover the content file to serve
|
||||
*
|
||||
* @see Pico::getRequestFile()
|
||||
* @return void
|
||||
*/
|
||||
protected function discoverRequestFile()
|
||||
|
|
@ -556,7 +572,33 @@ class Pico
|
|||
if (empty($this->requestUrl)) {
|
||||
$this->requestFile = $this->getConfig('content_dir') . 'index' . $this->getConfig('content_ext');
|
||||
} else {
|
||||
$this->requestFile = $this->getConfig('content_dir') . $this->requestUrl;
|
||||
// prevent content_dir breakouts using malicious request URLs
|
||||
// we don't use realpath() here because we neither want to check for file existance
|
||||
// nor prohibit symlinks which intentionally point to somewhere outside the content_dir
|
||||
// it is STRONGLY RECOMMENDED to use open_basedir - always, not just with Pico!
|
||||
$requestUrl = str_replace('\\', '/', $this->requestUrl);
|
||||
$requestUrlParts = explode('/', $requestUrl);
|
||||
|
||||
$requestFileParts = array();
|
||||
foreach ($requestUrlParts as $requestUrlPart) {
|
||||
if (($requestUrlPart === '') || ($requestUrlPart === '.')) {
|
||||
continue;
|
||||
} elseif ($requestUrlPart === '..') {
|
||||
array_pop($requestFileParts);
|
||||
continue;
|
||||
}
|
||||
|
||||
$requestFileParts[] = $requestUrlPart;
|
||||
}
|
||||
|
||||
if (empty($requestFileParts)) {
|
||||
$this->requestFile = $this->getConfig('content_dir') . 'index' . $this->getConfig('content_ext');
|
||||
return;
|
||||
}
|
||||
|
||||
// discover the content file to serve
|
||||
// Note: $requestFileParts neither contains a trailing nor a leading slash
|
||||
$this->requestFile = $this->getConfig('content_dir') . implode('/', $requestFileParts);
|
||||
if (is_dir($this->requestFile)) {
|
||||
// if no index file is found, try a accordingly named file in the previous dir
|
||||
// if this file doesn't exist either, show the 404 page, but assume the index
|
||||
|
|
@ -585,6 +627,7 @@ class Pico
|
|||
/**
|
||||
* Returns the raw contents of a file
|
||||
*
|
||||
* @see Pico::getRawContent()
|
||||
* @param string $file file path
|
||||
* @return string raw contents of the file
|
||||
*/
|
||||
|
|
@ -597,6 +640,7 @@ class Pico
|
|||
* Returns the raw contents of the first found 404 file when traversing
|
||||
* up from the directory the requested file is in
|
||||
*
|
||||
* @see Pico::getRawContent()
|
||||
* @param string $file path to requested (but not existing) file
|
||||
* @return string raw contents of the 404 file
|
||||
* @throws RuntimeException thrown when no suitable 404 file is found
|
||||
|
|
@ -618,9 +662,10 @@ class Pico
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns the cached raw contents, either of the requested or the 404 file
|
||||
* Returns the raw contents, either of the requested or the 404 file
|
||||
*
|
||||
* @see Pico::loadFileContent()
|
||||
* @see Pico::load404Content()
|
||||
* @return string|null raw contents
|
||||
*/
|
||||
public function getRawContent()
|
||||
|
|
@ -657,12 +702,13 @@ class Pico
|
|||
* Parses the file meta from raw file contents
|
||||
*
|
||||
* Meta data MUST start on the first line of the file, either opened and
|
||||
* closed by --- or C-style block comments (deprecated). The headers are
|
||||
* closed by `---` or C-style block comments (deprecated). The headers are
|
||||
* parsed by the YAML component of the Symfony project, keys are lowered.
|
||||
* If you're a plugin developer, you MUST register new headers during the
|
||||
* `onMetaHeaders` event first. The implicit availability of headers is
|
||||
* for users and pure (!) theme developers ONLY.
|
||||
*
|
||||
* @see Pico::getFileMeta()
|
||||
* @see <http://symfony.com/doc/current/components/yaml/introduction.html>
|
||||
* @param string $rawContent the raw file contents
|
||||
* @param string[] $headers known meta headers
|
||||
|
|
@ -725,6 +771,8 @@ class Pico
|
|||
* Applies some static preparations to the raw contents of a page,
|
||||
* e.g. removing the meta header and replacing %base_url%
|
||||
*
|
||||
* @see Pico::parseFileContent()
|
||||
* @see Pico::getFileContent()
|
||||
* @param string $rawContent raw contents of a page
|
||||
* @return string contents prepared for parsing
|
||||
*/
|
||||
|
|
@ -754,10 +802,13 @@ class Pico
|
|||
$content = str_replace('%theme_url%', $themeUrl, $content);
|
||||
|
||||
// replace %meta.*%
|
||||
$metaKeys = array_map(function ($metaKey) {
|
||||
return '%meta.' . $metaKey . '%';
|
||||
}, array_keys($this->meta));
|
||||
$metaValues = array_values($this->meta);
|
||||
$metaKeys = $metaValues = array();
|
||||
foreach ($this->meta as $metaKey => $metaValue) {
|
||||
if (is_scalar($metaValue) || ($metaValue === null)) {
|
||||
$metaKeys[] = '%meta.' . $metaKey . '%';
|
||||
$metaValues[] = strval($metaValue);
|
||||
}
|
||||
}
|
||||
$content = str_replace($metaKeys, $metaValues, $content);
|
||||
|
||||
return $content;
|
||||
|
|
@ -766,6 +817,8 @@ class Pico
|
|||
/**
|
||||
* Parses the contents of a page using ParsedownExtra
|
||||
*
|
||||
* @see Pico::prepareFileContent()
|
||||
* @see Pico::getFileContent()
|
||||
* @param string $content raw contents of a page (Markdown)
|
||||
* @return string parsed contents (HTML)
|
||||
*/
|
||||
|
|
@ -778,6 +831,7 @@ class Pico
|
|||
/**
|
||||
* Returns the cached contents of the requested page
|
||||
*
|
||||
* @see Pico::prepareFileContent()
|
||||
* @see Pico::parseFileContent()
|
||||
* @return string|null parsed contents
|
||||
*/
|
||||
|
|
@ -790,21 +844,25 @@ class Pico
|
|||
* Reads the data of all pages known to Pico
|
||||
*
|
||||
* The page data will be an array containing the following values:
|
||||
* +----------------+------------------------------------------+
|
||||
* | Array key | Description |
|
||||
* +----------------+------------------------------------------+
|
||||
* | id | relative path to the content file |
|
||||
* | url | URL to the page |
|
||||
* | title | title of the page (YAML header) |
|
||||
* | description | description of the page (YAML header) |
|
||||
* | author | author of the page (YAML header) |
|
||||
* | time | timestamp derived from the Date header |
|
||||
* | date | date of the page (YAML header) |
|
||||
* | date_formatted | formatted date of the page |
|
||||
* | raw_content | raw, not yet parsed contents of the page |
|
||||
* | meta | parsed meta data of the page) |
|
||||
* +----------------+------------------------------------------+
|
||||
* <pre>
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* | Array key | Type | Description |
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* | id | string | relative path to the content file |
|
||||
* | url | string | URL to the page |
|
||||
* | title | string | title of the page (YAML header) |
|
||||
* | description | string | description of the page (YAML header) |
|
||||
* | author | string | author of the page (YAML header) |
|
||||
* | time | string | timestamp derived from the Date header |
|
||||
* | date | string | date of the page (YAML header) |
|
||||
* | date_formatted | string | formatted date of the page |
|
||||
* | raw_content | string | raw, not yet parsed contents of the page |
|
||||
* | meta | string | parsed meta data of the page |
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* </pre>
|
||||
*
|
||||
* @see Pico::sortPages()
|
||||
* @see Pico::getPages()
|
||||
* @return void
|
||||
*/
|
||||
protected function readPages()
|
||||
|
|
@ -867,6 +925,8 @@ class Pico
|
|||
/**
|
||||
* Sorts all pages known to Pico
|
||||
*
|
||||
* @see Pico::readPages()
|
||||
* @see Pico::getPages()
|
||||
* @return void
|
||||
*/
|
||||
protected function sortPages()
|
||||
|
|
@ -907,6 +967,7 @@ class Pico
|
|||
* Returns the list of known pages
|
||||
*
|
||||
* @see Pico::readPages()
|
||||
* @see Pico::sortPages()
|
||||
* @return array|null the data of all pages
|
||||
*/
|
||||
public function getPages()
|
||||
|
|
@ -918,6 +979,9 @@ class Pico
|
|||
* Walks through the list of known pages and discovers the requested page
|
||||
* as well as the previous and next page relative to it
|
||||
*
|
||||
* @see Pico::getCurrentPage()
|
||||
* @see Pico::getPreviousPage()
|
||||
* @see Pico::getNextPage()
|
||||
* @return void
|
||||
*/
|
||||
protected function discoverCurrentPage()
|
||||
|
|
@ -987,6 +1051,7 @@ class Pico
|
|||
/**
|
||||
* Registers the twig template engine
|
||||
*
|
||||
* @see Pico::getTwig()
|
||||
* @return void
|
||||
*/
|
||||
protected function registerTwig()
|
||||
|
|
@ -1000,6 +1065,7 @@ class Pico
|
|||
/**
|
||||
* Returns the twig template engine
|
||||
*
|
||||
* @see Pico::registerTwig()
|
||||
* @return Twig_Environment|null twig template engine
|
||||
*/
|
||||
public function getTwig()
|
||||
|
|
@ -1010,8 +1076,8 @@ class Pico
|
|||
/**
|
||||
* Returns the variables passed to the template
|
||||
*
|
||||
* URLs and paths (namely base_dir, base_url, theme_dir and theme_url)
|
||||
* don't add a trailing slash for historic reasons.
|
||||
* URLs and paths (namely `base_dir`, `base_url`, `theme_dir` and
|
||||
* `theme_url`) don't add a trailing slash for historic reasons.
|
||||
*
|
||||
* @return mixed[] template variables
|
||||
*/
|
||||
|
|
@ -1150,11 +1216,14 @@ class Pico
|
|||
}
|
||||
|
||||
/**
|
||||
* Triggers events on plugins which implement {@link PicoPluginInterface}
|
||||
* Triggers events on plugins which implement PicoPluginInterface
|
||||
*
|
||||
* Deprecated events (as used by plugins not implementing
|
||||
* {@link IPocPlugin}) are triggered by {@link PicoDeprecated}.
|
||||
*
|
||||
* @see PicoPluginInterface
|
||||
* @see AbstractPicoPlugin
|
||||
* @see DummyPlugin
|
||||
* @param string $eventName name of the event to trigger
|
||||
* @param array $params optional parameters to pass
|
||||
* @return void
|
||||
|
|
@ -14,11 +14,11 @@
|
|||
* plugins are loaded. Consequently the old events are never triggered when
|
||||
* your plugin is implementing this interface and no old plugins are present.
|
||||
*
|
||||
* If you're developing a new plugin, you MUST implement PicoPluginInterface. If
|
||||
* If you're developing a new plugin, you MUST implement this interface. If
|
||||
* you're the developer of an old plugin, it is STRONGLY RECOMMENDED to use
|
||||
* the events introduced in Pico 1.0 when releasing a new version of your
|
||||
* plugin. If you want to use any of the new events, you MUST implement
|
||||
* PicoPluginInterface and update all other events you use.
|
||||
* this interface and update all other events you use.
|
||||
*
|
||||
* @author Daniel Rudolf
|
||||
* @link http://picocms.org
|
||||
|
|
@ -46,6 +46,8 @@ interface PicoPluginInterface
|
|||
/**
|
||||
* Enables or disables this plugin
|
||||
*
|
||||
* @see PicoPluginInterface::isEnabled()
|
||||
* @see PicoPluginInterface::isStatusChanged()
|
||||
* @param boolean $enabled enable (true) or disable (false) this plugin
|
||||
* @param boolean $recursive when true, enable or disable recursively
|
||||
* In other words, if you enable a plugin, all required plugins are
|
||||
|
|
@ -63,6 +65,7 @@ interface PicoPluginInterface
|
|||
/**
|
||||
* Returns true if this plugin is enabled, false otherwise
|
||||
*
|
||||
* @see PicoPluginInterface::setEnabled()
|
||||
* @return boolean plugin is enabled (true) or disabled (false)
|
||||
*/
|
||||
public function isEnabled();
|
||||
|
|
@ -70,6 +73,7 @@ interface PicoPluginInterface
|
|||
/**
|
||||
* Returns true if the plugin was ever enabled/disabled manually
|
||||
*
|
||||
* @see PicoPluginInterface::setEnabled()
|
||||
* @return boolean plugin is in its default state (true), false otherwise
|
||||
*/
|
||||
public function isStatusChanged();
|
||||
|
|
@ -91,6 +95,7 @@ interface PicoPluginInterface
|
|||
/**
|
||||
* Returns the plugins instance of Pico
|
||||
*
|
||||
* @see Pico
|
||||
* @return Pico the plugins instance of Pico
|
||||
*/
|
||||
public function getPico();
|
||||
|
|
@ -106,12 +106,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -136,10 +136,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1725438618"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-14326179"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1725438618" class="accordion-body collapse in">
|
||||
<div id="namespace-14326179" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -245,7 +245,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -16,16 +16,16 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
/**
|
||||
* This plugin is enabled by default?
|
||||
*
|
||||
* @var boolean
|
||||
* @see AbstractPicoPlugin::$enabled
|
||||
* @var boolean
|
||||
*/
|
||||
protected $enabled = false;
|
||||
|
||||
/**
|
||||
* This plugin depends on {@link ...}
|
||||
* This plugin depends on ...
|
||||
*
|
||||
* @var string[]
|
||||
* @see AbstractPicoPlugin::$dependsOn
|
||||
* @var string[]
|
||||
*/
|
||||
protected $dependsOn = array();
|
||||
|
||||
|
|
@ -60,7 +60,6 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
/**
|
||||
* Triggered after Pico has evaluated the request URL
|
||||
*
|
||||
* @see Pico::getBaseUrl()
|
||||
* @see Pico::getRequestUrl()
|
||||
* @param string &$url part of the URL describing the requested contents
|
||||
* @return void
|
||||
|
|
@ -73,6 +72,7 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
/**
|
||||
* Triggered after Pico has discovered the content file to serve
|
||||
*
|
||||
* @see Pico::getBaseUrl()
|
||||
* @see Pico::getRequestFile()
|
||||
* @param string &$file absolute path to the content file to serve
|
||||
* @return void
|
||||
|
|
@ -86,6 +86,7 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
* Triggered before Pico reads the contents of the file to serve
|
||||
*
|
||||
* @see Pico::loadFileContent()
|
||||
* @see DummyPlugin::onContentLoaded()
|
||||
* @param string &$file path to the file which contents will be read
|
||||
* @return void
|
||||
*/
|
||||
|
|
@ -107,9 +108,10 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
}
|
||||
|
||||
/**
|
||||
* Triggered before Pico reads the contents of the 404 file
|
||||
* Triggered before Pico reads the contents of a 404 file
|
||||
*
|
||||
* @see Pico::load404Content()
|
||||
* @see DummyPlugin::on404ContentLoaded()
|
||||
* @param string &$file path to the file which contents were requested
|
||||
* @return void
|
||||
*/
|
||||
|
|
@ -148,6 +150,7 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
* Triggered before Pico parses the meta header
|
||||
*
|
||||
* @see Pico::parseFileMeta()
|
||||
* @see DummyPlugin::onMetaParsed()
|
||||
* @param string &$rawContent raw file contents
|
||||
* @param string[] &$headers known meta header fields
|
||||
* @return void
|
||||
|
|
@ -173,6 +176,8 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
* Triggered before Pico parses the pages content
|
||||
*
|
||||
* @see Pico::prepareFileContent()
|
||||
* @see DummyPlugin::prepareFileContent()
|
||||
* @see DummyPlugin::onContentParsed()
|
||||
* @param string &$rawContent raw file contents
|
||||
* @return void
|
||||
*/
|
||||
|
|
@ -185,6 +190,7 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
* Triggered after Pico has prepared the raw file contents for parsing
|
||||
*
|
||||
* @see Pico::parseFileContent()
|
||||
* @see DummyPlugin::onContentParsed()
|
||||
* @param string &$content prepared file contents for parsing
|
||||
* @return void
|
||||
*/
|
||||
|
|
@ -205,23 +211,42 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
// your code
|
||||
}
|
||||
|
||||
/**
|
||||
* Triggered before Pico reads all known pages
|
||||
*
|
||||
* @see Pico::readPages()
|
||||
* @see DummyPlugin::onSinglePageLoaded()
|
||||
* @see DummyPlugin::onPagesLoaded()
|
||||
* @return void
|
||||
*/
|
||||
public function onPagesLoading()
|
||||
{
|
||||
// your code
|
||||
}
|
||||
|
||||
/**
|
||||
* Triggered when Pico reads a single page from the list of all known pages
|
||||
*
|
||||
* @param array &$pageData {
|
||||
* data of the loaded page
|
||||
* The `$pageData` parameter consists of the following values:
|
||||
* <pre>
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* | Array key | Type | Description |
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* | id | string | relative path to the content file |
|
||||
* | url | string | URL to the page |
|
||||
* | title | string | title of the page (YAML header) |
|
||||
* | description | string | description of the page (YAML header) |
|
||||
* | author | string | author of the page (YAML header) |
|
||||
* | time | string | timestamp derived from the Date header |
|
||||
* | date | string | date of the page (YAML header) |
|
||||
* | date_formatted | string | formatted date of the page |
|
||||
* | raw_content | string | raw, not yet parsed contents of the page |
|
||||
* | meta | string | parsed meta data of the page |
|
||||
* +----------------+--------+------------------------------------------+
|
||||
* </pre>
|
||||
*
|
||||
* @var string $id relative path to the content file
|
||||
* @var string $url URL to the page
|
||||
* @var string $title title of the page (YAML header)
|
||||
* @var string $description description of the page (YAML header)
|
||||
* @var string $author author of the page (YAML header)
|
||||
* @var string $time timestamp derived from the Date header
|
||||
* @var string $date date of the page (YAML header)
|
||||
* @var string $date_formatted formatted date of the page
|
||||
* @var string $raw_content raw, not yet parsed contents of the page
|
||||
* @var string $meta parsed meta data of the page
|
||||
* }
|
||||
* @see DummyPlugin::onPagesLoaded()
|
||||
* @param array &$pageData data of the loaded page
|
||||
* @return void
|
||||
*/
|
||||
public function onSinglePageLoaded(&$pageData)
|
||||
|
|
@ -264,6 +289,7 @@ class DummyPlugin extends AbstractPicoPlugin
|
|||
* Triggered before Pico renders the page
|
||||
*
|
||||
* @see Pico::getTwig()
|
||||
* @see DummyPlugin::onPageRendered()
|
||||
* @param Twig_Environment &$twig twig template engine
|
||||
* @param mixed[] &$twigVariables template variables
|
||||
* @param string &$templateName file name of the template
|
||||
|
Before Width: | Height: | Size: 248 KiB After Width: | Height: | Size: 248 KiB |
|
|
@ -83,12 +83,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -152,7 +152,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 8.2 KiB After Width: | Height: | Size: 8.2 KiB |
|
Before Width: | Height: | Size: 5.8 KiB After Width: | Height: | Size: 5.8 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 236 B After Width: | Height: | Size: 236 B |
|
Before Width: | Height: | Size: 428 B After Width: | Height: | Size: 428 B |
|
Before Width: | Height: | Size: 4.5 KiB After Width: | Height: | Size: 4.5 KiB |
|
Before Width: | Height: | Size: 308 B After Width: | Height: | Size: 308 B |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 340 B After Width: | Height: | Size: 340 B |
|
Before Width: | Height: | Size: 4.4 KiB After Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
|
@ -58,12 +58,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -88,10 +88,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-143734261"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-648937259"></a>
|
||||
<a href="namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-143734261" class="accordion-body collapse in">
|
||||
<div id="namespace-648937259" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -195,7 +195,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -58,12 +58,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -88,10 +88,10 @@
|
|||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-681713133"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2070251377"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-681713133" class="accordion-body collapse in">
|
||||
<div id="namespace-2070251377" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
|
|
@ -195,7 +195,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -59,12 +59,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -59,12 +59,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -94,7 +94,6 @@
|
|||
<li><a href="#lib/Pico.php"><i class="icon-file"></i> lib/Pico.php</a></li>
|
||||
<li><a href="#lib/PicoPluginInterface.php"><i class="icon-file"></i> lib/PicoPluginInterface.php</a></li>
|
||||
<li><a href="#index.php"><i class="icon-file"></i> index.php</a></li>
|
||||
<li><a href="#config/config.php"><i class="icon-file"></i> config/config.php</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -155,72 +154,72 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>62</td>
|
||||
<td>61</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>62</td>
|
||||
<td>61</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>70</td>
|
||||
<td>69</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>70</td>
|
||||
<td>69</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>70</td>
|
||||
<td>69</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>95</td>
|
||||
<td>94</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>95</td>
|
||||
<td>94</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>95</td>
|
||||
<td>94</td>
|
||||
<td>PPC:ERR-50015</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>95</td>
|
||||
<td>94</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>110</td>
|
||||
<td>109</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>118</td>
|
||||
<td>117</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>126</td>
|
||||
<td>125</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>193</td>
|
||||
<td>194</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>236</td>
|
||||
<td>238</td>
|
||||
<td>PPC:ERR-50008</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -286,32 +285,6 @@
|
|||
index.php
|
||||
<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div>
|
||||
<table class="table markers table-bordered">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Line</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>error</td>
|
||||
<td>0</td>
|
||||
<td>PPC:ERR-50000</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="package-contents">
|
||||
<a name="config/config.php" id="config/config.php"></a>
|
||||
<h3>
|
||||
<i class="icon-file"></i>
|
||||
config/config.php
|
||||
<small style="float: right;padding-right: 10px;">1</small>
|
||||
</h3>
|
||||
<div>
|
||||
<table class="table markers table-bordered">
|
||||
<thead>
|
||||
|
|
@ -370,7 +343,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -59,12 +59,12 @@
|
|||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">19</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -89,7 +89,7 @@
|
|||
<ul class="side-nav nav nav-list">
|
||||
<li class="nav-header">Navigation</li>
|
||||
<li><a href="#lib/Pico.php"><i class="icon-file"></i> lib/Pico.php</a></li>
|
||||
</ul>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="span10 offset2">
|
||||
|
|
@ -117,13 +117,13 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>TODO</td>
|
||||
<td>376</td>
|
||||
<td>382</td>
|
||||
<td>breaks backward compatibility</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
|
@ -163,7 +163,7 @@
|
|||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
on October 29th, 2015 at 18:14.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -1,249 +0,0 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Pico 1.0 API Documentation</title>
|
||||
<meta name="author" content=""/>
|
||||
<meta name="description" content=""/>
|
||||
|
||||
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
||||
<link href="../css/font-awesome.min.css" rel="stylesheet">
|
||||
<link href="../css/prism.css" rel="stylesheet" media="all"/>
|
||||
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../js/html5.js"></script>
|
||||
<![endif]-->
|
||||
<script src="../js/jquery-1.11.0.min.js"></script>
|
||||
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
|
||||
<script src="../js/bootstrap.min.js"></script>
|
||||
<script src="../js/jquery.smooth-scroll.js"></script>
|
||||
<script src="../js/prism.min.js"></script>
|
||||
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
||||
<script type="text/javascript">
|
||||
function loadExternalCodeSnippets() {
|
||||
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
|
||||
var src = pre.getAttribute('data-src');
|
||||
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
||||
var language = 'php';
|
||||
|
||||
var code = document.createElement('code');
|
||||
code.className = 'language-' + language;
|
||||
|
||||
pre.textContent = '';
|
||||
|
||||
code.textContent = 'Loading…';
|
||||
|
||||
pre.appendChild(code);
|
||||
|
||||
var xhr = new XMLHttpRequest();
|
||||
|
||||
xhr.open('GET', src, true);
|
||||
|
||||
xhr.onreadystatechange = function () {
|
||||
if (xhr.readyState == 4) {
|
||||
|
||||
if (xhr.status < 400 && xhr.responseText) {
|
||||
code.textContent = xhr.responseText;
|
||||
|
||||
Prism.highlightElement(code);
|
||||
}
|
||||
else if (xhr.status >= 400) {
|
||||
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
||||
}
|
||||
else {
|
||||
code.textContent = '✖ Error: File does not exist or is empty';
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
xhr.send(null);
|
||||
});
|
||||
}
|
||||
|
||||
$(document).ready(function(){
|
||||
loadExternalCodeSnippets();
|
||||
});
|
||||
$('#source-view').on('shown', function () {
|
||||
loadExternalCodeSnippets();
|
||||
})
|
||||
</script>
|
||||
|
||||
<link rel="shortcut icon" href="../images/favicon.ico"/>
|
||||
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
|
||||
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div class="navbar navbar-fixed-top">
|
||||
<div class="navbar-inner">
|
||||
<div class="container">
|
||||
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
||||
<i class="icon-ellipsis-vertical"></i>
|
||||
</a>
|
||||
<a class="brand" href="../index.html">Pico 1.0 API Documentation</a>
|
||||
|
||||
<div class="nav-collapse">
|
||||
<ul class="nav pull-right">
|
||||
<li class="dropdown" id="charts-menu">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Charts <b class="caret"></b>
|
||||
</a>
|
||||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../graphs/class.html">
|
||||
<i class="icon-list-alt"></i> Class hierarchy diagram
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="dropdown" id="reports-menu">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||||
Reports <b class="caret"></b>
|
||||
</a>
|
||||
<ul class="dropdown-menu">
|
||||
<li>
|
||||
<a href="../reports/errors.html">
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">20</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/deprecated.html">
|
||||
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<!--<div class="go_to_top">-->
|
||||
<!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
|
||||
<!--</div>-->
|
||||
</div>
|
||||
|
||||
<div id="___" class="container-fluid">
|
||||
<section class="row-fluid">
|
||||
<div class="span2 sidebar">
|
||||
<div class="accordion" style="margin-bottom: 0">
|
||||
<div class="accordion-group">
|
||||
<div class="accordion-heading">
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1949412653"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1949412653" class="accordion-body collapse in">
|
||||
<div class="accordion-inner">
|
||||
|
||||
|
||||
<ul>
|
||||
<li class="interface"><a href="../classes/PicoPluginInterface.html">PicoPluginInterface</a></li>
|
||||
<li class="class"><a href="../classes/AbstractPicoPlugin.html">AbstractPicoPlugin</a></li>
|
||||
<li class="class"><a href="../classes/DummyPlugin.html">DummyPlugin</a></li>
|
||||
<li class="class"><a href="../classes/Pico.html">Pico</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
<section class="row-fluid">
|
||||
<div class="span10 offset2">
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content file">
|
||||
<nav>
|
||||
</nav>
|
||||
|
||||
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
||||
<h1><small>config</small>config.php</h1>
|
||||
<p><em></em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<aside class="span4 detailsbar">
|
||||
<dl>
|
||||
<dt>Package</dt>
|
||||
<dd><div class="namespace-wrapper">\Default</div></dd>
|
||||
|
||||
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
</table>
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
|
||||
<div class="modal-header">
|
||||
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
||||
<h3 id="source-view-label"></h3>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<pre data-src="../files/config/config.php.txt" class="language-php line-numbers"></pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer class="row-fluid">
|
||||
<section class="span10 offset2">
|
||||
<section class="row-fluid">
|
||||
<section class="span10 offset1">
|
||||
<section class="row-fluid footer-sections">
|
||||
<section class="span4">
|
||||
<h1><i class="icon-code"></i></h1>
|
||||
<div>
|
||||
<ul>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="span4">
|
||||
<h1><i class="icon-bar-chart"></i></h1>
|
||||
<div>
|
||||
<ul>
|
||||
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="span4">
|
||||
<h1><i class="icon-pushpin"></i></h1>
|
||||
<div>
|
||||
<ul>
|
||||
<li><a href="../reports/errors.html">Errors</a></li>
|
||||
<li><a href="../reports/markers.html">Markers</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
<section class="row-fluid">
|
||||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on October 27th, 2015 at 02:57.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
<?php
|
||||
return array(
|
||||
'site_title' => 'config',
|
||||
'PicoGAnalytics' => array('enabled' => true)
|
||||
);
|
||||
|
||||
Loading…
Add table
Reference in a new issue