]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apifriendshipsexists.php
Give NoticeListItem its own class
[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 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 class ApiFriendshipsExistsAction extends ApiPrivateAuthAction
51 {
52     var $profile_a = null;
53     var $profile_b = null;
54
55     /**
56      * Take arguments for running
57      *
58      * @param array $args $_REQUEST args
59      *
60      * @return boolean success flag
61      */
62     function prepare($args)
63     {
64         parent::prepare($args);
65
66         $this->profile_a = $this->getTargetProfile($this->trimmed('user_a'));
67         $this->profile_b = $this->getTargetProfile($this->trimmed('user_b'));
68
69         return true;
70     }
71
72     /**
73      * Handle the request
74      *
75      * Check the format and show the user info
76      *
77      * @param array $args $_REQUEST data (unused)
78      *
79      * @return void
80      */
81     function handle($args)
82     {
83         parent::handle($args);
84
85         if (empty($this->profile_a) || empty($this->profile_b)) {
86             $this->clientError(
87                 // TRANS: Client error displayed when supplying invalid parameters to an API call checking if a friendship exists.
88                 _('Two valid IDs or nick names must be supplied.'),
89                 400,
90                 $this->format
91             );
92             return;
93         }
94
95         $result = Subscription::exists($this->profile_a, $this->profile_b);
96
97         switch ($this->format) {
98         case 'xml':
99             $this->initDocument('xml');
100             $this->element('friends', null, $result);
101             $this->endDocument('xml');
102             break;
103         case 'json':
104             $this->initDocument('json');
105             print json_encode($result);
106             $this->endDocument('json');
107             break;
108         default:
109             break;
110         }
111     }
112
113     /**
114      * Return true if read only.
115      *
116      * MAY override
117      *
118      * @param array $args other arguments
119      *
120      * @return boolean is read only action?
121      */
122     function isReadOnly($args)
123     {
124         return true;
125     }
126 }