ModuleLoader - Code Metrics - Inspection of "[FEATURE] Possible override of module configuratio..." - fabarea/vidi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3ff228...f62711 )

by Fabien

created 2016-07-20 10:39 UTC

ModuleLoader D

↳ Parent: Project

Complexity

Total Complexity

117

Size/Duplication

Total Lines	1024
Duplicated Lines	12.5 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	12
Bugs	0	Features	1

Metric	Value
wmc	117
c	12
b	0
f	1
lcom	1
cbo	3
dl	128
loc	1024
rs	4.4357

68 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	43	1
A	isRegistered()	0	5	1
A	getExistingInternalConfiguration()	0	7	2
A	getExistingMainConfiguration()	0	5	2
A	computeMainModule()	0	13	3
A	computeDefaultPid()	0	13	3
A	computeAdditionalJavaScriptFiles()	12	12	2
A	computeAdditionalStyleSheetFiles()	12	12	2
A	computeComponents()	0	5	1
B	register()	0	51	4
A	getSignature()	0	4	1
A	copeWithPageTree()	0	4	1
A	getCurrentPid()	0	4	2
B	getVidiModuleCode()	0	37	6
A	getModuleUrl()	0	17	4
A	getModuleAbsoluteUrl()	0	4	1
A	getParameterPrefix()	0	4	1
B	getModuleConfiguration()	0	24	4
A	setIcon()	0	5	1
A	getIcon()	15	15	3
A	setMainModule()	0	5	1
A	getMainModule()	0	7	2
A	setModuleLanguageFile()	0	5	1
A	getModuleLanguageFile()	13	13	3
A	setPosition()	0	5	1
A	getPosition()	0	4	1
A	addJavaScriptFiles()	0	7	2
A	addJavaScriptFile()	0	5	1
A	addStyleSheetFiles()	0	7	2
A	addStyleSheetFile()	0	5	1
A	getDataType()	0	7	2
A	getDataTypes()	0	8	2
A	setDataType()	0	5	1
A	getDefaultPid()	0	7	2
A	setDefaultPid()	0	5	1
A	showPageTree()	0	5	1
A	isShown()	0	5	1
A	getDocHeaderTopLeftComponents()	0	5	1
A	setDocHeaderTopLeftComponents()	0	5	1
A	addDocHeaderTopLeftComponents()	9	9	2
A	getDocHeaderTopRightComponents()	0	5	1
A	setDocHeaderTopRightComponents()	0	5	1
A	addDocHeaderTopRightComponents()	9	9	2
A	getDocHeaderBottomLeftComponents()	0	5	1
A	setDocHeaderBottomLeftComponents()	0	5	1
A	addDocHeaderBottomLeftComponents()	9	9	2
A	getDocHeaderBottomRightComponents()	0	5	1
A	setDocHeaderBottomRightComponents()	0	5	1
A	addDocHeaderBottomRightComponents()	9	9	2
A	getGridTopComponents()	0	5	1
A	setGridTopComponents()	0	5	1
A	addGridTopComponents()	9	9	2
A	getGridBottomComponents()	0	5	1
A	setGridBottomComponents()	0	5	1
A	addGridBottomComponents()	9	9	2
A	getGridButtonsComponents()	0	5	1
A	setGridButtonsComponents()	0	5	1
A	addGridButtonsComponents()	9	9	2
A	getMenuMassActionComponents()	0	5	1
A	setMenuMassActionComponents()	0	5	1
A	addMenuMassActionComponents()	0	9	2
A	getAccess()	13	13	3
A	setAccess()	0	5	1
A	getAdditionalJavaScriptFiles()	0	7	2
A	getAdditionalStyleSheetFiles()	0	7	2
A	getComponents()	0	4	1
A	hasPlugin()	0	11	4
A	getInternalModuleSignature()	0	8	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ModuleLoader often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ModuleLoader, and based on these observations, apply Extract Interface, too.

<?php
namespace Fab\Vidi\Module;

/**
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Utility\ExtensionUtility;
use Fab\Vidi\Exception\InvalidKeyInArrayException;
use Fab\Vidi\Service\BackendUserPreferenceService;

/**
 * Service class used in other extensions to register a vidi based backend module.
 */
class ModuleLoader
{

    /**
     * Define the default main module
     */
    const DEFAULT_MAIN_MODULE = 'content';

    /**
     * Define the default pid
     */
    const DEFAULT_PID = 0;

    /**
     * The type of data being listed (which corresponds to a table name in TCA)
     *
     * @var string
     */
    protected $dataType;

    /**
     * @var string
     */
    protected $defaultPid;

    /**
     * @var bool
     */
    protected $showPageTree = false;

    /**
     * @var bool
     */
    protected $isShown = true;

    /**
     * @var string
     */
    protected $access;

    /**
     * @var string
     */
    protected $mainModule;

    /**
     * @var string
     */
    protected $position = '';

    /**
     * @var string
     */
    protected $icon;

    /**
     * @var string
     */
    protected $moduleLanguageFile;

    /**
     * The module key such as m1, m2.
     *
     * @var string
     */
    protected $moduleKey = 'm1';

    /**
     * @var string[]
     */
    protected $additionalJavaScriptFiles = [];

    /**
     * @var string[]
     */
    protected $additionalStyleSheetFiles = [];

    /**
     * @var array
     */
    protected $components = [];

    /**
     * @param string $dataType
     */
    public function __construct($dataType = null)
    {
        $this->dataType = $dataType;

        // Initialize components
        $this->components = [
            ModulePosition::DOC_HEADER => [
                ModulePosition::TOP => [
                    ModulePosition::LEFT => [],
                    ModulePosition::RIGHT => [
                        'Fab\Vidi\View\Button\ToolButton',
                    ],
                ],
                ModulePosition::BOTTOM => [
                    ModulePosition::LEFT => [
                        'Fab\Vidi\View\Button\NewButton',
                        'Fab\Vidi\ViewHelpers\Link\BackViewHelper',
                    ],
                    ModulePosition::RIGHT => [],
                ],
            ],
            ModulePosition::GRID => [
                ModulePosition::TOP => [
                    'Fab\Vidi\View\Check\PidCheck',
                    'Fab\Vidi\View\Check\RelationsCheck',
                    'Fab\Vidi\View\Tab\DataTypeTab',
                ],
                ModulePosition::BUTTONS => [
                    'Fab\Vidi\View\Button\EditButton',
                    'Fab\Vidi\View\Button\DeleteButton',
                ],
                ModulePosition::BOTTOM => [],
            ],
            ModulePosition::MENU_MASS_ACTION => [
                'Fab\Vidi\View\MenuItem\ExportXlsMenuItem',
                'Fab\Vidi\View\MenuItem\ExportXmlMenuItem',
                'Fab\Vidi\View\MenuItem\ExportCsvMenuItem',
                'Fab\Vidi\View\MenuItem\DividerMenuItem',
                'Fab\Vidi\View\MenuItem\MassDeleteMenuItem',
                #'Fab\Vidi\View\MenuItem\MassEditMenuItem',
            ],
        ];
    }

    /**
     * Tell whether a module is already registered.
     *
     * @param string $dataType
     * @return bool
     */
    public function isRegistered($dataType)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $internalModuleSignature = $this->getInternalModuleSignature($dataType);
        return !empty($GLOBALS['TBE_MODULES_EXT']['vidi'][$internalModuleSignature]);
    }

    /**
     * @return array
     */
    protected function getExistingInternalConfiguration()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $internalModuleSignature = $this->getInternalModuleSignature();
        return is_array($GLOBALS['TBE_MODULES_EXT']['vidi'][$internalModuleSignature])
            ? $GLOBALS['TBE_MODULES_EXT']['vidi'][$internalModuleSignature]
            : [];
    }

    /**
     * @return array
     */
    protected function getExistingMainConfiguration()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $possibleConfiguration = $GLOBALS['TBE_MODULES']['_configuration']['Vidi_' . $this->getInternalModuleSignature()];
        return is_array($possibleConfiguration) ? $possibleConfiguration : [];
    }

    /**
     * @return string
     */
    protected function computeMainModule()
    {
        $existingConfiguration = $this->getExistingInternalConfiguration();

        if ($this->mainModule !== null) {
            $mainModule = $this->mainModule;
        } elseif ($existingConfiguration['mainModule']) { // existing configuration may override.
            $mainModule = $existingConfiguration['mainModule'];
        } else {
            $mainModule = self::DEFAULT_MAIN_MODULE; //default value.
        }
        return $mainModule;
    }

    /**
     * @return string
     */
    protected function computeDefaultPid()
    {
        $existingConfiguration = $this->getExistingInternalConfiguration();

        if ($this->defaultPid !== null) {
            $defaultPid = $this->defaultPid;
        } elseif ($existingConfiguration['defaultPid']) { // existing configuration may override.
            $defaultPid = $existingConfiguration['defaultPid'];
        } else {
            $defaultPid = self::DEFAULT_PID; //default value.
        }
        return $defaultPid;
    }

    /**
     * @return array
     */
    protected function computeAdditionalJavaScriptFiles()

    {
        $additionalJavaScriptFiles = $this->additionalJavaScriptFiles;

        // Possible merge of existing javascript files.
        $existingConfiguration = $this->getExistingInternalConfiguration();
        if ($existingConfiguration['additionalJavaScriptFiles']) {
            $additionalJavaScriptFiles = array_merge($additionalJavaScriptFiles, $existingConfiguration['additionalJavaScriptFiles']);
        }

        return $additionalJavaScriptFiles;
    }

    /**
     * @return array
     */
    protected function computeAdditionalStyleSheetFiles()

    {
        $additionalStyleSheetFiles = $this->additionalStyleSheetFiles;

        // Possible merge of existing style sheets.
        $existingConfiguration = $this->getExistingInternalConfiguration();
        if ($existingConfiguration['additionalStyleSheetFiles']) {
            $additionalStyleSheetFiles = array_merge($additionalStyleSheetFiles, $existingConfiguration['additionalStyleSheetFiles']);
        }

        return $additionalStyleSheetFiles;
    }

    /**
     * @return array
     */
    protected function computeComponents()
    {
        // We override the config in any case. See if we need more than that.
        return $this->components;
    }

    /**
     * Register the module in two places: core + vidi internal.
     *
     * @return void
     * @throws \InvalidArgumentException
     */
    public function register()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Internal Vidi module registration.
        $configuration = [];
        $configuration['dataType'] = $this->dataType;
        $configuration['mainModule'] = $this->computeMainModule();
        $configuration['defaultPid'] = $this->computeDefaultPid();
        $configuration['additionalJavaScriptFiles'] = $this->computeAdditionalJavaScriptFiles();
        $configuration['additionalStyleSheetFiles'] = $this->computeAdditionalStyleSheetFiles();
        $configuration['components'] = $this->computeComponents();

        $internalModuleSignature = $this->getInternalModuleSignature();
        $GLOBALS['TBE_MODULES_EXT']['vidi'][$internalModuleSignature] = $configuration;

        // Core module registration.
        // Register and displays module in the BE only if told, default is "true".
        if ($this->isShown) {

            $moduleConfiguration = [];
            #$moduleConfiguration['routeTarget'] = \Fab\Vidi\Controller\ContentController::class . '::mainAction', // what to do here?

            $moduleConfiguration['access'] = $this->getAccess();
            $moduleConfiguration['labels'] = $this->getModuleLanguageFile();
            $icon = $this->getIcon();
            if ($icon) {
                $moduleConfiguration['icon'] = $icon;
            }

            if ($this->showPageTree) {
                $moduleConfiguration['navigationComponentId'] = 'typo3-pagetree';
                $moduleConfiguration['inheritNavigationComponentFromMainModule'] = false;
            } else {
                $moduleConfiguration['inheritNavigationComponentFromMainModule'] = true;
            }

            ExtensionUtility::registerModule(
                'Fab.vidi',
                $this->mainModule,
                $this->dataType . '_' . $this->moduleKey,
                $this->position,
                [
                    'Content' => 'index, list, delete, update, edit, copy, move, localize, sort, copyClipboard, moveClipboard',
                    'Tool' => 'welcome, work',
                    'Facet' => 'autoSuggest, autoSuggests',
                    'Selection' => 'edit, update, create, delete, list, show',
                    'UserPreferences' => 'save',
                    'Clipboard' => 'save, flush, show',
                ],
                $moduleConfiguration
            );
        }
    }

    /**
     * Return the module code for a BE module.
     *
     * @return string
     */
    public function getSignature()
    {
        return GeneralUtility::_GP(Parameter::MODULE);
    }

    /**
     * Tell whether the current module is the list one.
     *
     * @return bool
     */
    public function copeWithPageTree()
    {
        return GeneralUtility::_GP(Parameter::MODULE) === 'web_VidiM1';
    }

    /**
     * Returns the current pid.
     *
     * @return bool
     */
    public function getCurrentPid()
    {
        return GeneralUtility::_GET(Parameter::PID) > 0 ? (int)GeneralUtility::_GET(Parameter::PID) : 0;
    }

    /**
     * Return the Vidi module code which is stored in TBE_MODULES_EXT
     *
     * @return string
     */
    public function getVidiModuleCode()
    {

        if ($this->copeWithPageTree()) {
            $userPreferenceKey = sprintf('Vidi_pid_%s', $this->getCurrentPid());

            if (GeneralUtility::_GP(Parameter::SUBMODULE)) {
                $subModuleCode = GeneralUtility::_GP(Parameter::SUBMODULE);
                BackendUserPreferenceService::getInstance()->set($userPreferenceKey, $subModuleCode);
            } else {

                $defaultModuleCode = BackendUserPreferenceService::getInstance()->get($userPreferenceKey);
                if (empty($defaultModuleCode)) {
                    $defaultModuleCode = 'VidiTtContentM1'; // hard-coded submodule
                    BackendUserPreferenceService::getInstance()->set($userPreferenceKey, $defaultModuleCode);
                }

                $vidiModules = ModuleService::getInstance()->getModulesForCurrentPid();

                if (empty($vidiModules)) {
                    $subModuleCode = $defaultModuleCode;
                } elseif (isset($vidiModules[$defaultModuleCode])) {
                    $subModuleCode = $defaultModuleCode;
                } else {
                    $subModuleCode = ModuleService::getInstance()->getFirstModuleForPid($this->getCurrentPid());
                }
            }
        } else {
            $moduleCode = $this->getSignature();

            // Remove first part which is separated "_"
            $delimiter = strpos($moduleCode, '_') + 1;
            $subModuleCode = substr($moduleCode, $delimiter);
        }

        return $subModuleCode;
    }

    /**
     * Return the module URL.
     *
     * @param array $additionalParameters
     * @param bool $absoluteUrl
     * @return string
     */
    public function getModuleUrl(array $additionalParameters = [], $absoluteUrl = false)
    {
        $moduleCode = $this->getSignature();

        // Add possible submodule if current module has page tree.
        if ($this->copeWithPageTree() && !isset($additionalParameters[Parameter::SUBMODULE])) {
            $additionalParameters[Parameter::SUBMODULE] = $this->getVidiModuleCode();
        }

        // And don't forget the pid!
        if (GeneralUtility::_GET(Parameter::PID)) {
            $additionalParameters[Parameter::PID] = GeneralUtility::_GET(Parameter::PID);
        }

        $moduleUrl = BackendUtility::getModuleUrl($moduleCode, $additionalParameters, false, $absoluteUrl);
        return $moduleUrl;
    }

    /**
     * Return the module absolute URL.
     *
     * @param array $additionalParameters
     * @return string
     */
    public function getModuleAbsoluteUrl(array $additionalParameters = [])
    {
        return $this->getModuleUrl($additionalParameters, true);
    }

    /**
     * Return the parameter prefix for a BE module.
     *
     * @return string
     */
    public function getParameterPrefix()
    {
        return 'tx_vidi_' . strtolower($this->getSignature());
    }

    /**
     * Return a configuration key or the entire module configuration array if not key is given.
     *
     * @param string $key
     * @throws InvalidKeyInArrayException
     * @return mixed
     */
    public function getModuleConfiguration($key = '')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {

        $vidiModuleCode = $this->getVidiModuleCode();

        // Module code must exist
        if (empty($GLOBALS['TBE_MODULES_EXT']['vidi'][$vidiModuleCode])) {
            $message = sprintf('Invalid or not existing module code "%s"', $vidiModuleCode);
            throw new InvalidKeyInArrayException($message, 1375092053);
        }

        $result = $GLOBALS['TBE_MODULES_EXT']['vidi'][$vidiModuleCode];

        if (!empty($key)) {
            if (isset($result[$key])) {
                $result = $result[$key];
            } else {
                // key must exist
                $message = sprintf('Invalid key configuration "%s"', $key);
                throw new InvalidKeyInArrayException($message, 1375092054);
            }
        }
        return $result;
    }

    /**
     * @param string $icon
     * @return $this
     */
    public function setIcon($icon)
    {
        $this->icon = $icon;
        return $this;
    }

    /**
     * @return string
     */
    protected function getIcon()

    {
        $moduleConfiguration = $this->getExistingMainConfiguration();


        if ($this->icon) {
            $icon = $this->icon;
        } elseif ($moduleConfiguration['icon']) { // existing configuration may override.
            $icon = $moduleConfiguration['icon'];
        } else {
            $icon = ''; //default value.
        }

        return $icon;
    }

    /**
     * @param string $mainModule
     * @return $this
     */
    public function setMainModule($mainModule)
    {
        $this->mainModule = $mainModule;
        return $this;
    }

    /**
     * @return string
     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getMainModule()
    {
        if ($this->mainModule === null) {
            $this->mainModule = $this->getModuleConfiguration('mainModule');
        }
        return $this->mainModule;
    }

    /**
     * @param string $moduleLanguageFile
     * @return $this
     */
    public function setModuleLanguageFile($moduleLanguageFile)
    {
        $this->moduleLanguageFile = $moduleLanguageFile;
        return $this;
    }

    /**
     * @return string
     */
    protected function getModuleLanguageFile()

    {
        $moduleConfiguration = $this->getExistingMainConfiguration();

        if ($this->moduleLanguageFile !== null) {
            $moduleLanguageFile = $this->moduleLanguageFile;
        } elseif ($moduleConfiguration['moduleLanguageFile']) { // existing configuration may override.
            $moduleLanguageFile = $moduleConfiguration['moduleLanguageFile'];
        } else {
            $moduleLanguageFile = 'LLL:EXT:vidi/Resources/Private/Language/locallang_module.xlf'; //default value.
        }
        return $moduleLanguageFile;
    }

    /**
     * @param string $position
     * @return $this
     */
    public function setPosition($position)
    {
        $this->position = $position;
        return $this;
    }

    /**
     * @return string
     */
    public function getPosition()
    {
        return $this->position;
    }

    /**
     * @param array $files
     * @return $this
     */
    public function addJavaScriptFiles(array $files)
    {
        foreach ($files as $file) {
            $this->additionalJavaScriptFiles[] = $file;
        }
        return $this;
    }

    /**
     * @param string $fileNameAndPath
     * @return $this
     */
    public function addJavaScriptFile($fileNameAndPath)
    {
        $this->additionalJavaScriptFiles[] = $fileNameAndPath;
        return $this;
    }

    /**
     * @param array $files
     * @return $this
     */
    public function addStyleSheetFiles(array $files)
    {
        foreach ($files as $file) {
            $this->additionalStyleSheetFiles[] = $file;
        }
        return $this;
    }

    /**
     * @param string $fileNameAndPath
     * @return $this
     */
    public function addStyleSheetFile($fileNameAndPath)
    {
        $this->additionalStyleSheetFiles[] = $fileNameAndPath;
        return $this;
    }

    /**
     * @return string
     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDataType()
    {
        if (is_null($this->dataType)) {
            $this->dataType = $this->getModuleConfiguration('dataType');
        }
        return $this->dataType;
    }

    /**
     * @return array
     */
    public function getDataTypes()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $dataTypes = [];
        foreach ($GLOBALS['TBE_MODULES_EXT']['vidi'] as $module) {
            $dataTypes[] = $module['dataType'];
        }
        return $dataTypes;
    }

    /**
     * @param string $dataType
     * @return $this
     */
    public function setDataType($dataType)
    {
        $this->dataType = $dataType;
        return $this;
    }

    /**
     * @return string
     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDefaultPid()
    {
        if (empty($this->defaultPid)) {
            $this->defaultPid = $this->getModuleConfiguration('defaultPid');
        }
        return $this->defaultPid;
    }

    /**
     * @param string $defaultPid
     * @return $this
     */
    public function setDefaultPid($defaultPid)
    {
        $this->defaultPid = $defaultPid;
        return $this;
    }

    /**
     * @param bool $isPageTreeShown
     * @return $this
     */
    public function showPageTree($isPageTreeShown)
    {
        $this->showPageTree = $isPageTreeShown;
        return $this;
    }

    /**
     * @param string $isShown
     * @return $this
     */
    public function isShown($isShown)
    {
        $this->isShown = $isShown;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDocHeaderTopLeftComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::LEFT];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setDocHeaderTopLeftComponents(array $components)
    {
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::LEFT] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addDocHeaderTopLeftComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::LEFT];
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::LEFT] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDocHeaderTopRightComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::RIGHT];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setDocHeaderTopRightComponents(array $components)
    {
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::RIGHT] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addDocHeaderTopRightComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::RIGHT];
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::TOP][ModulePosition::RIGHT] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDocHeaderBottomLeftComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::LEFT];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setDocHeaderBottomLeftComponents(array $components)
    {
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::LEFT] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addDocHeaderBottomLeftComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::LEFT];
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::LEFT] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getDocHeaderBottomRightComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::RIGHT];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setDocHeaderBottomRightComponents(array $components)
    {
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::RIGHT] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addDocHeaderBottomRightComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::RIGHT];
        $this->components[ModulePosition::DOC_HEADER][ModulePosition::BOTTOM][ModulePosition::RIGHT] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getGridTopComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::GRID][ModulePosition::TOP];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setGridTopComponents(array $components)
    {
        $this->components[ModulePosition::GRID][ModulePosition::TOP] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addGridTopComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::GRID][ModulePosition::TOP];
        $this->components[ModulePosition::GRID][ModulePosition::TOP] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getGridBottomComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::GRID][ModulePosition::BOTTOM];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setGridBottomComponents(array $components)
    {
        $this->components[ModulePosition::GRID][ModulePosition::BOTTOM] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addGridBottomComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::GRID][ModulePosition::BOTTOM];
        $this->components[ModulePosition::GRID][ModulePosition::BOTTOM] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getGridButtonsComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::GRID][ModulePosition::BUTTONS];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setGridButtonsComponents(array $components)
    {
        $this->components[ModulePosition::GRID][ModulePosition::BUTTONS] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addGridButtonsComponents($components)

    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::GRID][ModulePosition::BUTTONS];
        $this->components[ModulePosition::GRID][ModulePosition::BUTTONS] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return $array

     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getMenuMassActionComponents()
    {
        $configuration = $this->getModuleConfiguration();
        return $configuration['components'][ModulePosition::MENU_MASS_ACTION];
    }

    /**
     * @param array $components
     * @return $this
     */
    public function setMenuMassActionComponents(array $components)
    {
        $this->components[ModulePosition::MENU_MASS_ACTION] = $components;
        return $this;
    }

    /**
     * @param string|array $components
     * @return $this
     */
    public function addMenuMassActionComponents($components)
    {
        if (is_string($components)) {
            $components = [$components];
        }
        $currentComponents = $this->components[ModulePosition::MENU_MASS_ACTION];
        $this->components[ModulePosition::MENU_MASS_ACTION] = array_merge($currentComponents, $components);
        return $this;
    }

    /**
     * @return string
     */
    protected function getAccess()

    {
        $moduleConfiguration = $this->getExistingMainConfiguration();

        if ($this->access !== null) {
            $access = $this->access;
        } elseif ($moduleConfiguration['access']) { // existing configuration may override.
            $access = $moduleConfiguration['access'];
        } else {
            $access = Access::USER; //default value.
        }
        return $access;
    }

    /**
     * @param string $access
     * @return $this
     */
    public function setAccess($access)
    {
        $this->access = $access;
        return $this;
    }

    /**
     * @return \string[]
     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getAdditionalJavaScriptFiles()
    {
        if (empty($this->additionalJavaScriptFiles)) {
            $this->additionalJavaScriptFiles = $this->getModuleConfiguration('additionalJavaScriptFiles');

        }
        return $this->additionalJavaScriptFiles;
    }

    /**
     * @return \string[]
     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
     */
    public function getAdditionalStyleSheetFiles()
    {
        if (empty($this->additionalStyleSheetFiles)) {
            $this->additionalStyleSheetFiles = $this->getModuleConfiguration('additionalStyleSheetFiles');

        }
        return $this->additionalStyleSheetFiles;
    }

    /**
     * @return array
     */
    public function getComponents()
    {
        return $this->components;
    }

    /**
     * @param string $pluginName
     * @return bool
     */
    public function hasPlugin($pluginName = '')
    {
        $parameterPrefix = $this->getParameterPrefix();
        $parameters = GeneralUtility::_GET($parameterPrefix);

        $hasPlugin = !empty($parameters['plugins']) && is_array($parameters['plugins']);
        if ($hasPlugin && $pluginName) {
            $hasPlugin = in_array($pluginName, $parameters['plugins']);
        }
        return $hasPlugin;
    }

    /**
     * Compute the internal module code
     *
     * @param null|string $dataType
     * @return string
     */
    protected function getInternalModuleSignature($dataType = null)
    {
        if ($dataType === null) {
            $dataType = $this->dataType;
        }
        $subModuleName = $dataType . '_' . $this->moduleKey;
        return 'Vidi' . GeneralUtility::underscoredToUpperCamelCase($subModuleName);
    }

}


fabarea / vidi