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('GNUSOCIAL')) { exit(1); }
35 * Tests for the existence of friendship between two users. Will return true if
36 * user_a follows user_b, otherwise will return false.
40 * @author Dan Moore <dan@moore.cx>
41 * @author Evan Prodromou <evan@status.net>
42 * @author Zach Copley <zach@status.net>
43 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
44 * @link http://status.net/
46 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
48 var $profile_a = null;
49 var $profile_b = null;
52 * Take arguments for running
54 * @param array $args $_REQUEST args
56 * @return boolean success flag
58 protected function prepare(array $args=array())
60 parent::prepare($args);
62 $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
63 $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
71 * Check the format and show the user info
75 protected function handle()
79 if (empty($this->profile_a) || empty($this->profile_b)) {
81 // TRANS: Client error displayed when supplying invalid parameters to an API call checking if a friendship exists.
82 _('Two valid IDs or nick names must be supplied.'),
87 $result = Subscription::exists($this->profile_a, $this->profile_b);
89 switch ($this->format) {
91 $this->initDocument('xml');
92 $this->element('friends', null, $result);
93 $this->endDocument('xml');
96 $this->initDocument('json');
97 print json_encode($result);
98 $this->endDocument('json');
106 * Return true if read only.
110 * @param array $args other arguments
112 * @return boolean is read only action?
114 function isReadOnly($args)