AppBundle\Controller\BandController

Complexity

Total Complexity

26

Size/Duplication

Total Lines	406
Duplicated Lines	13.05 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

88.29%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	viewAction()	0	4	1
A	listAction()	0	4	1
A	createAction()	14	14	1
A	editAction()	0	12	1
A	listMembersAction()	13	13	2
B	addMemberAction()	0	40	4
B	deleteMemberAction()	0	30	4
B	updateMemberAction()	0	33	4
A	createLocationByNameFieldInForm()	0	6	1
A	createResponseFromCreateForm()	0	8	2
A	createResponseFromUpdateForm()	0	8	2
A	createFormBandCreate()	9	9	1
A	createFormUpdateBandMember()	8	8	1
A	createFormCreateBandMember()	9	9	1

<?php

namespace AppBundle\Controller;

use AppBundle\Entity\Band;
use AppBundle\Entity\BandMember;
use AppBundle\Entity\DTO\CreateBandMemberDTO;
use AppBundle\Entity\DTO\CreateBand;
use AppBundle\Entity\DTO\UpdateBandMemberDTO;
use AppBundle\Entity\Repository\BandRepository;
use AppBundle\Entity\User;
use AppBundle\Form\Ambassador\BandFormType;
use AppBundle\Form\FormOptions;
use AppBundle\Response\ApiValidationError;
use AppBundle\Response\CreatedApiResponse;
use AppBundle\Response\EmptyApiResponse;
use AppBundle\Response\Infrastructure\AbstractApiResponse;
use AppBundle\Service\Entity\BandService;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use AppBundle\Controller\Infrastructure\RestController;
use AppBundle\Response\ApiError;
use AppBundle\Response\ApiResponse;
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @author Vehsamrak
 * @Route("band")
 */
class BandController extends RestController
{

    /**
     * List all registered bands
     * @Route("s/{limit}/{offset}", name="bands_list")
     * @Method("GET")
     * @ApiDoc(
     *     section="Band",
     *     statusCodes={
     *         200="OK",
     *     }
     * )
     * @param int $limit Limit results. Default is 50
     * @param int $offset Starting serial number of result collection. Default is 0
     */
    public function listAction($limit = null, $offset = null): Response
    {
        return $this->listEntities($this->get('rockparade.band_repository'), $limit, $offset);
    }

    /**
     * View band by name
     * @Route("/{id}", name="band_view")
     * @Method("GET")
     * @ApiDoc(
     *     section="Band",
     *     statusCodes={
     *         200="Band was found",
     *         404="Band with given name was not found",
     *     }
     * )
     * @param string $id band name
     */
    public function viewAction(string $id): Response
    {
        return $this->viewEntity($this->get('rockparade.band_repository'), $id);
    }

    /**
     * Create new band
     * @Route("", name="band_create")
     * @Method("POST")
     * @Security("has_role('ROLE_USER')")
     * @ApiDoc(
     *     section="Band",
     *     requirements={
     *         {
     *             "name"="name",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="band name"
     *         },
     *         {
     *             "name"="description",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="band description"
     *         },
     *         {
     *             "name"="members",
     *             "dataType"="array",
     *             "requirement"="false",
     *             "description"="logins and short descriptions of band musicians"
     *         },
     *     },
     *     statusCodes={
     *         201="New band was created. Link to new resource provided in header 'Location'",
     *         400="Validation error",
     *     }
     * )
     */
    public function createAction(Request $request): Response

This method seems to be duplicated in your project.

    {
        $form = $this->createAndProcessForm($request, BandFormType::class);

        $apiResponseFactory = $this->get('rockparade.api_response_factory');
        $response = $apiResponseFactory->createResponse(
            $this->createApiOperation($request),
            $form,
            $this->getUser(),
            Band::class
        );

        return $this->respond($response);
    }

    /**
     * Edit band
     * @Route("/{bandName}", name="band_edit")
     * @Method("PUT")
     * @Security("has_role('ROLE_USER')")
     * @ApiDoc(
     *     section="Band",
     *     requirements={
     *         {
     *             "name"="name",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="band name"
     *         },
     *         {
     *             "name"="description",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="band description"
     *         },
     *         {
     *             "name"="users",
     *             "dataType"="array",
     *             "requirement"="true",
     *             "description"="logins of band musicians"
     *         },
     *     },
     *     statusCodes={
     *         204="Band was edited with new data",
     *         400="Validation error",
     *     }
     * )
     * @param string $bandName band name
     */
    public function editAction(Request $request, string $bandName): Response
    {
        /** @var BandRepository $bandRepository */
        $bandRepository = $this->get('rockparade.band_repository');
        $band = $bandRepository->findOneByName($bandName);

        $form = $this->createFormBandCreate();
        $this->processForm($request, $form);
        $form = $this->get('rockparade.band')->processFormAndUpdateBand($form, $band, $this->getUser());

        return $this->respond($this->createResponseFromUpdateForm($form));
    }

    /**
     * List all band members
     * @Route("/{bandName}/members", name="band_members")
     * @Method("GET")
     * @ApiDoc(
     *     section="Band",
     *     statusCodes={
     *         200="OK",
     *         404="Band was not found",
     *     }
     * )
     */
    public function listMembersAction(string $bandName): Response

This method seems to be duplicated in your project.

    {
        $bandRepository = $this->get('rockparade.band_repository');
        $band = $bandRepository->findOneByName($bandName);

        if (!$band) {
            $response = $this->createEntityNotFoundResponse(Band::class, $bandName);
        } else {
            $response = new ApiResponse($band->getMembers(), Response::HTTP_OK);
        }

        return $this->respond($response);
    }

    /**
     * Add member to band
     * @Route("/{bandName}/members", name="band_member_add")
     * @Method("POST")
     * @Security("has_role('ROLE_USER')")
     * @ApiDoc(
     *     section="Band",
     *     requirements={
     *         {
     *             "name"="login",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="user login"
     *         },
     *         {
     *             "name"="short_description",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="short description of musicians role in band"
     *         },
     *         {
     *             "name"="description",
     *             "dataType"="string",
     *             "requirement"="false",
     *             "description"="long description of musician"
     *         },
     *     },
     *     statusCodes={
     *         200="Member was added to the band",
     *         400="Validation error",
     *     }
     * )
     * @param string $bandName band name
     */
    public function addMemberAction(Request $request, string $bandName): Response
    {
        $form = $this->createFormCreateBandMember();
        $this->processForm($request, $form);

        if ($form->isValid()) {
            $bandRepository = $this->get('rockparade.band_repository');
            $band = $bandRepository->findOneByName($bandName);

            if (!$band) {
                $response = $this->createEntityNotFoundResponse(Band::class, $bandName);
            } else {
                $newUserLogin = $form->get('login')->getData();
                $newUser = $this->get('rockparade.user_repository')->findOneByLogin($newUserLogin);

                if (!$newUser) {
                    $response = $this->createEntityNotFoundResponse(User::class, $newUserLogin);
                } else {
                    $bandMemberRepository = $this->get('rockparade.band_member_repository');
                    $shortDescription = (string) $form->get('short_description')->getData();
                    $description = (string) $form->get('description')->getData();
                    $bandMember = $bandMemberRepository->getOrCreateByBandAndUser(
                        $band,
                        $newUser,
                        $shortDescription,
                        $description
                    );

                    $band->addMember($bandMember);
                    $bandRepository->flush();

                    $response = new EmptyApiResponse(Response::HTTP_OK);
                }
            }
        } else {
            $response = new ApiValidationError($form);
        }

        return $this->respond($response);
    }

    /**
     * Delete member from band
     * @Route("/{bandName}/member/{userLogin}", name="band_member_delete")
     * @Method("DELETE")
     * @Security("has_role('ROLE_USER')")
     * @ApiDoc(
     *     section="Band",
     *     statusCodes={
     *         204="Member was deleted from the band",
     *         404="Band or user was not found",
     *     }
     * )
     * @param string $bandName band name
     * @param string $userLogin member login
     */
    public function deleteMemberAction(string $bandName, string $userLogin)
    {
        $bandRepository = $this->get('rockparade.band_repository');
        $band = $bandRepository->findOneByName($bandName);

        if ($band) {
            $userRepository = $this->get('rockparade.user_repository');
            $user = $userRepository->findOneByLogin($userLogin);

            if ($user) {
                $bandMemberRepository = $this->get('rockparade.band_member_repository');
                $bandMember = $bandMemberRepository->findByBandAndUser($band, $user);

                if ($bandMember) {
                    $band->removeMember($bandMember);
                    $bandRepository->flush();

                    $response = new EmptyApiResponse(Response::HTTP_NO_CONTENT);
                } else {
                    $response = $this->createEntityNotFoundResponse(BandMember::class, $userLogin);
                }
            } else {
                $response = $this->createEntityNotFoundResponse(User::class, $userLogin);
            }
        } else {
            $response = $this->createEntityNotFoundResponse(Band::class, $bandName);
        }

        return $this->respond($response);
    }
    
    /**
     * Update band member
     * @Route("/{bandName}/member/{userLogin}", name="band_member_update")
     * @Method("PUT")
     * @Security("has_role('ROLE_USER')")
     * @ApiDoc(
     *     section="Band",
     *     requirements={
     *         {
     *             "name"="short_description",
     *             "dataType"="string",
     *             "requirement"="true",
     *             "description"="short description of role in band"
     *         },
     *         {
     *             "name"="description",
     *             "dataType"="string",
     *             "requirement"="false",
     *             "description"="long description of musician"
     *         },
     *     },
     *     statusCodes={
     *         204="Band member was successfully updated",
     *         404="Band or user was not found",
     *     }
     * )
     * @param string $bandName band name
     * @param string $userLogin member login
     */
    public function updateMemberAction(Request $request, string $bandName, string $userLogin)
    {
        $bandRepository = $this->get('rockparade.band_repository');
        $band = $bandRepository->findOneByName($bandName);

        if ($band) {
            $userRepository = $this->get('rockparade.user_repository');
            $user = $userRepository->findOneByLogin($userLogin);

            if ($user) {
                $bandMemberRepository = $this->get('rockparade.band_member_repository');
                $bandMember = $bandMemberRepository->findByBandAndUser($band, $user);
                
                if ($bandMember) {
                    $form = $this->createFormUpdateBandMember();
                    $this->processForm($request, $form);
                    $form = $this->get('rockparade.band')->processFormAndUpdateBandMember($form, $bandMember);
                    
                    $bandRepository->flush();

                    $response = $this->createResponseFromUpdateForm($form);
                } else {
                    $response = $this->createEntityNotFoundResponse(BandMember::class, $userLogin);
                }
            } else {
                $response = $this->createEntityNotFoundResponse(User::class, $userLogin);
            }
        } else {
            $response = $this->createEntityNotFoundResponse(Band::class, $bandName);
        }

        return $this->respond($response);
    }

    private function createLocationByNameFieldInForm(FormInterface $form): string
    {
        $bandName = $form->get('name')->getData();

        return $this->generateUrl('band_view', ['bandName' => $bandName]);
    }

    /**
     * @param $form
     * @param $band
     * @return ApiError|CreatedApiResponse|EmptyApiResponse
     */
    private function createResponseFromCreateForm(FormInterface $form): AbstractApiResponse

This method is not used, and could be removed.

    {
        if ($form->isValid()) {
            return new CreatedApiResponse($this->createLocationByNameFieldInForm($form));
        } else {
            return new ApiValidationError($form);
        }
    }

    /**
     * @return ApiError|CreatedApiResponse|EmptyApiResponse
     */
    private function createResponseFromUpdateForm(FormInterface $form): AbstractApiResponse
    {
        if ($form->isValid()) {
            return new EmptyApiResponse(Response::HTTP_NO_CONTENT);
        } else {
            return new ApiValidationError($form);
        }
    }

    private function createFormBandCreate(): FormInterface

This method seems to be duplicated in your project.

    {
        $formBuilder = $this->createFormBuilder(new CreateBand());
        $formBuilder->add('name', TextType::class);
        $formBuilder->add(BandService::ATTRIBUTE_MEMBERS, TextType::class);
        $formBuilder->add('description', TextareaType::class);

        return $formBuilder->getForm();
    }

    private function createFormUpdateBandMember(): FormInterface

This method seems to be duplicated in your project.

    {
        $formBuilder = $this->createFormBuilder(new UpdateBandMemberDTO());
        $formBuilder->add('short_description', TextType::class);
        $formBuilder->add('description', TextareaType::class);

        return $formBuilder->getForm();
    }

    private function createFormCreateBandMember(): FormInterface

This method seems to be duplicated in your project.

    {
        $formBuilder = $this->createFormBuilder(new CreateBandMemberDTO());
        $formBuilder->add('login', TextType::class);
        $formBuilder->add('short_description', TextType::class);
        $formBuilder->add('description', TextareaType::class);

        return $formBuilder->getForm();
    }
}