v0.1

Author: nliautaud

LICENCE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nicolas Liautaud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

PicoOutput.php

@@ -0,0 +1,96 @@
+<?php
+/**
+ * Output the page content or data as raw, html, json or xml with `?output`.
+ *
+ * @author	Nicolas Liautaud
+ * @link	https://github.com/nliautaud/pico-content-output
+ * @link    http://picocms.org
+ * @license http://opensource.org/licenses/MIT The MIT License
+ * @version 0.1.0
+ */
+final class PicoOutput extends AbstractPicoPlugin
+{
+    private $serveContent;
+    private $contentFormat;
+
+    /**
+     * Look for ?output=format in url (format as `content` by default)
+     *
+     * Triggered after Pico has evaluated the request URL
+     *
+     * @see    Pico::getRequestUrl()
+     * @param  string &$url part of the URL describing the requested contents
+     * @return void
+     */
+     public function onRequestUrl(&$url)
+     {
+        $this->serveContent = isset($_GET['output']);
+        if ($this->serveContent)
+            $this->contentFormat = $_GET['output'] ? $_GET['output'] : 'content';
+    }
+    /**
+     * Output the page data in the defined format.
+     *
+     * Triggered after Pico has rendered the page
+     *
+     * @param  string &$output contents which will be sent to the user
+     * @return void
+     */
+    public function onPageRendered(&$output)
+    {
+        if ($this->serveContent && $this->enabledFormat())
+            $output = $this->contentOutput();
+    } 
+    /**
+     * Check if the requested format is enabled in config.
+     *
+     * @return bool
+     */
+    public function enabledFormat()
+    {
+        $enabledFormats = $this->getPico()->getConfig('PicoOutput.enabledFormats');
+        return is_array($enabledFormats) && in_array($this->contentFormat, $enabledFormats);
+    } 
+    
+    /**
+     * Return the current page data in the defined format.
+     * @return string
+     */
+    private function contentOutput()
+    {
+        $pico = $this->getPico();
+        switch ($this->contentFormat) {
+            case 'raw':
+                return $pico->getRawContent();
+            case 'prepared':
+                return $pico->prepareFileContent($pico->getRawContent(), $pico->getFileMeta());
+            case 'json':
+                header('Content-Type: application/json;charset=utf-8');
+                return json_encode($pico->getCurrentPage());
+            case 'xml':
+                header("Content-type: text/xml");
+                $xml = new SimpleXMLElement('<page/>');
+                $this->array_to_xml($pico->getCurrentPage(), $xml);
+                return $xml->asXML();
+            default:
+                return $pico->getFileContent();
+        }
+    }  
+
+    // function defination to convert array to xml
+    private function array_to_xml( $data, &$xml_data )
+    {
+        foreach( $data as $key => $value ) {
+            if( is_numeric($key) ){
+                $key = 'item'.$key; //dealing with <0/>..<n/> issues
+            }
+            if( is_array($value) ) {
+                $subnode = $xml_data->addChild($key);
+                $this->array_to_xml($value, $subnode);
+            } else {
+                $xml_data->addChild("$key",htmlspecialchars("$value"));
+            }
+         }
+    }
+}
+?>

README.md

@@ -0,0 +1,28 @@
+# Pico Page Output
+
+Output the page content or data as raw, html, json or xml with `?output` in [Pico CMS](http://picocms.org).
+
+## Installation
+
+Copy `PicoPageOutput.php` to the `plugins/` directory of your Pico Project.
+
+## Usage
+
+Enable the plugin and the output formats in Pico `config.php`.
+
+```php
+$config['PicoPageOutput.enabled'] = true; // by default
+$config['PicoPageOutput.enabledFormats'] = array('content', 'prepared');
+```
+
+Then add `?output=format` to any url.
+
+format|desc.|example
+---|---|---
+`content`|The html content.|`<p>Some content. <emph>base_url</emph>: http://monsite.com</p>`
+`raw`|The raw page, with meta header and raw variables.|`---\nTitle:My title\n---\nSome content. *base_url*: %base_url%`
+`prepared`|The page content without the meta header and with parsed variables.|`Some content. *base_url*: http://monsite.com`
+`json`|The page data in json format.|`{"id":"index","url":"http:\/\/monsite.com\/index","title":"My title","author":"","time":"","date":"","date_formatted":"","raw_content":"---\nTitle:My title\n---\nSome content. *base_url*: %base_url%","content":"<p>Some content. <emph>base_url</emph>: http://monsite.com</p>"}`
+`xml`|The page data in xml format.|`{"id":"index","url":"http:\/\/monsite.com\/index","title":"My title","author":"","time":"","date":"","date_formatted":"","raw_content":"---\nTitle:My title\n---\nSome content. *base_url*: %base_url%","content":"<p>Some content. <emph>base_url</emph>: http://monsite.com</p>"}`
+
+Note that some formats output the page meta or basic internal data.