X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Factivitystreamjsondocument.php;h=12c3882c25d444b299293f27544294762719010d;hb=0b9a2fdf3ad19942e85a66b94d08501ce9c927dd;hp=2b99d19eb76f27151c3fced17d7bca3b2416b78e;hpb=061c8d959ba8351b145a27690d5a4caa477915ca;p=quix0rs-gnu-social.git diff --git a/lib/activitystreamjsondocument.php b/lib/activitystreamjsondocument.php index 2b99d19eb7..12c3882c25 100644 --- a/lib/activitystreamjsondocument.php +++ b/lib/activitystreamjsondocument.php @@ -41,14 +41,30 @@ if (!defined('STATUSNET')) * @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 +class ActivityStreamJSONDocument extends JSONActivityCollection { + // Note: Lot of AS folks think the content type should be: + // 'application/stream+json; charset=utf-8', but this is more + // useful at the moment, because some programs actually understand + // it. + const CONTENT_TYPE = 'application/json; charset=utf-8'; /* Top level array representing the document */ protected $doc = array(); /* The current authenticated user */ - protected $cur = null; + protected $cur; + protected $scoped = null; + + /* Title of the document */ + protected $title; + + /* Links associated with this document */ + protected $links; + + /* Count of items in this document */ + // XXX This is cryptically referred to in the spec: "The Stream serialization MAY contain a count property." + protected $count; /** * Constructor @@ -56,20 +72,27 @@ class ActivityStreamJSONDocument * @param User $cur the current authenticated user */ - function __construct($cur = null) + function __construct($cur = null, $title = null, $items = null, $links = null, $url = null) { + parent::__construct($items, $url); - $this->cur = $cur; + $this->cur = $cur ?: common_current_user(); + $this->scoped = !is_null($this->cur) ? $this->cur->getProfile() : null; /* Title of the JSON document */ - $this->doc['title'] = null; + $this->title = $title; - /* Array of activity items */ - $this->doc['items'] = array(); + if (!empty($items)) { + $this->count = count($this->items); + } /* Array of links associated with the document */ - $this->doc['links'] = array(); + $this->links = empty($links) ? array() : $items; + /* URL of a document, this document? containing a list of all the items in the stream */ + if (!empty($this->url)) { + $this->url = $this->url; + } } /** @@ -80,9 +103,15 @@ class ActivityStreamJSONDocument function setTitle($title) { - $this->doc['title'] = $title; + $this->title = $title; + } + + function setUrl($url) + { + $this->url = $url; } + /** * Add more than one Item to the document * @@ -111,11 +140,10 @@ class ActivityStreamJSONDocument function addItemFromNotice($notice) { - $cur = empty($this->cur) ? common_current_user() : $this->cur; - - $act = $notice->asActivity($cur); - $act->extra[] = $notice->noticeInfo($cur); - array_push($this->doc['items'], $act->asArray()); + $act = $notice->asActivity($this->scoped); + $act->extra[] = $notice->noticeInfo($this->scoped); + array_push($this->items, $act->asArray()); + $this->count++; } /** @@ -127,7 +155,7 @@ class ActivityStreamJSONDocument function addLink($url = null, $rel = null, $mediaType = null) { $link = new ActivityStreamsLink($url, $rel, $mediaType); - $this->doc['link'][] = $link->asArray(); + array_push($this->links, $link->asArray()); } /* @@ -137,81 +165,13 @@ class ActivityStreamJSONDocument */ function asString() { - return json_encode(array_filter($this->doc)); + $this->doc['generator'] = 'GNU social ' . GNUSOCIAL_VERSION; // extension + $this->doc['title'] = $this->title; + $this->doc['url'] = $this->url; + $this->doc['totalItems'] = $this->count; + $this->doc['items'] = $this->items; + $this->doc['links'] = $this->links; // extension + return json_encode(array_filter($this->doc)); // filter out empty elements } } - -/** - * A class for representing MediaLinks in JSON Activities - * - * @category Feed - * @package StatusNet - * @author Zach Copley - * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 - * @link http://status.net/ - */ - -class ActivityStreamsMediaLink extends ActivityStreamsLink -{ - private $linkDict; - - function __construct( - $url = null, - $width = null, - $height = null, - $mediaType = null, - $rel = null, - $duration = null - ) - { - parent::__construct($url, $rel, $mediaType); - $this->linkDict = array( - 'width' => $width, - 'height' => $height, - 'duration' => $duration - ); - } - - function asArray() - { - return array_merge( - parent::asArray(), - array_filter($this->linkDict) - ); - } -} - -/** - * A class for representing links in JSON Activities - * - * @category Feed - * @package StatusNet - * @author Zach Copley - * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 - * @link http://status.net/ - */ - -class ActivityStreamsLink -{ - private $linkDict; - - function __construct($url = null, $rel = null, $mediaType = null) - { - // links MUST have a URL - if (empty($url)) { - throw new Exception('Links must have a URL.'); - } - - $this->linkDict = array( - 'url' => $url, - 'rel' => $rel, // extension - 'type' => $mediaType // extension - ); - } - - function asArray() - { - return array_filter($this->linkDict); - } -}