3 * Laconica, the distributed open-source microblogging tool
5 * widget for displaying a list of notices
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Zach Copley <zach@controlyourself.ca>
25 * @copyright 2009 Control Yourself, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://laconi.ca/
30 if (!defined('LACONICA')) {
35 * widget-like class for showing JSON search results
39 * @author Zach Copley <zach@controlyourself.ca>
40 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
41 * @link http://laconi.ca/
45 class JSONSearchResultsList
47 protected $notice; // protected attrs invisible to json_encode()
50 // The below attributes are carefully named so the JSON output from
51 // this obj matches the output from search.twitter.com
57 var $results_per_page;
65 * @param Notice $notice stream of notices from DB_DataObject
66 * @param string $query the original search query
67 * @param int $rpp the number of results to display per page
68 * @param int $page a page offset
69 * @param int $since_id only display notices newer than this
72 function __construct($notice, $query, $rpp, $page, $since_id = 0)
74 $this->notice = $notice;
75 $this->query = urlencode($query);
76 $this->results_per_page = $rpp;
79 $this->since_id = $since_id;
80 $this->results = array();
84 * show the list of search results
86 * @return int $count of the search results listed.
93 $time_start = microtime(true);
95 while ($this->notice->fetch() && $cnt <= $this->rpp) {
98 // XXX: Hmmm. this depends on desc sort order
100 $this->max_id = (int)$this->notice->id;
103 if ($cnt > $this->rpp) {
107 $item = new ResultItem($this->notice);
108 array_push($this->results, $item);
111 $time_end = microtime(true);
112 $this->completed_in = $time_end - $time_start;
116 $this->refresh_url = '?since_id=' . $this->max_id .
117 '&q=' . $this->query;
121 if ($cnt > $this->rpp) {
122 $this->next_page = '?page=' . ($this->page + 1) .
123 '&max_id=' . $this->max_id;
124 if ($this->rpp != 15) {
125 $this->next_page .= '&rpp=' . $this->rpp;
127 $this->next_page .= '&q=' . $this->query;
130 if ($this->page > 1) {
131 $this->previous_page = '?page=' . ($this->page - 1) .
132 '&max_id=' . $this->max_id;
133 if ($this->rpp != 15) {
134 $this->previous_page .= '&rpp=' . $this->rpp;
136 $this->previous_page .= '&q=' . $this->query;
139 print json_encode($this);
146 * widget for displaying a single JSON search result
150 * @author Zach Copley <zach@controlyourself.ca>
151 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
152 * @link http://laconi.ca/
153 * @see JSONSearchResultsList
158 /** The notice this item is based on. */
160 protected $notice; // protected attrs invisible to json_encode()
162 /** The profile associated with the notice. */
166 // The below attributes are carefully named so the JSON output from
167 // this obj matches the output from search.twitter.com
175 var $iso_language_code;
177 var $profile_image_url;
183 * Also initializes the profile attribute.
185 * @param Notice $notice The notice we'll display
188 function __construct($notice)
190 $this->notice = $notice;
191 $this->profile = $notice->getProfile();
192 $this->buildResult();
196 * Build a search result object
198 * This populates the the result in preparation for JSON encoding.
203 function buildResult()
205 $this->text = $this->notice->content;
206 $replier_profile = null;
208 if ($this->notice->reply_to) {
209 $reply = Notice::staticGet(intval($notice->reply_to));
211 $replier_profile = $reply->getProfile();
215 $this->to_user_id = ($replier_profile) ?
216 intval($replier_profile->id) : null;
217 $this->to_user = ($replier_profile) ?
218 $replier_profile->nickname : null;
220 $this->from_user = $this->profile->nickname;
221 $this->id = $this->notice->id;
222 $this->from_user_id = $this->profile->id;
224 $user = User::staticGet('id', $this->profile->id);
226 $this->iso_language_code = $this->user->language;
228 $this->source = $this->getSourceLink($this->notice->source);
230 $avatar = $this->profile->getAvatar(AVATAR_STREAM_SIZE);
232 $this->profile_image_url = ($avatar) ?
233 $avatar->displayUrl() : Avatar::defaultImage(AVATAR_STREAM_SIZE);
235 $this->created_at = common_date_rfc2822($this->notice->created);
239 * Show the source of the notice
241 * Either the name (and link) of the API client that posted the notice,
242 * or one of other other channels.
244 * @param string $source the source of the Notice
246 * @return string a fully rendered source of the Notice
249 function getSourceLink($source)
251 $source_name = _($source);
260 $ns = Notice_source::staticGet($source);
262 $source_name = '<a href="' . $ns->url . '">' . $ns->name . '</a>';