tfboe / fm-lib

src/Exceptions/Handler.php

<?php
declare(strict_types=1);

namespace Tfboe\FmLib\Exceptions;

use Exception;
use Illuminate\Validation\ValidationException;
use Laravel\Lumen\Exceptions\Handler as ExceptionHandler;

/**
 * Class Handler
 * @package Tfboe\FmLib\Exceptions
 */
class Handler extends ExceptionHandler
{
//<editor-fold desc="Fields">
  /**
   * A list of the exception types that should not be reported.
   *
   * @var array
   */
  protected $dontReport = [
    ValidationException::class,
  ];
//</editor-fold desc="Fields">

//<editor-fold desc="Public Methods">
  /** @noinspection PhpMissingParentCallCommonInspection */
  /**
   * Render an exception into an HTTP response.
   *
   * @param  \Illuminate\Http\Request $request
   * @param  \Exception $exception
   * @param  bool $printTrace if true a trace will be appended to the exception message
   * @return \Illuminate\Http\Response
   * @SuppressWarnings(PHPMD.UnusedFormalParameter)
   */
  public function render($request, Exception $exception, $printTrace = false)
  {
    //don't throw html exceptions always render using json
    $statusCode = $this->getExceptionHTTPStatusCode($exception);

    return response()->json(

The method json does only exist in Laravel\Lumen\Http\ResponseFactory, but not in Illuminate\Http\Response.

      $this->getJsonMessage($exception, $statusCode, $printTrace),
      $statusCode
    );
  }
//</editor-fold desc="Public Methods">

//<editor-fold desc="Protected Methods">
  /**
   * Extracts the status code of an exception
   * @param Exception $exception the exception to extract from
   * @return int|mixed the status code or 500 if no status code found
   */
  protected function getExceptionHTTPStatusCode(Exception $exception)
  {
    // Not all Exceptions have a http status code
    // We will give Error 500 if none found
    if ($exception instanceof ValidationException) {
      return $exception->getResponse()->getStatusCode();
    }
    return method_exists($exception, 'getStatusCode') ? $exception->getStatusCode() :

It seems like you code against a specific sub-type and not the parent class Exception as the method getStatusCode() does only exist in the following sub-classes of Exception: Composer\Downloader\TransportException, Illuminate\Http\Exceptions\PostTooLargeException, Illuminate\Http\Exceptions\ThrottleRequestsException, Illuminate\Routing\Exceptions\InvalidSignatureException, Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException, Symfony\Component\HttpKernel\Exception\BadRequestHttpException, Symfony\Component\HttpKernel\Exception\ConflictHttpException, Symfony\Component\HttpKernel\Exception\GoneHttpException, Symfony\Component\HttpKernel\Exception\HttpException, Symfony\Component\HttpKernel\Exception\LengthRequiredHttpException, Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException, Symfony\Component\HttpKernel\Exception\NotAcceptableHttpException, Symfony\Component\HttpKernel\Exception\NotFoundHttpException, Symfony\Component\HttpKernel\Exception\PreconditionFailedHttpException, Symfony\Component\HttpKernel\Exception\PreconditionRequiredHttpException, Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException, Symfony\Component\HttpKernel\Exception\TooManyRequestsHttpException, Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException, Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException, Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException. Maybe you want to instanceof check for one of these explicitly?

      ($exception->getCode() > 0 ? $exception->getCode() : 500);
  }

  /**
   * Gets the exception name of an exception which is used by clients to identify the type of the error.
   * @param Exception $exception the exception whose name we want
   * @return string the exception name
   */
  protected function getExceptionName(Exception $exception): string
  {
    if ($exception instanceof AuthenticationException) {
      return ExceptionNames::AUTHENTICATION_EXCEPTION;
    }
    if ($exception instanceof DuplicateException) {
      return ExceptionNames::DUPLICATE_EXCEPTION;
    }
    if ($exception instanceof UnorderedPhaseNumberException) {
      return ExceptionNames::UNORDERED_PHASE_NUMBER_EXCEPTION;
    }
    if ($exception instanceof ReferenceException) {
      return ExceptionNames::REFERENCE_EXCEPTION;
    }
    if ($exception instanceof PlayerAlreadyExists) {
      return ExceptionNames::PLAYER_ALREADY_EXISTS_EXCEPTION;
    }
    if ($exception instanceof ValidationException) {
      return ExceptionNames::VALIDATION_EXCEPTION;
    }
    return ExceptionNames::INTERNAL_EXCEPTION;
  }

  /**
   * Extracts the status and the message from the given exception and status code
   * @param Exception $exception the raised exception
   * @param string|null $statusCode the status code or null if unknown
   * @param  bool $printTrace if true a trace will be appended to the exception message
   * @return array containing the infos status and message
   */
  protected function getJsonMessage(Exception $exception, $statusCode = null, $printTrace = false)
  {

    $result = method_exists($exception, 'getJsonMessage') ? $exception->getJsonMessage() :

It seems like you code against a specific sub-type and not the parent class Exception as the method getJsonMessage() does only exist in the following sub-classes of Exception: Tfboe\FmLib\Exceptions\DuplicateException, Tfboe\FmLib\Exceptions\MethodNotExistingException, Tfboe\FmLib\Exceptions\PlayerAlreadyExists, Tfboe\FmLib\Exceptions\PropertyNotExistingException, Tfboe\FmLib\Exceptions\ReferenceException, Tfboe\FmLib\Exceptions\UnorderedPhaseNumberException. Maybe you want to instanceof check for one of these explicitly?

      ['message' => $exception->getMessage()];

    if ($exception instanceof ValidationException) {
      $result["errors"] = $exception->errors();
    }

    if (!array_key_exists('status', $result)) {
      $result['status'] = $statusCode !== null ? $statusCode : "false";
    }

    if (!array_key_exists('name', $result)) {
      $result['name'] = $this->getExceptionName($exception);
    }

    if ($printTrace || env('APP_DEBUG') === true) {
      //attach trace back
      $result['trace'] = $exception->getTraceAsString();
    }

    return $result;
  }
//</editor-fold desc="Protected Methods">
}