Transform ApiResponse::formatData() into dynamic method

diff --git a/include/api.php b/include/api.php
index 118db50bce8e2791163145f30061c562e17c423c..346863f7412d488253054bb5f021a418a32cf6c7 100644 (file)
--- a/include/api.php
+++ b/include/api.php
@@ -707,7 +707,7 @@ function api_account_verify_credentials($type)
        unset($user_info["uid"]);
        unset($user_info["self"]);
 
-       return ApiResponse::formatData("user", $type, ['user' => $user_info]);
+       return DI::apiResponse()->formatData("user", $type, ['user' => $user_info]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1096,7 +1096,7 @@ function api_status_show($type, $item_id)
 
        Logger::info(API_LOG_PREFIX . 'End', ['action' => 'get_status', 'status_info' => $status_info]);
 
-       return ApiResponse::formatData('statuses', $type, ['status' => $status_info]);
+       return DI::apiResponse()->formatData('statuses', $type, ['status' => $status_info]);
 }
 
 /**
@@ -1162,7 +1162,7 @@ function api_users_show($type)
        unset($user_info['uid']);
        unset($user_info['self']);
 
-       return ApiResponse::formatData('user', $type, ['user' => $user_info]);
+       return DI::apiResponse()->formatData('user', $type, ['user' => $user_info]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1218,7 +1218,7 @@ function api_users_search($type)
                throw new BadRequestException('No search term specified.');
        }
 
-       return ApiResponse::formatData('users', $type, $userlist);
+       return DI::apiResponse()->formatData('users', $type, $userlist);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1254,7 +1254,7 @@ function api_users_lookup($type)
                throw new NotFoundException;
        }
 
-       return ApiResponse::formatData("users", $type, ['users' => $users]);
+       return DI::apiResponse()->formatData("users", $type, ['users' => $users]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1317,7 +1317,7 @@ function api_search($type)
                DBA::close($tags);
 
                if (empty($uriids)) {
-                       return ApiResponse::formatData('statuses', $type, $data);
+                       return DI::apiResponse()->formatData('statuses', $type, $data);
                }
 
                $condition = ['uri-id' => $uriids];
@@ -1358,7 +1358,7 @@ function api_search($type)
 
        bindComments($data['status']);
 
-       return ApiResponse::formatData('statuses', $type, $data);
+       return DI::apiResponse()->formatData('statuses', $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1455,7 +1455,7 @@ function api_statuses_home_timeline($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 
@@ -1541,7 +1541,7 @@ function api_statuses_public_timeline($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1600,7 +1600,7 @@ function api_statuses_networkpublic_timeline($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1676,10 +1676,10 @@ function api_statuses_show($type)
 
        if ($conversation) {
                $data = ['status' => $ret];
-               return ApiResponse::formatData("statuses", $type, $data);
+               return DI::apiResponse()->formatData("statuses", $type, $data);
        } else {
                $data = ['status' => $ret[0]];
-               return ApiResponse::formatData("status", $type, $data);
+               return DI::apiResponse()->formatData("status", $type, $data);
        }
 }
 
@@ -1758,7 +1758,7 @@ function api_conversation_show($type)
        $ret = api_format_items(Post::toArray($statuses), $user_info, false, $type);
 
        $data = ['status' => $ret];
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -1969,7 +1969,7 @@ function api_statuses_mentions($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -2047,7 +2047,7 @@ function api_statuses_user_timeline($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -2129,7 +2129,7 @@ function api_favorites_create_destroy($type)
                        break;
        }
 
-       return ApiResponse::formatData("status", $type, $data);
+       return DI::apiResponse()->formatData("status", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -2202,7 +2202,7 @@ function api_favorites($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -2908,7 +2908,7 @@ function api_lists_list($type)
 {
        $ret = [];
        /// @TODO $ret is not filled here?
-       return ApiResponse::formatData('lists', $type, ["lists_list" => $ret]);
+       return DI::apiResponse()->formatData('lists', $type, ["lists_list" => $ret]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -2958,7 +2958,7 @@ function api_lists_ownerships($type)
                        'mode' => $mode
                ];
        }
-       return ApiResponse::formatData("lists", $type, ['lists' => ['lists' => $lists]]);
+       return DI::apiResponse()->formatData("lists", $type, ['lists' => ['lists' => $lists]]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3038,7 +3038,7 @@ function api_lists_statuses($type)
                        break;
        }
 
-       return ApiResponse::formatData("statuses", $type, $data);
+       return DI::apiResponse()->formatData("statuses", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3152,7 +3152,7 @@ function api_statuses_friends($type)
        if ($data === false) {
                return false;
        }
-       return ApiResponse::formatData("users", $type, $data);
+       return DI::apiResponse()->formatData("users", $type, $data);
 }
 
 /**
@@ -3171,7 +3171,7 @@ function api_statuses_followers($type)
        if ($data === false) {
                return false;
        }
-       return ApiResponse::formatData("users", $type, $data);
+       return DI::apiResponse()->formatData("users", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3195,7 +3195,7 @@ function api_blocks_list($type)
        if ($data === false) {
                return false;
        }
-       return ApiResponse::formatData("users", $type, $data);
+       return DI::apiResponse()->formatData("users", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3224,7 +3224,7 @@ function api_friendships_incoming($type)
                $ids[] = $user['id'];
        }
 
-       return ApiResponse::formatData("ids", $type, ['id' => $ids]);
+       return DI::apiResponse()->formatData("ids", $type, ['id' => $ids]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3265,7 +3265,7 @@ function api_statusnet_config($type)
                ],
        ];
 
-       return ApiResponse::formatData('config', $type, ['config' => $config]);
+       return DI::apiResponse()->formatData('config', $type, ['config' => $config]);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3349,7 +3349,7 @@ function api_direct_messages_new($type)
                        break;
        }
 
-       return ApiResponse::formatData("direct-messages", $type, $data);
+       return DI::apiResponse()->formatData("direct-messages", $type, $data);
 }
 
 /// @TODO move to top of file or somewhere better
@@ -3388,7 +3388,7 @@ function api_direct_messages_destroy($type)
        // error if no id or parenturi specified (for clients posting parent-uri as well)
        if ($verbose == "true" && ($id == 0 || $parenturi == "")) {
                $answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
-               return ApiResponse::formatData("direct_messages_delete", $type, ['$result' => $answer]);
+               return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
        }
 
        // BadRequestException if no id specified (for clients using Twitter API)
@@ -3403,7 +3403,7 @@ function api_direct_messages_destroy($type)
        if (!DBA::exists('mail', ["`uid` = ? AND `id` = ? " . $sql_extra, $uid, $id])) {
                if ($verbose == "true") {
                        $answer = ['result' => 'error', 'message' => 'message id not in database'];
-                       return ApiResponse::formatData("direct_messages_delete", $type, ['$result' => $answer]);
+                       return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
                }
                /// @todo BadRequestException ok for Twitter API clients?
                throw new BadRequestException('message id not in database');
@@ -3416,10 +3416,10 @@ function api_direct_messages_destroy($type)
                if ($result) {
                        // return success
                        $answer = ['result' => 'ok', 'message' => 'message deleted'];
-                       return ApiResponse::formatData("direct_message_delete", $type, ['$result' => $answer]);
+                       return DI::apiResponse()->formatData("direct_message_delete", $type, ['$result' => $answer]);
                } else {
                        $answer = ['result' => 'error', 'message' => 'unknown error'];
-                       return ApiResponse::formatData("direct_messages_delete", $type, ['$result' => $answer]);
+                       return DI::apiResponse()->formatData("direct_messages_delete", $type, ['$result' => $answer]);
                }
        }
        /// @todo return JSON data like Twitter API not yet implemented
@@ -3504,7 +3504,7 @@ function api_friendships_destroy($type)
        // Set screen_name since Twidere requests it
        $contact['screen_name'] = $contact['nick'];
 
-       return ApiResponse::formatData('friendships-destroy', $type, ['user' => $contact]);
+       return DI::apiResponse()->formatData('friendships-destroy', $type, ['user' => $contact]);
 }
 
 api_register_func('api/friendships/destroy', 'api_friendships_destroy', true, API_METHOD_POST);
@@ -3586,7 +3586,7 @@ function api_direct_messages_box($type, $box, $verbose)
        ));
        if ($verbose == "true" && !DBA::isResult($r)) {
                $answer = ['result' => 'error', 'message' => 'no mails available'];
-               return ApiResponse::formatData("direct_messages_all", $type, ['$result' => $answer]);
+               return DI::apiResponse()->formatData("direct_messages_all", $type, ['$result' => $answer]);
        }
 
        $ret = [];
@@ -3614,7 +3614,7 @@ function api_direct_messages_box($type, $box, $verbose)
                        break;
        }
 
-       return ApiResponse::formatData("direct-messages", $type, $data);
+       return DI::apiResponse()->formatData("direct-messages", $type, $data);
 }
 
 /**
@@ -3728,7 +3728,7 @@ function api_fr_photos_list($type)
                        }
                }
        }
-       return ApiResponse::formatData("photos", $type, $data);
+       return DI::apiResponse()->formatData("photos", $type, $data);
 }
 
 /**
@@ -3800,7 +3800,7 @@ function api_fr_photo_create_update($type)
 
                // return success of updating or error message
                if (!is_null($data)) {
-                       return ApiResponse::formatData("photo_create", $type, $data);
+                       return DI::apiResponse()->formatData("photo_create", $type, $data);
                } else {
                        throw new InternalServerErrorException("unknown error - uploading photo failed, see Friendica log for more information");
                }
@@ -3851,18 +3851,18 @@ function api_fr_photo_create_update($type)
                        $media = $_FILES['media'];
                        $data = save_media_to_database("photo", $media, $type, $album, $allow_cid, $deny_cid, $allow_gid, $deny_gid, $desc, Photo::DEFAULT, $visibility, $photo_id);
                        if (!is_null($data)) {
-                               return ApiResponse::formatData("photo_update", $type, $data);
+                               return DI::apiResponse()->formatData("photo_update", $type, $data);
                        }
                }
 
                // return success of updating or error message
                if ($result) {
                        $answer = ['result' => 'updated', 'message' => 'Image id `' . $photo_id . '` has been updated.'];
-                       return ApiResponse::formatData("photo_update", $type, ['$result' => $answer]);
+                       return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]);
                } else {
                        if ($nothingtodo) {
                                $answer = ['result' => 'cancelled', 'message' => 'Nothing to update for image id `' . $photo_id . '`.'];
-                               return ApiResponse::formatData("photo_update", $type, ['$result' => $answer]);
+                               return DI::apiResponse()->formatData("photo_update", $type, ['$result' => $answer]);
                        }
                        throw new InternalServerErrorException("unknown error - update photo entry in database failed");
                }
@@ -3895,7 +3895,7 @@ function api_fr_photo_detail($type)
        // prepare json/xml output with data from database for the requested photo
        $data = prepare_photo_data($type, $scale, $photo_id);
 
-       return ApiResponse::formatData("photo_detail", $type, $data);
+       return DI::apiResponse()->formatData("photo_detail", $type, $data);
 }
 
 
@@ -4626,7 +4626,7 @@ function api_friendica_group_show($type)
                }
                $grps[] = ['name' => $rr['name'], 'gid' => $rr['id'], $user_element => $users];
        }
-       return ApiResponse::formatData("groups", $type, ['group' => $grps]);
+       return DI::apiResponse()->formatData("groups", $type, ['group' => $grps]);
 }
 
 api_register_func('api/friendica/group_show', 'api_friendica_group_show', true);
@@ -4684,7 +4684,7 @@ function api_friendica_group_delete($type)
        if ($ret) {
                // return success
                $success = ['success' => $ret, 'gid' => $gid, 'name' => $name, 'status' => 'deleted', 'wrong users' => []];
-               return ApiResponse::formatData("group_delete", $type, ['result' => $success]);
+               return DI::apiResponse()->formatData("group_delete", $type, ['result' => $success]);
        } else {
                throw new BadRequestException('other API error');
        }
@@ -4737,7 +4737,7 @@ function api_lists_destroy($type)
                        'user' => $user_info
                ];
 
-               return ApiResponse::formatData("lists", $type, ['lists' => $list]);
+               return DI::apiResponse()->formatData("lists", $type, ['lists' => $list]);
        }
 }
 
@@ -4826,7 +4826,7 @@ function api_friendica_group_create($type)
 
        $success = group_create($name, $uid, $users);
 
-       return ApiResponse::formatData("group_create", $type, ['result' => $success]);
+       return DI::apiResponse()->formatData("group_create", $type, ['result' => $success]);
 }
 
 api_register_func('api/friendica/group_create', 'api_friendica_group_create', true, API_METHOD_POST);
@@ -4866,7 +4866,7 @@ function api_lists_create($type)
                        'user' => $user_info
                ];
 
-               return ApiResponse::formatData("lists", $type, ['lists' => $grp]);
+               return DI::apiResponse()->formatData("lists", $type, ['lists' => $grp]);
        }
 }
 
@@ -4940,7 +4940,7 @@ function api_friendica_group_update($type)
        // return success message incl. missing users in array
        $status = ($erroraddinguser ? "missing user" : "ok");
        $success = ['success' => true, 'gid' => $gid, 'name' => $name, 'status' => $status, 'wrong users' => $errorusers];
-       return ApiResponse::formatData("group_update", $type, ['result' => $success]);
+       return DI::apiResponse()->formatData("group_update", $type, ['result' => $success]);
 }
 
 api_register_func('api/friendica/group_update', 'api_friendica_group_update', true, API_METHOD_POST);
@@ -4992,7 +4992,7 @@ function api_lists_update($type)
                        'user' => $user_info
                ];
 
-               return ApiResponse::formatData("lists", $type, ['lists' => $list]);
+               return DI::apiResponse()->formatData("lists", $type, ['lists' => $list]);
        }
 }
 
@@ -5044,12 +5044,12 @@ function api_friendica_notification_seen($type)
                                // we found the item, return it to the user
                                $ret  = api_format_items([$item], $user_info, false, $type);
                                $data = ['status' => $ret];
-                               return ApiResponse::formatData('status', $type, $data);
+                               return DI::apiResponse()->formatData('status', $type, $data);
                        }
                        // the item can't be found, but we set the notification as seen, so we count this as a success
                }
 
-               return ApiResponse::formatData('result', $type, ['result' => 'success']);
+               return DI::apiResponse()->formatData('result', $type, ['result' => 'success']);
        } catch (NotFoundException $e) {
                throw new BadRequestException('Invalid argument', $e);
        } catch (Exception $e) {
@@ -5090,7 +5090,7 @@ function api_friendica_direct_messages_search($type, $box = "")
        // error if no searchstring specified
        if ($searchstring == "") {
                $answer = ['result' => 'error', 'message' => 'searchstring not specified'];
-               return ApiResponse::formatData("direct_messages_search", $type, ['$result' => $answer]);
+               return DI::apiResponse()->formatData("direct_messages_search", $type, ['$result' => $answer]);
        }
 
        // get data for the specified searchstring
@@ -5125,7 +5125,7 @@ function api_friendica_direct_messages_search($type, $box = "")
                $success = ['success' => true, 'search_results' => $ret];
        }
 
-       return ApiResponse::formatData("direct_message_search", $type, ['$result' => $success]);
+       return DI::apiResponse()->formatData("direct_message_search", $type, ['$result' => $success]);
 }
 
 /// @TODO move to top of file or somewhere better

diff --git a/src/Module/Api/ApiResponse.php b/src/Module/Api/ApiResponse.php
index 270185025a0c308bdb8b836410a10126fc18c804..2ce9137337f13b7f581df2768db169d6525f989e 100644 (file)
--- a/src/Module/Api/ApiResponse.php
+++ b/src/Module/Api/ApiResponse.php
@@ -87,13 +87,13 @@ class ApiResponse
         *
         * @return array|string (string|array) XML data or JSON data
         */
-       public static function formatData(string $root_element, string $type, array $data)
+       public function formatData(string $root_element, string $type, array $data)
        {
                switch ($type) {
                        case 'atom':
                        case 'rss':
                        case 'xml':
-                               $ret = DI::apiResponse()->createXML($data, $root_element);
+                               $ret = $this->createXML($data, $root_element);
                                break;
                        case 'json':
                        default:
@@ -161,7 +161,7 @@ class ApiResponse
        {
                $format = $format ?? 'json';
 
-               $return = static::formatData($root_element, $format, $data);
+               $return = DI::apiResponse()->formatData($root_element, $format, $data);
 
                switch ($format) {
                        case 'xml':

diff --git a/tests/legacy/ApiTest.php b/tests/legacy/ApiTest.php
index c5d28f2d52509e22650368381fe9e2676b55f4ce..6bf144463a9582d2b69661ff06ed8afb15374e91 100644 (file)
--- a/tests/legacy/ApiTest.php
+++ b/tests/legacy/ApiTest.php
@@ -1142,7 +1142,7 @@ class ApiTest extends FixtureTest
        public function testApiFormatData()
        {
                $data = ['some_data'];
-               self::assertEquals($data, ApiResponse::formatData('root_element', 'json', $data));
+               self::assertEquals($data, DI::apiResponse()->formatData('root_element', 'json', $data));
        }
 
        /**
@@ -1159,7 +1159,7 @@ class ApiTest extends FixtureTest
                        'xmlns:georss="http://www.georss.org/georss">' . "\n" .
                        '  <data>some_data</data>' . "\n" .
                        '</root_element>' . "\n",
-                       ApiResponse::formatData('root_element', 'xml', ['data' => ['some_data']])
+                       DI::apiResponse()->formatData('root_element', 'xml', ['data' => ['some_data']])
                );
        }