CRM_Utils_SQL_Select - Allow fluent query execution #10686
Merged
Conversation
This file contains 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
When I first wrote `CRM_Utils_SQL_Select`, I was a bit dogmatic about
loose-coupling and wanted the class to be entirely independent of the SQL
runtime. But this is a bit annoying in usage and training.
Before
======
To build and execute query, you had to pass the rendered SQL to the execute
function, eg
```php
$select = CRM_Utils_SQL_Select::from('mytable')
->select('...')
$dao = CRM_Core_DAO::executeQuery($select->toSQL());
while ($dao->fetch()) { ... }
```
After
=====
You can use more fluent style:
```php
$dao = CRM_Utils_SQL_Select::from('mytable')
->select('...')
->execute();
while ($dao->fetch()) { ... }
```
And you can chain with other DAO functions like `fetchAll()` or
`fetchValue()`.
```php
$records = CRM_Utils_SQL_Select::from('mytable')
->select('...')
->execute()
->fetchAll();
```
seancolsen
reviewed
Jul 19, 2017
CRM/Utils/SQL/Select.php
Outdated
| @@ -594,6 +594,25 @@ public function toSQL() { | |||
| } | |||
|
|
|||
| /** | |||
| * @return CRM_Core_DAO | |||
| */ | |||
There was a problem hiding this comment.
It would be nice to flesh out this docblock by:
- providing a short description
- documenting the parameters with types and descriptions (e.g. what happens when
$i18nRewriteisTRUEvsFALSE?
There was a problem hiding this comment.
Thanks, good point. I've updated docblock in c4dcc9c
|
I like this improvement. @totten is this PR ready for review? |
|
@monishdeb Absolutely. If it works for you and seems safe, then lets merge it. |
|
@totten yup it works fine, merging it now. Also I have raised a doc PR civicrm/civicrm-dev-docs#225. Please have a look!! |
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.
When I first wrote
CRM_Utils_SQL_Select, I was a bit dogmatic aboutloose-coupling and wanted the class to be entirely independent of the SQL
runtime. But this is a bit annoying in usage and training.
Before
To build and execute query, you had to pass the rendered SQL to the execute
function, eg
After
You can use more fluent style:
And you can chain with other DAO functions like
fetchAll(),fetchValue(), orfetchMap().