ResponseFactory.php

<?php

namespace Dingo\Api\Http;

use Closure;
use BadMethodCallException;
use Illuminate\Support\Str;
use Illuminate\Pagination\Paginator;
use Dingo\Api\Transformer\TransformerFactory;

class ResponseFactory
{
    /**
     * API transformer factory instance.
     *
     * @var \Dingo\Api\Transformer\TransformerFactory
     */
    protected $transformer;

    /**
     * Create a new response factory instance.
     *
     * @param  \Dingo\Api\Transformer\TransformerFactory  $transformer
     * @return void
     */
    public function __construct(TransformerFactory $transformer)
    {
        $this->transformer = $transformer;
    }

    /**
     * Respond with a created response and associate a location if provided.
     *
     * @param null|string $location
     * @return \Dingo\Api\Http\ResponseBuilder
     */
    public function created($location = null)
    {
        $response = new ResponseBuilder(null);
        $response->setStatusCode(201);

        if (! is_null($location)) {
            $response->addHeader('Location', $location);
        }

        return $response;
    }

    /**
     * Respond with a no content response.
     *
     * @return \Dingo\Api\Http\ResponseBuilder
     */
    public function noContent()
    {
        $response = new ResponseBuilder(null);
        $response->setStatusCode(204);

        return $response;
    }

    /**
     * Bind a collection to a transformer and start building a response.
     *
     * @param  object  $collection
     * @param  object  $transformer
     * @param  array  $parameters
     * @param  \Closure  $after
     * @return \Dingo\Api\Http\ResponseBuilder
     */
    public function collection($collection, $transformer, array $parameters = [], Closure $after = null)
    {
        $class = get_class($collection->first());

        $binding = $this->transformer->register($class, $transformer, $parameters, $after);

        return new ResponseBuilder($collection, $binding);
    }

    /**
     * Bind an item to a transformer and start building a response.
     *
     * @param  object  $item
     * @param  object  $transformer
     * @param  array  $parameters
     * @param  \Closure  $after
     * @return \Dingo\Api\Http\ResponseBuilder
     */
    public function item($item, $transformer, array $parameters = [], Closure $after = null)
    {
        $class = get_class($item);

        $binding = $this->transformer->register($class, $transformer, $parameters, $after);

        return new ResponseBuilder($item, $binding);
    }

    /**
     * Bind a paginator to a transformer and start building a response.
     *
     * @param  \Illuminate\Pagination\Paginator  $paginator
     * @param  object  $transformer
     * @param  array  $parameters
     * @param  \Closure  $after
     * @return \Dingo\Api\Http\ResponseBuilder
     */
    public function paginator(Paginator $paginator, $transformer, array $parameters = [], Closure $after = null)
    {
        $collection = $paginator->getCollection();

        $class = get_class($collection->first());

        $binding = $this->transformer->register($class, $transformer, $parameters, $after);

        return new ResponseBuilder($paginator, $binding);
    }

    /**
     * Return an error response.
     *
     * @param  string|array  $error
     * @param  int  $statusCode
     * @return \Illuminate\Http\Response
     */
    public function error($error, $statusCode)
    {
        if (! is_array($error)) {
            $error = ['message' => $error];
        }

        $error = array_merge(['status_code'  => $statusCode], $error);

        return $this->array($error)->setStatusCode($statusCode);
    }

    /**
     * Return a 404 not found error.
     *
     * @param  string|array  $message
     * @return \Illuminate\Http\Response
     */
    public function errorNotFound($message = 'Not Found')
    {
        return $this->error($message, 404);
    }

    /**
     * Return a 400 bad request error.
     *
     * @param  string|array  $message
     * @return \Illuminate\Http\Response
     */
    public function errorBadRequest($message = 'Bad Request')
    {
        return $this->error($message, 400);
    }

    /**
     * Return a 403 forbidden error.
     *
     * @param  string|array  $message
     * @return \Illuminate\Http\Response
     */
    public function errorForbidden($message = 'Forbidden')
    {
        return $this->error($message, 403);
    }

    /**
     * Return a 500 internal server error.
     *
     * @param  string|array  $message
     * @return \Illuminate\Http\Response
     */
    public function errorInternal($message = 'Internal Error')
    {
        return $this->error($message, 500);
    }

    /**
     * Return a 401 unauthorized error.
     *
     * @param  string|array  $message
     * @return \Illuminate\Http\Response
     */
    public function errorUnauthorized($message = 'Unauthorized')
    {
        return $this->error($message, 401);
    }

    /**
     * Call magic methods beginning with "with".
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return mixed
     * @throws \BadMethodCallException
     */
    public function __call($method, $parameters)
    {
        if (Str::startsWith($method, 'with')) {
            return call_user_func_array([$this, Str::camel(substr($method, 4))], $parameters);

        // Because PHP won't let us name the method "array" we'll simply watch for it
        // in here and return the new binding. Gross.
        } elseif ($method == 'array') {
            return new ResponseBuilder($parameters[0]);
        }

        throw new BadMethodCallException('Method '.$method.' does not exist on class.');
    }
}