3 * StatusNet, the distributed open-source microblogging tool
5 * Show whether there is a friendship between two users
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 Dan Moore <dan@moore.cx>
25 * @author Evan Prodromou <evan@status.net>
26 * @author Zach Copley <zach@status.net>
27 * @copyright 2009-2010 StatusNet, Inc.
28 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
29 * @link http://status.net/
32 if (!defined('STATUSNET')) {
36 require_once INSTALLDIR . '/lib/apiprivateauth.php';
39 * Tests for the existence of friendship between two users. Will return true if
40 * user_a follows user_b, otherwise will return false.
44 * @author Dan Moore <dan@moore.cx>
45 * @author Evan Prodromou <evan@status.net>
46 * @author Zach Copley <zach@status.net>
47 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
48 * @link http://status.net/
51 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
53 var $profile_a = null;
54 var $profile_b = null;
57 * Take arguments for running
59 * @param array $args $_REQUEST args
61 * @return boolean success flag
65 function prepare($args)
67 parent::prepare($args);
69 $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
70 $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
78 * Check the format and show the user info
80 * @param array $args $_REQUEST data (unused)
85 function handle($args)
87 parent::handle($args);
89 if (empty($this->profile_a) || empty($this->profile_b)) {
91 _('Two valid IDs or screen_names must be supplied.'),
98 $result = Subscription::exists($this->profile_a, $this->profile_b);
100 switch ($this->format) {
102 $this->initDocument('xml');
103 $this->element('friends', null, $result);
104 $this->endDocument('xml');
107 $this->initDocument('json');
108 print json_encode($result);
109 $this->endDocument('json');
117 * Return true if read only.
121 * @param array $args other arguments
123 * @return boolean is read only action?
126 function isReadOnly($args)