04-error-handling.md

Error Handling

• API Errors
• Validation Errors

API Errors

To handle API response errors, multiple exceptions are provided.

All API errors do not count towards the rate limit, except for the NoResultsFoundException. For this reason, this exception (only) includes the getRateLimit(), getSubscriptions() and getTimezone() methods.

You can see all available exceptions below:

try {
    $response = $api->fixtures()->getById(1);
}
// when the query did not return any results (for example, the requested id does not exist or is empty)
// or there is no access via the current subscription
catch (NoResultsFoundException $exception) {
    echo $exception->getMessage();
    echo $exception->getRateLimit()->getRemainingNumRequests();
}
// https://docs.sportmonks.com/football/api/error-codes
catch (BadRequestException $exception) {}
catch (UnauthorizedException $exception) {}
catch (ForbiddenException $exception) {}
catch (TooManyRequestsException $exception) {}
// https://docs.sportmonks.com/football/api/error-codes/include-exceptions
catch (IncludeNotAllowedException $exception) {}
catch (IncludeNotFoundException $exception) {}
catch (IncludeDepthException $exception) {}
catch (IncludeNotAvailableException $exception) {}
//https://docs.sportmonks.com/football/api/error-codes/filtering-and-complexity-exceptions
catch (QueryComplexityException $exception) {}
catch (InvalidQueryParameterException $exception) {}
catch (FilterNotApplicableException $exception) {}
// https://docs.sportmonks.com/football/api/error-codes/other-exceptions
catch (PaginationLimitException $exception) {}
catch (RateLimitException $exception) {}
catch (InsufficientResourcesException $exception) {}
catch (InsufficientIncludesException $exception) {}
// any other error
catch (UnexpectedErrorException $exception) {}

To catch all API errors with a single exception, ApiErrorException is available:

use ProgrammatorDev\SportMonksFootball\Exception\ApiErrorException;

try {
    $response = $api->fixtures()->getById(1);
}
// catches all API response errors
catch (ApiErrorException $exception) {
    echo $exception->getCode();
    echo $exception->getMessage();
}

Validation Errors

To catch invalid input data, the ValidationException is available:

use ProgrammatorDev\Validator\Exception\ValidationException;

try {
    $response = $api->fixtures()->getAllBySearchQuery('');
}
catch (ValidationException $exception) {
    // should print: The query value should not be blank, "" given.
    echo $exception->getMessage();
}