Permalink
Browse files

Update phpDocumentor class docs for pico-1.1 branch @ b129a4fb12600e8…

…e064b4a9760df5e686604da25
  • Loading branch information...
Pico CI
Pico CI committed Dec 27, 2017
1 parent a26791d commit 0a60d1befd8c27c44e3c7ca72affdaaf63ee0da5
Showing with 220 additions and 166 deletions.
  1. +1 −1 _data/phpDoc.yml
  2. BIN phpDoc/pico-1.1.cache/phpdoc-cache-58/phpdoc-cache-file_b78917338d8edcbdc6fc6e418eef4b79.dat
  3. BIN phpDoc/pico-1.1.cache/phpdoc-cache-6c/phpdoc-cache-file_e07f26d47f89181e749b30a55e680000.dat
  4. BIN phpDoc/pico-1.1.cache/phpdoc-cache-7f/phpdoc-cache-file_a7a7271e77c256202e6507732f6dbdfb.dat
  5. BIN phpDoc/pico-1.1.cache/phpdoc-cache-a4/phpdoc-cache-file_289e59c41d8343702c56a09ba45a998a.dat
  6. BIN phpDoc/pico-1.1.cache/phpdoc-cache-b2/phpdoc-cache-file_e1ef3619f8e68d43f7065af5939e1dc8.dat
  7. +11 −9 phpDoc/pico-1.1/classes/AbstractPicoPlugin.html
  8. +26 −11 phpDoc/pico-1.1/classes/DummyPlugin.html
  9. +35 −32 phpDoc/pico-1.1/classes/Pico.html
  10. +9 −7 phpDoc/pico-1.1/classes/PicoPluginInterface.html
  11. +3 −3 phpDoc/pico-1.1/classes/PicoTwigExtension.html
  12. +3 −3 phpDoc/pico-1.1/files/config.config.yml.html
  13. +3 −3 phpDoc/pico-1.1/files/index.html
  14. +2 −2 phpDoc/pico-1.1/files/index.php.dist.txt
  15. +3 −3 phpDoc/pico-1.1/files/index.php.html
  16. +3 −3 phpDoc/pico-1.1/files/lib.AbstractPicoPlugin.html
  17. +3 −3 phpDoc/pico-1.1/files/lib.Pico.html
  18. +3 −3 phpDoc/pico-1.1/files/lib.PicoPluginInterface.html
  19. +3 −3 phpDoc/pico-1.1/files/lib.PicoTwigExtension.html
  20. +5 −4 phpDoc/pico-1.1/files/lib/AbstractPicoPlugin.php.txt
  21. +56 −45 phpDoc/pico-1.1/files/lib/Pico.php.txt
  22. +6 −2 phpDoc/pico-1.1/files/lib/PicoPluginInterface.php.txt
  23. +3 −3 phpDoc/pico-1.1/files/plugins.DummyPlugin.html
  24. +19 −3 phpDoc/pico-1.1/files/plugins/DummyPlugin.php.txt
  25. +1 −1 phpDoc/pico-1.1/graphs/class.html
  26. +3 −3 phpDoc/pico-1.1/index.html
  27. +3 −3 phpDoc/pico-1.1/namespaces/default.html
  28. +1 −1 phpDoc/pico-1.1/reports/deprecated.html
  29. +14 −14 phpDoc/pico-1.1/reports/errors.html
  30. +1 −1 phpDoc/pico-1.1/reports/markers.html
View
@@ -21,7 +21,7 @@
- id: pico-1.1
type: branch
title: <code>pico-1.1</code> branch
last_update: 1511643838
last_update: 1514408855
- id: v1.0.2
type: version
title: Pico 1.0.2
@@ -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-952399452"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1218369257"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-952399452" class="accordion-body collapse in">
<div id="namespace-1218369257" class="accordion-body collapse in">
<div class="accordion-inner">
@@ -303,12 +303,12 @@ <h2>Properties</h2>
<a id="property_enabled" name="property_enabled" class="anchor"></a>
<article class="property">
<h3 class="protected ">$enabled</h3>
<pre class="signature">$enabled : boolean</pre>
<pre class="signature">$enabled : boolean|null</pre>
<p><em>Boolean indicating if this plugin is enabled (TRUE) or disabled (FALSE)</em></p>
<h4>Type</h4>
boolean
boolean|null
</article>
</div>
<aside class="span4 detailsbar">
@@ -599,14 +599,16 @@ <h2>Tags</h2>
<article class="method">
<h3 class="public ">isEnabled()</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;">isEnabled() : boolean</pre>
<p><em>Returns TRUE if this plugin is enabled, FALSE otherwise</em></p>
<pre class="signature" style="margin-right: 54px;">isEnabled() : boolean|null</pre>
<p><em>Returns a boolean indicating whether this plugin is enabled or not</em></p>
<p>You musn't rely on the return value when Pico's <code>onConfigLoaded</code> event
wasn't triggered on all plugins yet. This method might even return NULL
then. The plugin's status might change later.</p>
<h4>Returns</h4>
boolean
boolean|null
&mdash; <p>plugin is enabled (TRUE) or disabled (FALSE)</p>
</article>
@@ -1006,7 +1008,7 @@ <h1><i class="icon-pushpin"></i></h1>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on November 25th, 2017 at 21:03.
on December 27th, 2017 at 21:07.
</section>
</section>
</section>
@@ -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-1294938623"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2102473067"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1294938623" class="accordion-body collapse in">
<div id="namespace-2102473067" class="accordion-body collapse in">
<div class="accordion-inner">
@@ -358,13 +358,26 @@ <h2>Properties</h2>
<a id="property_enabled" name="property_enabled" class="anchor"></a>
<article class="property">
<h3 class="protected ">$enabled</h3>
<pre class="signature">$enabled : boolean</pre>
<pre class="signature">$enabled : boolean|null</pre>
<p><em>This plugin is disabled by default</em></p>
<p>If you want to enable your plugin by default, simply remove this class
property.</p>
<p>Usually you should remove this class property (or set it to NULL) to
leave the decision whether this plugin should be enabled or disabled by
default up to Pico. If all the plugin's dependenies are fulfilled (see
\self::$dependsOn), Pico enables the plugin by default. Otherwise
the plugin is silently disabled.</p>
<p>If this plugin should never be disabled <em>silently</em> (e.g. when dealing
with security-relevant stuff like access control, or similar), set this
to TRUE. If Pico can't fulfill all the plugin's dependencies, it will
throw an RuntimeException.</p>
<p>If this plugin rather does some &quot;crazy stuff&quot; a user should really be
aware of before using it, you can set this to FALSE. The user will then
have to enable the plugin manually. However, if another plugin depends
on this plugin, it might get enabled silently nevertheless.</p>
<p>No matter what, the user can always explicitly enable or disable this
plugin in Pico's config.</p>
<h4>Type</h4>
boolean
boolean|null
</article>
</div>
<aside class="span4 detailsbar">
@@ -669,14 +682,16 @@ <h2>Tags</h2>
<article class="method">
<h3 class="public ">isEnabled()</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;">isEnabled() : boolean</pre>
<p><em>Returns TRUE if this plugin is enabled, FALSE otherwise</em></p>
<pre class="signature" style="margin-right: 54px;">isEnabled() : boolean|null</pre>
<p><em>Returns a boolean indicating whether this plugin is enabled or not</em></p>
<p>You musn't rely on the return value when Pico's <code>onConfigLoaded</code> event
wasn't triggered on all plugins yet. This method might even return NULL
then. The plugin's status might change later.</p>
<h4>Returns</h4>
boolean
boolean|null
&mdash; <p>plugin is enabled (TRUE) or disabled (FALSE)</p>
</article>
@@ -2141,7 +2156,7 @@ <h1><i class="icon-pushpin"></i></h1>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on November 25th, 2017 at 21:03.
on December 27th, 2017 at 21:07.
</section>
</section>
</section>
@@ -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-1972377751"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1436258644"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1972377751" class="accordion-body collapse in">
<div id="namespace-1436258644" class="accordion-body collapse in">
<div class="accordion-inner">
@@ -2132,10 +2132,9 @@ <h2>Tags</h2>
<h3 class="public ">prepareFileContent()</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;">prepareFileContent(string <span class="argument">$rawContent</span>, array <span class="argument">$meta</span>) : string</pre>
<p><em>Applies some static preparations to the raw contents of a page,
e.g. removing the meta header and replacing %.</em></p>
<p>..% placehodlers</p>
<p>This method calls the <a href="../classes/Pico.html#method_substituteFileContent">\Pico::substituteFileContent()</a> method.</p>
<p><em>Applies some static preparations to the raw contents of a page</em></p>
<p>This method removes the meta header and replaces <code>%...%</code> placeholders
by calling the <a href="../classes/Pico.html#method_substituteFileContent">\Pico::substituteFileContent()</a> method.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
@@ -2454,8 +2453,8 @@ <h3 class="public ">getTwig()</h3>
<p><em>Returns the Twig template engine</em></p>
<p>This method triggers the <code>onTwigRegistered</code> event when the Twig template
engine wasn't initiated yet. When initiating Twig, this method also
registers Pico's core Twig filters <code>link</code> and <code>content</code> as well as
Pico's <a href="../classes/PicoTwigExtension.html">\PicoTwigExtension</a> Twig extension.</p>
registers Pico's core Twig filter <code>content</code> as well as Pico's
<a href="../classes/PicoTwigExtension.html">\PicoTwigExtension</a> Twig extension.</p>
@@ -2549,14 +2548,14 @@ <h3 class="public ">getPageUrl()</h3>
<pre class="signature" style="margin-right: 54px;">getPageUrl(string <span class="argument">$page</span>, array|string <span class="argument">$queryData = null</span>, boolean <span class="argument">$dropIndex = true</span>) : string</pre>
<p><em>Returns the URL to a given page</em></p>
<p>This method can be used in Twig templates by applying the <code>link</code> filter
to a string representing a page identifier.</p>
to a string representing a page ID.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$page </td>
<td><p>identifier of the page to link to</p></td>
<td><p>ID of the page to link to</p></td>
</tr>
<tr>
<td>array|string</td>
@@ -2567,8 +2566,8 @@ <h4>Parameters</h4>
<tr>
<td>boolean</td>
<td>$dropIndex </td>
<td><p>when the last path component is &quot;index&quot;,
then passing TRUE (default) leads to removing this path component</p></td>
<td><p>if the last path component is &quot;index&quot;,
passing TRUE (default) leads to removing this path component</p></td>
</tr>
</table>
@@ -2982,12 +2981,15 @@ <h3 class="protected ">loadPlugins()</h3>
<p><em>Loads plugins from vendor/pico-plugin.php and Pico::$pluginsDir</em></p>
<p>See <a href="../classes/Pico.html#method_loadComposerPlugins">\Pico::loadComposerPlugins()</a> for details about plugins loaded
from <code>vendor/pico-plugin.php</code> (i.e. plugins that were installed using
<code>composer</code>), and <a href="../classes/Pico.html#method_loadLocalPlugins">\Pico::loadLocalPlugins()</a> for details about
plugins installed to <a href="../classes/Pico.html#property_pluginsDir">\Pico::$pluginsDir</a>. Pico loads plugins from
the filesystem only if <a href="../classes/Pico.html#property_enableLocalPlugins">\Pico::$enableLocalPlugins</a> is set to TRUE
composer), and <a href="../classes/Pico.html#method_loadLocalPlugins">\Pico::loadLocalPlugins()</a> for details about plugins
installed to <a href="../classes/Pico.html#property_pluginsDir">\Pico::$pluginsDir</a>. Pico loads plugins from the
filesystem only if <a href="../classes/Pico.html#property_enableLocalPlugins">\Pico::$enableLocalPlugins</a> is set to TRUE
(this is the default).</p>
<p>Pico always loads plugins from <code>vendor/pico-plugin.php</code> first and
ignores conflicting plugins in <a href="../classes/Pico.html#property_pluginsDir">\Pico::$pluginsDir</a>.</p>
<p>The official PicoDeprecated plugin must be loaded when plugins that use
an older API version than Pico's API version (<a href="../classes/Pico.html#constant_API_VERSION">\Pico::API_VERSION</a>)
are loaded.</p>
<p>Please note that Pico will change the processing order when needed to
incorporate plugin dependencies. See <a href="../classes/Pico.html#method_sortPlugins">\Pico::sortPlugins()</a> for
details.</p>
@@ -3025,9 +3027,9 @@ <h3 class="protected ">loadComposerPlugins()</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;">loadComposerPlugins(array&lt;mixed,string&gt; <span class="argument">$pluginBlacklist = array()</span>) : array&lt;mixed,string&gt;</pre>
<p><em>Loads plugins from vendor/pico-plugin.php</em></p>
<p>This method loads all plugins installed using <code>composer</code> and Pico's
<code>picocms/pico-installer</code> installer by reading the <code>pico-plugin.php</code> in
composer's <code>vendor</code> dir.</p>
<p>This method loads all plugins installed using composer and Pico's
<code>picocms/composer-installer</code> installer by reading the <code>pico-plugin.php</code>
in composer's <code>vendor</code> dir.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
@@ -3293,7 +3295,7 @@ <h3 class="protected ">readPages()</h3>
</tr>
<tr>
<td>time</td>
<td>string</td>
<td>int</td>
<td>timestamp derived from the Date header</td>
</tr>
<tr>
@@ -3309,7 +3311,7 @@ <h3 class="protected ">readPages()</h3>
<tr>
<td>hidden</td>
<td>bool</td>
<td>this page shouldn't be visible to the user</td>
<td>this page shouldn't be visible</td>
</tr>
<tr>
<td>raw_content</td>
@@ -3318,30 +3320,30 @@ <h3 class="protected ">readPages()</h3>
</tr>
<tr>
<td>meta</td>
<td>string</td>
<td>string[]</td>
<td>parsed meta data of the page</td>
</tr>
<tr>
<td>previous_page</td>
<td>&amp;array</td>
<td>&amp;array[]</td>
<td>reference to the previous page</td>
</tr>
<tr>
<td>next_page</td>
<td>&amp;array</td>
<td>&amp;array[]</td>
<td>reference to the next page</td>
</tr>
<tr>
<td>tree_node</td>
<td>&amp;array</td>
<td>&amp;array[]</td>
<td>reference to the page's tree node</td>
</tr>
</tbody>
</table>
<p>Please note that the <code>previous_page</code> and <code>next_page</code> keys aren't
available until the <code>onCurrentPageDiscovered</code> event is triggered
(<a href="../classes/Pico.html#method_discoverPageSiblings">\Pico::discoverPageSiblings()</a>). The <code>tree_node</code> key isn't
available until the <code>onPageTreeBuilt</code> event is triggered
<p>Please note that the <code>previous_page</code> and <code>next_page</code> keys don't
exist until the <code>onCurrentPageDiscovered</code> event is triggered
(<a href="../classes/Pico.html#method_discoverPageSiblings">\Pico::discoverPageSiblings()</a>). The <code>tree_node</code> key doesn't
exit until the <code>onPageTreeBuilt</code> event is triggered
(<a href="../classes/Pico.html#method_buildPageTree">\Pico::buildPageTree()</a>).</p>
@@ -3485,9 +3487,10 @@ <h3 class="protected ">buildPageTree()</h3>
reference to its matching branch (i.e. a list of the node's children).
The order of a node's children matches the order in Pico's pages array.</p>
<p>If you want to walk the whole page tree, start with the tree's root node
at <code>$pageTree[""]["/"]</code>. The root node's <code>children</code> key is a reference
to the <code>/</code> branch at <code>$pageTree["/"]</code>, that is a list of the root node's
direct child nodes and their siblings.</p>
at <code>$pageTree[""]["/"]</code>, or rather, use <code>$pages["index"]["tree_node"]</code>.
The root node's <code>children</code> key is a reference to the <code>/</code> branch at
<code>$pageTree["/"]</code>, that is a list of the root node's direct child nodes
and their siblings.</p>
<p>You MUST NOT iterate the page tree itself (i.e. the list of the tree's
branches), its order is undefined and the array will be replaced by a
non-iterable data structure with Pico 3.0.</p>
@@ -3697,7 +3700,7 @@ <h1><i class="icon-pushpin"></i></h1>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on November 25th, 2017 at 21:03.
on December 27th, 2017 at 21:07.
</section>
</section>
</section>
Oops, something went wrong.

0 comments on commit 0a60d1b

Please sign in to comment.