Merge pull request #18 from fuzz-productions/feature-improve-query-modifiers-api

Feature improve query modifiers api

Author: kfuchs

src/Contracts/Repository.php

@@ -2,40 +2,42 @@
 
 namespace Fuzz\MagicBox\Contracts;
 
-use Fuzz\MagicBox\EloquentRepository;
+use Closure;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Pagination\Paginator;
 
 interface Repository
 {
 	/**
 	 * Set the model for an instance of this resource controller.
 	 *
 	 * @param string $model_class
-	 * @return static
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setModelClass($model_class);
+	public function setModelClass($model_class): Repository;
 
 	/**
 	 * Get the model class.
 	 *
 	 * @return string
 	 */
-	public function getModelClass();
+	public function getModelClass(): string;
 
 	/**
 	 * Set input manually.
 	 *
 	 * @param array $input
-	 * @return static
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setInput(array $input);
+	public function setInput(array $input): Repository;
 
 	/**
 	 * Get input.
 	 *
 	 * @return array
 	 */
-	public function getInput();
+	public function getInput(): array;
 
 	/**
 	 * Get the PK name
@@ -55,60 +57,69 @@ public function exists(): bool;
 	 * Set eager load manually.
 	 *
 	 * @param array $eager_loads
-	 * @return static
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setEagerLoads(array $eager_loads);
+	public function setEagerLoads(array $eager_loads): Repository;
 
 	/**
 	 * Get eager loads.
 	 *
 	 * @return array
 	 */
-	public function getEagerLoads();
+	public function getEagerLoads(): array;
 
 	/**
 	 * Set filters manually.
 	 *
 	 * @param array $filters
-	 * @return static
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setFilters(array $filters);
+	public function setFilters(array $filters): Repository;
 
 	/**
 	 * Get filters.
 	 *
 	 * @return array
 	 */
-	public function getFilters();
+	public function getFilters(): array;
+
+	/**
+	 * Add a single modifier
+	 *
+	 * @param \Closure $modifier
+	 *
+	 * @return \Fuzz\MagicBox\Contracts\Repository
+	 */
+	public function addModifier(Closure $modifier): Repository;
 
 	/**
 	 * Set modifiers.
 	 *
 	 * @param array $modifiers
-	 * @return static
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setModifiers(array $modifiers);
+	public function setModifiers(array $modifiers): Repository;
 
 	/**
 	 * Get modifiers.
 	 *
 	 * @return array
 	 */
-	public function getModifiers();
+	public function getModifiers(): array;
 
 	/**
 	 * Return a model's fields.
 	 *
 	 * @param \Illuminate\Database\Eloquent\Model $instance
 	 * @return array
 	 */
-	public static function getFields(Model $instance);
+	public static function getFields(Model $instance): array;
 
 	/**
 	 * Find an instance of a model by ID.
 	 *
 	 * @param int $id
-	 * @return \Illuminate\Database\Eloquent\Model
+	 * @return \Illuminate\Database\Eloquent\Model|null
 	 */
 	public function find($id);
 
@@ -118,43 +129,43 @@ public function find($id);
 	 * @param int $id
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function findOrFail($id);
+	public function findOrFail($id): Model;
 
 	/**
 	 * Get all elements against the base query.
 	 *
 	 * @return \Illuminate\Database\Eloquent\Collection
 	 */
-	public function all();
+	public function all(): Collection;
 
 	/**
 	 * Return paginated response.
 	 *
 	 * @param  int $per_page
-	 * @return \Illuminate\Pagination\Paginator
+	 * @return \Illuminate\Contracts\Pagination\Paginator
 	 */
-	public function paginate($per_page);
+	public function paginate($per_page): Paginator;
 
 	/**
 	 * Count all elements against the base query.
 	 *
 	 * @return int
 	 */
-	public function count();
+	public function count(): int;
 
 	/**
 	 * Determine if the base query returns a nonzero count.
 	 *
 	 * @return bool
 	 */
-	public function hasAny();
+	public function hasAny(): bool;
 
 	/**
 	 * Get a random value.
 	 *
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function random();
+	public function random(): Model;
 
 	/**
 	 * Get the primary key from input.
@@ -168,44 +179,44 @@ public function getInputId();
 	 *
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function create();
+	public function create(): Model;
 
 	/**
 	 * Read a model.
 	 *
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function read();
+	public function read(): Model;
 
 	/**
 	 * Update a model.
 	 *
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function update();
+	public function update(): Model;
 
 	/**
 	 * Update a model.
 	 *
 	 * @return boolean
 	 */
-	public function delete();
+	public function delete(): bool;
 
 	/**
 	 * Save a model, regardless of whether or not it is "new".
 	 *
 	 * @return \Illuminate\Database\Eloquent\Model
 	 */
-	public function save();
+	public function save(): Model;
 
 	/**
 	 * Set the fillable array
 	 *
 	 * @param array $fillable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setFillable(array $fillable): EloquentRepository;
+	public function setFillable(array $fillable): Repository;
 
 	/**
 	 * Get the fillable attributes
@@ -221,36 +232,36 @@ public function getFillable(bool $assoc = false): array;
 	 *
 	 * @param string $fillable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addFillable(string $fillable): EloquentRepository;
+	public function addFillable(string $fillable): Repository;
 
 	/**
 	 * Add many fillable fields
 	 *
 	 * @param array $fillable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addManyFillable(array $fillable): EloquentRepository;
+	public function addManyFillable(array $fillable): Repository;
 
 	/**
 	 * Remove a fillable attribute
 	 *
 	 * @param string $fillable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeFillable(string $fillable): EloquentRepository;
+	public function removeFillable(string $fillable): Repository;
 
 	/**
 	 * Remove many fillable fields
 	 *
 	 * @param array $fillable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeManyFillable(array $fillable): EloquentRepository;
+	public function removeManyFillable(array $fillable): Repository;
 
 	/**
 	 * Determine whether a given key is fillable
@@ -266,9 +277,9 @@ public function isFillable(string $key): bool;
 	 *
 	 * @param array $includable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setIncludable(array $includable): EloquentRepository;
+	public function setIncludable(array $includable): Repository;
 
 	/**
 	 * Get the includable relationships
@@ -284,36 +295,36 @@ public function getIncludable(bool $assoc = false): array;
 	 *
 	 * @param string $includable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addIncludable(string $includable): EloquentRepository;
+	public function addIncludable(string $includable): Repository;
 
 	/**
 	 * Add many includable fields
 	 *
 	 * @param array $includable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addManyIncludable(array $includable): EloquentRepository;
+	public function addManyIncludable(array $includable): Repository;
 
 	/**
 	 * Remove an includable relationship
 	 *
 	 * @param string $includable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeIncludable(string $includable): EloquentRepository;
+	public function removeIncludable(string $includable): Repository;
 
 	/**
 	 * Remove many includable relationships
 	 *
 	 * @param array $includable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeManyIncludable(array $includable): EloquentRepository;
+	public function removeManyIncludable(array $includable): Repository;
 
 	/**
 	 * Determine whether a given key is includable
@@ -329,9 +340,9 @@ public function isIncludable(string $key): bool;
 	 *
 	 * @param array $filterable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function setFilterable(array $filterable): EloquentRepository;
+	public function setFilterable(array $filterable): Repository;
 
 	/**
 	 * Get the filterable fields
@@ -347,36 +358,36 @@ public function getFilterable(bool $assoc = false): array;
 	 *
 	 * @param string $filterable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addFilterable(string $filterable): EloquentRepository;
+	public function addFilterable(string $filterable): Repository;
 
 	/**
 	 * Add many filterable fields
 	 *
 	 * @param array $filterable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function addManyFilterable(array $filterable): EloquentRepository;
+	public function addManyFilterable(array $filterable): Repository;
 
 	/**
 	 * Remove a filterable field
 	 *
 	 * @param string $filterable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeFilterable(string $filterable): EloquentRepository;
+	public function removeFilterable(string $filterable): Repository;
 
 	/**
 	 * Remove many filterable fields
 	 *
 	 * @param array $filterable
 	 *
-	 * @return \Fuzz\MagicBox\EloquentRepository
+	 * @return \Fuzz\MagicBox\Contracts\Repository
 	 */
-	public function removeManyFilterable(array $filterable): EloquentRepository;
+	public function removeManyFilterable(array $filterable): Repository;
 
 	/**
 	 * Determine whether a given key is filterable