Creating Custom Filter

Remember, this package firstly checks whether it is or not custom filter. (except constant parameters). If there is a custom filter for query parameter, applies it. Otherwise, searches this parameter in the table columns and applies.

Which is needed in the case?

1. If you don't want to use table column names clearly with the API parameters:

Create a class derived from QueryBuilder
Then, add method into this class. Method name must be study case type and begin with "filterBy". (eg: "filterByName" for "?name" query parameter)

<?php 
	use Unlu\Laravel\Api\QueryBuilder;

	class UserQueryBuilder extends QueryBuilder
	{
		public function filterByName($query, $name)
		{
	           return $query->where('firstname', $name);
		}
	}
?>

Finally, use this class instead of the QueryBuilder class in your controller file.

<?php 
	namespace App\Whatever\Api\Controllers;

	use App\Http\Requests;
	use App\User;
	use Illuminate\Http\Request;

	// Add this line
	use YourNameSpace\Path\UserQueryBuilder;

	class UsersController extends Controller
	{
	  public function index(Request $request)
	  {
	    $queryBuilder = new UserQueryBuilder(new User, $request);
	    
	    return response->json([
	      'data' => $queryBuilder->paginate()->result(),
	      .
	      .
	    ]);
	  }
	}
?>

2. When you need the advanced query:

You can also use this when you needed the advanced query instead of basic where query.

Example for /api/users?city_name=Istanbul

use Unlu\Laravel\Api\QueryBuilder;

class UserQueryBuilder extends QueryBuilder 
{
   public function filterByCityName($query, $name)
   {
      return $query->whereHas('city', function($q) use ($name) {
         return $q->where('name', $name);
      });
   }
}

Access Operator (=, !=, <, <=, >, >=)

If you want to access operator you must edit your method:

<?php 
  use Unlu\Laravel\Api\QueryBuilder;

  class UserQueryBuilder extends QueryBuilder
  {
    public function filterByCityId($query, $id, $operator)
    {
      return $query->whereHas('city', function($q) use ($id, $operator) {
        return $q->where('id', $operator, $id);
      });
    }
  }
?>

All Parameters For Custom Method

<?php 
  use Unlu\Laravel\Api\QueryBuilder;

  class UserQueryBuilder extends QueryBuilder
  {
    public function filterByCityId($query, $value, $operator, $type)
    {
      return $query->whereHas('city', function($q) use ($id, $operator) {
        return $q->where('id', $operator, $id);
      });
    }
  }
?>