Rename ApipResponse->exit* methods to better show their meaning

This commit is contained in:
Hypolite Petovan 2023-09-22 10:14:46 -04:00
parent 960171c4e0
commit 642baa1f2a
68 changed files with 88 additions and 88 deletions

View file

@ -51,6 +51,6 @@ class RateLimitStatus extends BaseApi
];
}
$this->response->exit('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
}
}

View file

@ -66,6 +66,6 @@ class UpdateProfile extends BaseApi
// "uid" is only needed for some internal stuff, so remove it from here
unset($user_info['uid']);
$this->response->exit('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -67,6 +67,6 @@ class UpdateProfileImage extends BaseApi
// "uid" is only needed for some internal stuff, so remove it from here
unset($user_info['uid']);
$this->response->exit('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -47,6 +47,6 @@ class VerifyCredentials extends BaseApi
// "uid" is only needed for some internal stuff, so remove it from here
unset($user_info['uid']);
$this->response->exit('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -84,6 +84,6 @@ class Lists extends ContactEndpoint
self::setLinkHeader();
$this->response->exit('lists', ['lists' => $return]);
$this->response->addFormattedContent('lists', ['lists' => $return]);
}
}

View file

@ -61,7 +61,7 @@ class Destroy extends BaseApi
// error if no id or parenturi specified (for clients posting parent-uri as well)
if ($verbose && $id == 0 && $parenturi == "") {
$answer = ['result' => 'error', 'message' => 'message id or parenturi not specified'];
$this->response->exit('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
return;
}
@ -72,7 +72,7 @@ class Destroy extends BaseApi
if (!$this->dba->exists('mail', ["`uid` = ? AND `id` = ? " . $sql_extra, $uid, $id])) {
if ($verbose) {
$answer = ['result' => 'error', 'message' => 'message id not in database'];
$this->response->exit('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
return;
}
throw new BadRequestException('message id not in database');
@ -85,10 +85,10 @@ class Destroy extends BaseApi
if ($result) {
// return success
$answer = ['result' => 'ok', 'message' => 'message deleted'];
$this->response->exit('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
} else {
$answer = ['result' => 'error', 'message' => 'unknown error'];
$this->response->exit('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('direct_messages_delete', ['direct_messages_delete' => $answer], $this->parameters['extension'] ?? null);
}
}
}

View file

@ -91,6 +91,6 @@ class NewDM extends BaseApi
$ret = ['error' => $id];
}
$this->response->exit('direct-messages', ['direct_message' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('direct-messages', ['direct_message' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -99,7 +99,7 @@ abstract class DirectMessagesEndpoint extends BaseApi
$mails = $this->dba->selectToArray('mail', ['id'], $condition, $params);
if ($verbose && !DBA::isResult($mails)) {
$answer = ['result' => 'error', 'message' => 'no mails available'];
$this->response->exit('direct-messages', ['direct_message' => $answer], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('direct-messages', ['direct_message' => $answer], $this->parameters['extension'] ?? null);
return;
}
@ -116,6 +116,6 @@ abstract class DirectMessagesEndpoint extends BaseApi
self::setLinkHeader();
$this->response->exit('direct-messages', ['direct_message' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('direct-messages', ['direct_message' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -72,6 +72,6 @@ class Favorites extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -52,6 +52,6 @@ class Create extends BaseApi
$status_info = DI::twitterStatus()->createFromUriId($id, $uid)->toArray();
$this->response->exit('status', ['status' => $status_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('status', ['status' => $status_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -52,6 +52,6 @@ class Destroy extends BaseApi
$status_info = DI::twitterStatus()->createFromUriId($id, $uid)->toArray();
$this->response->exit('status', ['status' => $status_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('status', ['status' => $status_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -114,6 +114,6 @@ class Lists extends ContactEndpoint
$this->response->setHeader(self::getLinkHeader());
$this->response->exit('lists', ['lists' => $return]);
$this->response->addFormattedContent('lists', ['lists' => $return]);
}
}

View file

@ -114,6 +114,6 @@ class Lists extends ContactEndpoint
$this->response->setHeader(self::getLinkHeader());
$this->response->exit('lists', ['lists' => $return]);
$this->response->addFormattedContent('lists', ['lists' => $return]);
}
}

View file

@ -87,6 +87,6 @@ class Destroy extends ContactEndpoint
throw new HTTPException\InternalServerErrorException('Unable to unfollow this contact, please contact your administrator');
}
$this->response->exit('friendships', ['user' => $user], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('friendships', ['user' => $user], $this->parameters['extension'] ?? null);
}
}

View file

@ -82,6 +82,6 @@ class Incoming extends ContactEndpoint
$this->response->setHeader(self::getLinkHeader());
$this->response->exit('incoming', ['incoming' => $return]);
$this->response->addFormattedContent('incoming', ['incoming' => $return]);
}
}

View file

@ -112,6 +112,6 @@ class Show extends ContactEndpoint
]
];
DI::apiResponse()->exit('relationship', ['relationship' => $relationship], $this->parameters['extension'] ?? null);
DI::apiResponse()->addFormattedContent('relationship', ['relationship' => $relationship], $this->parameters['extension'] ?? null);
}
}

View file

@ -80,6 +80,6 @@ class Create extends BaseApi
$grp = $this->friendicaCircle->createFromId($gid);
$this->response->exit('statuses', ['lists' => ['lists' => $grp]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['lists' => ['lists' => $grp]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -77,7 +77,7 @@ class Destroy extends BaseApi
$list = $this->friendicaCircle->createFromId($gid);
if (Circle::remove($gid)) {
$this->response->exit('statuses', ['lists' => ['lists' => $list]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['lists' => ['lists' => $list]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}
}

View file

@ -38,6 +38,6 @@ class Lists extends BaseApi
// This is a dummy endpoint
$ret = [];
$this->response->exit('statuses', ["lists_list" => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ["lists_list" => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -64,6 +64,6 @@ class Ownership extends BaseApi
$lists[] = $this->friendicaCircle->createFromId($circle['id']);
}
$this->response->exit('statuses', ['lists' => ['lists' => $lists]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['lists' => ['lists' => $lists]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -103,6 +103,6 @@ class Statuses extends BaseApi
}
$this->dba->close($statuses);
$this->response->exit('statuses', ['status' => $items], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $items], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -78,7 +78,7 @@ class Update extends BaseApi
if (Circle::update($gid, $name)) {
$list = $this->friendicaCircle->createFromId($gid);
$this->response->exit('statuses', ['lists' => ['lists' => $list]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['lists' => ['lists' => $list]], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}
}

View file

@ -65,6 +65,6 @@ class Upload extends BaseApi
Logger::info('Media uploaded', ['return' => $returndata]);
$this->response->exit('media', ['media' => $returndata], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('media', ['media' => $returndata], $this->parameters['extension'] ?? null);
}
}

View file

@ -44,6 +44,6 @@ class SavedSearches extends BaseApi
DBA::close($terms);
$this->response->exit('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
}
}

View file

@ -72,7 +72,7 @@ class Tweets extends BaseApi
DBA::close($tags);
if (empty($uriids)) {
$this->response->exit('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
return;
}
@ -116,6 +116,6 @@ class Tweets extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -59,6 +59,6 @@ class Destroy extends BaseApi
Item::deleteForUser(['id' => $post['id']], $uid);
$this->response->exit('status', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('status', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -87,6 +87,6 @@ class HomeTimeline extends BaseApi
}
}
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -80,6 +80,6 @@ class Mentions extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -63,6 +63,6 @@ class NetworkPublicTimeline extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -85,6 +85,6 @@ class PublicTimeline extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -69,6 +69,6 @@ class Retweet extends BaseApi
$status_info = DI::twitterStatus()->createFromItemId($item_id, $uid)->toArray();
DI::apiResponse()->exit('statuses', ['status' => $status_info], $this->parameters['extension'] ?? null);
DI::apiResponse()->addFormattedContent('statuses', ['status' => $status_info], $this->parameters['extension'] ?? null);
}
}

View file

@ -85,10 +85,10 @@ class Show extends BaseApi
if ($conversation) {
$data = ['status' => $ret];
$this->response->exit('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
} else {
$data = ['status' => $ret[0]];
$this->response->exit('status', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('status', $data, $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}
}

View file

@ -184,7 +184,7 @@ class Update extends BaseApi
if (!empty($item['uri-id'])) {
// output the post that we just posted.
$status_info = DI::twitterStatus()->createFromUriId($item['uri-id'], $uid, $request['include_entities'])->toArray();
DI::apiResponse()->exit('status', ['status' => $status_info], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
DI::apiResponse()->addFormattedContent('status', ['status' => $status_info], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
return;
}
}

View file

@ -80,6 +80,6 @@ class UserTimeline extends BaseApi
}
DBA::close($statuses);
$this->response->exit('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
$this->response->addFormattedContent('statuses', ['status' => $ret], $this->parameters['extension'] ?? null, Contact::getPublicIdByUserId($uid));
}
}

View file

@ -51,6 +51,6 @@ class Lookup extends BaseApi
throw new NotFoundException();
}
$this->response->exit('users', ['user' => $users], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('users', ['user' => $users], $this->parameters['extension'] ?? null);
}
}

View file

@ -69,6 +69,6 @@ class Search extends BaseApi
throw new BadRequestException('No search term specified.');
}
$this->response->exit('users', $userlist, $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('users', $userlist, $this->parameters['extension'] ?? null);
}
}

View file

@ -48,6 +48,6 @@ class Show extends BaseApi
// "uid" is only needed for some internal stuff, so remove it from here
unset($user_info['uid']);
$this->response->exit('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
$this->response->addFormattedContent('user', ['user' => $user_info], $this->parameters['extension'] ?? null);
}
}