refactor(QueryBuilder): Properly type the query builder #57763
+895
−2,044
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4949aa8 to
27c24e9
Compare
27c24e9 to
75af4a1
Compare
And make sure the related unit tests are also typed and checked by psalm. Signed-off-by: Carl Schwan <carlschwan@kde.org>
75af4a1 to
ca05129
Compare
come-nc
reviewed
Jan 27, 2026
| */ | ||
| public function eq($x, $y, $type = null): string { | ||
| #[Override] | ||
| public function eq(string|ILiteral|IQueryFunction|IParameter $x, IQueryFunction|ILiteral|IParameter|string $y, int|string|null $type = null): string { |
Contributor
There was a problem hiding this comment.
Suggested change
| public function eq(string|ILiteral|IQueryFunction|IParameter $x, IQueryFunction|ILiteral|IParameter|string $y, int|string|null $type = null): string { | |
| public function eq( | |
| string|ILiteral|IQueryFunction|IParameter $x, | |
| IQueryFunction|ILiteral|IParameter|string $y, | |
| int|string|null $type = null, | |
| ): string { |
Please split on several lines when types get that complicated.
| */ | ||
| public function like($x, $y, $type = null): string { | ||
| #[Override] | ||
| public function like(ILiteral|IParameter|IQueryFunction|string $x, mixed $y, mixed $type = null): string { |
Contributor
There was a problem hiding this comment.
Why are these parameters mixed and not the same as the other methods above?
| * @return string | ||
| */ | ||
| public function notIn($x, $y, $type = null): string { | ||
| #[Override] |
Contributor
There was a problem hiding this comment.
All the types parameter in the file should be typed the same way.
Comment on lines
+258
to
+259
| parent::innerJoin($fromAlias, $join, $alias, $condition); | ||
| return $this; |
Contributor
There was a problem hiding this comment.
I think if you properly type the methods with @return $this in phpdoc you do not need to split all these return parent::… into 2 lines, as $this of self and parent is the same.
| * @since 12.0.0 | ||
| */ | ||
| public function concat($x, ...$expr): IQueryFunction; | ||
| public function concat(string|ILiteral|IParameter|IQueryFunction $x, ...$expr): IQueryFunction; |
Contributor
There was a problem hiding this comment.
I believe you can type the variadic parameter as well.
| * Gets the type of the currently built query. | ||
| * | ||
| * @return integer | ||
| * @deprecated Since 34.0.0, if necessary, track the type of the query being built outside of the builder. |
Contributor
There was a problem hiding this comment.
Suggested change
| * @deprecated Since 34.0.0, if necessary, track the type of the query being built outside of the builder. | |
| * @deprecated 34.0.0 If necessary, track the type of the query being built outside of the builder. |
| * @param mixed $value The parameter value. | ||
| * @param string|null|int $type One of the IQueryBuilder::PARAM_* constants. | ||
| * | ||
| * @return $this This QueryBuilder instance. |
Contributor
There was a problem hiding this comment.
I think we should have the @return $this on all fluent methods. It’s stronger typing than : self.
| * @param mixed $key The key (index or name) of the bound parameter type. | ||
| * @param int|string $key The key (index or name) of the bound parameter type. | ||
| * | ||
| * @return mixed The value of the bound parameter type. |
Contributor
There was a problem hiding this comment.
I guess it’s the type and not the value?
And probably string|int and not mixed?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
TODO
Checklist
3. to review, feature component)stable32)