CachesController::getCacheDetails() - Code Metrics - Inspection of "Rework for occ 78 occ 79 occ 80" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — development (#812)

unknown

created 2021-01-13 10:56 UTC

CachesController::getCacheDetails() B

↳ Parent: CachesController

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	6
nop	3
dl	0
loc	68
rs	8.0759
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace Oc\Controller\Backend;

use Doctrine\DBAL\Connection;
use Form\CachesFormType;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Oc\Repository\Exception\RecordAlreadyExistsException;
use Oc\Repository\Exception\RecordNotFoundException;
use Oc\Repository\Exception\RecordNotPersistedException;
use Oc\Repository\Exception\RecordsNotFoundException;
use Oc\Repository\CachesRepository;
use Oc\Repository\UserRepository;
use Oc\Repository\SecurityRolesRepository;
use Oc\Entity\CachesEntity;

class CachesController extends AbstractController
{
    /**
     * @Route("/caches", name="caches_index")
     */
    public function index(Connection $connection, Request $request)
    : Response {
        $fetchedCaches = '0';

        // create input field for caches_by_searchfield
        $form = $this->createForm(CachesFormType::class);

        // see: https://symfonycasts.com/screencast/symfony-forms/form-submit
        // handles the request (submit-button of the form), but only if there is a POST request
        $form->handleRequest($request);
        // if is true only if there is a request submitted and it is valid
        if ($form->isSubmitted() && $form->isValid()) {
            // read content of form input field
            $inputData = $form->getData();

            // send request to DB
            $fetchedCaches = $this->getCachesForSearchField($connection, $inputData["content_caches_searchfield"]);
        }

        if ($fetchedCaches === '0') {
            return $this->render('backend/caches/index.html.twig', ['cachesForm' => $form->createView()]);
        } else {
            return $this->render(
                'backend/caches/basicsearch.html.twig', [
                                                          'cachesForm' => $form->createView(),
                                                          'caches_by_searchfield' => $fetchedCaches
                                                      ]
            );
        }
    }

    /**
     * @Route("/cache/{wpID}", name="cache_by_wp_oc_gc")
     */
    public function search_by_cache_wp(Connection $connection, string $wpID)
    : Response {
        $fetchedCaches = $this->getCacheDetails($connection, $wpID);

        return $this->render('backend/caches/detailsearch.html.twig', ['cache_by_id' => $fetchedCaches]);
    }

    /**
     *
     */
    function getCachesForSearchField(Connection $connection, string $searchtext)
    : array {
        //      so sieht die SQL-Vorlage aus..
        //        SELECT cache_id, name, wp_oc, user.username
        //        FROM caches
        //        INNER JOIN user ON caches.user_id = user.user_id
        //        WHERE wp_oc         =       "' . $searchtext . '"
        //        OR wp_gc            =       "' . $searchtext . '"
        //        OR caches.name     LIKE    "%' . $searchtext . '%"'
        $qb = $connection->createQueryBuilder();
        $qb
            ->select('caches.cache_id', 'caches.name', 'caches.wp_oc', 'caches.wp_gc', 'user.username')
            ->from('caches')
            ->innerJoin('caches', 'user', 'user', 'caches.user_id = user.user_id')
            ->where('caches.wp_oc = :searchTerm')
            ->orWhere('caches.wp_gc = :searchTerm')
            ->orWhere('caches.name LIKE :searchTermLIKE')
            ->setParameters(['searchTerm' => $searchtext, 'searchTermLIKE' => '%' . $searchtext . '%'])
            ->orderBy('caches.wp_oc', 'ASC');

        $result = $qb->execute()->fetchAll();

        return $result;
    }

    /**
     * getCacheDetails_Nr3: Suche mittels Suchtext (Wegpunkte, Cachename) oder cache_id
     * Grundidee: diese Funktion holt sich die Daten über die fetch-Funktionen im Repository und
     *            ergänzt weitere Angaben aus anderen Tabellen, indem in den Entitys Beziehungen zwischen den Tabellen
     *            geknüpft werden (ManyToOne, OneToMany, ..)
     * Das konnte ich aber nicht wie gewollt implementieren.
     */
    function getCacheDetails_Nr3(Connection $connection, string $wpID = "", int $cacheId = 0)

    : array {
        $fetchedCaches = [];
//        $fetchedCache = [];
//
//        if ($cacheId != 0) {
//            $request = new CachesRepository($connection);
//
//            $fetchedCache = $request->fetchOneBy(['cache_id' => $cacheId]);
//
//            if ($fetchedCache) {
//                $wpID = $fetchedCache->getOCid();
//            }
//        }
//
//        if ($wpID != "") {
//            $request = new CachesRepository($connection);
//            $fetchedCache = $request->fetchOneBy(['wp_OC' => $wpID]);
//
//            if ($fetchedCache) {
//                $fetchedCaches = $fetchedCache->convertEntityToArray();
//            }
//        }

//        dd($fetchedCaches);
//        die();

        return $fetchedCaches;
    }

    /**
     * getCacheDetails_Nr2: Suche mittels der cache_id
     * Alternative zu getCacheDetails() ??
     */
    function getCacheDetails_Nr2(Connection $connection, int $cacheId)
    : array {
        $fetchedCache = [];
        $securityRolesRepository = new SecurityRolesRepository($connection);

        if ($cacheId != 0) {
            $requestCache = new CachesRepository($connection);
            $fetchedCache = $requestCache->fetchOneBy(['cache_id' => $cacheId]);

            if ($fetchedCache) {
                // ersetze caches.user_id mit user.username
                $requestUser = new UserRepository($connection, $securityRolesRepository);
                $fetchedUser = $requestUser->fetchOneById(intval($fetchedCache->getUserId()));

                $fetchedCache->setUserId($fetchedUser->getUsername());

                // ersetze caches.status mit cache_status.name
                // ..

                // ersetze caches.type mit cache_type.name
                // ..

                // ersetze caches.size mit cache_size.name
                // ..

                // ?? ..
            }
        }

        dd($fetchedCache);
        die();

        return $fetchedCache;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    /**
     * getCacheDetails: Suche mittels Suchtext (Wegpunkte, Cachename) oder cache_id
     * Grundidee: diese Funktion baut sich die SQL-Anweisung selbst zusammen und holt die Daten aus der DB.
     */
    function getCacheDetails(Connection $connection, string $searchText = "", int $cacheId = 0)
    : array {
        $fetchedCaches = [];

        if ($cacheId != 0) {
            $request = new CachesRepository($connection);

            $fetchedCache = $request->fetchOneBy(['cache_id' => $cacheId]);

            if ($fetchedCache) {
                $searchText = $fetchedCache->getOCid();
            }
        }

        if ($searchText != "") {
            //      so sieht die SQL-Vorlage aus..
            //            SELECT caches.cache_id, caches.name, caches.wp_oc, caches.wp_gc,
            //                   caches.date_hidden, caches.date_created, caches.is_publishdate, caches.latitude, caches.longitude,
            //                   caches.difficulty, caches.terrain, caches.size, caches.logpw,
            //                   cache_status.name as cache_status_name, cache_type.icon_large as cache_type_picture,
            //                   cache_size.name as cache_size_name, user.username
            //            FROM caches
            //            INNER JOIN user ON caches.user_id = user.user_id
            //            INNER JOIN cache_status ON caches.status = cache_status.id
            //            INNER JOIN cache_type ON caches.type = cache_type.id
            //            INNER JOIN cache_size ON caches.size = cache_size.id
            //            WHERE caches.wp_oc         = "' . $searchtext . '"
            $qb = $connection->createQueryBuilder();
            $qb
                ->select('caches.cache_id', 'caches.name', 'caches.wp_oc', 'caches.wp_gc')
                ->addSelect('caches.date_hidden', 'caches.date_created', 'caches.is_publishdate', 'caches.latitude', 'caches.longitude')
                ->addSelect('caches.difficulty', 'caches.terrain', 'caches.size', 'caches.logpw')
                ->addSelect('cache_status.name as cache_status_name', 'cache_type.icon_large as cache_type_picture')
                ->addSelect('cache_size.name as cache_size_name', 'user.username')
                ->from('caches')
                ->innerJoin('caches', 'user', 'user', 'caches.user_id = user.user_id')
                ->innerJoin('caches', 'cache_status', 'cache_status', 'caches.status = cache_status.id')
                ->innerJoin('caches', 'cache_type', 'cache_type', 'caches.type = cache_type.id')
                ->innerJoin('caches', 'cache_size', 'cache_size', 'caches.size = cache_size.id')
                ->where('caches.wp_oc = :searchTerm')
                ->setParameters(['searchTerm' => $searchText])
                ->orderBy('caches.wp_oc', 'DESC');

            $fetchedCaches = $qb->execute()->fetchAll();

            $array_size = count($fetchedCaches);
            for ($i = 0; $i < $array_size; $i ++) {
                // replace existing log passwords with something different
                // nur der Teil mit den Bilderzuweisungen müsste nochmal überdacht werden..
                if ($fetchedCaches[$i]["logpw"] != "") {
                    $fetchedCaches[$i]["logpw"] = 1;
                } else {
                    $fetchedCaches[$i]["logpw"] = 0;
                }

                // replace cache type information with picture links
                // auch hier müsste die Bildzuweisung nochmal überarbeitet werden..
                $fetchedCaches[$i]["cache_type_picture"] =
                    "https://www.opencaching.de/resource2/ocstyle/images/cacheicon/"
                    . $fetchedCaches[$i]["cache_type_picture"];
            }
        }

        //dd($fetchedCaches);
        //die();

        return $fetchedCaches;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Oc\Controller\Backend;
6
7			use Doctrine\DBAL\Connection;
8			use Form\CachesFormType;
9			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
10			use Symfony\Component\HttpFoundation\Request;
11			use Symfony\Component\HttpFoundation\Response;
12			use Symfony\Component\Routing\Annotation\Route;
13			use Oc\Repository\Exception\RecordAlreadyExistsException;
14			use Oc\Repository\Exception\RecordNotFoundException;
15			use Oc\Repository\Exception\RecordNotPersistedException;
16			use Oc\Repository\Exception\RecordsNotFoundException;
17			use Oc\Repository\CachesRepository;
18			use Oc\Repository\UserRepository;
19			use Oc\Repository\SecurityRolesRepository;
20			use Oc\Entity\CachesEntity;
21
22			class CachesController extends AbstractController
23			{
24			/**
25			* @Route("/caches", name="caches_index")
26			*/
27			public function index(Connection $connection, Request $request)
28			: Response {
29			$fetchedCaches = '0';
30
31			// create input field for caches_by_searchfield
32			$form = $this->createForm(CachesFormType::class);
33
34			// see: https://symfonycasts.com/screencast/symfony-forms/form-submit
35			// handles the request (submit-button of the form), but only if there is a POST request
36			$form->handleRequest($request);
37			// if is true only if there is a request submitted and it is valid
38			if ($form->isSubmitted() && $form->isValid()) {
39			// read content of form input field
40			$inputData = $form->getData();
41
42			// send request to DB
43			$fetchedCaches = $this->getCachesForSearchField($connection, $inputData["content_caches_searchfield"]);
44			}
45
46			if ($fetchedCaches === '0') {
47			return $this->render('backend/caches/index.html.twig', ['cachesForm' => $form->createView()]);
48			} else {
49			return $this->render(
50			'backend/caches/basicsearch.html.twig', [
51			'cachesForm' => $form->createView(),
52			'caches_by_searchfield' => $fetchedCaches
53			]
54			);
55			}
56			}
57
58			/**
59			* @Route("/cache/{wpID}", name="cache_by_wp_oc_gc")
60			*/
61			public function search_by_cache_wp(Connection $connection, string $wpID)
62			: Response {
63			$fetchedCaches = $this->getCacheDetails($connection, $wpID);
64
65			return $this->render('backend/caches/detailsearch.html.twig', ['cache_by_id' => $fetchedCaches]);
66			}
67
68			/**
69			*
70			*/
71			function getCachesForSearchField(Connection $connection, string $searchtext)
72			: array {
73			// so sieht die SQL-Vorlage aus..
74			// SELECT cache_id, name, wp_oc, user.username
75			// FROM caches
76			// INNER JOIN user ON caches.user_id = user.user_id
77			// WHERE wp_oc = "' . $searchtext . '"
78			// OR wp_gc = "' . $searchtext . '"
79			// OR caches.name LIKE "%' . $searchtext . '%"'
80			$qb = $connection->createQueryBuilder();
81			$qb
82			->select('caches.cache_id', 'caches.name', 'caches.wp_oc', 'caches.wp_gc', 'user.username')
83			->from('caches')
84			->innerJoin('caches', 'user', 'user', 'caches.user_id = user.user_id')
85			->where('caches.wp_oc = :searchTerm')
86			->orWhere('caches.wp_gc = :searchTerm')
87			->orWhere('caches.name LIKE :searchTermLIKE')
88			->setParameters(['searchTerm' => $searchtext, 'searchTermLIKE' => '%' . $searchtext . '%'])
89			->orderBy('caches.wp_oc', 'ASC');
90
91			$result = $qb->execute()->fetchAll();
92
93			return $result;
94			}
95
96			/**
97			* getCacheDetails_Nr3: Suche mittels Suchtext (Wegpunkte, Cachename) oder cache_id
98			* Grundidee: diese Funktion holt sich die Daten über die fetch-Funktionen im Repository und
99			* ergänzt weitere Angaben aus anderen Tabellen, indem in den Entitys Beziehungen zwischen den Tabellen
100			* geknüpft werden (ManyToOne, OneToMany, ..)
101			* Das konnte ich aber nicht wie gewollt implementieren.
102			*/
103			function getCacheDetails_Nr3(Connection $connection, string $wpID = "", int $cacheId = 0)
			0 ignored issues – show Unused Code introduced 2021-01-11 16:54 UTC by Report Bug Copy Issue Report The parameter `$connection` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2021-01-11 16:54 UTC by Report Bug Copy Issue Report The parameter `$wpID` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2021-01-11 16:54 UTC by Report Bug Copy Issue Report The parameter `$cacheId` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
104			: array {
105			$fetchedCaches = [];
106			// $fetchedCache = [];
107			//
108			// if ($cacheId != 0) {
109			// $request = new CachesRepository($connection);
110			//
111			// $fetchedCache = $request->fetchOneBy(['cache_id' => $cacheId]);
112			//
113			// if ($fetchedCache) {
114			// $wpID = $fetchedCache->getOCid();
115			// }
116			// }
117			//
118			// if ($wpID != "") {
119			// $request = new CachesRepository($connection);
120			// $fetchedCache = $request->fetchOneBy(['wp_OC' => $wpID]);
121			//
122			// if ($fetchedCache) {
123			// $fetchedCaches = $fetchedCache->convertEntityToArray();
124			// }
125			// }
126
127			// dd($fetchedCaches);
128			// die();
129
130			return $fetchedCaches;
131			}
132
133			/**
134			* getCacheDetails_Nr2: Suche mittels der cache_id
135			* Alternative zu getCacheDetails() ??
136			*/
137			function getCacheDetails_Nr2(Connection $connection, int $cacheId)
138			: array {
139			$fetchedCache = [];
140			$securityRolesRepository = new SecurityRolesRepository($connection);
141
142			if ($cacheId != 0) {
143			$requestCache = new CachesRepository($connection);
144			$fetchedCache = $requestCache->fetchOneBy(['cache_id' => $cacheId]);
145
146			if ($fetchedCache) {
147			// ersetze caches.user_id mit user.username
148			$requestUser = new UserRepository($connection, $securityRolesRepository);
149			$fetchedUser = $requestUser->fetchOneById(intval($fetchedCache->getUserId()));
150
151			$fetchedCache->setUserId($fetchedUser->getUsername());
152
153			// ersetze caches.status mit cache_status.name
154			// ..
155
156			// ersetze caches.type mit cache_type.name
157			// ..
158
159			// ersetze caches.size mit cache_size.name
160			// ..
161
162			// ?? ..
163			}
164			}
165
166			dd($fetchedCache);
167			die();
168
169			return $fetchedCache;
			0 ignored issues – show Unused Code introduced 2021-01-11 16:54 UTC by Report Bug Copy Issue Report `return $fetchedCache;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
170			}
171
172			/**
173			* getCacheDetails: Suche mittels Suchtext (Wegpunkte, Cachename) oder cache_id
174			* Grundidee: diese Funktion baut sich die SQL-Anweisung selbst zusammen und holt die Daten aus der DB.
175			*/
176			function getCacheDetails(Connection $connection, string $searchText = "", int $cacheId = 0)
177			: array {
178			$fetchedCaches = [];
179
180			if ($cacheId != 0) {
181			$request = new CachesRepository($connection);
182
183			$fetchedCache = $request->fetchOneBy(['cache_id' => $cacheId]);
184
185			if ($fetchedCache) {
186			$searchText = $fetchedCache->getOCid();
187			}
188			}
189
190			if ($searchText != "") {
191			// so sieht die SQL-Vorlage aus..
192			// SELECT caches.cache_id, caches.name, caches.wp_oc, caches.wp_gc,
193			// caches.date_hidden, caches.date_created, caches.is_publishdate, caches.latitude, caches.longitude,
194			// caches.difficulty, caches.terrain, caches.size, caches.logpw,
195			// cache_status.name as cache_status_name, cache_type.icon_large as cache_type_picture,
196			// cache_size.name as cache_size_name, user.username
197			// FROM caches
198			// INNER JOIN user ON caches.user_id = user.user_id
199			// INNER JOIN cache_status ON caches.status = cache_status.id
200			// INNER JOIN cache_type ON caches.type = cache_type.id
201			// INNER JOIN cache_size ON caches.size = cache_size.id
202			// WHERE caches.wp_oc = "' . $searchtext . '"
203			$qb = $connection->createQueryBuilder();
204			$qb
205			->select('caches.cache_id', 'caches.name', 'caches.wp_oc', 'caches.wp_gc')
206			->addSelect('caches.date_hidden', 'caches.date_created', 'caches.is_publishdate', 'caches.latitude', 'caches.longitude')
207			->addSelect('caches.difficulty', 'caches.terrain', 'caches.size', 'caches.logpw')
208			->addSelect('cache_status.name as cache_status_name', 'cache_type.icon_large as cache_type_picture')
209			->addSelect('cache_size.name as cache_size_name', 'user.username')
210			->from('caches')
211			->innerJoin('caches', 'user', 'user', 'caches.user_id = user.user_id')
212			->innerJoin('caches', 'cache_status', 'cache_status', 'caches.status = cache_status.id')
213			->innerJoin('caches', 'cache_type', 'cache_type', 'caches.type = cache_type.id')
214			->innerJoin('caches', 'cache_size', 'cache_size', 'caches.size = cache_size.id')
215			->where('caches.wp_oc = :searchTerm')
216			->setParameters(['searchTerm' => $searchText])
217			->orderBy('caches.wp_oc', 'DESC');
218
219			$fetchedCaches = $qb->execute()->fetchAll();
220
221			$array_size = count($fetchedCaches);
222			for ($i = 0; $i < $array_size; $i ++) {
223			// replace existing log passwords with something different
224			// nur der Teil mit den Bilderzuweisungen müsste nochmal überdacht werden..
225			if ($fetchedCaches[$i]["logpw"] != "") {
226			$fetchedCaches[$i]["logpw"] = 1;
227			} else {
228			$fetchedCaches[$i]["logpw"] = 0;
229			}
230
231			// replace cache type information with picture links
232			// auch hier müsste die Bildzuweisung nochmal überarbeitet werden..
233			$fetchedCaches[$i]["cache_type_picture"] =
234			"https://www.opencaching.de/resource2/ocstyle/images/cacheicon/"
235			. $fetchedCaches[$i]["cache_type_picture"];
236			}
237			}
238
239			//dd($fetchedCaches);
240			//die();
241
242			return $fetchedCaches;
243			}
244			}
245

OpencachingDeutschland / oc-server3

Pull Request — development (#812)

CachesController::getCacheDetails() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like