]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - actions/apigroupismember.php
Merge branch 'nightly' of gitorious.org:social/mainline into nightly
[quix0rs-gnu-social.git] / actions / apigroupismember.php
index facc58174eee3897893dc4c2624e5a24ffa36d74..97ae325cb56c125d5489a15e6a785a66f8692424 100644 (file)
  *
  * @category  API
  * @package   StatusNet
+ * @author    Craig Andrews <candrews@integralblue.com>
+ * @author    Evan Prodromou <evan@status.net>
+ * @author    Jeffery To <jeffery.to@gmail.com>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009 StatusNet, Inc.
+ * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
@@ -31,22 +35,20 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once INSTALLDIR . '/lib/apibareauth.php';
-
 /**
  * Returns whether a user is a member of a specified group.
  *
  * @category API
  * @package  StatusNet
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Jeffery To <jeffery.to@gmail.com>
  * @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 $format  = null;
-    var $user    = null;
     var $group   = null;
 
     /**
@@ -55,22 +57,14 @@ class ApiGroupIsMemberAction extends ApiBareAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
 
-    function prepare($args)
+    protected function prepare(array $args=array())
     {
         parent::prepare($args);
 
-        if ($this->requiresAuth()) {
-            if ($this->checkBasicAuthUser() == false) {
-                return;
-            }
-        }
-
-        $this->user   = $this->getTargetUser(null);
+        $this->target = $this->getTargetProfile(null);
         $this->group  = $this->getTargetGroup(null);
-        $this->format = $this->arg('format');
 
         return true;
     }
@@ -80,46 +74,52 @@ class ApiGroupIsMemberAction extends ApiBareAuthAction
      *
      * Save the new message
      *
-     * @param array $args $_REQUEST data (unused)
-     *
      * @return void
      */
-
-    function handle($args)
+    protected function handle()
     {
-        parent::handle($args);
+        parent::handle();
 
-        if (empty($this->user)) {
-            $this->clientError(_('No such user!'), 404, $this->format);
-            return;
+        if (empty($this->target)) {
+            // TRANS: Client error displayed when checking group membership for a non-existing user.
+            $this->clientError(_('No such user.'), 404);
         }
 
         if (empty($this->group)) {
-            $this->clientError('Group not found!', 404, $this->format);
-            return false;
+            // TRANS: Client error displayed when checking group membership for a non-existing group.
+            $this->clientError(_('Group not found.'), 404);
         }
 
-        $is_member = $this->user->isMember($this->group);
+        $is_member = $this->target->isMember($this->group);
 
         switch($this->format) {
         case 'xml':
-            $this->init_document('xml');
+            $this->initDocument('xml');
             $this->element('is_member', null, $is_member);
-            $this->end_document('xml');
+            $this->endDocument('xml');
             break;
         case 'json':
-            $this->init_document('json');
-            $this->show_json_objects(array('is_member' => $is_member));
-            $this->end_document('json');
+            $this->initDocument('json');
+            $this->showJsonObjects(array('is_member' => $is_member));
+            $this->endDocument('json');
             break;
         default:
-            $this->clientError(
-                _('API method not found!'),
-                400,
-                $this->format
-            );
-            break;
+            // TRANS: Client error displayed when coming across a non-supported API method.
+            $this->clientError(_('API method not found.'));
         }
     }
 
+    /**
+     * Return true if read only.
+     *
+     * MAY override
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean is read only action?
+     */
+    function isReadOnly(array $args=array())
+    {
+        return true;
+    }
 }