Skip to content
This repository has been archived by the owner on Mar 10, 2022. It is now read-only.

Latest commit

 

History

History
91 lines (68 loc) · 1.61 KB

usage.md

File metadata and controls

91 lines (68 loc) · 1.61 KB

Usage

Create new exception in your API

Create a new class exception extends an exception from this bundle

<?php 

namespace Acme\DemoBundle\Exception;

use M6Web\Bundle\ApiExceptionBundle\Exception\HttpException;

/**
 * Class UserNotFoundException
 */
class UserNotFoundException extends HttpException
{
}

Configure your new exception

# ./app/config/config.yml

m6web_api_exception:
    exceptions:
        Acme\DemoBundle\Exception\UserNotFoundException:
            status: 404 # Used for exceptions implements HttpExceptionInterface
            code: 5286 # Create an unique code for this exception in your API, optional, default to 0 and not displayed
            message: "user not found"

The configuration will impact only the exceptions that implements M6Web\Bundle\ApiExceptionBundle\Exception\Interfaces\ExceptionInterface

Use your new exception

<?php 

namespace Acme\DemoBundle\Manager;

use Acme\DemoBundle\Entity\User;
use Acme\DemoBundle\Exception\UserNotFoundException;

/**
 * Class UserManager
 */
class UserManager
{
    /*...*/

    /**
     * @param integer $id
     *
     * @throws UserNotFoundException
     *
     * @return User $user
     */
    public function getUser($id)
    {
        $user = /*...*/;
        
        if (!$user) {
            throw new UserNotFoundException;
        }

        return $user;
    }
    
    /*...*/
}

result request with bad user

{
    "error": {
        "status": 404,
        "code": 5286,
        "message": "user not found"
    }
}

Prev : Installation

Next : Variables