beenull/Pico
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve class docs

Browse source
This commit is contained in:
Daniel Rudolf 2015-10-29 18:13:35 +01:00
parent e6681ea903
commit afb55b9cb6
2 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
lib/Pico.php
View file

@ -845,20 +845,20 @@ class Pico
*
* The page data will be an array containing the following values:
* <pre>
* +----------------+------------------------------------------+
* | 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) |
* +----------------+------------------------------------------+
* +----------------+--------+------------------------------------------+
* | 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()

30
plugins/DummyPlugin.php
View file

@ -227,22 +227,22 @@ class DummyPlugin extends AbstractPicoPlugin
/**
* Triggered when Pico reads a single page from the list of all known pages
*
* The $pageData variable consits of the following values:
* 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 |
* +-----------------+--------+------------------------------------------+
* +----------------+--------+------------------------------------------+
* | 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 DummyPlugin::onPagesLoaded()