WidgetsController::selectLinkAction() - Code Metrics - Inspection of "[MediaBundle] Code improvement found by static cod..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aba493...5356ed )

by Ruud

created 2019-06-11 15:20 UTC

WidgetsController::selectLinkAction() A

↳ Parent: WidgetsController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	8
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	8
loc	8
ccs	0
cts	7
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Kunstmaan\NodeBundle\Controller;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\EntityManagerInterface;
use Kunstmaan\MultiDomainBundle\Helper\DomainConfiguration;
use Kunstmaan\NodeBundle\Entity\Node;
use Kunstmaan\NodeBundle\Entity\NodeTranslation;
use Kunstmaan\NodeBundle\Entity\StructureNode;
use Symfony\Component\Routing\Annotation\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;

/**
 * WidgetsController
 */
class WidgetsController extends Controller

{
    /**
     * @Route("/ckselecturl", name="KunstmaanNodeBundle_ckselecturl")
     * @Template("KunstmaanNodeBundle:Widgets:selectLink.html.twig")
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return array
     */
    public function ckSelectLinkAction(Request $request)

    {
        $params = $this->getTemplateParameters($request);
        $params['cke'] = true;
        $params['multilanguage'] = $this->getParameter('kunstmaan_admin.multi_language');

        return $params;
    }

    /**
     * Select a link
     *
     * @Route("/selecturl", name="KunstmaanNodeBundle_selecturl")
     * @Template("KunstmaanNodeBundle:Widgets:selectLink.html.twig")
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return array
     */
    public function selectLinkAction(Request $request)

    {
        $params = $this->getTemplateParameters($request);
        $params['cke'] = false;
        $params['multilanguage'] = $this->getParameter('kunstmaan_admin.multi_language');

        return $params;
    }

    /**
     * Select a link
     *
     * @Route("/select-nodes-lazy_search", name="KunstmaanNodeBundle_nodes_lazy_search")
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return JsonResponse
     */
    public function selectNodesLazySearch(Request $request)
    {
        @trigger_error(sprintf('The "%s" controller action is deprecated in KunstmaanNodeBundle 5.1 and will be removed in KunstmaanNodeBundle 6.0.', __METHOD__), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        /* @var EntityManagerInterface $em */
        $em = $this->getDoctrine()->getManager();
        $locale = $request->getLocale();
        $search = $request->query->get('str');

        $results = [];
        if ($search) {
            $nts = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->getNodeTranslationsLikeTitle($search, $locale);
            /** @var NodeTranslation $nt */
            foreach ($nts as $nt) {
                $node = $nt->getNode();
                $results[] = $node->getId();
                while ($node->getParent()) {
                    $node = $node->getParent();
                    $results[] = $node->getId();
                }
            }
            $results = array_unique($results);
            sort($results);
        }

        return new JsonResponse($results);
    }

    /**
     * Select a link
     *
     * @Route("/select-nodes-lazy", name="KunstmaanNodeBundle_nodes_lazy")
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return JsonResponse
     */
    public function selectNodesLazy(Request $request)
    {
        /* @var EntityManagerInterface $em */
        $em = $this->getDoctrine()->getManager();
        $locale = $request->getLocale();
        $id = $request->query->get('id');
        $depth = $this->getParameter('kunstmaan_node.url_chooser.lazy_increment');

        if (!$id || $id == '#') {
            $domainConfig = $this->get('kunstmaan_admin.domain_configuration');

            if ($domainConfig->isMultiDomainHost()) {
                $switchedHost = $domainConfig->getHostSwitched();
                $rootItems = [$domainConfig->getRootNode($switchedHost['host'])];
            } else {
                $rootItems = $em->getRepository('KunstmaanNodeBundle:Node')->getAllTopNodes();
            }
        } else {
            $rootItems = $em->getRepository('KunstmaanNodeBundle:Node')->find($id)->getChildren();
        }

        $results = $this->nodesToArray($locale, $rootItems, $depth);

        return new JsonResponse($results);
    }

    /**
     * Get the parameters needed in the template. This is common for the
     * default link chooser and the cke link chooser.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return array

     */
    private function getTemplateParameters(Request $request)
    {
        // When the media bundle is available, we show a link in the header to the media chooser
        $allBundles = $this->getParameter('kernel.bundles');
        $mediaChooserLink = null;

        if (\array_key_exists('KunstmaanMediaBundle', $allBundles)) {
            $params = ['linkChooser' => 1];
            $cKEditorFuncNum = $request->get('CKEditorFuncNum');
            if (!empty($cKEditorFuncNum)) {
                $params['CKEditorFuncNum'] = $cKEditorFuncNum;
            }
            $mediaChooserLink = $this->generateUrl(
                'KunstmaanMediaBundle_chooser',
                $params
            );
        }

        return [
            'mediaChooserLink' => $mediaChooserLink,
        ];
    }

    /**
     * Determine if current node is a structure node.
     *
     * @param string $refEntityName
     *
     * @return bool
     */
    protected function isStructureNode($refEntityName)
    {
        $structureNode = false;
        if (class_exists($refEntityName)) {
            $page = new $refEntityName();
            $structureNode = ($page instanceof StructureNode);
            unset($page);
        }

        return $structureNode;
    }

    /**
     * Determine if current node is a structure node.
     *
     * @param string                 $locale
     * @param Node[]|ArrayCollection $rootNodes
     * @param int                    $depth
     *
     * @return array
     */
    protected function nodesToArray($locale, $rootNodes, $depth = 2)
    {
        /** @var DomainConfiguration $domainconfig */
        $domainconfig = $this->get('kunstmaan_admin.domain_configuration');
        $isMultiDomain = $domainconfig->isMultiDomainHost();
        $switchedHost = $domainconfig->getHostSwitched();
        $switched = $domainconfig->getHost() == $switchedHost['host'];

        $results = [];

        /** @var Node $rootNode */
        foreach ($rootNodes as $rootNode) {
            if ($nodeTranslation = $rootNode->getNodeTranslation($locale, true)) {
                if ($isMultiDomain && !$switched) {
                    $slug = sprintf('[%s:%s]', $switchedHost['id'], 'NT'.$nodeTranslation->getId());
                } else {
                    $slug = sprintf('[%s]', 'NT'.$nodeTranslation->getId());
                }

                switch (true) {
                    case !$nodeTranslation->isOnline():
                        $type = 'offline';

                        break;
                    case $rootNode->isHiddenFromNav():
                        $type = 'hidden-from-nav';

                        break;
                    default:
                        $type = 'default';
                }

                $root = [
                    'id' => $rootNode->getId(),
                    'type' => $type,
                    'text' => $nodeTranslation->getTitle(),
                    'li_attr' => ['class' => 'js-url-chooser-link-select', 'data-slug' => $slug, 'data-id' => $rootNode->getId()],
                ];

                if ($rootNode->getChildren()->count()) {
                    if ($depth - 1) {
                        $root['children'] = $this->nodesToArray($locale, $rootNode->getChildren(), --$depth);
                    } else {
                        $root['children'] = true;
                    }
                }
                $results[] = $root;
            }
        }

        return $results;
    }
}


1		<?php
2
3		namespace Kunstmaan\NodeBundle\Controller;
4
5		use Doctrine\Common\Collections\ArrayCollection;
6		use Doctrine\ORM\EntityManagerInterface;
7		use Kunstmaan\MultiDomainBundle\Helper\DomainConfiguration;
8		use Kunstmaan\NodeBundle\Entity\Node;
9		use Kunstmaan\NodeBundle\Entity\NodeTranslation;
10		use Kunstmaan\NodeBundle\Entity\StructureNode;
11		use Symfony\Component\Routing\Annotation\Route;
12		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
13		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
14		use Symfony\Component\HttpFoundation\JsonResponse;
15		use Symfony\Component\HttpFoundation\Request;
16
17		/**
18		* WidgetsController
19		*/
20		class WidgetsController extends Controller
		0 ignored issues – show Deprecated Code introduced 2019-05-13 08:29 UTC by Report Bug Copy Issue Report The class `Symfony\Bundle\Framework...e\Controller\Controller` has been deprecated with message: since Symfony 4.2, use "Symfony\Bundle\FrameworkBundle\Controller\AbstractController" instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
21		{
22		/**
23		* @Route("/ckselecturl", name="KunstmaanNodeBundle_ckselecturl")
24		* @Template("KunstmaanNodeBundle:Widgets:selectLink.html.twig")
25		*
26		* @param \Symfony\Component\HttpFoundation\Request $request
27		*
28		* @return array
29		*/
30	View Code Duplication	public function ckSelectLinkAction(Request $request)
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
31		{
32		$params = $this->getTemplateParameters($request);
33		$params['cke'] = true;
34		$params['multilanguage'] = $this->getParameter('kunstmaan_admin.multi_language');
35
36		return $params;
37		}
38
39		/**
40		* Select a link
41		*
42		* @Route("/selecturl", name="KunstmaanNodeBundle_selecturl")
43		* @Template("KunstmaanNodeBundle:Widgets:selectLink.html.twig")
44		*
45		* @param \Symfony\Component\HttpFoundation\Request $request
46		*
47		* @return array
48		*/
49	View Code Duplication	public function selectLinkAction(Request $request)
		0 ignored issues – show Duplication introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
50		{
51		$params = $this->getTemplateParameters($request);
52		$params['cke'] = false;
53		$params['multilanguage'] = $this->getParameter('kunstmaan_admin.multi_language');
54
55		return $params;
56		}
57
58		/**
59		* Select a link
60		*
61		* @Route("/select-nodes-lazy_search", name="KunstmaanNodeBundle_nodes_lazy_search")
62		*
63		* @param \Symfony\Component\HttpFoundation\Request $request
64		*
65		* @return JsonResponse
66		*/
67		public function selectNodesLazySearch(Request $request)
68		{
69		@trigger_error(sprintf('The "%s" controller action is deprecated in KunstmaanNodeBundle 5.1 and will be removed in KunstmaanNodeBundle 6.0.', __METHOD__), E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2018-04-18 14:49 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
70
71		/* @var EntityManagerInterface $em */
72		$em = $this->getDoctrine()->getManager();
73		$locale = $request->getLocale();
74		$search = $request->query->get('str');
75
76		$results = [];
77		if ($search) {
78		$nts = $em->getRepository('KunstmaanNodeBundle:NodeTranslation')->getNodeTranslationsLikeTitle($search, $locale);
79		/** @var NodeTranslation $nt */
80		foreach ($nts as $nt) {
81		$node = $nt->getNode();
82		$results[] = $node->getId();
83		while ($node->getParent()) {
84		$node = $node->getParent();
85		$results[] = $node->getId();
86		}
87		}
88		$results = array_unique($results);
89		sort($results);
90		}
91
92		return new JsonResponse($results);
93		}
94
95		/**
96		* Select a link
97		*
98		* @Route("/select-nodes-lazy", name="KunstmaanNodeBundle_nodes_lazy")
99		*
100		* @param \Symfony\Component\HttpFoundation\Request $request
101		*
102		* @return JsonResponse
103		*/
104		public function selectNodesLazy(Request $request)
105		{
106		/* @var EntityManagerInterface $em */
107		$em = $this->getDoctrine()->getManager();
108		$locale = $request->getLocale();
109		$id = $request->query->get('id');
110		$depth = $this->getParameter('kunstmaan_node.url_chooser.lazy_increment');
111
112		if (!$id \|\| $id == '#') {
113		$domainConfig = $this->get('kunstmaan_admin.domain_configuration');
114
115		if ($domainConfig->isMultiDomainHost()) {
116		$switchedHost = $domainConfig->getHostSwitched();
117		$rootItems = [$domainConfig->getRootNode($switchedHost['host'])];
118		} else {
119		$rootItems = $em->getRepository('KunstmaanNodeBundle:Node')->getAllTopNodes();
120		}
121		} else {
122		$rootItems = $em->getRepository('KunstmaanNodeBundle:Node')->find($id)->getChildren();
123		}
124
125		$results = $this->nodesToArray($locale, $rootItems, $depth);
126
127		return new JsonResponse($results);
128		}
129
130		/**
131		* Get the parameters needed in the template. This is common for the
132		* default link chooser and the cke link chooser.
133		*
134		* @param \Symfony\Component\HttpFoundation\Request $request
135		*
136		* @return array
		0 ignored issues – show Documentation introduced 2018-09-26 07:17 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string\|null>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
137		*/
138		private function getTemplateParameters(Request $request)
139		{
140		// When the media bundle is available, we show a link in the header to the media chooser
141		$allBundles = $this->getParameter('kernel.bundles');
142		$mediaChooserLink = null;
143
144		if (\array_key_exists('KunstmaanMediaBundle', $allBundles)) {
145		$params = ['linkChooser' => 1];
146		$cKEditorFuncNum = $request->get('CKEditorFuncNum');
147		if (!empty($cKEditorFuncNum)) {
148		$params['CKEditorFuncNum'] = $cKEditorFuncNum;
149		}
150		$mediaChooserLink = $this->generateUrl(
151		'KunstmaanMediaBundle_chooser',
152		$params
153		);
154		}
155
156		return [
157		'mediaChooserLink' => $mediaChooserLink,
158		];
159		}
160
161		/**
162		* Determine if current node is a structure node.
163		*
164		* @param string $refEntityName
165		*
166		* @return bool
167		*/
168		protected function isStructureNode($refEntityName)
169		{
170		$structureNode = false;
171		if (class_exists($refEntityName)) {
172		$page = new $refEntityName();
173		$structureNode = ($page instanceof StructureNode);
174		unset($page);
175		}
176
177		return $structureNode;
178		}
179
180		/**
181		* Determine if current node is a structure node.
182		*
183		* @param string $locale
184		* @param Node[]\|ArrayCollection $rootNodes
185		* @param int $depth
186		*
187		* @return array
188		*/
189		protected function nodesToArray($locale, $rootNodes, $depth = 2)
190		{
191		/** @var DomainConfiguration $domainconfig */
192		$domainconfig = $this->get('kunstmaan_admin.domain_configuration');
193		$isMultiDomain = $domainconfig->isMultiDomainHost();
194		$switchedHost = $domainconfig->getHostSwitched();
195		$switched = $domainconfig->getHost() == $switchedHost['host'];
196
197		$results = [];
198
199		/** @var Node $rootNode */
200		foreach ($rootNodes as $rootNode) {
201		if ($nodeTranslation = $rootNode->getNodeTranslation($locale, true)) {
202		if ($isMultiDomain && !$switched) {
203		$slug = sprintf('[%s:%s]', $switchedHost['id'], 'NT'.$nodeTranslation->getId());
204		} else {
205		$slug = sprintf('[%s]', 'NT'.$nodeTranslation->getId());
206		}
207
208		switch (true) {
209		case !$nodeTranslation->isOnline():
210		$type = 'offline';
211
212		break;
213		case $rootNode->isHiddenFromNav():
214		$type = 'hidden-from-nav';
215
216		break;
217		default:
218		$type = 'default';
219		}
220
221		$root = [
222		'id' => $rootNode->getId(),
223		'type' => $type,
224		'text' => $nodeTranslation->getTitle(),
225		'li_attr' => ['class' => 'js-url-chooser-link-select', 'data-slug' => $slug, 'data-id' => $rootNode->getId()],
226		];
227
228		if ($rootNode->getChildren()->count()) {
229		if ($depth - 1) {
230		$root['children'] = $this->nodesToArray($locale, $rootNode->getChildren(), --$depth);
231		} else {
232		$root['children'] = true;
233		}
234		}
235		$results[] = $root;
236		}
237		}
238
239		return $results;
240		}
241		}
242

Kunstmaan / KunstmaanBundlesCMS

Push — master ( aba493...5356ed )

WidgetsController::selectLinkAction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like