akalongman / laravel-platfourm

src/Platfourm/Foundation/Exceptions/Handler.php

<?php
/*
 * This file is part of the Laravel Platfourm package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\Platfourm\Foundation\Exceptions;

use App;
use Exception;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Illuminate\Foundation\Validation\ValidationException;
use Slack;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that should not be reported.
     *
     * @var array
     */
    protected $dontReport = [
        AuthorizationException::class,
        HttpException::class,
        ModelNotFoundException::class,
        ValidationException::class,
    ];

    public function sendToSlack(Exception $e)
    {
        if (!App::environment('production')) {
            return false;
        }

        $endpoint = config('slack.endpoint');
        if (strlen($endpoint) < 40) {
            return false;
        }

        Slack::send($e->getMessage());
    }

    /**
     * Render the given HttpException.
     *
     * @param  \Symfony\Component\HttpKernel\Exception\HttpException $e
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function renderHttpException(HttpException $e)
    {
        $status = $e->getStatusCode();

        if (view()->exists("common.errors.{$status}")) {

The method exists does only exist in Illuminate\Contracts\View\Factory, but not in Illuminate\View\View.

            return response()->view("common.errors.{$status}", ['exception' => $e], $status, $e->getHeaders());
        } else {
            return $this->convertExceptionToResponse($e);
        }
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request $request
     * @param  \Exception               $e
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $e)
    {
        if ($e instanceof ModelNotFoundException) {
            $e = new NotFoundHttpException($e->getMessage(), $e);
        }

        if ($this->shouldRenderAsJson($request, $e)) {
            return $this->renderAsJson($request, $e);

The return type of return $this->renderAsJson($request, $e); (Illuminate\Http\JsonResponse) is incompatible with the return type documented by Longman\Platfourm\Foundation\Exceptions\Handler::render of type Illuminate\Http\Response.

        }

        return parent::render($request, $e);
    }

    protected function shouldRenderAsJson($request, Exception $e)
    {
        if ($e instanceof ValidationException) {

The class Illuminate\Foundation\Validation\ValidationException does not exist. Did you forget a USE statement, or did you not list all dependencies?

            return false;
        }

        return $request->wantsJson();
    }

    protected function renderAsJson($request, Exception $e)

The parameter $request is not used and could be removed.

    {
        // Define the response
        $response = [
            'errors' => 'Sorry, something went wrong.'
        ];

        // If the app is in debug mode
        if (config('app.debug')) {
            // Add the exception class name, message and stack trace to response
            $response['exception'] = (new \ReflectionClass($e))->getName();

Consider using (new \ReflectionClass($e))->name. There is an issue with getName() and APC-enabled PHP versions.

            $response['message']   = $e->getMessage();
            $response['trace']     = $e->getTrace();
        }

        // Default response of 400
        $status = 400;

        // If this exception is an instance of HttpException
        if ($this->isHttpException($e)) {
            // Grab the HTTP status code from the Exception
            $status = $e->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: Illuminate\Foundation\Http\Exceptions\MaintenanceModeException, Longman\Platfourm\Auth\Exceptions\ForbiddenException, Longman\Platfourm\Auth\Exceptions\UnauthorizedException, Longman\Platfourm\Foundation\Exceptions\ForbiddenException, Longman\Platfourm\Foundation\Exceptions\InvalidValueException, Longman\Platfourm\Foundation\Exceptions\UnauthorizedException, Longman\Platfourm\Foundation\Exceptions\ValueNotFoundException, 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?

        }

        // Return a JSON response with the response array and status code
        return response()->json($response, $status);
    }

}