implement composer package PhpRestfulApiResponse

Author: harryolx

composer.json

@@ -15,7 +15,8 @@
         "symfony/console": "^3.3",
         "league/fractal": "^0.17.0",
         "phpcollection/phpcollection": "^0.5.0",
-        "zendframework/zend-diactoros": "^1.7"
+        "zendframework/zend-diactoros": "^1.7",
+        "harryosmar/php-restful-api-response": "^1.0"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",
@@ -34,5 +35,11 @@
     },
     "scripts": {
         "test": "./vendor/bin/phpunit -c phpunit.xml"
-    }
+    },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "git@github.com:harryosmar/php-restful-api-response.git"
+        }
+    ]
 }

composer.lock

@@ -8,131 +8,9 @@
 
 namespace PhpBootstrap\Contracts;
 
-use League\Fractal\Pagination\Cursor;
-use League\Fractal\TransformerAbstract;
-use Psr\Http\Message\ResponseInterface;
+use PhpRestfulApiResponse\Contracts\PhpRestfulApiResponse;
 
-interface Response extends ResponseInterface
+interface Response extends PhpRestfulApiResponse
 {
-    /**
-     * @param $data
-     * @param $code
-     * @param array $headers
-     * @return Response|static
-     */
-    public function withArray(array $data, $code = 200, array $headers = []);
 
-    /**
-     * @param $data
-     * @param TransformerAbstract|callable $transformer
-     * @param int $code
-     * @param null $resourceKey
-     * @param array $meta
-     * @param array $headers
-     * @return Response
-     */
-    public function withItem($data, $transformer, $code = 200, $resourceKey = null, $meta = [], array $headers = []);
-
-    /**
-     * @param $data
-     * @param TransformerAbstract|callable $transformer
-     * @param int $code
-     * @param null $resourceKey
-     * @param Cursor|null $cursor
-     * @param array $meta
-     * @param array $headers
-     * @return Response
-     */
-    public function withCollection($data, $transformer, $code = 200, $resourceKey = null, Cursor $cursor = null, $meta = [], array $headers = []);
-
-    /**
-     * Generates a response with custom code HTTP header and a given message.
-     *
-     * @param $message
-     * @param $code
-     * @param array $headers
-     * @return mixed
-     */
-    public function withError($message, $code, array $headers = []);
-
-    /**
-     * Generates a response with a 403 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorForbidden($message = '', array $headers = []);
-
-    /**
-     * Generates a response with a 500 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorInternalError($message = '', array $headers = []);
-
-    /**
-     * Generates a response with a 404 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorNotFound($message = '', array $headers = []);
-
-    /**
-     * Generates a response with a 401 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorUnauthorized($message = '', array $headers = []);
-
-    /**
-     * Generates a response with a 400 HTTP header and a given message.
-     *
-     * @param array $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorWrongArgs(array $message, array $headers = []);
-
-    /**
-     * Generates a response with a 410 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorGone($message = '', array $headers = []);
-
-    /**
-     * Generates a response with a 405 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorMethodNotAllowed($message = '', array $headers = []);
-
-    /**
-     * Generates a Response with a 431 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorUnwillingToProcess($message = '', array $headers = []);
-
-    /**
-     * Generates a Response with a 422 HTTP header and a given message.
-     *
-     * @param string $message
-     * @param array  $headers
-     * @return mixed
-     */
-    public function errorUnprocessable($message = '', array $headers = []);
 }