claserre9/doctrine-generic-filter

Provide a simple mechanism to filter doctrine queries

1.0.0 2023-10-10 00:23 UTC

Requires

• php: >=8.1
• doctrine/dbal: ^3.2
• doctrine/orm: ^2.11.0
• symfony/cache: ^6.3

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Clifford Laserre

• orm
• doctrine
• filter
• generic

README

This package provides a GenericRepository class which is a versatile utility class designed to simplify database operations using the Doctrine ORM library. It provides methods for retrieving paginated results, applying filters, and sorting data from your database entities. This README file will guide you through using this class effectively.

Table of contents

• Installation
• Usage
• Methods
• Examples
• Contributing
• Licence

Installation

To use the GenericRepository class, you need to have the Doctrine ORM library set up in your PHP project.

composer req claserre9/doctrine-generic-filter

Usage

The GenericRepository class provides methods for retrieving data from your database entities with various options:

• getPaginatedResults: Retrieves paginated results with optional filters and sorting.
• getResults: Retrieves results without pagination but with optional filters and sorting.

Create an instance of the GenericRepository class by injecting the EntityManagerInterface:

$entityManager = ...; // Instantiate your EntityManager
$repository = new GenericRepository($entityManager);

Methods

getPaginatedResults

public function getPaginatedResults(
    string $entityClass,
    int $page = self::DEFAULT_PAGE,
    int $limit = self::DEFAULT_LIMIT,
    ?array $filters = []
): array

• $entityClass (string): The name of the entity for which you want to retrieve results.
• $page (int): The current page number (default is 1).
• $limit (int): The number of results to fetch per page (default is 10).
• $filters (array|null): An array of filters to apply to the query.

Returns an array containing the paginated results along with pagination metadata.

getResults

public function getResults(
    string $entityClass,
    ?array $filters = []
): array

$entityClass (string): The name of the entity for which you want to retrieve results. $filters (array|null): An array of filters to apply to the query.

Returns an array containing the results without pagination.

Examples

Here are some examples of how to use the GenericRepository class:

// Create an instance of GenericRepository (assuming $entityManager is already instantiated).
$repository = new GenericRepository($entityManager);

// Example 1: Get paginated results with filters and ordering.
$results = $repository->getPaginatedResults('Your\Entity\Class', 2, 15, ['column' => ['operator' => 'value']]);

// Example 2: Get results without pagination with filters and ordering.
$results = $repository->getResults('Your\Entity\Class', ['column' => ['operator' => 'value']]);

This is the list of all operators supported

• eq (equal)
• neq (not equal)
• gt (greater than)
• lt (less than)
• gte (greater than or equal)
• lte (less than or equal)
• in
• notin (not in)
• between
• sort

Some concrete examples

/** Retrieve paginated results for the User entity with a filter
* on the gender field where it should be equal to 'Male'
*/

$filters = ['gender' => ["eq" => 'Male'],];
$results = $genericRepository->getPaginatedResults(User::class, 1, 10, $filters);

/** Retrieve paginated results for the User entity with a filter 
 * on the age field where it should be less than or equal to 20*
 */
$filters = ['age' => ["lte" => 20]];
$results = $genericRepository->getPaginatedResults(User::class, 1, 20, $filters);

/**
* Retrieve paginated results for the User entity with a filter 
 * on the age field where the age should be between 20 and 30
 */
$filters = ['age' => ["between" => ["start" => 20, "end" => 30]]];
$results = $genericRepository->getPaginatedResults(User::class, 1, 10, $filters);

We can also apply sort :

/**
* Multiple filters and sort
 */


$filters = [
    'country' => ['eq' => 'China'],
    'gender' => ['eq' => 'Male'],
    'age' =>['sort' => 'DESC'],
    'id' => ['sort' => 'DESC'],
];

$results = $genericRepository->getPaginatedResults(User::class, 1, 10, $filters);

Contributing

Feel free to contribute to this project by opening issues or pull requests on the GitHub repository.

Licence

This project is licensed under the MIT License.

This README file provides an overview of the GenericRepository class, its usage, and how to get started with it in your PHP project. If you have any questions or encounter issues, please refer to the provided examples and documentation in the code or reach out for support.

Happy coding!