Update docblock for APIException class' constructor function to include correct params and param types

[sampurcell]

@VicV came across a minor issue in the SDK, its throwing an error in our IDE, when you have the time would appreciate an update. Thanks!

Description

The APIException::_construct method parameters are string $reason and TaplyticsLib\Http\HttpContext $context however the docblock refers to an int $responseCode and string $responseBody instead which raises a warning in the IDE when mocking the object for tests, etc.

Link to the docblock: APIException.php#L31-L33

[VicV]

Hey @sampurcell sorry for the delayed response! I'll take a look at this shortly.

[kavitasookrah]

Hey @sampurcell How's it going? Just following up here - Can you provide a bit more context around the error you're seeing and what you're hoping to do. Let me know if this is blocking you in anyway.

[sampurcell]

Hi, no problem.

It is not blocking and not really an error, just a warning in my IDE. Here are some more details:

When I mock an APIException, I get a warning that looks this this:

Also in the APIException class I also see this warning:

The reason it gives this warning seems to be because the docblock for APIException defines the params as a string $reason, int $responseCode and string $responseBody

However if you look at the APIException constructor, you'll see it actually wants a string $reason and an HttpContext $context.

So it thinks the second parameter is an int instead of an HttpContext instance and gives the warnings seen in the screenshots above.

To fix, I think you just need to add:
use TaplyticsLib\Http\HttpContext; at the top of the APIException.php file and repalce:

* @param int $responseCode the HTTP response code from the API request
* @param string $responseBody the HTTP response body from the API request

In the APIException constructor docblock with:
@param HttpContext $context

Should quiet the warnings when creating instances of the class in the IDE.

[kavitasookrah]

Hey @sampurcell this is great! Thanks very much for all the details. I'll pass this on to the team and get you an update :)