Implementing Database Services in Symfony

Welcome to another step in our journey of adding enterprise features to our Symfony MVC App. In this lesson, we will focus on adapting our existing service class to use the database for managing Todo items instead of sessions, by leveraging Symfony Services and Doctrine ORM. As a quick reminder from our last lesson, Doctrine ORM helps us manage database operations using PHP objects instead of raw SQL queries. Today, we will update our existing service class to perform CRUD (Create, Read, Update, Delete) operations on our Todo entity using the database. Service classes in Symfony encapsulate reusable business logic and help maintain a clean architecture. By the end of this lesson, you will understand how to modify and utilize a TodoService class that interacts with the database.

Setting Up the TodoService

Let's start by setting up our TodoService class for database operations. This service class will manage the CRUD operations for our Todo entity. We'll need to inject two dependencies into this service: the EntityManagerInterface and the TodoRepository. PHP<?php namespace App\Service; use App\Entity\Todo; use App\Repository\TodoRepository; use Doctrine\ORM\EntityManagerInterface; class TodoService { private $entityManager; private $todoRepository; public function __construct(EntityManagerInterface $entityManager, TodoRepository $todoRepository) { $this->entityManager = $entityManager; $this->todoRepository = $todoRepository; } } The EntityManagerInterface helps manage the entity lifecycle, including persistence operations. Meanwhile, the TodoRepository provides specific data retrieval methods for the Todo entity. By injecting these dependencies, our service class now has the necessary tools to interact with the database. Next, let's implement the CRUD operations in our TodoService, which will allow us to create, read, update, and delete Todo items in the database.

Read Operations

We will utilize our previously created TodoRepository to fetch records from our database. Update the methods in your service class to use the repository for data retrieval. PHP public function findAll(): array {return $this->todoRepository->findAll();} public function findOne(int $id): ?Todo {return $this->todoRepository->find($id);} For the findAll and findOne methods, we use the TodoRepository : findAll() from TodoRepository retrieves all Todo entities from the database. find($id) from TodoRepository finds a Todo entity by its ID.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

The method for creating a new Todo item in the database remains straightforward. Update your existing method to use the EntityManagerInterface.

PHP

public function create(string $title, ?string $description): Todo
{
    $todo = new Todo();
    $todo->setTitle($title);
    $todo->setDescription($description);

    $this->entityManager->persist($todo);
    $this->entityManager->flush();

    return $todo;
}

In the create method, we:

Instantiate a new Todo object.
Set the title and optional description for the Todo item.
Use persist to let Doctrine know that we want to save the new Todo to the database.
Call flush to execute the SQL commands that actually insert the new Todo into the database. Without calling flush, the changes would not be saved.

To modify an existing Todo item, update your existing method to use the repository and the EntityManagerInterface.

PHP

public function update(int $id, string $title, ?string $description): ?Todo
{
    $todo = $this->findOne($id);
    if ($todo) {
        $todo->setTitle($title);
        $todo->setDescription($description);
        $this->entityManager->flush();
        return $todo;
    }

    return null;
}

In the update method, we:

Use the findOne method to retrieve the existing Todo by its ID.
If found, update the title and optional description of the Todo.
Call flush to execute the SQL commands that actually update the Todo in the database with the new information.

Finally, to remove an existing Todo item, update your existing method to use the repository and the EntityManagerInterface.

PHP

public function delete(int $id): void
{
    $todo = $this->findOne($id);
    if ($todo) {
        $this->entityManager->remove($todo);
        $this->entityManager->flush();
    }
}

In the delete method, we:

Use the findOne method to retrieve the existing Todo by its ID.
If found, use remove to mark the Todo for deletion.
Call flush to execute the SQL commands that actually remove the Todo from the database.

Let's put everything together and see the complete, updated TodoService class.

PHP

<?php

namespace App\Service;

use App\Entity\Todo;
use App\Repository\TodoRepository;
use Doctrine\ORM\EntityManagerInterface;

class TodoService
{
    private $entityManager;
    private $todoRepository;

    public function __construct(EntityManagerInterface $entityManager, TodoRepository $todoRepository)
    {
        $this->entityManager = $entityManager;
        $this->todoRepository = $todoRepository;
    }

    public function findAll(): array
    {
        return $this->todoRepository->findAll();
    }

    public function findOne(int $id): ?Todo
    {
        return $this->todoRepository->find($id);
    }

    public function create(string $title, ?string $description): Todo
    {
        $todo = new Todo();
        $todo->setTitle($title);
        $todo->setDescription($description);

        $this->entityManager->persist($todo);
        $this->entityManager->flush();

        return $todo;
    }

    public function update(int $id, string $title, ?string $description): ?Todo
    {
        $todo = $this->findOne($id);
        if ($todo) {
            $todo->setTitle($title);
            $todo->setDescription($description);
            $this->entityManager->flush();
            return $todo;
        }

        return null;
    }

    public function delete(int $id): void
    {
        $todo = $this->findOne($id);
        if ($todo) {
            $this->entityManager->remove($todo);
            $this->entityManager->flush();
        }
    }
}

In this lesson, we focused on adapting our existing TodoService class to manage CRUD operations for our Todo entity using the database:

Setting up the service class and injecting dependencies.
Implementing read operations (findAll and findOne).
Implementing create (create), update (update), and delete (delete) operations.
Providing a complete code example and explaining each part.

Now that you have a solid understanding of implementing a service class with CRUD operations using Doctrine, it's time to put your knowledge into practice. Proceed to the practice exercises and apply what you've learned. These hands-on tasks will reinforce your understanding and help you become proficient in managing database operations within your Symfony application.

Great job on getting through this lesson! Keep up the excellent work as you continue to build and enhance your Symfony MVC app.