SELECTing into a New DTO Object
Keep on Learning!
If you liked what you've learned so far, dive in! Subscribe to get access to this tutorial plus video, code and script downloads.
With a Subscription, click any sentence in the script to jump to that part of the video!
Login SubscribeHaving the flexibility to select any data we want is awesome. Dealing with the associative array that we get back is... less awesome! I like to work with objects whenever possible. Fortunately, Doctrine gives us a simple way to improve this situation: we query for the data we want... but tell it to give us an object.
Creating the DTO
First, we need to create a new class that will hold the data from our query. I'll make a new directory called src/Model/
... but it could be called anything. Call the class... how about CategoryFortuneStats
.
The entire purpose of this class is to hold the data from this specific query. So add a public function __construct()
with a few public
properties for simplicity: public int $fortunesPrinted
, public float $fortunesAverage
, and public string $categoryName
.
// ... lines 1 - 4 | |
class CategoryFortuneStats | |
{ | |
public function __construct( | |
public int $fortunesPrinted, | |
public float $fortunesAverage, | |
public string $categoryName, | |
) | |
{ | |
} | |
} |
Beautiful!
Back in the repository, we actually don't need any Doctrine magic to use this new class. We could query for the associative array, then return new CategoryFortuneStats()
and pass each key into it.
That's a great option, dead simple and then this repository method would return an object instead of an array. But... Doctrine makes this even easier thanks to a little-known feature.
Add a new ->select()
that will contain all of these selects in one. Also add a sprintf()
: you'll see why in a minute. Inside, check this out! Say NEW %s()
then pass CategoryFortuneStats::class
for that placeholder. Basically, we're saying NEW App\Model\CategoryFortuneStats()
... I just wanted to avoid typing that long class name.
Inside of NEW
, grab each of the 3 things that we want to select and paste them, as if we're passing them directly as the first, second and third arguments to our new class's constructor.
// ... lines 1 - 18 | |
class FortuneCookieRepository extends ServiceEntityRepository | |
{ | |
// ... lines 21 - 25 | |
public function countNumberPrintedForCategory(Category $category): array | |
{ | |
$result = $this->createQueryBuilder('fortuneCookie') | |
->select(sprintf( | |
'NEW %s( | |
SUM(fortuneCookie.numberPrinted) AS fortunesPrinted, | |
AVG(fortuneCookie.numberPrinted) fortunesAverage, | |
category.name | |
)', | |
CategoryFortuneStats::class | |
)) | |
// ... lines 37 - 44 | |
} | |
// ... lines 46 - 88 | |
} |
Isn't that cool? Let's dd($result)
so we can see what it looks like!
No Aliasing with NEW
If we head over and refresh... oh... I get an error: T_CLOSE_PARENTHESIS, got 'AS'
. When we select data into an object, aliasing is no longer needed... or allowed. And it makes sense: Doctrine will pass whatever this is to the first argument of our constructor, this to the second argument, and this to the third. Since aliases don't make sense anymore... remove them.
// ... lines 1 - 25 | |
public function countNumberPrintedForCategory(Category $category): array | |
{ | |
$result = $this->createQueryBuilder('fortuneCookie') | |
->select(sprintf( | |
'NEW %s( | |
SUM(fortuneCookie.numberPrinted), | |
AVG(fortuneCookie.numberPrinted), | |
category.name | |
)', | |
CategoryFortuneStats::class | |
)) | |
// ... lines 37 - 44 | |
} | |
// ... lines 46 - 90 |
If we check it now... got it! I love it! We have an object with our data inside!
Let's celebrate by cleaning up our method. Instead of an array
, we're returning a CategoryFortuneStats
. Also remove the dd($result)
down here.
// ... lines 1 - 25 | |
public function countNumberPrintedForCategory(Category $category): CategoryFortuneStats | |
{ | |
// ... lines 28 - 43 | |
} | |
// ... lines 45 - 89 |
Back in the controller, to show off how nice this is, change $result
to... how about $stats
. Then we can use $stats->fortunesPrinted
, $stats->fortunesAverage
, and $stats->categoryName
.
// ... lines 1 - 12 | |
class FortuneController extends AbstractController | |
{ | |
// ... lines 15 - 30 | |
public function showCategory(int $id, CategoryRepository $categoryRepository, FortuneCookieRepository $fortuneCookieRepository): Response | |
{ | |
// ... lines 33 - 36 | |
$stats = $fortuneCookieRepository->countNumberPrintedForCategory($category); | |
// ... line 38 | |
return $this->render('fortune/showCategory.html.twig',[ | |
'category' => $category, | |
'fortunesPrinted' => $stats->fortunesPrinted, | |
'fortunesAverage' => $stats->fortunesAverage, | |
'categoryName' => $stats->categoryName, | |
]); | |
} | |
} |
Now that we've tidied up a bit, let's check to see if this still works. And... it does.
Next: Sometimes queries are so complex... the best option is just to write the darn thing in raw, native SQL. Let's talk about how to do that.
Actually, in this specific case I would still probably prefer selecting to an array, because then I could just spread it in the controller:
But it's still a cool lesson, good to know this feature exists!