]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apifriendshipsexists.php
Qvitter API changes (thanks hannes2peer)
[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-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/
30  */
31
32 if (!defined('STATUSNET')) {
33     exit(1);
34 }
35
36 /**
37  * Tests for the existence of friendship between two users. Will return true if
38  * user_a follows user_b, otherwise will return false.
39  *
40  * @category API
41  * @package  StatusNet
42  * @author   Dan Moore <dan@moore.cx>
43  * @author   Evan Prodromou <evan@status.net>
44  * @author   Zach Copley <zach@status.net>
45  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
46  * @link     http://status.net/
47  */
48 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
49 {
50     var $profile_a = null;
51     var $profile_b = null;
52
53     /**
54      * Take arguments for running
55      *
56      * @param array $args $_REQUEST args
57      *
58      * @return boolean success flag
59      */
60     function prepare($args)
61     {
62         parent::prepare($args);
63
64         $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
65         $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
66
67         return true;
68     }
69
70     /**
71      * Handle the request
72      *
73      * Check the format and show the user info
74      *
75      * @param array $args $_REQUEST data (unused)
76      *
77      * @return void
78      */
79     function handle($args)
80     {
81         parent::handle($args);
82
83         if (empty($this->profile_a) || empty($this->profile_b)) {
84             $this->clientError(
85                 // TRANS: Client error displayed when supplying invalid parameters to an API call checking if a friendship exists.
86                 _('Two valid IDs or nick names must be supplied.'),
87                 400,
88                 $this->format
89             );
90             return;
91         }
92
93         $result = Subscription::exists($this->profile_a, $this->profile_b);
94
95         switch ($this->format) {
96         case 'xml':
97             $this->initDocument('xml');
98             $this->element('friends', null, $result);
99             $this->endDocument('xml');
100             break;
101         case 'json':
102             $this->initDocument('json');
103             print json_encode($result);
104             $this->endDocument('json');
105             break;
106         default:
107             break;
108         }
109     }
110
111     /**
112      * Return true if read only.
113      *
114      * MAY override
115      *
116      * @param array $args other arguments
117      *
118      * @return boolean is read only action?
119      */
120     function isReadOnly($args)
121     {
122         return true;
123     }
124 }