Improved type-hint for following methods:

[quix0rs-gnu-social.git] / actions / apifriendshipsshow.php

diff --git a/actions/apifriendshipsshow.php b/actions/apifriendshipsshow.php
index 0ae6a7b82b8b1c152f7f2da213edd719b19beb02..1cbb98891ae2c01c6f05623938908ba8e9faa577 100644 (file)
--- a/actions/apifriendshipsshow.php
+++ b/actions/apifriendshipsshow.php
@@ -21,6 +21,8 @@
  *
  * @category  API
  * @package   StatusNet
+ * @author    Dan Moore <dan@moore.cx>
+ * @author    Evan Prodromou <evan@status.net>
  * @author    Zach Copley <zach@status.net>
  * @copyright 2009 StatusNet, Inc.
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
@@ -31,21 +33,19 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once INSTALLDIR.'/lib/apibareauth.php';
-
 /**
  * Outputs detailed information about the relationship between two users
  *
  * @category API
  * @package  StatusNet
+ * @author   Dan Moore <dan@moore.cx>
+ * @author   Evan Prodromou <evan@status.net>
  * @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 ApiFriendshipsShowAction extends ApiBareAuthAction
 {
-    var $user   = null;
     var $source = null;
     var $target = null;
 
@@ -55,10 +55,8 @@ class ApiFriendshipsShowAction extends ApiBareAuthAction
      * @param array $args $_REQUEST args
      *
      * @return boolean success flag
-     *
      */
-
-    function prepare($args)
+    function prepare(array $args=array())
     {
         parent::prepare($args);
 
@@ -66,32 +64,30 @@ class ApiFriendshipsShowAction extends ApiBareAuthAction
         $source_screen_name = $this->trimmed('source_screen_name');
         $target_id          = (int)$this->trimmed('target_id');
         $target_screen_name = $this->trimmed('target_screen_name');
-    
+
         if (!empty($source_id)) {
-            $this->source = User::staticGet($source_id);
+            $this->source = User::getKV($source_id);
         } elseif (!empty($source_screen_name)) {
-            $this->source = User::staticGet('nickname', $source_screen_name);
+            $this->source = User::getKV('nickname', $source_screen_name);
         } else {
             $this->source = $this->auth_user;
         }
 
         if (!empty($target_id)) {
-            $this->target = User::staticGet($target_id);
+            $this->target = User::getKV($target_id);
         } elseif (!empty($target_screen_name)) {
-            $this->target = User::staticGet('nickname', $target_screen_name);
+            $this->target = User::getKV('nickname', $target_screen_name);
         }
 
         return true;
     }
 
-
     /**
      * Determines whether this API resource requires auth.  Overloaded to look
      * return true in case source_id and source_screen_name are both empty
      *
      * @return boolean true or false
      */
-       
     function requiresAuth()
     {
         if (common_config('site', 'private')) {
@@ -117,49 +113,61 @@ class ApiFriendshipsShowAction extends ApiBareAuthAction
      *
      * @return void
      */
-
-    function handle($args)
+    function handle(array $args=array())
     {
         parent::handle($args);
 
         if (!in_array($this->format, array('xml', 'json'))) {
-            $this->clientError(_('API method not found!'), 404);
-            return;
+            // TRANS: Client error displayed when coming across a non-supported API method.
+            $this->clientError(_('API method not found.'), 404);
         }
-        
+
         if (empty($this->source)) {
             $this->clientError(
+                // TRANS: Client error displayed when a source user could not be determined showing friendship.
                 _('Could not determine source user.'),
                 404
              );
-            return;
         }
-              
+
         if (empty($this->target)) {
             $this->clientError(
+                // TRANS: Client error displayed when a target user could not be determined showing friendship.
                 _('Could not find target user.'),
                 404
             );
-            return;
         }
-        
-        $result = $this->twitter_relationship_array($this->source, $this->target);
+
+        $result = $this->twitterRelationshipArray($this->source, $this->target);
 
         switch ($this->format) {
         case 'xml':
-            $this->init_document('xml');
-            $this->show_twitter_xml_relationship($result[relationship]);
-            $this->end_document('xml');
+            $this->initDocument('xml');
+            $this->showTwitterXmlRelationship($result[relationship]);
+            $this->endDocument('xml');
             break;
         case 'json':
-            $this->init_document('json');
+            $this->initDocument('json');
             print json_encode($result);
-            $this->end_document('json');
+            $this->endDocument('json');
             break;
         default:
             break;
         }
-        
     }
 
+    /**
+     * 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;
+    }
 }