git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

apigroupismember.php 3.64 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Check to see whether a user a member of a group
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  API
 * @package   StatusNet
Zach Copley's avatar
Zach Copley committed
24 25 26
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Evan Prodromou <evan@status.net>
 * @author    Jeffery To <jeffery.to@gmail.com>
27 28
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
29
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
30 31 32 33 34 35 36 37 38 39 40 41 42
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

/**
 * Returns whether a user is a member of a specified group.
 *
 * @category API
 * @package  StatusNet
Zach Copley's avatar
Zach Copley committed
43 44 45
 * @author   Craig Andrews <candrews@integralblue.com>
 * @author   Evan Prodromou <evan@status.net>
 * @author   Jeffery To <jeffery.to@gmail.com>
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class ApiGroupIsMemberAction extends ApiBareAuthAction
{
    var $group   = null;

    /**
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     */

62
    protected function prepare(array $args=array())
63 64 65
    {
        parent::prepare($args);

66
        $this->target = $this->getTargetProfile(null);
67 68 69 70 71 72 73 74 75 76 77 78
        $this->group  = $this->getTargetGroup(null);

        return true;
    }

    /**
     * Handle the request
     *
     * Save the new message
     *
     * @return void
     */
79
    protected function handle()
80
    {
81
        parent::handle();
82

83
        if (empty($this->target)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
84
            // TRANS: Client error displayed when checking group membership for a non-existing user.
85
            $this->clientError(_('No such user.'), 404);
86 87 88
        }

        if (empty($this->group)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
89
            // TRANS: Client error displayed when checking group membership for a non-existing group.
90
            $this->clientError(_('Group not found.'), 404);
91 92
        }

93
        $is_member = $this->target->isMember($this->group);
94 95 96

        switch($this->format) {
        case 'xml':
97
            $this->initDocument('xml');
98
            $this->element('is_member', null, $is_member);
99
            $this->endDocument('xml');
100 101
            break;
        case 'json':
102 103 104
            $this->initDocument('json');
            $this->showJsonObjects(array('is_member' => $is_member));
            $this->endDocument('json');
105 106
            break;
        default:
107 108
            // TRANS: Client error displayed when coming across a non-supported API method.
            $this->clientError(_('API method not found.'));
109 110 111
        }
    }

112 113 114 115 116 117 118 119 120 121 122 123 124
    /**
     * Return true if read only.
     *
     * MAY override
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return true;
    }
125
}