CODEWITHSUNDEEP
phpsymfony
Stefano De La Burczymuchito
Stefano De La Burczymuchito

Reputation: 133

Symfony 2 - ways to reduce redundant code

I'm writing a simple Symfony2 web application. I realised that almost every controller in my application does the same operations, but on a different object. I'm talkin about standard CRUD operations: creating, reading, updating and deleting. I will use 'delete' operation as an example

Example:

class CustomerController {
/**
 * @Route("/customer")
 * @Method("DELETE")
 */
public function deleteAction(Request $request){
    $rep =this->getDoctrine()->getManager()->getRepository('AppBundle:Customer');

    $customerId = $request->get('id');
    if ($customerId != null) {
        $rep->delete($customerId);
    } else {
        $rep->deleteAll();
    }
    $response = new Response(null, Response::HTTP_OK);
    return $response;
}
}

class ProductController {
/**
 * @Route("/product")
 * @Method("DELETE")
 */
public function deleteAction(Request $request){
    $rep =this->getDoctrine()->getManager()->getRepository('AppBundle:Product');

    $productId = $request->get('id');
    if ($productId != null) {
        $rep->delete($productId);
    } else {
        $rep->deleteAll();
    }
    $response = new Response(null, Response::HTTP_OK);
    return $response;
}
}

class CompanyController {
/**
 * @Route("/company")
 * @Method("DELETE")
 */
public function deleteAction(Request $request){
    $rep =this->getDoctrine()->getManager()->getRepository('AppBundle:Company');

    $companyId = $request->get('id');
    if ($companyId != null) {
        $rep->delete($companyId);
    } else {
        $rep->deleteAll();
    }
    $response = new Response(null, Response::HTTP_OK);
    return $response;
}
}

and so on ...

The only thing that really changes is the entity name ("Customer", "Product", "Company", etc...).

Do you have any ideas how to get rid off all this redundancy and at the same time keep the code readable ?

The first thing that comes to my mind is to create a base class with the delete method logic and just pass entity name as a parameter. Is it ok to do so? For example:

class CustomerController extends BaseController{
/**
 * @Route("/customer")
 * @Method("DELETE")
 */
public function deleteAction(Request $request){
    parent::deleteAction($request, 'AppBundle:Customer');
}

Is the above legit solution ? Are there ways to simplify it further ?

Upvotes: 0

Views: 85

Answers (1)

Carlos
Carlos

Reputation: 1431

I would use a single controller. Use the route to get the entity classname.

/**
 * @Route("/{entityName}/{entityId}")
 * @Route("/{entityName}")
 * @Method("DELETE")
 */
public function deleteAction($entityName, $entityId = null){
    $rep =this->getDoctrine()->getManager()->getRepository('AppBundle:'.$entityName);
    if ($productId != null) {
        $rep->delete($productId);
    } else {
        $rep->deleteAll();
    }
    $response = new Response(null, Response::HTTP_OK);
    return $response;
}
}

Depending on how you build your routes you should have to translate the $entityName string for instance: /entity-name to EntityName or /entity to Entity

Upvotes: 1

Related Questions