Merge pull request #92 from vinkla/docblocs

Update docblocs
tobyzerner · May 26, 2016 · 0feda5d · 0feda5d
2 parents 7cb11ec + 3035ee5
commit 0feda5d
Show file tree

Hide file tree

Showing 15 changed files with 93 additions and 34 deletions.
diff --git a/src/AbstractSerializer.php b/src/AbstractSerializer.php
@@ -65,7 +65,7 @@ public function getMeta($model)
     /**
      * {@inheritdoc}
      *
-     * @throws LogicException
+     * @throws \LogicException
      */
     public function getRelationship($model, $name)
     {
@@ -88,6 +88,7 @@ public function getRelationship($model, $name)
      * kebab-case is converted into camelCase.
      *
      * @param string $name
+     *
      * @return string
      */
     private function getRelationshipMethodName($name)

diff --git a/src/Collection.php b/src/Collection.php
@@ -22,7 +22,7 @@ class Collection implements ElementInterface
      * Create a new collection instance.
      *
      * @param mixed $data
-     * @param SerializerInterface $serializer
+     * @param \Tobscure\JsonApi\SerializerInterface $serializer
      */
     public function __construct($data, SerializerInterface $serializer)
     {
@@ -34,7 +34,8 @@ public function __construct($data, SerializerInterface $serializer)
      *
      * @param mixed $data
      * @param SerializerInterface $serializer
-     * @return Resource[]
+     *
+     * @return \Tobscure\JsonApi\Resource[]
      */
     protected function buildResources($data, SerializerInterface $serializer)
     {
@@ -63,6 +64,8 @@ public function getResources()
      * Set the resources array.
      *
      * @param array $resources
+     *
+     * @return void
      */
     public function setResources($resources)
     {
@@ -73,6 +76,7 @@ public function setResources($resources)
      * Request a relationship to be included for all resources.
      *
      * @param string|array $relationships
+     *
      * @return $this
      */
     public function with($relationships)
@@ -88,6 +92,7 @@ public function with($relationships)
      * Request a relationship to be identified for all resources.
      *
      * @param string|array $relationships
+     *
      * @return $this
      */
     public function identify($relationships)
@@ -103,6 +108,7 @@ public function identify($relationships)
      * Request a restricted set of fields.
      *
      * @param array|null $fields
+     *
      * @return $this
      */
     public function fields($fields)

diff --git a/src/Document.php b/src/Document.php
@@ -57,9 +57,10 @@ public function __construct(ElementInterface $data = null)
     /**
      * Get included resources.
      *
-     * @param ElementInterface $element
+     * @param \Tobscure\JsonApi\ElementInterface $element
      * @param bool $includeParent
-     * @return Resource[]
+     *
+     * @return \Tobscure\JsonApi\Resource[]
      */
     protected function getIncluded(ElementInterface $element, $includeParent = false)
     {
@@ -107,9 +108,10 @@ protected function getIncluded(ElementInterface $element, $includeParent = false
     }
 
     /**
-     * @param Resource[] $resources
-     * @param Resource $newResource
-     * @return Resource[]
+     * @param \Tobscure\JsonApi\Resource[] $resources
+     * @param \Tobscure\JsonApi\Resource $newResource
+     *
+     * @return \Tobscure\JsonApi\Resource[]
      */
     protected function mergeResource(array $resources, Resource $newResource)
     {
@@ -128,7 +130,8 @@ protected function mergeResource(array $resources, Resource $newResource)
     /**
      * Set the data object.
      *
-     * @param ElementInterface $element
+     * @param \Tobscure\JsonApi\ElementInterface $element
+     *
      * @return $this
      */
     public function setData(ElementInterface $element)
@@ -142,6 +145,7 @@ public function setData(ElementInterface $element)
      * Set the errors array.
      *
      * @param array $errors
+     *
      * @return $this
      */
     public function setErrors($errors)
@@ -155,6 +159,7 @@ public function setErrors($errors)
      * Set the jsonapi array.
      *
      * @param array $jsonapi
+     *
      * @return $this
      */
     public function setJsonapi($jsonapi)

diff --git a/src/ElementInterface.php b/src/ElementInterface.php
@@ -38,6 +38,7 @@ public function toIdentifier();
      * Request a relationship to be included.
      *
      * @param string|array $relationships
+     *
      * @return $this
      */
     public function with($relationships);
@@ -46,6 +47,7 @@ public function with($relationships);
      * Request a restricted set of fields.
      *
      * @param array|null $fields
+     *
      * @return $this
      */
     public function fields($fields);

diff --git a/src/ErrorHandler.php b/src/ErrorHandler.php
@@ -20,16 +20,18 @@ class ErrorHandler
     /**
      * Stores the valid handlers.
      *
-     * @var ExceptionHandlerInterface[]
+     * @var \Tobscure\JsonApi\Exception\Handler\ExceptionHandlerInterface[]
      */
     private $handlers = [];
 
     /**
      * Handle the exception provided.
      *
      * @param Exception $e
-     * @return \Tobscure\JsonApi\Exception\Handler\ResponseBag
+     *
      * @throws RuntimeException
+     *
+     * @return \Tobscure\JsonApi\Exception\Handler\ResponseBag
      */
     public function handle(Exception $e)
     {
@@ -45,7 +47,9 @@ public function handle(Exception $e)
     /**
      * Register a new exception handler.
      *
-     * @param ExceptionHandlerInterface $handler
+     * @param \Tobscure\JsonApi\Exception\Handler\ExceptionHandlerInterface $handler
+     *
+     * @return void
      */
     public function registerHandler(ExceptionHandlerInterface $handler)
     {

diff --git a/src/Exception/Handler/ExceptionHandlerInterface.php b/src/Exception/Handler/ExceptionHandlerInterface.php
@@ -19,16 +19,18 @@ interface ExceptionHandlerInterface
      * If the exception handler is able to format a response for the provided exception,
      * then the implementation should return true.
      *
-     * @param Exception $e
+     * @param \Exception $e
+     *
      * @return bool
      */
     public function manages(Exception $e);
 
     /**
      * Handle the provided exception.
      *
-     * @param Exception $e
-     * @return ResponseBag
+     * @param \Exception $e
+     *
+     * @return \Tobscure\JsonApi\Exception\Handler\ResponseBag
      */
     public function handle(Exception $e);
 }
diff --git a/src/Exception/Handler/FallbackExceptionHandler.php b/src/Exception/Handler/FallbackExceptionHandler.php
@@ -48,8 +48,9 @@ public function handle(Exception $e)
     }
 
     /**
-     * @param Exception $e
+     * @param \Exception $e
      * @param $status
+     *
      * @return array
      */
     private function constructError(Exception $e, $status)

diff --git a/src/Exception/InvalidParameterException.php b/src/Exception/InvalidParameterException.php
@@ -15,4 +15,5 @@
 
 class InvalidParameterException extends Exception
 {
+    //
 }
diff --git a/src/LinksTrait.php b/src/LinksTrait.php
@@ -34,6 +34,7 @@ public function getLinks()
      * Set the links.
      *
      * @param array $links
+     *
      * @return $this
      */
     public function setLinks(array $links)
@@ -48,6 +49,7 @@ public function setLinks(array $links)
      *
      * @param string $key
      * @param string $value
+     *
      * @return $this
      */
     public function addLink($key, $value)
@@ -65,6 +67,8 @@ public function addLink($key, $value)
      * @param int $offset The current offset.
      * @param int $limit The current limit.
      * @param int|null $total The total number of results, or null if unknown.
+     *
+     * @return void
      */
     public function addPaginationLinks($url, array $queryParams, $offset, $limit, $total = null)
     {
@@ -95,6 +99,8 @@ public function addPaginationLinks($url, array $queryParams, $offset, $limit, $t
      * @param array $queryParams The query params provided in the request.
      * @param int $offset The offset to link to.
      * @param int $limit The current limit.
+     *
+     * @return void
      */
     protected function addPaginationLink($name, $url, array $queryParams, $offset, $limit)
     {

diff --git a/src/MetaTrait.php b/src/MetaTrait.php
@@ -34,6 +34,7 @@ public function getMeta()
      * Set the meta data array.
      *
      * @param array $meta
+     *
      * @return $this
      */
     public function setMeta(array $meta)
@@ -48,6 +49,7 @@ public function setMeta(array $meta)
      *
      * @param string $key
      * @param string $value
+     *
      * @return $this
      */
     public function addMeta($key, $value)

diff --git a/src/Parameters.php b/src/Parameters.php
@@ -32,8 +32,10 @@ public function __construct(array $input)
      * Get the includes.
      *
      * @param array $available
+     *
+     * @throws \Tobscure\JsonApi\Exception\InvalidParameterException
+     *
      * @return array
-     * @throws InvalidParameterException
      */
     public function getInclude(array $available = [])
     {
@@ -56,8 +58,10 @@ public function getInclude(array $available = [])
      * Get number of offset.
      *
      * @param int|null $perPage
+     *
+     * @throws \Tobscure\JsonApi\Exception\InvalidParameterException
+     *
      * @return int
-     * @throws InvalidParameterException
      */
     public function getOffset($perPage = null)
     {
@@ -78,8 +82,10 @@ public function getOffset($perPage = null)
      * Calculate the offset based on the page[number] parameter.
      *
      * @param int $perPage
+     *
+     * @throws \Tobscure\JsonApi\Exception\InvalidParameterException
+     *
      * @return int
-     * @throws InvalidParameterException
      */
     protected function getOffsetFromNumber($perPage)
     {
@@ -96,6 +102,7 @@ protected function getOffsetFromNumber($perPage)
      * Get the limit.
      *
      * @param int|null $max
+     *
      * @return int|null
      */
     public function getLimit($max = null)
@@ -113,8 +120,10 @@ public function getLimit($max = null)
      * Get the sort.
      *
      * @param array $available
+     *
+     * @throws \Tobscure\JsonApi\Exception\InvalidParameterException
+     *
      * @return array
-     * @throws InvalidParameterException
      */
     public function getSort(array $available = [])
     {
@@ -177,6 +186,7 @@ public function getFilter()
      *
      * @param string $key
      * @param null $default
+     *
      * @return mixed
      */
     protected function getInput($key, $default = null)
@@ -188,6 +198,7 @@ protected function getInput($key, $default = null)
      * Get the page.
      *
      * @param string $key
+     *
      * @return string
      */
     protected function getPage($key)

diff --git a/src/Relationship.php b/src/Relationship.php
@@ -19,14 +19,14 @@ class Relationship
     /**
      * The data object.
      *
-     * @var ElementInterface|null
+     * @var \Tobscure\JsonApi\ElementInterface|null
      */
     protected $data;
 
     /**
      * Create a new relationship.
      *
-     * @param ElementInterface|null $data
+     * @param \Tobscure\JsonApi\ElementInterface|null $data
      */
     public function __construct(ElementInterface $data = null)
     {
@@ -36,7 +36,7 @@ public function __construct(ElementInterface $data = null)
     /**
      * Get the data object.
      *
-     * @return ElementInterface|null
+     * @return \Tobscure\JsonApi\ElementInterface|null
      */
     public function getData()
     {
@@ -46,7 +46,8 @@ public function getData()
     /**
      * Set the data object.
      *
-     * @param ElementInterface|null $data
+     * @param \Tobscure\JsonApi\ElementInterface|null $data
+     *
      * @return $this
      */
     public function setData($data)