mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-09 04:14:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: rename functions (#4655)

Browse source 
returnClientError => throwClientException
returnServerError => throwServerException

New convenience function: throwRateLimitException

Old functions are kept but deprecated.
This commit is contained in:
Dag 2025-08-05 20:44:40 +02:00 • committed by GitHub
parent b39964cee3
commit f11571ae78
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
90 changed files with 279 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/06_Helper_functions/index.md
View file

@ -87,23 +87,22 @@ $html = getSimpleHTMLDOMCached('your URI', 86400); // Duration 24h
[Defined in lib/contents.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/lib/contents.php)
# returnClientError
The `returnClientError` function aborts execution of the current bridge
and returns the given error message with error code **400**:
# throwClientException($message = '')
The `throwClientException` function aborts execution of the current bridge.
```PHP
returnClientError('Your error message')
throwClientException('Bad user input')
```
Use this function when the user provided invalid parameter or a required parameter is missing.
[Defined in lib/utils.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/lib/utils.php)
# returnServerError
The `returnServerError` function aborts execution of the current bridge and returns the given error message with error code **500**:
# throwServerException($message = '')
The `throwServerException` function aborts execution of the current bridge.
```PHP
returnServerError('Your error message')
throwServerException('Received empty reply from thirdparty api')
```
Use this function when a problem occurs that has nothing to do with the parameters provided by the user.
@ -111,6 +110,10 @@ Use this function when a problem occurs that has nothing to do with the paramete
[Defined in lib/utils.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/lib/utils.php)
# throwRateLimitException($message = '')
Throws a `RateLimitException` which produces an HTTP 429 response.
# defaultLinkTo
Automatically replaces any relative URL in a given string or DOM object
(i.e. the one returned by [getSimpleHTMLDOM](#getsimplehtmldom)) with an absolute URL.