Merge pull request #2 from cbikash/query-builder

added functions which helps to return a query builder with associated with table

Author: cbikash

README.md

@@ -145,6 +145,39 @@ public function index(Request $request)
 ## Available Repository Functions
 Here are some of the key functions available within your repositories:
 ```php 
+ /**
+  * Get the current model instance.
+  *
+  * This method returns the model associated with the repository.
+  * The returned object could either be an instance of the Model class or any object that extends Model.
+  * Useful when you need to access the model for further operations in the repository.
+  *
+  * @return Model|mixed The model instance being used by the repository.
+  */
+ public function getModel();
+
+ /**
+  * Get the name of the table associated with the model.
+  *
+  * This method retrieves the table name from the model instance.
+  * It assumes that the model has a method `getTable()` which returns the database table's name associated with the model.
+  * Useful when you need to dynamically reference the model's table in queries.
+  *
+  * @return string The table name associated with the current model.
+  */
+ public function getTable();
+
+ /**
+  * Create a new query builder instance for the current table.
+  *
+  * This method initiates a query builder for the table associated with the current model.
+  * It uses the `connection` property to access the database connection and starts a new query on the table retrieved from `getTable()`.
+  * Useful when you need to build complex queries programmatically in the repository.
+  *
+  * @return \Illuminate\Database\Query\Builder A new query builder instance for the table.
+  */
+ public function createQueryBuilder();
+
 /**
  * Find a single record based on criteria.
  * @param array $criteria
@@ -164,7 +197,7 @@ public function findAll(): mixed;
  * @param array $orders
  * @return mixed
  */
-public function findBy(array $filters = [], array $orders = []): mixed;
+public function findBy(array $filters, array $orders = []): mixed;
 
 /**
  * Retrieve a record by its ID.

src/Command/CreateRepository.php

@@ -112,7 +112,7 @@ private function getContent(string $modelName, string $modelClass, string $repos
                  * 
                  * @method {$modelName}|null findOneBy(array \$criteria) Retrieve a single {$modelName} record based on criteria
                  * @method {$modelName}|null getById(mixed \$id) Retrieve a {$modelName} record by ID
-                 * @method Collection|{$modelName}[]|null findBy(array \$filters = [], array \$orders = []) Retrieve records based on filters and ordering
+                 * @method Collection|{$modelName}[]|null findBy(array \$filters, array \$orders = []) Retrieve records based on filters and ordering
                  * @method {$modelName} create(array \$data) Create a new {$modelName} record
                  * @method {$modelName} update(mixed \$id, array \$data) Update an existing {$modelName} record by ID
                  * @method void delete(mixed \$id) Delete a {$modelName} record by ID

src/EntityRepository.php

@@ -60,6 +60,47 @@ public function __construct($entityClass = null, null|string $name = null)
         $this->connection = DB::connection($name);
     }
 
+    /**
+     * Get the current model instance.
+     *
+     * This method returns the model associated with the repository.
+     * The returned object could either be an instance of the Model class or any object that extends Model.
+     * Useful when you need to access the model for further operations in the repository.
+     *
+     * @return Model|mixed The model instance being used by the repository.
+     */
+    public function getModel()
+    {
+        return $this->model;
+    }
+
+    /**
+     * Get the name of the table associated with the model.
+     *
+     * This method retrieves the table name from the model instance.
+     * It assumes that the model has a method `getTable()` which returns the database table's name associated with the model.
+     * Useful when you need to dynamically reference the model's table in queries.
+     *
+     * @return string The table name associated with the current model.
+     */
+    public function getTable(){
+        return $this->model->getTable();
+    }
+
+    /**
+     * Create a new query builder instance for the current table.
+     *
+     * This method initiates a query builder for the table associated with the current model.
+     * It uses the `connection` property to access the database connection and starts a new query on the table retrieved from `getTable()`.
+     * Useful when you need to build complex queries programmatically in the repository.
+     *
+     * @return \Illuminate\Database\Query\Builder A new query builder instance for the table.
+     */
+    public function createQueryBuilder()
+    {
+        return $this->connection->table($this->getTable());
+    }
+
     /**
      * Get the repository for a specific entity (model).
      *
@@ -109,7 +150,7 @@ public function findAll(): Collection|array
      *
      * @return Collection|array - The filtered and sorted model instances.
      */
-    public function findBy(array $filters = [], array $orders = []): Collection|array
+    public function findBy(array $filters, array $orders = []): Collection|array
     {
         $qb = $this->model->query();
         foreach ($filters as $key => $value)

src/Interfaces/EntityManagerInterface.php

@@ -20,14 +20,59 @@
 interface EntityManagerInterface
 {
     /**
-     * @param string $entityClass
+     * Get the repository for a specific entity (model).
+     *
+     * @param string $entityClass - The fully qualified class name of the entity (model).
+     *
+     * @throws \Exception - If the repository class does not exist.
+     *
+     * <code>
+     *     $object = $this->entityManager->getRepository(Model::class)->find($id)
+     * </code>
+     *
+     * @inheritDoc
      */
     public function getRepository(string $entityClass): mixed;
 
     /**
-     * @param array $criteria
-     * @return Model|array|Builder|null Find One result according to given criteria
-     * Find One result according to given criteria
+     * Get the current model instance.
+     *
+     * This method returns the model associated with the repository.
+     * The returned object could either be an instance of the Model class or any object that extends Model.
+     * Useful when you need to access the model for further operations in the repository.
+     *
+     * @return Model|mixed The model instance being used by the repository.
+     */
+    public function getModel();
+
+    /**
+     * Get the name of the table associated with the model.
+     *
+     * This method retrieves the table name from the model instance.
+     * It assumes that the model has a method `getTable()` which returns the database table's name associated with the model.
+     * Useful when you need to dynamically reference the model's table in queries.
+     *
+     * @return string The table name associated with the current model.
+     */
+    public function getTable();
+
+    /**
+     * Create a new query builder instance for the current table.
+     *
+     * This method initiates a query builder for the table associated with the current model.
+     * It uses the `connection` property to access the database connection and starts a new query on the table retrieved from `getTable()`.
+     * Useful when you need to build complex queries programmatically in the repository.
+     *
+     * @return \Illuminate\Database\Query\Builder A new query builder instance for the table.
+     */
+    public function createQueryBuilder();
+
+    /**
+     * Find a single record that matches the provided criteria.
+     *
+     * @param array $criteria - Filters to apply to the query.
+     *
+     * @return Model|Builder|null - The found model instance or null if not found.
      */
     public function findOneBy(array $criteria): Model|array|Builder|null;
 
@@ -44,7 +89,7 @@ public function findAll(): mixed;
      *
      * Return values according to filter or criteria, it also accepts orders parameter and return order according to it
      */
-    public function findBy(array $filters = [], array $orders = []): mixed;
+    public function findBy(array $filters, array $orders = []): mixed;
 
     /**
      * @param $id