Implementing Database Services in Symfony | CodeSignal Learn

Implementing Database Services in Symfony | CodeSignal Learn

First, we need to configure the TodoService class to handle database operations. This class will manage all CRUD operations for the Todo entity. We'll inject two key dependencies: the EntityManagerInterface and the TodoRepository. The EntityManagerInterface manages database operations for entities, acting as the central manager for them.

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;
    }
}

Here, by setting up these dependencies, we prepare our service class to interact with the database through Doctrine ORM, ensuring that we can easily manage Todo entities.

Next, let's look at implementing the CRUD operations in the TodoService class. These operations will allow us to create, read, update, and delete Todo items in the database.

We'll use the TodoRepository to fetch Todo items from the database.

PHP

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

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

By utilizing these methods, we can easily retrieve a list of all Todo items, or fetch a specific Todo by its ID, making our data retrieval process straightforward and efficient.

To add a new Todo item to the database, we use the EntityManagerInterface.

PHP

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

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

    return $todo;
}

This method allows us to create a new Todo item, setting its basic properties, persisting it to be managed by Doctrine, and then saving it into the database in one seamless operation. The persist function marks the Todo entity for being managed by Doctrine, and flush commits the changes to the database, saving the new item.

To modify an existing Todo item, we use the TodoRepository and EntityManagerInterface.

PHP

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

    return null;
}

Here, we efficiently update an existing Todo item by finding it through its ID, changing its details if it exists, and then committing these changes to the database.

Finally, to remove an existing Todo item, modify the method to use the TodoRepository and EntityManagerInterface.

PHP

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

This method facilitates the deletion of a Todo item by locating it and then using Doctrine's integrated mechanisms to remove it from the database.

Let's review the complete TodoService class with all the integrated functions.

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 getAllTodos(): array
    {
        return $this->todoRepository->findAll();
    }

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

    public function addTodoItem(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 modifyTodoItem(int $id, string $title, ?string $description): ?Todo
    {
        $todo = $this->getTodoById($id);
        if ($todo) {
            $todo->setTitle($title);
            $todo->setDescription($description);
            $this->entityManager->flush();
            return $todo;
        }

        return null;
    }

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