]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apifriendshipsexists.php
Localisation updates from translatewiki.net
[quix0rs-gnu-social.git] / actions / apifriendshipsexists.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Show whether there is a friendship between two users
6  *
7  * PHP version 5
8  *
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.
13  *
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.
18  *
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/>.
21  *
22  * @category  API
23  * @package   StatusNet
24  * @author    Dan Moore <dan@moore.cx>
25  * @author    Evan Prodromou <evan@status.net>
26  * @author    Zach Copley <zach@status.net>
27  * @copyright 2009 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/
30  */
31
32 if (!defined('STATUSNET')) {
33     exit(1);
34 }
35
36 require_once INSTALLDIR . '/lib/apiprivateauth.php';
37
38 /**
39  * Tests for the existence of friendship between two users. Will return true if
40  * user_a follows user_b, otherwise will return false.
41  *
42  * @category API
43  * @package  StatusNet
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/
49  */
50
51 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
52 {
53     var $user_a = null;
54     var $user_b = null;
55
56     /**
57      * Take arguments for running
58      *
59      * @param array $args $_REQUEST args
60      *
61      * @return boolean success flag
62      *
63      */
64
65     function prepare($args)
66     {
67         parent::prepare($args);
68
69         $user_a_id = $this->trimmed('user_a');
70         $user_b_id = $this->trimmed('user_b');
71
72         $this->user_a = $this->getTargetUser($user_a_id);
73         $this->user_b = $this->getTargetUser($user_b_id);
74
75         return true;
76     }
77
78     /**
79      * Handle the request
80      *
81      * Check the format and show the user info
82      *
83      * @param array $args $_REQUEST data (unused)
84      *
85      * @return void
86      */
87
88     function handle($args)
89     {
90         parent::handle($args);
91
92         if (empty($this->user_a) || empty($this->user_b)) {
93             $this->clientError(
94                 _('Two user ids or screen_names must be supplied.'),
95                 400,
96                 $this->format
97             );
98             return;
99         }
100
101         $result = $this->user_a->isSubscribed($this->user_b);
102
103         switch ($this->format) {
104         case 'xml':
105             $this->initDocument('xml');
106             $this->element('friends', null, $result);
107             $this->endDocument('xml');
108             break;
109         case 'json':
110             $this->initDocument('json');
111             print json_encode($result);
112             $this->endDocument('json');
113             break;
114         default:
115             break;
116         }
117     }
118
119 }