NewIncludeExcludeStructureUpdate::updateNecessary() - Code Metrics - Inspection of "TYPO3 10 compatibility" - lochmueller/calendarize - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#397)

unknown

created 2020-06-10 17:13 UTC

updateNecessary() A

↳ Parent: NewIncludeExcludeStructureUpdate

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * NewIncludeExcludeStructureUpdate.
 */
declare(strict_types=1);

namespace HDNET\Calendarize\Updates;

use HDNET\Calendarize\Domain\Model\ConfigurationInterface;
use HDNET\Calendarize\Utility\HelperUtility;
use TYPO3\CMS\Install\Updates\DatabaseUpdatedPrerequisite;
use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;

/**
 * NewIncludeExcludeStructureUpdate.
 */
class NewIncludeExcludeStructureUpdate implements UpgradeWizardInterface
{
    /**
     * The human-readable title of the upgrade wizard.
     *
     * @var string
     */
    protected $title = 'Migrate the calendarize configurations to the new include/exclude/override/cutout structure';

    /**
     * Checks whether updates are required.
     *
     * @param string &$description The description for the update
     *
     * @return bool Whether an update is required (TRUE) or not (FALSE)
     */
    public function checkForUpdate(&$description)
    {
        $table = 'tx_calendarize_domain_model_configuration';

        $q = HelperUtility::getDatabaseConnection($table)->createQueryBuilder();

        $q->count('handling')
            ->from($table)
            ->where(
                $q->expr()->orX(
                    $q->expr()->eq('handling', $q->quote('')),
                    $q->expr()->isNull('handling')
                )
            );

        $count = $q->execute()->fetchColumn(0);

        if ($count > 0) {
            $description = 'We will update ' . $count . ' calendarize configurations';

            return true;
        }

        return false;
    }

    /**
     * Performs the accordant updates.
     *
     * @param array &$dbQueries      Queries done in this update
     * @param mixed &$customMessages Custom messages
     *
     * @return bool Whether everything went smoothly or not
     */
    public function executeUpdate() : bool
    {
        $table = 'tx_calendarize_domain_model_configuration';

        $q = HelperUtility::getDatabaseConnection($table)->createQueryBuilder();
        $q->update($table)
            ->where(
                $q->expr()->eq('type', $q->quote('timeExclude'))
            )
            ->set('type', ConfigurationInterface::TYPE_TIME)
            ->set('handling', ConfigurationInterface::HANDLING_INCLUDE);

        $dbQueries[] = $q->getSQL();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $q->execute();

        $q->resetQueryParts();

        $q->update($table)
            ->where(
                $q->expr()->eq('type', $q->quote('include'))
            )
            ->set('type', ConfigurationInterface::TYPE_GROUP)
            ->set('handling', ConfigurationInterface::HANDLING_INCLUDE);

        $dbQueries[] = $q->getSQL();
        $q->execute();

        $q->resetQueryParts();

        $q->update($table)
            ->where(
                $q->expr()->eq('type', $q->quote('exclude'))
            )
            ->set('type', ConfigurationInterface::TYPE_GROUP)
            ->set('handling', ConfigurationInterface::HANDLING_EXCLUDE);

        $dbQueries[] = $q->getSQL();
        $q->execute();

        $q->resetQueryParts();

        $q->update($table)
            ->where(
                $q->expr()->orX(
                    $q->expr()->eq('handling', $q->quote('')),
                    $q->expr()->isNull('handling')
                )
            )
            ->set('handling', ConfigurationInterface::HANDLING_INCLUDE);

        $dbQueries[] = $q->getSQL();
        $q->execute();

        $customMessages = 'All queries are done! :)';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return true;
    }

    public function getIdentifier(): string
    {
        return "calendarizeNewIncludeExcludeStructureUpdate";
    }

    public function getTitle(): string
    {
        return "";
    }

    public function getDescription(): string
    {
        return "";
    }

    public function updateNecessary(): bool
    {
        return false;
    }

    public function getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class
        ];
    }

}


1			<?php
2
3			/**
4			* NewIncludeExcludeStructureUpdate.
5			*/
6			declare(strict_types=1);
7
8			namespace HDNET\Calendarize\Updates;
9
10			use HDNET\Calendarize\Domain\Model\ConfigurationInterface;
11			use HDNET\Calendarize\Utility\HelperUtility;
12			use TYPO3\CMS\Install\Updates\DatabaseUpdatedPrerequisite;
13			use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;
14
15			/**
16			* NewIncludeExcludeStructureUpdate.
17			*/
18			class NewIncludeExcludeStructureUpdate implements UpgradeWizardInterface
19			{
20			/**
21			* The human-readable title of the upgrade wizard.
22			*
23			* @var string
24			*/
25			protected $title = 'Migrate the calendarize configurations to the new include/exclude/override/cutout structure';
26
27			/**
28			* Checks whether updates are required.
29			*
30			* @param string &$description The description for the update
31			*
32			* @return bool Whether an update is required (TRUE) or not (FALSE)
33			*/
34			public function checkForUpdate(&$description)
35			{
36			$table = 'tx_calendarize_domain_model_configuration';
37
38			$q = HelperUtility::getDatabaseConnection($table)->createQueryBuilder();
39
40			$q->count('handling')
41			->from($table)
42			->where(
43			$q->expr()->orX(
44			$q->expr()->eq('handling', $q->quote('')),
45			$q->expr()->isNull('handling')
46			)
47			);
48
49			$count = $q->execute()->fetchColumn(0);
50
51			if ($count > 0) {
52			$description = 'We will update ' . $count . ' calendarize configurations';
53
54			return true;
55			}
56
57			return false;
58			}
59
60			/**
61			* Performs the accordant updates.
62			*
63			* @param array &$dbQueries Queries done in this update
64			* @param mixed &$customMessages Custom messages
65			*
66			* @return bool Whether everything went smoothly or not
67			*/
68			public function executeUpdate() : bool
69			{
70			$table = 'tx_calendarize_domain_model_configuration';
71
72			$q = HelperUtility::getDatabaseConnection($table)->createQueryBuilder();
73			$q->update($table)
74			->where(
75			$q->expr()->eq('type', $q->quote('timeExclude'))
76			)
77			->set('type', ConfigurationInterface::TYPE_TIME)
78			->set('handling', ConfigurationInterface::HANDLING_INCLUDE);
79
80			$dbQueries[] = $q->getSQL();
			0 ignored issues – show Coding Style Comprehensibility introduced 2020-06-10 17:16 UTC by Report Bug Copy Issue Report `$dbQueries` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$dbQueries = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
81			$q->execute();
82
83			$q->resetQueryParts();
84
85			$q->update($table)
86			->where(
87			$q->expr()->eq('type', $q->quote('include'))
88			)
89			->set('type', ConfigurationInterface::TYPE_GROUP)
90			->set('handling', ConfigurationInterface::HANDLING_INCLUDE);
91
92			$dbQueries[] = $q->getSQL();
93			$q->execute();
94
95			$q->resetQueryParts();
96
97			$q->update($table)
98			->where(
99			$q->expr()->eq('type', $q->quote('exclude'))
100			)
101			->set('type', ConfigurationInterface::TYPE_GROUP)
102			->set('handling', ConfigurationInterface::HANDLING_EXCLUDE);
103
104			$dbQueries[] = $q->getSQL();
105			$q->execute();
106
107			$q->resetQueryParts();
108
109			$q->update($table)
110			->where(
111			$q->expr()->orX(
112			$q->expr()->eq('handling', $q->quote('')),
113			$q->expr()->isNull('handling')
114			)
115			)
116			->set('handling', ConfigurationInterface::HANDLING_INCLUDE);
117
118			$dbQueries[] = $q->getSQL();
119			$q->execute();
120
121			$customMessages = 'All queries are done! :)';
			0 ignored issues – show Unused Code introduced 2020-06-10 17:16 UTC by Report Bug Copy Issue Report `$customMessages` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
122
123			return true;
124			}
125
126			public function getIdentifier(): string
127			{
128			return "calendarizeNewIncludeExcludeStructureUpdate";
129			}
130
131			public function getTitle(): string
132			{
133			return "";
134			}
135
136			public function getDescription(): string
137			{
138			return "";
139			}
140
141			public function updateNecessary(): bool
142			{
143			return false;
144			}
145
146			public function getPrerequisites(): array
147			{
148			return [
149			DatabaseUpdatedPrerequisite::class
150			];
151			}
152
153			}
154

lochmueller / calendarize

Pull Request — master (#397)

updateNecessary() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like