First cut at some JSON Activity Streams output

2011-02-15 20:25:39 -08:00
parent ff502bb148
commit a1b436a8c6
6 changed files with 220 additions and 6 deletions
--- a/lib/activitystreamjsondocument.php
+++ b/lib/activitystreamjsondocument.php
@@ -0,0 +1,112 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Class for serializing Activity Streams in JSON
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Feed
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2011 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET'))
+{
+    exit(1);
+}
+
+/**
+ * A class for generating JSON documents that represent an Activity Streams
+ *
+ * @category Feed
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+class ActivityStreamJSONDocument
+{
+    /* Top level array representing the document */
+    protected $doc = array();
+
+    /* The current authenticated user */
+    protected $cur = null;
+
+    /**
+     * Constructor
+     *
+     * @param User $cur the current authenticated user
+     */
+
+    function __construct($cur = null)
+    {
+        $this->cur = $cur;
+
+        $this->doc['items'] = array();
+    }
+
+    /**
+     * Add more than one Item to the document
+     *
+     * @param mixed $notices an array of Notice objects or handle
+     *
+     */
+
+    function addItemsFromNotices($notices)
+    {
+        common_debug("addItemsFromNotices");
+        if (is_array($notices)) {
+            foreach ($notices as $notice) {
+                $this->addItemFromNotice($notice);
+            }
+        } else {
+            while ($notices->fetch()) {
+                $this->addItemFromNotice($notices);
+            }
+        }
+    }
+
+    /**
+     * Add a single Notice to the document
+     *
+     * @param Notice $notice a Notice to add
+     */
+
+    function addItemFromNotice($notice)
+    {
+        $cur = empty($this->cur) ? common_current_user() : $this->cur;
+
+        $act          = $notice->asActivity();
+        $act->extra[] = $notice->noticeInfo($cur);
+
+        array_push($this->doc['items'], $act->asArray());
+    }
+
+    /*
+     * Return the entire document as a big string of JSON
+     *
+     * @return string encoded JSON output
+     */
+    function asString()
+    {
+        return json_encode($this->doc);
+    }
+
+}