]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/apiblockdestroy.php
CamelCase all function names in the API code
[quix0rs-gnu-social.git] / actions / apiblockdestroy.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Un-block a user via the API
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    Zach Copley <zach@status.net>
25  * @copyright 2009 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('STATUSNET')) {
31     exit(1);
32 }
33
34 require_once INSTALLDIR . '/lib/apiauth.php';
35
36 /**
37  * Un-blocks the user specified in the ID parameter for the authenticating user.
38  * Returns the un-blocked user in the requested format when successful.
39  *
40  * @category API
41  * @package  StatusNet
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/
45  */
46
47 class ApiBlockDestroyAction extends ApiAuthAction
48 {
49     var $user    = null;
50     var $other   = null;
51
52     /**
53      * Take arguments for running
54      *
55      * @param array $args $_REQUEST args
56      *
57      * @return boolean success flag
58      *
59      */
60
61     function prepare($args)
62     {
63         parent::prepare($args);
64
65         $this->user   = $this->auth_user;
66         $this->other  = $this->getTargetUser($this->arg('id'));
67
68         return true;
69     }
70
71     /**
72      * Handle the request
73      *
74      * Save the new message
75      *
76      * @param array $args $_REQUEST data (unused)
77      *
78      * @return void
79      */
80
81     function handle($args)
82     {
83         parent::handle($args);
84
85         if ($_SERVER['REQUEST_METHOD'] != 'POST') {
86             $this->clientError(
87                 _('This method requires a POST.'),
88                 400,
89                 $this->format
90             );
91             return;
92         }
93
94         if (empty($this->user) || empty($this->other)) {
95             $this->clientError(_('No such user!'), 404, $this->format);
96             return;
97         }
98
99         if (!$this->user->hasBlocked($this->other)
100             || $this->user->unblock($this->other)
101         ) {
102             $this->initDocument($this->format);
103             $this->showProfile($this->other, $this->format);
104             $this->endDocument($this->format);
105         } else {
106             $this->serverError(_('Unblock user failed.'));
107         }
108
109     }
110
111 }
112