SettingsManagerController::updateAction() - Code Metrics - Inspection of "[WIP] Refactoring front end" - ongr-io/SettingsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#168)

unknown

created 2016-04-08 06:01 UTC

SettingsManagerController::updateAction() A

↳ Parent: SettingsManagerController

Complexity

Conditions	3
Paths	3

Size

Total Lines	47
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	47
rs	9.0303
cc	3
eloc	31
nc	3
nop	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\SettingsBundle\Controller;

use ONGR\SettingsBundle\Settings\General\SettingsManager;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Yaml\Dumper;

/**
 * SettingsManager controller responsible for CRUD actions from frontend for settings.
 *
 * @package ONGR\SettingsBundle\Controller
 */
class SettingsManagerController extends Controller
{
    /**
     * Action for saving/seting setting values.
     *
     * @param Request $request
     *
     * @return Response
     */
    public function setSettingAction(Request $request)
    {
        $data = $this->get('ongr_settings.form_validator')->validateSettingForm($request);
        $cache = $this->get('es.cache_engine');

        if ($data['error'] != '') {
            $cache->save('settings_errors', $data['error']);
            return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
        }
        $manager = $this->getSettingsManager();

        try {
            $manager->set(
                $data['name'],
                $data['type'],
                $data['description'],
                $data['value'],
                $data['profiles']
            );
        } catch (\Exception $e) {
            $cache->save('settings_errors', $e->getMessage());
            return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
        }

        $cache->save('settings_success', true);
        return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
    }

    /**
     * Action for rendering single setting edit page.
     *
     * @param Request $request
     * @param string  $name
     * @param string  $profile
     *
     * @return Response
     * @throws NotFoundHttpException
     */
    public function editAction(Request $request, $name, $profile)
    {
        $setting = $this->getSettingsManager()->get($name, $profile, false, $request->query->get('type', 'string'));
        $params = [];
        $params['setting'] = $setting;
        $cache = $this->get('es.cache_engine');
        if ($setting->getType() == 'object') {
            $dumper = new Dumper();
            $setting->setData(
                [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'value' => $dumper->dump(json_decode($setting->getData()['value'], true), 2)
                ]
            );
        }
        if ($cache->contains('settings_errors')) {

            $params['errors'] = $cache->fetch('settings_errors');
            $cache->delete('settings_errors');
        } elseif ($cache->contains('settings_success')) {
            $params['success'] = $cache->fetch('settings_success');
            $cache->delete('settings_success');
        }
        return $this->render(
            'ONGRSettingsBundle:Settings:edit.html.twig',
            $params
        );
    }

    /**
     * Action updating a setting.
     *
     * @param Request $request
     *
     * @return Response
     */
    public function updateAction(Request $request)
    {
        $data = $this->get('ongr_settings.form_validator')->validateSettingForm($request);
        $manager = $this->getSettingsManager();
        $cache = $this->get('es.cache_engine');

        if ($data['error'] != '') {
            $cache->save('settings_errors', $data['error']);
            return new RedirectResponse(
                $this->generateUrl(
                    'ongr_settings_setting_edit',
                    ['name' => $data['name'], 'profile' => $data['profiles'][0]]
                )
            );
        }

        $model = $manager->get(
            $data['name'],
            $data['profiles'][0],
            false,
            $data['type']
        );

        $model->setData((object)['value' => $data['value']]);
        $model->setType($data['type']);
        $model->setDescription($data['description']);

        try {
            $manager->save($model);
        } catch (\Exception $e) {
            $cache->save('settings_errors', $e->getMessage());
            return new RedirectResponse(
                $this->generateUrl(
                    'ongr_settings_setting_edit',
                    ['name' => $data['name'], 'profile' => $data['profiles'][0]]
                )
            );
        }

        $cache->save('settings_success', true);
        return new RedirectResponse(
            $this->generateUrl(
                'ongr_settings_setting_edit',
                ['name' => $data['name'], 'profile' => $data['profiles'][0]]
            )
        );
    }

    /**
     * Action for deleting a setting.
     *
     * @param string $name
     * @param string $profile
     *
     * @return Response
     * @throws NotFoundHttpException
     */
    public function removeAction($name, $profile)
    {
        $setting = $this->getSettingsManager()->get($name, $profile);

        $this->getSettingsManager()->remove($setting);

        return new Response();
    }

    /**
     * Copies a setting to a new profile.
     *
     * @param string $name
     * @param string $from
     * @param string $to
     *
     * @return Response
     * @throws NotFoundHttpException
     */
    public function copyAction($name, $from, $to)
    {
        $settingsManager = $this->getSettingsManager();

        $setting = $settingsManager->get($name, $from);

        $this->getSettingsManager()->duplicate($setting, $to);

        return new Response();
    }

    /**
     * @return SettingsManager
     */
    protected function getSettingsManager()
    {
        return $this->get('ongr_settings.settings_manager');
    }
}


1		<?php
2
3		/*
4		* This file is part of the ONGR package.
5		*
6		* (c) NFQ Technologies UAB <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ONGR\SettingsBundle\Controller;
13
14		use ONGR\SettingsBundle\Settings\General\SettingsManager;
15		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
16		use Symfony\Component\HttpFoundation\JsonResponse;
17		use Symfony\Component\HttpFoundation\RedirectResponse;
18		use Symfony\Component\HttpFoundation\Request;
19		use Symfony\Component\HttpFoundation\Response;
20		use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
21		use Symfony\Component\Yaml\Dumper;
22
23		/**
24		* SettingsManager controller responsible for CRUD actions from frontend for settings.
25		*
26		* @package ONGR\SettingsBundle\Controller
27		*/
28		class SettingsManagerController extends Controller
29		{
30		/**
31		* Action for saving/seting setting values.
32		*
33		* @param Request $request
34		*
35		* @return Response
36		*/
37		public function setSettingAction(Request $request)
38		{
39		$data = $this->get('ongr_settings.form_validator')->validateSettingForm($request);
40		$cache = $this->get('es.cache_engine');
41
42		if ($data['error'] != '') {
43		$cache->save('settings_errors', $data['error']);
44		return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
45		}
46		$manager = $this->getSettingsManager();
47
48		try {
49		$manager->set(
50		$data['name'],
51		$data['type'],
52		$data['description'],
53		$data['value'],
54		$data['profiles']
55		);
56		} catch (\Exception $e) {
57		$cache->save('settings_errors', $e->getMessage());
58		return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
59		}
60
61		$cache->save('settings_success', true);
62		return new RedirectResponse($this->generateUrl('ongr_settings_settings_add'));
63		}
64
65		/**
66		* Action for rendering single setting edit page.
67		*
68		* @param Request $request
69		* @param string $name
70		* @param string $profile
71		*
72		* @return Response
73		* @throws NotFoundHttpException
74		*/
75		public function editAction(Request $request, $name, $profile)
76		{
77		$setting = $this->getSettingsManager()->get($name, $profile, false, $request->query->get('type', 'string'));
78		$params = [];
79		$params['setting'] = $setting;
80		$cache = $this->get('es.cache_engine');
81		if ($setting->getType() == 'object') {
82		$dumper = new Dumper();
83		$setting->setData(
84		[
		0 ignored issues – show Documentation introduced 2016-04-08 06:16 UTC by Report Bug Copy Issue Report `array('value' => $dumper...()['value'], true), 2))` is of type `array<string,string,{"value":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
85		'value' => $dumper->dump(json_decode($setting->getData()['value'], true), 2)
86		]
87		);
88		}
89	View Code Duplication	if ($cache->contains('settings_errors')) {
		0 ignored issues – show Duplication introduced 2016-04-08 06:16 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
90		$params['errors'] = $cache->fetch('settings_errors');
91		$cache->delete('settings_errors');
92		} elseif ($cache->contains('settings_success')) {
93		$params['success'] = $cache->fetch('settings_success');
94		$cache->delete('settings_success');
95		}
96		return $this->render(
97		'ONGRSettingsBundle:Settings:edit.html.twig',
98		$params
99		);
100		}
101
102		/**
103		* Action updating a setting.
104		*
105		* @param Request $request
106		*
107		* @return Response
108		*/
109		public function updateAction(Request $request)
110		{
111		$data = $this->get('ongr_settings.form_validator')->validateSettingForm($request);
112		$manager = $this->getSettingsManager();
113		$cache = $this->get('es.cache_engine');
114
115		if ($data['error'] != '') {
116		$cache->save('settings_errors', $data['error']);
117		return new RedirectResponse(
118		$this->generateUrl(
119		'ongr_settings_setting_edit',
120		['name' => $data['name'], 'profile' => $data['profiles'][0]]
121		)
122		);
123		}
124
125		$model = $manager->get(
126		$data['name'],
127		$data['profiles'][0],
128		false,
129		$data['type']
130		);
131
132		$model->setData((object)['value' => $data['value']]);
133		$model->setType($data['type']);
134		$model->setDescription($data['description']);
135
136		try {
137		$manager->save($model);
138		} catch (\Exception $e) {
139		$cache->save('settings_errors', $e->getMessage());
140		return new RedirectResponse(
141		$this->generateUrl(
142		'ongr_settings_setting_edit',
143		['name' => $data['name'], 'profile' => $data['profiles'][0]]
144		)
145		);
146		}
147
148		$cache->save('settings_success', true);
149		return new RedirectResponse(
150		$this->generateUrl(
151		'ongr_settings_setting_edit',
152		['name' => $data['name'], 'profile' => $data['profiles'][0]]
153		)
154		);
155		}
156
157		/**
158		* Action for deleting a setting.
159		*
160		* @param string $name
161		* @param string $profile
162		*
163		* @return Response
164		* @throws NotFoundHttpException
165		*/
166		public function removeAction($name, $profile)
167		{
168		$setting = $this->getSettingsManager()->get($name, $profile);
169
170		$this->getSettingsManager()->remove($setting);
171
172		return new Response();
173		}
174
175		/**
176		* Copies a setting to a new profile.
177		*
178		* @param string $name
179		* @param string $from
180		* @param string $to
181		*
182		* @return Response
183		* @throws NotFoundHttpException
184		*/
185		public function copyAction($name, $from, $to)
186		{
187		$settingsManager = $this->getSettingsManager();
188
189		$setting = $settingsManager->get($name, $from);
190
191		$this->getSettingsManager()->duplicate($setting, $to);
192
193		return new Response();
194		}
195
196		/**
197		* @return SettingsManager
198		*/
199		protected function getSettingsManager()
200		{
201		return $this->get('ongr_settings.settings_manager');
202		}
203		}
204

ongr-io / SettingsBundle

Pull Request — master (#168)

SettingsManagerController::updateAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like