SettingsController::updateSetting() - Code Metrics - Inspection of "Upgrade" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5329)

by Angel Fernando Quiroz

created 2024-04-07 22:17 UTC

SettingsController::updateSetting() C

↳ Parent: SettingsController

Complexity

Conditions	11
Paths	56

Size

Total Lines	76
Code Lines	52

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	52
nc	56
nop	3
dl	0
loc	76
rs	6.9006
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\CoreBundle\Controller\Admin;

use Chamilo\CoreBundle\Controller\BaseController;
use Chamilo\CoreBundle\ServiceHelper\AccessUrlHelper;
use Chamilo\CoreBundle\Traits\ControllerTrait;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
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\Routing\Annotation\Route;
use Symfony\Component\Validator\Exception\ValidatorException;

#[Route('/admin')]
class SettingsController extends BaseController
{
    use ControllerTrait;

    #[Route('/settings', name: 'admin_settings')]
    public function index(): Response
    {
        return $this->redirectToRoute('chamilo_platform_settings', ['namespace' => 'platform']);
    }

    /**
     * Edit configuration with given namespace.
     */
    #[IsGranted('ROLE_ADMIN')]
    #[Route('/settings/search_settings', name: 'chamilo_platform_settings_search')]
    public function searchSetting(Request $request): Response
    {
        $manager = $this->getSettingsManager();
        $formList = [];
        $keyword = $request->get('keyword');

        $searchForm = $this->getSearchForm();
        $searchForm->handleRequest($request);
        if ($searchForm->isSubmitted() && $searchForm->isValid()) {
            $values = $searchForm->getData();
            $keyword = $values['keyword'];
        }

        if (empty($keyword)) {
            throw $this->createNotFoundException();
        }

        $settingsFromKeyword = $manager->getParametersFromKeywordOrderedByCategory($keyword);

        $settings = [];
        if (!empty($settingsFromKeyword)) {
            foreach ($settingsFromKeyword as $category => $parameterList) {
                $list = [];
                foreach ($parameterList as $parameter) {
                    $list[] = $parameter->getVariable();
                }
                $settings = $manager->load($category, null);
                $schemaAlias = $manager->convertNameSpaceToService($category);
                $form = $this->getSettingsFormFactory()->create($schemaAlias);

                foreach (array_keys($settings->getParameters()) as $name) {
                    if (!\in_array($name, $list, true)) {
                        $form->remove($name);
                        $settings->remove($name);
                    }
                }
                $form->setData($settings);
                $formList[$category] = $form->createView();
            }
        }

        $schemas = $manager->getSchemas();

        return $this->render(
            '@ChamiloCore/Admin/Settings/search.html.twig',
            [
                'keyword' => $keyword,
                'schemas' => $schemas,
                'settings' => $settings,
                'form_list' => $formList,
                'search_form' => $searchForm->createView(),
            ]
        );
    }

    /**
     * Edit configuration with given namespace.
     */
    #[IsGranted('ROLE_ADMIN')]
    #[Route('/settings/{namespace}', name: 'chamilo_platform_settings')]
    public function updateSetting(Request $request, AccessUrlHelper $accessUrlHelper, string $namespace): Response
    {
        $manager = $this->getSettingsManager();
        $url = $accessUrlHelper->getCurrent();
        $manager->setUrl($url);
        $schemaAlias = $manager->convertNameSpaceToService($namespace);
        $searchForm = $this->getSearchForm();

        $keyword = '';
        $settingsFromKeyword = null;
        $searchForm->handleRequest($request);
        if ($searchForm->isSubmitted() && $searchForm->isValid()) {
            $values = $searchForm->getData();
            $keyword = $values['keyword'];
            $settingsFromKeyword = $manager->getParametersFromKeyword(
                $schemaAlias,
                $keyword
            );
        }

        $keywordFromGet = $request->query->get('keyword');
        if ($keywordFromGet) {
            $keyword = $keywordFromGet;
            $searchForm->setData([
                'keyword' => $keyword,
            ]);
            $settingsFromKeyword = $manager->getParametersFromKeyword(
                $schemaAlias,
                $keywordFromGet
            );
        }

        $settings = $manager->load($namespace);
        $form = $this->getSettingsFormFactory()->create($schemaAlias);

        if (!empty($keyword)) {
            $params = $settings->getParameters();
            foreach (array_keys($params) as $name) {
                if (!\array_key_exists($name, $settingsFromKeyword)) {
                    $form->remove($name);
                }
            }
        }

        $form->setData($settings);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {
            $messageType = 'success';

            try {
                $manager->save($form->getData());
                $message = $this->trans('Settings have been successfully updated');
            } catch (ValidatorException $validatorException) {
                // $message = $this->trans($exception->getMessage(), [], 'validators');
                $message = $this->trans($validatorException->getMessage());
                $messageType = 'error';
            }

            $this->addFlash($messageType, $message);
            if (!empty($keywordFromGet)) {
                return $this->redirect($request->headers->get('referer'));
            }
        }
        $schemas = $manager->getSchemas();

        return $this->render(
            '@ChamiloCore/Admin/Settings/default.html.twig',
            [
                'schemas' => $schemas,
                'settings' => $settings,
                'form' => $form->createView(),
                'keyword' => $keyword,
                'search_form' => $searchForm->createView(),
            ]
        );
    }

    /**
     * Sync settings from classes with the database.
     */
    #[IsGranted('ROLE_ADMIN')]
    #[Route('/settings_sync', name: 'sync_settings')]
    public function syncSettings(AccessUrlHelper $accessUrlHelper): Response
    {
        $manager = $this->getSettingsManager();
        $url = $accessUrlHelper->getCurrent();
        $manager->setUrl($url);
        $manager->installSchemas($url);

        return new Response('Updated');
    }

    /**
     * @return FormInterface
     */
    private function getSearchForm()
    {
        $builder = $this->container->get('form.factory')->createNamedBuilder('search');
        $builder->add('keyword', TextType::class);
        $builder->add('search', SubmitType::class, ['attr' => ['class' => 'btn btn--primary']]);

        return $builder->getForm();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Controller\Admin;
8
9			use Chamilo\CoreBundle\Controller\BaseController;
10			use Chamilo\CoreBundle\ServiceHelper\AccessUrlHelper;
11			use Chamilo\CoreBundle\Traits\ControllerTrait;
12			use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
13			use Symfony\Component\Form\Extension\Core\Type\SubmitType;
14			use Symfony\Component\Form\Extension\Core\Type\TextType;
15			use Symfony\Component\Form\FormInterface;
16			use Symfony\Component\HttpFoundation\Request;
17			use Symfony\Component\HttpFoundation\Response;
18			use Symfony\Component\Routing\Annotation\Route;
19			use Symfony\Component\Validator\Exception\ValidatorException;
20
21			#[Route('/admin')]
22			class SettingsController extends BaseController
23			{
24			use ControllerTrait;
25
26			#[Route('/settings', name: 'admin_settings')]
27			public function index(): Response
28			{
29			return $this->redirectToRoute('chamilo_platform_settings', ['namespace' => 'platform']);
30			}
31
32			/**
33			* Edit configuration with given namespace.
34			*/
35			#[IsGranted('ROLE_ADMIN')]
36			#[Route('/settings/search_settings', name: 'chamilo_platform_settings_search')]
37			public function searchSetting(Request $request): Response
38			{
39			$manager = $this->getSettingsManager();
40			$formList = [];
41			$keyword = $request->get('keyword');
42
43			$searchForm = $this->getSearchForm();
44			$searchForm->handleRequest($request);
45			if ($searchForm->isSubmitted() && $searchForm->isValid()) {
46			$values = $searchForm->getData();
47			$keyword = $values['keyword'];
48			}
49
50			if (empty($keyword)) {
51			throw $this->createNotFoundException();
52			}
53
54			$settingsFromKeyword = $manager->getParametersFromKeywordOrderedByCategory($keyword);
55
56			$settings = [];
57			if (!empty($settingsFromKeyword)) {
58			foreach ($settingsFromKeyword as $category => $parameterList) {
59			$list = [];
60			foreach ($parameterList as $parameter) {
61			$list[] = $parameter->getVariable();
62			}
63			$settings = $manager->load($category, null);
64			$schemaAlias = $manager->convertNameSpaceToService($category);
65			$form = $this->getSettingsFormFactory()->create($schemaAlias);
66
67			foreach (array_keys($settings->getParameters()) as $name) {
68			if (!\in_array($name, $list, true)) {
69			$form->remove($name);
70			$settings->remove($name);
71			}
72			}
73			$form->setData($settings);
74			$formList[$category] = $form->createView();
75			}
76			}
77
78			$schemas = $manager->getSchemas();
79
80			return $this->render(
81			'@ChamiloCore/Admin/Settings/search.html.twig',
82			[
83			'keyword' => $keyword,
84			'schemas' => $schemas,
85			'settings' => $settings,
86			'form_list' => $formList,
87			'search_form' => $searchForm->createView(),
88			]
89			);
90			}
91
92			/**
93			* Edit configuration with given namespace.
94			*/
95			#[IsGranted('ROLE_ADMIN')]
96			#[Route('/settings/{namespace}', name: 'chamilo_platform_settings')]
97			public function updateSetting(Request $request, AccessUrlHelper $accessUrlHelper, string $namespace): Response
98			{
99			$manager = $this->getSettingsManager();
100			$url = $accessUrlHelper->getCurrent();
101			$manager->setUrl($url);
102			$schemaAlias = $manager->convertNameSpaceToService($namespace);
103			$searchForm = $this->getSearchForm();
104
105			$keyword = '';
106			$settingsFromKeyword = null;
107			$searchForm->handleRequest($request);
108			if ($searchForm->isSubmitted() && $searchForm->isValid()) {
109			$values = $searchForm->getData();
110			$keyword = $values['keyword'];
111			$settingsFromKeyword = $manager->getParametersFromKeyword(
112			$schemaAlias,
113			$keyword
114			);
115			}
116
117			$keywordFromGet = $request->query->get('keyword');
118			if ($keywordFromGet) {
119			$keyword = $keywordFromGet;
120			$searchForm->setData([
121			'keyword' => $keyword,
122			]);
123			$settingsFromKeyword = $manager->getParametersFromKeyword(
124			$schemaAlias,
125			$keywordFromGet
126			);
127			}
128
129			$settings = $manager->load($namespace);
130			$form = $this->getSettingsFormFactory()->create($schemaAlias);
131
132			if (!empty($keyword)) {
133			$params = $settings->getParameters();
134			foreach (array_keys($params) as $name) {
135			if (!\array_key_exists($name, $settingsFromKeyword)) {
136			$form->remove($name);
137			}
138			}
139			}
140
141			$form->setData($settings);
142			$form->handleRequest($request);
143
144			if ($form->isSubmitted() && $form->isValid()) {
145			$messageType = 'success';
146
147			try {
148			$manager->save($form->getData());
149			$message = $this->trans('Settings have been successfully updated');
150			} catch (ValidatorException $validatorException) {
151			// $message = $this->trans($exception->getMessage(), [], 'validators');
152			$message = $this->trans($validatorException->getMessage());
153			$messageType = 'error';
154			}
155
156			$this->addFlash($messageType, $message);
157			if (!empty($keywordFromGet)) {
158			return $this->redirect($request->headers->get('referer'));
159			}
160			}
161			$schemas = $manager->getSchemas();
162
163			return $this->render(
164			'@ChamiloCore/Admin/Settings/default.html.twig',
165			[
166			'schemas' => $schemas,
167			'settings' => $settings,
168			'form' => $form->createView(),
169			'keyword' => $keyword,
170			'search_form' => $searchForm->createView(),
171			]
172			);
173			}
174
175			/**
176			* Sync settings from classes with the database.
177			*/
178			#[IsGranted('ROLE_ADMIN')]
179			#[Route('/settings_sync', name: 'sync_settings')]
180			public function syncSettings(AccessUrlHelper $accessUrlHelper): Response
181			{
182			$manager = $this->getSettingsManager();
183			$url = $accessUrlHelper->getCurrent();
184			$manager->setUrl($url);
185			$manager->installSchemas($url);
186
187			return new Response('Updated');
188			}
189
190			/**
191			* @return FormInterface
192			*/
193			private function getSearchForm()
194			{
195			$builder = $this->container->get('form.factory')->createNamedBuilder('search');
196			$builder->add('keyword', TextType::class);
197			$builder->add('search', SubmitType::class, ['attr' => ['class' => 'btn btn--primary']]);
198
199			return $builder->getForm();
200			}
201			}
202

chamilo / chamilo-lms

Pull Request — master (#5329)

SettingsController::updateSetting() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like