|
| 1 | +# Contributte / Nextras Criteria |
| 2 | + |
| 3 | +Criteria pattern for [Nextras ORM](https://nextras.org/orm), inspired by [Doctrine Criteria API](https://www.doctrine-project.org/projects/doctrine-collections/en/latest/expressions.html). |
| 4 | + |
| 5 | +## Content |
| 6 | + |
| 7 | +- [Installation](#installation) |
| 8 | +- [Usage](#usage) |
| 9 | +- [Expression Builder](#expression-builder) |
| 10 | +- [Ordering](#ordering) |
| 11 | +- [Pagination](#pagination) |
| 12 | +- [Examples](#examples) |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +Install package using composer. |
| 17 | + |
| 18 | +```bash |
| 19 | +composer require contributte/nextras-criteria |
| 20 | +``` |
| 21 | + |
| 22 | +## Usage |
| 23 | + |
| 24 | +### Basic usage |
| 25 | + |
| 26 | +```php |
| 27 | +use Contributte\Criteria\Criteria; |
| 28 | +use Contributte\Criteria\Ordering; |
| 29 | +use Contributte\Criteria\Nextras\CriteriaApplicator; |
| 30 | + |
| 31 | +// Create criteria |
| 32 | +$criteria = Criteria::create() |
| 33 | + ->where(Criteria::expr()->eq('status', 'active')) |
| 34 | + ->andWhere(Criteria::expr()->gt('age', 18)) |
| 35 | + ->orderBy(Ordering::desc('createdAt')) |
| 36 | + ->setMaxResults(10); |
| 37 | + |
| 38 | +// Apply to Nextras collection |
| 39 | +$applicator = new CriteriaApplicator(); |
| 40 | +$users = $applicator->apply($orm->users->findAll(), $criteria); |
| 41 | +``` |
| 42 | + |
| 43 | +### Advanced usage |
| 44 | + |
| 45 | +```php |
| 46 | +use Contributte\Criteria\Criteria; |
| 47 | +use Contributte\Criteria\Ordering; |
| 48 | +use Contributte\Criteria\Nextras\CriteriaApplicator; |
| 49 | + |
| 50 | +class UserRepository |
| 51 | +{ |
| 52 | + private CriteriaApplicator $applicator; |
| 53 | + |
| 54 | + public function __construct( |
| 55 | + private UserOrmRepository $ormRepository, |
| 56 | + ) { |
| 57 | + $this->applicator = new CriteriaApplicator(); |
| 58 | + } |
| 59 | + |
| 60 | + public function findActiveAdults(int $page, int $perPage): array |
| 61 | + { |
| 62 | + $criteria = Criteria::create() |
| 63 | + ->where(Criteria::expr()->andX( |
| 64 | + Criteria::expr()->eq('status', 'active'), |
| 65 | + Criteria::expr()->gte('age', 18), |
| 66 | + Criteria::expr()->isNotNull('verifiedAt') |
| 67 | + )) |
| 68 | + ->orderBy([ |
| 69 | + Ordering::desc('createdAt'), |
| 70 | + Ordering::asc('lastName'), |
| 71 | + ]) |
| 72 | + ->setFirstResult(($page - 1) * $perPage) |
| 73 | + ->setMaxResults($perPage); |
| 74 | + |
| 75 | + return $this->applicator |
| 76 | + ->apply($this->ormRepository->findAll(), $criteria) |
| 77 | + ->fetchAll(); |
| 78 | + } |
| 79 | +} |
| 80 | +``` |
| 81 | + |
| 82 | +## Expression Builder |
| 83 | + |
| 84 | +The `Criteria::expr()` method returns an `ExpressionBuilder` for creating filter expressions. |
| 85 | + |
| 86 | +### Comparison operators |
| 87 | + |
| 88 | +```php |
| 89 | +$expr = Criteria::expr(); |
| 90 | + |
| 91 | +// Equality |
| 92 | +$expr->eq('name', 'John'); // name = 'John' |
| 93 | +$expr->neq('status', 'deleted'); // status != 'deleted' |
| 94 | + |
| 95 | +// Comparison |
| 96 | +$expr->lt('age', 18); // age < 18 |
| 97 | +$expr->lte('price', 100); // price <= 100 |
| 98 | +$expr->gt('rating', 4); // rating > 4 |
| 99 | +$expr->gte('quantity', 10); // quantity >= 10 |
| 100 | + |
| 101 | +// IN / NOT IN |
| 102 | +$expr->in('status', ['active', 'pending']); |
| 103 | +$expr->notIn('role', ['banned', 'suspended']); |
| 104 | + |
| 105 | +// LIKE patterns |
| 106 | +$expr->contains('description', 'keyword'); // LIKE '%keyword%' |
| 107 | +$expr->startsWith('email', 'admin@'); // LIKE 'admin@%' |
| 108 | +$expr->endsWith('email', '@example.com'); // LIKE '%@example.com' |
| 109 | + |
| 110 | +// NULL checks |
| 111 | +$expr->isNull('deletedAt'); |
| 112 | +$expr->isNotNull('verifiedAt'); |
| 113 | +``` |
| 114 | + |
| 115 | +### Composite expressions (AND/OR) |
| 116 | + |
| 117 | +```php |
| 118 | +$expr = Criteria::expr(); |
| 119 | + |
| 120 | +// AND condition |
| 121 | +$criteria = Criteria::create()->where( |
| 122 | + $expr->andX( |
| 123 | + $expr->eq('status', 'active'), |
| 124 | + $expr->gt('age', 18), |
| 125 | + $expr->isNotNull('email') |
| 126 | + ) |
| 127 | +); |
| 128 | + |
| 129 | +// OR condition |
| 130 | +$criteria = Criteria::create()->where( |
| 131 | + $expr->orX( |
| 132 | + $expr->eq('role', 'admin'), |
| 133 | + $expr->eq('role', 'moderator') |
| 134 | + ) |
| 135 | +); |
| 136 | + |
| 137 | +// Nested conditions: (status = 'active' AND age > 18) OR role = 'admin' |
| 138 | +$criteria = Criteria::create()->where( |
| 139 | + $expr->orX( |
| 140 | + $expr->andX( |
| 141 | + $expr->eq('status', 'active'), |
| 142 | + $expr->gt('age', 18) |
| 143 | + ), |
| 144 | + $expr->eq('role', 'admin') |
| 145 | + ) |
| 146 | +); |
| 147 | +``` |
| 148 | + |
| 149 | +### Fluent where methods |
| 150 | + |
| 151 | +```php |
| 152 | +$criteria = Criteria::create() |
| 153 | + ->where(Criteria::expr()->eq('status', 'active')) |
| 154 | + ->andWhere(Criteria::expr()->gt('age', 18)) |
| 155 | + ->orWhere(Criteria::expr()->eq('role', 'admin')); |
| 156 | +``` |
| 157 | + |
| 158 | +### Relationship traversal |
| 159 | + |
| 160 | +Nextras ORM supports filtering by related entity properties using `->` notation: |
| 161 | + |
| 162 | +```php |
| 163 | +// Filter books by author's name |
| 164 | +$criteria = Criteria::create() |
| 165 | + ->where(Criteria::expr()->eq('author->name', 'Jon Snow')); |
| 166 | + |
| 167 | +// Order by related entity |
| 168 | +$criteria = Criteria::create() |
| 169 | + ->orderBy(Ordering::asc('author->lastName')); |
| 170 | +``` |
| 171 | + |
| 172 | +## Ordering |
| 173 | + |
| 174 | +```php |
| 175 | +use Contributte\Criteria\Ordering; |
| 176 | + |
| 177 | +// Single ordering |
| 178 | +$criteria = Criteria::create() |
| 179 | + ->orderBy(Ordering::desc('createdAt')); |
| 180 | + |
| 181 | +// Multiple orderings |
| 182 | +$criteria = Criteria::create() |
| 183 | + ->orderBy([ |
| 184 | + Ordering::asc('lastName'), |
| 185 | + Ordering::asc('firstName'), |
| 186 | + ]); |
| 187 | + |
| 188 | +// Add ordering |
| 189 | +$criteria = Criteria::create() |
| 190 | + ->orderBy(Ordering::desc('priority')) |
| 191 | + ->addOrderBy(Ordering::asc('name')); |
| 192 | +``` |
| 193 | + |
| 194 | +## Pagination |
| 195 | + |
| 196 | +```php |
| 197 | +$criteria = Criteria::create() |
| 198 | + ->setFirstResult(20) // offset |
| 199 | + ->setMaxResults(10); // limit |
| 200 | +``` |
| 201 | + |
| 202 | +## Examples |
| 203 | + |
| 204 | +### Reusable criteria |
| 205 | + |
| 206 | +Create reusable criteria specifications: |
| 207 | + |
| 208 | +```php |
| 209 | +class ActiveUserCriteria |
| 210 | +{ |
| 211 | + public static function create(): Criteria |
| 212 | + { |
| 213 | + return Criteria::create() |
| 214 | + ->where(Criteria::expr()->andX( |
| 215 | + Criteria::expr()->eq('status', 'active'), |
| 216 | + Criteria::expr()->isNull('deletedAt') |
| 217 | + )); |
| 218 | + } |
| 219 | +} |
| 220 | + |
| 221 | +// Combine criteria |
| 222 | +$criteria = ActiveUserCriteria::create() |
| 223 | + ->andWhere(Criteria::expr()->gte('age', 18)) |
| 224 | + ->orderBy(Ordering::desc('createdAt')); |
| 225 | +``` |
| 226 | + |
| 227 | +> [!TIP] |
| 228 | +> Take a look at more examples in [contributte/playground](https://github.com/contributte/playground). |
0 commit comments