symfony 3.4 business logic in AppBundle\Utils

Question

I am new to symfony, i was reading through the best practices guide here https://symfony.com/doc/3.4/best_practices/business-logic.html

I have a controller called Category and i have this action method to list down categories.

public function listCategory(Request $request, CategoryLogic $categoryLogic)
{
    $categories = $categoryLogic->getAllCategory($this->getDoctrine());

    return $this->render('listCategory.html.twig', ['categories' => $categories]);
}

As you can see all my business logic for controller goes to -> AppBundle\Utils\CategoryLogic

There i have this method to handle the logic and return the categories

use AppBundle\Entity\Category; 

/**
 * @param Registry $doctrine
 * @return array
 */
public function getAllCategory(Registry $doctrine)
{
    $repositoryCategory = $doctrine->getRepository(Category::class);
    $category = $repositoryCategory->findAll();

    return $category;
}

The purpose is to keep the controller clean. is this the best way to do it? i have a little concern about naming the logic class as CategoryLogic instead i would like to name it as Category but then i have another problem because i am already importing use AppBundle\Entity\Category in CategoryLogic class so there cant be two Category classes

Answer 1

For your specific example, its useless to use a Util class when you can inject Repository in controller.

public function listCategory(Request $request, CategoryRepository $categoryRepository)
{
    $categories = $categoryRepository->findAll();

    return $this->render('listCategory.html.twig', ['categories' => $categories]);
}

Since symfony 3.3, it has dependency injection that means you can inject services into other services. If you want to handle it with some services e.g. Utils, you can make it like this.

//CategoryController.php

public function listCategory(Request $request, CategoryService $categoryService)
{
    $categories = $categoryService->getAllCategories();

    return $this->render('listCategory.html.twig', ['categories' => $categories]);
}

//CategoryService.php

namespace App\Service;

use App\Repository\CategoryRepository ;

class CategoryService 
{
    private $categoryRepository;

    // We need to inject these variables for later use.
    public function __construct(CategoryRepository $categoryRepository)
    {
        $this->categoryRepository = $categoryRepository;
    }

    public function getAllCategories()
    {
        $categories = $this->categoryRepository->findAll();

        return $categories;
    }
}

Always use singular and plural names to rule out confusions e.g. $category will have a Category object and $categories will be an array of Category objects or at least Iteratable (Collection) object of Category objects. It will make your life easy when you try to debug code later and help others to understand your code better.

Appendix:

https://symfony.com/doc/current/doctrine.html#querying-for-objects-the-repository https://symfony.com/doc/current/service_container/3.3-di-changes.html https://symfony.com/doc/current/service_container/injection_types.html