phpdoc and typehint cleanups

Author: jarischaefer

src/Jarischaefer/HalApi/Controllers/HalApiResourceController.php

@@ -41,7 +41,7 @@ abstract class HalApiResourceController extends HalApiController implements HalA
 	/**
 	 * The model's transformer.
 	 *
-	 * @var HalApiTransformer
+	 * @var HalApiTransformerContract
 	 */
 	protected $transformer;
 	/**
@@ -69,10 +69,10 @@ abstract class HalApiResourceController extends HalApiController implements HalA
 
 	/**
 	 * @param HalApiControllerParameters $parameters
-	 * @param HalApiTransformer $transformer
+	 * @param HalApiTransformerContract $transformer
 	 * @param Builder $schemaBuilder
 	 */
-	public function __construct(HalApiControllerParameters $parameters, HalApiTransformer $transformer, Builder $schemaBuilder)
+	public function __construct(HalApiControllerParameters $parameters, HalApiTransformerContract $transformer, Builder $schemaBuilder)
 	{
 		parent::__construct($parameters);
 
@@ -84,10 +84,6 @@ public function __construct(HalApiControllerParameters $parameters, HalApiTransf
 		$this->schemaBuilder = $schemaBuilder;
 		$this->model = static::getModel();
 
-		if (!is_subclass_of($this->transformer, HalApiTransformerContract::class)) {
-			throw new RuntimeException('Transformer must be child of ' . HalApiTransformerContract::class);
-		}
-
 		if (!is_subclass_of($this->model, Model::class)) {
 			throw new RuntimeException('Model must be child of ' . Model::class);
 		}

src/Jarischaefer/HalApi/Controllers/HalApiResourceControllerContract.php

@@ -2,12 +2,11 @@
 
 use Exception;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\Request;
 use Jarischaefer\HalApi\Exceptions\BadPostRequestException;
 use Jarischaefer\HalApi\Exceptions\BadPutRequestException;
 use Jarischaefer\HalApi\Exceptions\DatabaseConflictException;
 use Jarischaefer\HalApi\Exceptions\DatabaseSaveException;
-use Jarischaefer\HalApi\Transformers\HalApiTransformer;
+use Jarischaefer\HalApi\Transformers\HalApiTransformerContract;
 use Symfony\Component\HttpFoundation\Response;
 
 /**
@@ -39,11 +38,12 @@ public static function getModel();
 	 * exception.
 	 *
 	 * If you do not typehint your method (take a look at the update method in this class), the variable passed
-	 * will be null. Otherwise an instance of your model with the ->exists property set to false is passed.
+	 * will be the original route parameter.
+	 * Otherwise, an instance of your model with the ->exists property set to false is passed.
 	 *
-	 * public function update($user = null)
+	 * public function update($user)
 	 * {
-	 *        var_dump($user) // null if not found in database
+	 *        var_dump($user) // original route parameter (e.g. new resource's ID) if not found in database
 	 * }
 	 *
 	 * public function update(User $user)
@@ -61,7 +61,7 @@ public static function getModelBindingCallback();
 	/**
 	 * Returns an instance of a transformer to be used for all transformations in this controller.
 	 *
-	 * @return HalApiTransformer
+	 * @return HalApiTransformerContract
 	 */
 	public function getTransformer();