LabelController::generator() - Code Metrics - Inspection of "Merge branch 'label_generator'" - Part-DB/Part-DB-symfony - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ec0d02...c0f595 )

by Jan

created 2020-05-10 12:19 UTC

LabelController::generator() C

↳ Parent: LabelController

Complexity

Conditions	14
Paths	160

Size

Total Lines	69
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	14
eloc	39
c	2
b	0
f	0
nc	160
nop	2
dl	0
loc	69
rs	5.7666

How to fix Long Method Complexity

<?php
/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Controller;


use App\Entity\Base\AbstractDBElement;
use App\Entity\Contracts\NamedElementInterface;
use App\Entity\LabelSystem\LabelOptions;
use App\Entity\LabelSystem\LabelProfile;
use App\Entity\Parts\Part;
use App\Exceptions\TwigModeException;
use App\Form\LabelOptionsType;
use App\Form\LabelSystem\LabelDialogType;
use App\Helpers\LabelResponse;
use App\Repository\DBElementRepository;
use App\Services\ElementTypeNameGenerator;
use App\Services\LabelSystem\LabelGenerator;
use App\Services\Misc\RangeParser;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormError;
use Symfony\Component\Form\SubmitButton;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\Translation\TranslatorInterface;

/**
 * @Route("/label")
 * @package App\Controller
 */
class LabelController extends AbstractController
{
    protected $labelGenerator;
    protected $em;
    protected $elementTypeNameGenerator;
    protected $rangeParser;
    protected $translator;

    public function __construct(LabelGenerator $labelGenerator, EntityManagerInterface $em, ElementTypeNameGenerator $elementTypeNameGenerator,
        RangeParser $rangeParser, TranslatorInterface $translator)
    {
        $this->labelGenerator = $labelGenerator;
        $this->em = $em;
        $this->elementTypeNameGenerator = $elementTypeNameGenerator;
        $this->rangeParser = $rangeParser;
        $this->translator = $translator;
    }

    /**
     * @Route("/dialog", name="label_dialog")
     * @Route("/{profile}/dialog", name="label_dialog_profile")
     */
    public function generator(Request $request, ?LabelProfile $profile = null)
    {
        $this->denyAccessUnlessGranted('@labels.create_labels');

        //If we inherit a LabelProfile, the user need to have access to it...
        if ($profile !== null) {
            $this->denyAccessUnlessGranted('read', $profile);
        }

        if ($profile) {
            $label_options = $profile->getOptions();
        } else {
            $label_options = new LabelOptions();
        }

        //We have to disable the options, if twig mode is selected and user is not allowed to use it.
        $disable_options = $label_options->getLinesMode() === 'twig' && !$this->isGranted("@labels.use_twig");

        $form = $this->createForm(LabelDialogType::class, null, [
            'disable_options' => $disable_options,
        ]);

        //Try to parse given target_type and target_id
        $target_type = $request->query->get('target_type', null);
        $target_id = $request->query->get('target_id', null);
        $generate = $request->query->getBoolean('generate', false);

        if ($profile === null && is_string($target_type)) {
            $label_options->setSupportedElement($target_type);
        }
        if (is_string($target_id)) {
            $form['target_id']->setData($target_id);
        }


        $form['options']->setData($label_options);
        $form->handleRequest($request);

        /** @var LabelOptions $form_options */
        $form_options = $form['options']->getData();

        $pdf_data = null;
        $filename = 'invalid.pdf';

        //Generate PDF either when the form is submitted and valid, or the form  was not submit yet, and generate is set
        if (($form->isSubmitted() && $form->isValid()) || ($generate && !$form->isSubmitted() && $profile !== null)) {
            $target_id = (string) $form->get('target_id')->getData();
            $targets = $this->findObjects($form_options->getSupportedElement(), $target_id);
            if (!empty($targets)) {
                try {
                    $pdf_data = $this->labelGenerator->generateLabel($form_options, $targets);
                    $filename = $this->getLabelName($targets[0], $profile);
                } catch (TwigModeException $exception) {
                    $form->get('options')->get('lines')->addError(new FormError($exception->getMessage()));
                }

            } else {
                //$this->addFlash('warning', 'label_generator.no_entities_found');
                $form->get('target_id')->addError(
                    new FormError($this->translator->trans('label_generator.no_entities_found'))
                );
            }
        }

        return $this->render('LabelSystem/dialog.html.twig', [
            'form' => $form->createView(),
            'pdf_data' => $pdf_data,
            'filename' => $filename,
            'profile' => $profile,
        ]);
    }

    protected function getLabelName(AbstractDBElement $element, ?LabelProfile $profile = null): string
    {
        $ret = 'label_' . $this->elementTypeNameGenerator->getLocalizedTypeLabel($element);
        $ret .= $element->getID();

        return $ret . '.pdf';
    }

    protected function findObjects(string $type, string $ids): array
    {
        if(!isset(LabelGenerator::CLASS_SUPPORT_MAPPING[$type])) {
            throw new \InvalidArgumentException('The given type is not known and can not be mapped to a class!');
        }

        $id_array = $this->rangeParser->parse($ids);

        /** @var DBElementRepository $repo */
        $repo = $this->em->getRepository(LabelGenerator::CLASS_SUPPORT_MAPPING[$type]);
        return $repo->getElementsFromIDArray($id_array);
    }
}

1			<?php
2			/**
3			* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
4			*
5			* Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
6			*
7			* This program is free software: you can redistribute it and/or modify
8			* it under the terms of the GNU Affero General Public License as published
9			* by the Free Software Foundation, either version 3 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU Affero General Public License for more details.
16			*
17			* You should have received a copy of the GNU Affero General Public License
18			* along with this program. If not, see <https://www.gnu.org/licenses/>.
19			*/
20
21			namespace App\Controller;
22
23
24			use App\Entity\Base\AbstractDBElement;
25			use App\Entity\Contracts\NamedElementInterface;
26			use App\Entity\LabelSystem\LabelOptions;
27			use App\Entity\LabelSystem\LabelProfile;
28			use App\Entity\Parts\Part;
29			use App\Exceptions\TwigModeException;
30			use App\Form\LabelOptionsType;
31			use App\Form\LabelSystem\LabelDialogType;
32			use App\Helpers\LabelResponse;
33			use App\Repository\DBElementRepository;
34			use App\Services\ElementTypeNameGenerator;
35			use App\Services\LabelSystem\LabelGenerator;
36			use App\Services\Misc\RangeParser;
37			use Doctrine\ORM\EntityManagerInterface;
38			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
39			use Symfony\Component\Form\Form;
40			use Symfony\Component\Form\FormError;
41			use Symfony\Component\Form\SubmitButton;
42			use Symfony\Component\HttpFoundation\BinaryFileResponse;
43			use Symfony\Component\HttpFoundation\Request;
44			use Symfony\Component\HttpFoundation\Response;
45			use Symfony\Component\HttpFoundation\ResponseHeaderBag;
46			use Symfony\Component\Routing\Annotation\Route;
47			use Symfony\Contracts\Translation\TranslatorInterface;
48
49			/**
50			* @Route("/label")
51			* @package App\Controller
52			*/
53			class LabelController extends AbstractController
54			{
55			protected $labelGenerator;
56			protected $em;
57			protected $elementTypeNameGenerator;
58			protected $rangeParser;
59			protected $translator;
60
61			public function __construct(LabelGenerator $labelGenerator, EntityManagerInterface $em, ElementTypeNameGenerator $elementTypeNameGenerator,
62			RangeParser $rangeParser, TranslatorInterface $translator)
63			{
64			$this->labelGenerator = $labelGenerator;
65			$this->em = $em;
66			$this->elementTypeNameGenerator = $elementTypeNameGenerator;
67			$this->rangeParser = $rangeParser;
68			$this->translator = $translator;
69			}
70
71			/**
72			* @Route("/dialog", name="label_dialog")
73			* @Route("/{profile}/dialog", name="label_dialog_profile")
74			*/
75			public function generator(Request $request, ?LabelProfile $profile = null)
76			{
77			$this->denyAccessUnlessGranted('@labels.create_labels');
78
79			//If we inherit a LabelProfile, the user need to have access to it...
80			if ($profile !== null) {
81			$this->denyAccessUnlessGranted('read', $profile);
82			}
83
84			if ($profile) {
85			$label_options = $profile->getOptions();
86			} else {
87			$label_options = new LabelOptions();
88			}
89
90			//We have to disable the options, if twig mode is selected and user is not allowed to use it.
91			$disable_options = $label_options->getLinesMode() === 'twig' && !$this->isGranted("@labels.use_twig");
92
93			$form = $this->createForm(LabelDialogType::class, null, [
94			'disable_options' => $disable_options,
95			]);
96
97			//Try to parse given target_type and target_id
98			$target_type = $request->query->get('target_type', null);
99			$target_id = $request->query->get('target_id', null);
100			$generate = $request->query->getBoolean('generate', false);
101
102			if ($profile === null && is_string($target_type)) {
103			$label_options->setSupportedElement($target_type);
104			}
105			if (is_string($target_id)) {
106			$form['target_id']->setData($target_id);
107			}
108
109
110			$form['options']->setData($label_options);
111			$form->handleRequest($request);
112
113			/** @var LabelOptions $form_options */
114			$form_options = $form['options']->getData();
115
116			$pdf_data = null;
117			$filename = 'invalid.pdf';
118
119			//Generate PDF either when the form is submitted and valid, or the form was not submit yet, and generate is set
120			if (($form->isSubmitted() && $form->isValid()) \|\| ($generate && !$form->isSubmitted() && $profile !== null)) {
121			$target_id = (string) $form->get('target_id')->getData();
122			$targets = $this->findObjects($form_options->getSupportedElement(), $target_id);
123			if (!empty($targets)) {
124			try {
125			$pdf_data = $this->labelGenerator->generateLabel($form_options, $targets);
126			$filename = $this->getLabelName($targets[0], $profile);
127			} catch (TwigModeException $exception) {
128			$form->get('options')->get('lines')->addError(new FormError($exception->getMessage()));
129			}
130
131			} else {
132			//$this->addFlash('warning', 'label_generator.no_entities_found');
133			$form->get('target_id')->addError(
134			new FormError($this->translator->trans('label_generator.no_entities_found'))
135			);
136			}
137			}
138
139			return $this->render('LabelSystem/dialog.html.twig', [
140			'form' => $form->createView(),
141			'pdf_data' => $pdf_data,
142			'filename' => $filename,
143			'profile' => $profile,
144			]);
145			}
146
147			protected function getLabelName(AbstractDBElement $element, ?LabelProfile $profile = null): string
148			{
149			$ret = 'label_' . $this->elementTypeNameGenerator->getLocalizedTypeLabel($element);
150			$ret .= $element->getID();
151
152			return $ret . '.pdf';
153			}
154
155			protected function findObjects(string $type, string $ids): array
156			{
157			if(!isset(LabelGenerator::CLASS_SUPPORT_MAPPING[$type])) {
158			throw new \InvalidArgumentException('The given type is not known and can not be mapped to a class!');
159			}
160
161			$id_array = $this->rangeParser->parse($ids);
162
163			/** @var DBElementRepository $repo */
164			$repo = $this->em->getRepository(LabelGenerator::CLASS_SUPPORT_MAPPING[$type]);
165			return $repo->getElementsFromIDArray($id_array);
166			}
167			}

Part-DB / Part-DB-symfony

Push — master ( ec0d02...c0f595 )

LabelController::generator() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like