SeaCMS
/
pico
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve class docs

Browse Source
pico-3.0-alpha
Daniel Rudolf 10 years ago
parent e6681ea903
commit afb55b9cb6
2 changed files with 29 additions and 29 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 28
      lib/Pico.php
  2. 30
      plugins/DummyPlugin.php

28
lib/Pico.php
Unescape View File

@ -845,20 +845,20 @@ class Pico
* *
* The page data will be an array containing the following values: * The page data will be an array containing the following values:
* <pre> * <pre>
* +----------------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* | Array key | Description | * | Array key | Type | Description |
* +----------------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* | id | relative path to the content file | * | id | string | relative path to the content file |
* | url | URL to the page | * | url | string | URL to the page |
* | title | title of the page (YAML header) | * | title | string | title of the page (YAML header) |
* | description | description of the page (YAML header) | * | description | string | description of the page (YAML header) |
* | author | author of the page (YAML header) | * | author | string | author of the page (YAML header) |
* | time | timestamp derived from the Date header | * | time | string | timestamp derived from the Date header |
* | date | date of the page (YAML header) | * | date | string | date of the page (YAML header) |
* | date_formatted | formatted date of the page | * | date_formatted | string | formatted date of the page |
* | raw_content | raw, not yet parsed contents of the page | * | raw_content | string | raw, not yet parsed contents of the page |
* | meta | parsed meta data of the page) | * | meta | string | parsed meta data of the page |
* +----------------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* </pre> * </pre>
* *
* @see Pico::sortPages() * @see Pico::sortPages()

30
plugins/DummyPlugin.php
Unescape View File

@ -227,22 +227,22 @@ class DummyPlugin extends AbstractPicoPlugin
/** /**
* Triggered when Pico reads a single page from the list of all known pages * 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> * <pre>
* +-----------------+--------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* | Array key | Type | Description | * | Array key | Type | Description |
* +-----------------+--------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* | $id | string | relative path to the content file | * | id | string | relative path to the content file |
* | $url | string | URL to the page | * | url | string | URL to the page |
* | $title | string | title of the page (YAML header) | * | title | string | title of the page (YAML header) |
* | $description | string | description of the page (YAML header) | * | description | string | description of the page (YAML header) |
* | $author | string | author of the page (YAML header) | * | author | string | author of the page (YAML header) |
* | $time | string | timestamp derived from the Date header | * | time | string | timestamp derived from the Date header |
* | $date | string | date of the page (YAML header) | * | date | string | date of the page (YAML header) |
* | $date_formatted | string | formatted date of the page | * | date_formatted | string | formatted date of the page |
* | $raw_content | string | raw, not yet parsed contents of the page | * | raw_content | string | raw, not yet parsed contents of the page |
* | $meta | string | parsed meta data of the page | * | meta | string | parsed meta data of the page |
* +-----------------+--------+------------------------------------------+ * +----------------+--------+------------------------------------------+
* </pre> * </pre>
* *
* @see DummyPlugin::onPagesLoaded() * @see DummyPlugin::onPagesLoaded()

Write Preview
Loading…
Cancel
Save