MailerModuleInstaller::upgrade() - Code Metrics - Inspection of "Extension installer refactor (#4125)" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e8ce57...2ef872 )

by Craig

created 2020-02-10 17:24 UTC

MailerModuleInstaller::upgrade() F

↳ Parent: MailerModuleInstaller

Complexity

Conditions	14
Paths	720

Size

Total Lines	65
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
eloc	46
nc	720
nop	1
dl	0
loc	65
rs	2.4888
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\MailerModule;

use Doctrine\Persistence\ManagerRegistry;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Contracts\Translation\TranslatorInterface;
use Zikula\Bundle\CoreBundle\Doctrine\Helper\SchemaHelper;
use Zikula\Bundle\CoreBundle\DynamicConfigDumper;
use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;
use Zikula\ExtensionsModule\AbstractExtension;
use Zikula\ExtensionsModule\Api\ApiInterface\VariableApiInterface;
use Zikula\ExtensionsModule\Entity\ExtensionVarEntity;
use Zikula\ExtensionsModule\Installer\AbstractExtensionInstaller;

/**
 * Installation and upgrade routines for the mailer module.
 */
class MailerModuleInstaller extends AbstractExtensionInstaller
{
    /**
     * @var ZikulaHttpKernelInterface
     */
    private $kernel;

    /**
     * @var DynamicConfigDumper
     */
    private $configDumper;

    public function __construct(
        ZikulaHttpKernelInterface $kernel,
        DynamicConfigDumper $configDumper,
        AbstractExtension $extension,
        ManagerRegistry $managerRegistry,
        SchemaHelper $schemaTool,
        RequestStack $requestStack,
        TranslatorInterface $translator,
        VariableApiInterface $variableApi
    ) {
        $this->kernel = $kernel;
        $this->configDumper = $configDumper;
        parent::__construct($extension, $managerRegistry, $schemaTool, $requestStack, $translator, $variableApi);
    }

    public function install(): bool
    {
        $this->setVars($this->getDefaults());

        // Initialisation successful
        return true;
    }

    public function upgrade(string $oldVersion): bool
    {
        // Upgrade dependent on old version number
        switch ($oldVersion) {
            case '1.3.1':
                $this->setVar('smtpsecuremethod', 'ssl');

            case '1.3.2':
                // clear old modvars
                // use manual method because getVars() is not available during system upgrade
                $modVarEntities = $this->managerRegistry->getRepository(ExtensionVarEntity::class)->findBy(['modname' => $this->name]);
                $modVars = [];
                foreach ($modVarEntities as $var) {
                    $modVars[$var['name']] = $var['value'];
                }
                $this->delVars();
                $this->setVarWithDefault('charset', $modVars['charset']);
                $this->setVarWithDefault('encoding', $modVars['encoding']);
                $this->setVarWithDefault('html', $modVars['html']);
                $this->setVarWithDefault('wordwrap', $modVars['wordwrap']);
                // new modvar for 1.4.0
                $this->setVarWithDefault('enableLogging', false);

                // write the config file
                $mailerTypeConversion = [
                    1 => 'mail',
                    2 => 'sendmail',
                    3 => 'mail',
                    4 => 'smtp',
                    5 => 'mail',
                ];
                $config = [
                    'transport' => $mailerTypeConversion[$modVars['mailertype']],
                    'username' => $modVars['smtpusername'],
                    'password' => $modVars['smtppassword'],
                    'host' => $modVars['smtpserver'],
                    'port' => $modVars['smtpport'],
                    'encryption' => isset($modVars['smtpsecuremethod']) && in_array($modVars['smtpsecuremethod'], ['ssl', 'tls']) ? $modVars['smtpsecuremethod'] : 'ssl',
                    'auth_mode' => !empty($modVars['auth']) ? 'login' : null,
                    'spool' => ['type' => 'memory'],
                    'delivery_addresses' => [],
                    'disable_delivery' => 5 === $modVars['mailertype'],
                ];
                $this->configDumper->setConfiguration('swiftmailer', $config);
            case '1.4.0':
                $config = $this->configDumper->getConfiguration('swiftmailer');
                // remove spool parameter
                unset($config['spool']);
                $this->configDumper->setConfiguration('swiftmailer', $config);
            case '1.4.1':
                // install subscriber hooks
            case '1.4.2':
                $config = $this->configDumper->getConfiguration('swiftmailer');
                // delivery_address has changed to an array named delivery_addresses
                $config['delivery_addresses'] = !empty($config['delivery_address']) ? [$config['delivery_address']] : [];
                unset($config['delivery_address']);
            $this->configDumper->setConfiguration('swiftmailer', $config);
            case '1.4.3':
                // nothing
            case '1.5.0':
            case '1.5.1':
                // future upgrade routines
        }

        // Update successful
        return true;
    }

    public function uninstall(): bool
    {
        // Delete any module variables
        $this->delVars();

        // Deletion successful
        return true;
    }

    /**
     * Default module vars.
     */
    private function getDefaults(): array
    {
        return [
            'charset' => $this->kernel->getCharset(),
            'encoding' => '8bit',
            'html' => false,
            'wordwrap' => 50,
            'enableLogging' => false
        ];
    }

    /**
     * Set the module var but if it is not set, use the default instead.
     *
     * @param mixed $value
     */
    private function setVarWithDefault(string $key, $value = null): void
    {
        if (isset($value)) {
            $this->setVar($key, $value);
        }
        $defaults = $this->getDefaults();
        $this->setVar($key, $defaults[$key]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Zikula package.
7			*
8			* Copyright Zikula Foundation - https://ziku.la/
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Zikula\MailerModule;
15
16			use Doctrine\Persistence\ManagerRegistry;
17			use Symfony\Component\HttpFoundation\RequestStack;
18			use Symfony\Contracts\Translation\TranslatorInterface;
19			use Zikula\Bundle\CoreBundle\Doctrine\Helper\SchemaHelper;
20			use Zikula\Bundle\CoreBundle\DynamicConfigDumper;
21			use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;
22			use Zikula\ExtensionsModule\AbstractExtension;
23			use Zikula\ExtensionsModule\Api\ApiInterface\VariableApiInterface;
24			use Zikula\ExtensionsModule\Entity\ExtensionVarEntity;
25			use Zikula\ExtensionsModule\Installer\AbstractExtensionInstaller;
26
27			/**
28			* Installation and upgrade routines for the mailer module.
29			*/
30			class MailerModuleInstaller extends AbstractExtensionInstaller
31			{
32			/**
33			* @var ZikulaHttpKernelInterface
34			*/
35			private $kernel;
36
37			/**
38			* @var DynamicConfigDumper
39			*/
40			private $configDumper;
41
42			public function __construct(
43			ZikulaHttpKernelInterface $kernel,
44			DynamicConfigDumper $configDumper,
45			AbstractExtension $extension,
46			ManagerRegistry $managerRegistry,
47			SchemaHelper $schemaTool,
48			RequestStack $requestStack,
49			TranslatorInterface $translator,
50			VariableApiInterface $variableApi
51			) {
52			$this->kernel = $kernel;
53			$this->configDumper = $configDumper;
54			parent::__construct($extension, $managerRegistry, $schemaTool, $requestStack, $translator, $variableApi);
55			}
56
57			public function install(): bool
58			{
59			$this->setVars($this->getDefaults());
60
61			// Initialisation successful
62			return true;
63			}
64
65			public function upgrade(string $oldVersion): bool
66			{
67			// Upgrade dependent on old version number
68			switch ($oldVersion) {
69			case '1.3.1':
70			$this->setVar('smtpsecuremethod', 'ssl');
			0 ignored issues – show Coding Style Comprehensibility introduced 2019-03-17 07:27 UTC by Report Bug Copy Issue Report Consider adding a comment if this fall-through is intended. Loading history...
71			case '1.3.2':
72			// clear old modvars
73			// use manual method because getVars() is not available during system upgrade
74			$modVarEntities = $this->managerRegistry->getRepository(ExtensionVarEntity::class)->findBy(['modname' => $this->name]);
75			$modVars = [];
76			foreach ($modVarEntities as $var) {
77			$modVars[$var['name']] = $var['value'];
78			}
79			$this->delVars();
80			$this->setVarWithDefault('charset', $modVars['charset']);
81			$this->setVarWithDefault('encoding', $modVars['encoding']);
82			$this->setVarWithDefault('html', $modVars['html']);
83			$this->setVarWithDefault('wordwrap', $modVars['wordwrap']);
84			// new modvar for 1.4.0
85			$this->setVarWithDefault('enableLogging', false);
86
87			// write the config file
88			$mailerTypeConversion = [
89			1 => 'mail',
90			2 => 'sendmail',
91			3 => 'mail',
92			4 => 'smtp',
93			5 => 'mail',
94			];
95			$config = [
96			'transport' => $mailerTypeConversion[$modVars['mailertype']],
97			'username' => $modVars['smtpusername'],
98			'password' => $modVars['smtppassword'],
99			'host' => $modVars['smtpserver'],
100			'port' => $modVars['smtpport'],
101			'encryption' => isset($modVars['smtpsecuremethod']) && in_array($modVars['smtpsecuremethod'], ['ssl', 'tls']) ? $modVars['smtpsecuremethod'] : 'ssl',
102			'auth_mode' => !empty($modVars['auth']) ? 'login' : null,
103			'spool' => ['type' => 'memory'],
104			'delivery_addresses' => [],
105			'disable_delivery' => 5 === $modVars['mailertype'],
106			];
107			$this->configDumper->setConfiguration('swiftmailer', $config);
108			case '1.4.0':
109			$config = $this->configDumper->getConfiguration('swiftmailer');
110			// remove spool parameter
111			unset($config['spool']);
112			$this->configDumper->setConfiguration('swiftmailer', $config);
113			case '1.4.1':
114			// install subscriber hooks
115			case '1.4.2':
116			$config = $this->configDumper->getConfiguration('swiftmailer');
117			// delivery_address has changed to an array named delivery_addresses
118			$config['delivery_addresses'] = !empty($config['delivery_address']) ? [$config['delivery_address']] : [];
119			unset($config['delivery_address']);
120			$this->configDumper->setConfiguration('swiftmailer', $config);
121			case '1.4.3':
122			// nothing
123			case '1.5.0':
124			case '1.5.1':
125			// future upgrade routines
126			}
127
128			// Update successful
129			return true;
130			}
131
132			public function uninstall(): bool
133			{
134			// Delete any module variables
135			$this->delVars();
136
137			// Deletion successful
138			return true;
139			}
140
141			/**
142			* Default module vars.
143			*/
144			private function getDefaults(): array
145			{
146			return [
147			'charset' => $this->kernel->getCharset(),
148			'encoding' => '8bit',
149			'html' => false,
150			'wordwrap' => 50,
151			'enableLogging' => false
152			];
153			}
154
155			/**
156			* Set the module var but if it is not set, use the default instead.
157			*
158			* @param mixed $value
159			*/
160			private function setVarWithDefault(string $key, $value = null): void
161			{
162			if (isset($value)) {
163			$this->setVar($key, $value);
164			}
165			$defaults = $this->getDefaults();
166			$this->setVar($key, $defaults[$key]);
167			}
168			}
169

zikula / core

Push — master ( e8ce57...2ef872 )

MailerModuleInstaller::upgrade() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like