Add "when()" method to QueryBuilder to be more readable conditional query #7342

New Issue

admin · 2026-01-22T15:50:18+01:00

admin commented

2026-01-22 15:50:18 +01:00

Originally created by @iku12phycho on GitHub (Mar 12, 2024).

Feature Request

Hello,
Code visibility is good if Query Builder is more Declarative.

Q	A
New Feature	yes
RFC	no
BC Break	no

Summary

add when()method to contain condition statements.
nests and if statements are less.

when()method has follow arguments

$condition (boolean)
$truthy (Closure) run if $condition is true
$falsy(Closure|null) run if $condition is false. when it is null, skip.

before

// switch null clause
if ($label === null) {
  $queryBuilder->where(`label is :label`)
    ->setParameter( 'label', $label);
}else {
  $queryBuilder->where(`label = :label`)
    ->setParameter( 'label', $label);
}
// conditional clause
if (!$isAdmin) {
  $queryBuilder->addWhere('isPublic = true');
}

after

$queryBuilder->when(
  condition: $label === null,
  truthy: fn ($queryBuilder) => $queryBuilder->where(`label is :label`),
  falsy: fn ($queryBuilder) => $queryBuilder->where(`label = :label`)
)
->setParameter( 'label', $label)
->when(!$isAdmin, fn ($queryBuilder) => $queryBuilder->addWhere('isPublic = true'))
;

Originally created by @iku12phycho on GitHub (Mar 12, 2024). ### Feature Request Hello, Code visibility is good if Query Builder is more Declarative. | Q | A |------------ | ------ | New Feature | yes | RFC | no | BC Break | no #### Summary add `when()`method to contain condition statements. nests and if statements are less. `when()`method has follow arguments - $condition (boolean) - $truthy (Closure) run if $condition is true - $falsy(Closure|null) run if $condition is false. when it is null, skip. before ``` // switch null clause if ($label === null) { $queryBuilder->where(`label is :label`) ->setParameter( 'label', $label); }else { $queryBuilder->where(`label = :label`) ->setParameter( 'label', $label); } // conditional clause if (!$isAdmin) { $queryBuilder->addWhere('isPublic = true'); } ``` after ``` $queryBuilder->when( condition: $label === null, truthy: fn ($queryBuilder) => $queryBuilder->where(`label is :label`), falsy: fn ($queryBuilder) => $queryBuilder->where(`label = :label`) ) ->setParameter( 'label', $label) ->when(!$isAdmin, fn ($queryBuilder) => $queryBuilder->addWhere('isPublic = true')) ; ```

admin referenced this issue

2026-01-22 16:07:32 +01:00

[PR #7342] Rebase 2.7 onto 2.6 #10438

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#7342