fabarea / vidi

Classes/Tool/AbstractTool.php

Indentation +32 added lines, -32 removed lines

@@ -18,40 +18,40 @@
  */
 abstract class AbstractTool implements ToolInterface
 {
-    /**
-     * @param string $templateNameAndPath
-     * @return StandaloneView
-     * @throws \InvalidArgumentException
-     */
-    protected function initializeStandaloneView($templateNameAndPath)
-    {
-        $templateNameAndPath = GeneralUtility::getFileAbsFileName($templateNameAndPath);
+	/**
+	 * @param string $templateNameAndPath
+	 * @return StandaloneView
+	 * @throws \InvalidArgumentException
+	 */
+	protected function initializeStandaloneView($templateNameAndPath)
+	{
+		$templateNameAndPath = GeneralUtility::getFileAbsFileName($templateNameAndPath);
 
-        /** @var StandaloneView $view */
-        $view = GeneralUtility::makeInstance(StandaloneView::class);
+		/** @var StandaloneView $view */
+		$view = GeneralUtility::makeInstance(StandaloneView::class);
 
-        $view->setTemplatePathAndFilename($templateNameAndPath);
-        return $view;
-    }
+		$view->setTemplatePathAndFilename($templateNameAndPath);
+		return $view;
+	}
 
-    /**
-     * Returns an instance of the current Backend User.
-     *
-     * @return BackendUserAuthentication
-     */
-    protected function getBackendUser()
-    {
-        return $GLOBALS['BE_USER'];
-    }
+	/**
+	 * Returns an instance of the current Backend User.
+	 *
+	 * @return BackendUserAuthentication
+	 */
+	protected function getBackendUser()
+	{
+		return $GLOBALS['BE_USER'];
+	}
 
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader
-     * @throws \InvalidArgumentException
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader
+	 * @throws \InvalidArgumentException
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 }

Classes/Tool/ModulePreferencesTool.php

Indentation +117 added lines, -117 removed lines

@@ -22,121 +22,121 @@
  */
 class ModulePreferencesTool extends AbstractTool
 {
-    /**
-     * Display the title of the tool on the welcome screen.
-     *
-     * @return string
-     */
-    public function getTitle()
-    {
-        return LocalizationUtility::translate(
-            'module_preferences_for',
-            'vidi',
-            array(Tca::table($this->getModuleLoader()->getDataType())->getTitle())
-        );
-    }
-
-    /**
-     * Display the description of the tool in the welcome screen.
-     *
-     * @return string
-     */
-    public function getDescription()
-    {
-        $templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ModulePreferences/Launcher.html';
-        $view = $this->initializeStandaloneView($templateNameAndPath);
-        $view->assign('sitePath', Environment::getPublicPath() . '/');
-        return $view->render();
-    }
-
-    /**
-     * Do the job!
-     *
-     * @param array $arguments
-     * @return string
-     */
-    public function work(array $arguments = array())
-    {
-        if (isset($arguments['save'])) {
-            // Revert visible <-> excluded
-            $excludedFields = array_diff(
-                Tca::grid()->getAllFieldNames(),
-                $arguments['excluded_fields'],
-                $this->getExcludedFieldsFromTca()
-            );
-            $arguments['excluded_fields'] = $excludedFields;
-            $this->getModulePreferences()->save($arguments);
-        }
-
-        $templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ModulePreferences/WorkResult.html';
-        $view = $this->initializeStandaloneView($templateNameAndPath);
-
-        $view->assign('title', Tca::table($this->getModuleLoader()->getDataType())->getTitle());
-
-        // Fetch the menu of visible items.
-        $menuVisibleItems = $this->getModulePreferences()->get(ConfigurablePart::MENU_VISIBLE_ITEMS);
-        $view->assign(ConfigurablePart::MENU_VISIBLE_ITEMS, $menuVisibleItems);
-
-        // Fetch the default number of menu visible items.
-        $menuDefaultVisible = $this->getModulePreferences()->get(ConfigurablePart::MENU_VISIBLE_ITEMS_DEFAULT);
-        $view->assign(ConfigurablePart::MENU_VISIBLE_ITEMS_DEFAULT, $menuDefaultVisible);
-
-        // Get the visible columns
-        $view->assign('columns', Tca::grid()->getAllFieldNames());
-
-        return $view->render();
-    }
-
-    /**
-     * @return array
-     */
-    protected function getExcludedFieldsFromTca()
-    {
-        $tca = Tca::grid()->getTca();
-        $excludedFields = [];
-        if (!empty($tca['excluded_fields'])) {
-            $excludedFields = GeneralUtility::trimExplode(',', $tca['excluded_fields'], true);
-        } elseif (!empty($tca['export']['excluded_fields'])) { // only for export for legacy reason.
-            $excludedFields = GeneralUtility::trimExplode(',', $tca['export']['excluded_fields'], true);
-        }
-        return $excludedFields;
-    }
-
-    /**
-     * Tell whether the tools should be displayed according to the context.
-     *
-     * @return bool
-     */
-    public function isShown()
-    {
-        return $this->getBackendUser()->isAdmin();
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader|object
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
-
-    /**
-     * @return ModulePreferences|object
-     */
-    protected function getModulePreferences()
-    {
-        return GeneralUtility::makeInstance(ModulePreferences::class);
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return GridAnalyserService|object
-     */
-    protected function getGridAnalyserService()
-    {
-        return GeneralUtility::makeInstance(GridAnalyserService::class);
-    }
+	/**
+	 * Display the title of the tool on the welcome screen.
+	 *
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		return LocalizationUtility::translate(
+			'module_preferences_for',
+			'vidi',
+			array(Tca::table($this->getModuleLoader()->getDataType())->getTitle())
+		);
+	}
+
+	/**
+	 * Display the description of the tool in the welcome screen.
+	 *
+	 * @return string
+	 */
+	public function getDescription()
+	{
+		$templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ModulePreferences/Launcher.html';
+		$view = $this->initializeStandaloneView($templateNameAndPath);
+		$view->assign('sitePath', Environment::getPublicPath() . '/');
+		return $view->render();
+	}
+
+	/**
+	 * Do the job!
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	public function work(array $arguments = array())
+	{
+		if (isset($arguments['save'])) {
+			// Revert visible <-> excluded
+			$excludedFields = array_diff(
+				Tca::grid()->getAllFieldNames(),
+				$arguments['excluded_fields'],
+				$this->getExcludedFieldsFromTca()
+			);
+			$arguments['excluded_fields'] = $excludedFields;
+			$this->getModulePreferences()->save($arguments);
+		}
+
+		$templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ModulePreferences/WorkResult.html';
+		$view = $this->initializeStandaloneView($templateNameAndPath);
+
+		$view->assign('title', Tca::table($this->getModuleLoader()->getDataType())->getTitle());
+
+		// Fetch the menu of visible items.
+		$menuVisibleItems = $this->getModulePreferences()->get(ConfigurablePart::MENU_VISIBLE_ITEMS);
+		$view->assign(ConfigurablePart::MENU_VISIBLE_ITEMS, $menuVisibleItems);
+
+		// Fetch the default number of menu visible items.
+		$menuDefaultVisible = $this->getModulePreferences()->get(ConfigurablePart::MENU_VISIBLE_ITEMS_DEFAULT);
+		$view->assign(ConfigurablePart::MENU_VISIBLE_ITEMS_DEFAULT, $menuDefaultVisible);
+
+		// Get the visible columns
+		$view->assign('columns', Tca::grid()->getAllFieldNames());
+
+		return $view->render();
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function getExcludedFieldsFromTca()
+	{
+		$tca = Tca::grid()->getTca();
+		$excludedFields = [];
+		if (!empty($tca['excluded_fields'])) {
+			$excludedFields = GeneralUtility::trimExplode(',', $tca['excluded_fields'], true);
+		} elseif (!empty($tca['export']['excluded_fields'])) { // only for export for legacy reason.
+			$excludedFields = GeneralUtility::trimExplode(',', $tca['export']['excluded_fields'], true);
+		}
+		return $excludedFields;
+	}
+
+	/**
+	 * Tell whether the tools should be displayed according to the context.
+	 *
+	 * @return bool
+	 */
+	public function isShown()
+	{
+		return $this->getBackendUser()->isAdmin();
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader|object
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
+
+	/**
+	 * @return ModulePreferences|object
+	 */
+	protected function getModulePreferences()
+	{
+		return GeneralUtility::makeInstance(ModulePreferences::class);
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return GridAnalyserService|object
+	 */
+	protected function getGridAnalyserService()
+	{
+		return GeneralUtility::makeInstance(GridAnalyserService::class);
+	}
 }

Classes/Tool/ToolRegistry.php

Indentation +169 added lines, -169 removed lines

@@ -18,173 +18,173 @@
  */
 class ToolRegistry implements SingletonInterface
 {
-    /**
-     * @var array
-     */
-    protected $tools = [];
-
-    /**
-     * @var array
-     */
-    protected $overriddenPermissions = [];
-
-    /**
-     * Returns a class instance.
-     *
-     * @return \Fab\Vidi\Tool\ToolRegistry|object
-     */
-    public static function getInstance()
-    {
-        return GeneralUtility::makeInstance(\Fab\Vidi\Tool\ToolRegistry::class);
-    }
-
-    /**
-     * Register a tool for a data type.
-     *
-     * @param string $dataType corresponds to the table name or can be "*" for all data types.
-     * @param string $toolName class name which must implement "ToolInterface".
-     * @return $this
-     */
-    public function register($dataType, $toolName)
-    {
-        if (!isset($this->tools[$dataType])) {
-            $this->tools[$dataType] = [];
-        }
-
-        $this->tools[$dataType][] = $toolName;
-        return $this;
-    }
-
-    /**
-     * Override permissions for a tool by passing a Closure that will be evaluated when checking permissions.
-     *
-     * @param string $dataType corresponds to the table name or can be "*" for all data types.
-     * @param string $toolName class name which must implement "ToolInterface".
-     * @param $permission
-     * @return $this
-     */
-    public function overridePermission($dataType, $toolName, Closure $permission)
-    {
-        if (empty($this->overriddenPermissions[$dataType])) {
-            $this->overriddenPermissions[$dataType] = [];
-        }
-
-        $this->overriddenPermissions[$dataType][$toolName] = $permission;
-        return $this;
-    }
-
-    /**
-     * Un-Register a tool for a given data type.
-     *
-     * @param string $dataType corresponds to the table name or can be "*" for all data types.
-     * @param string $toolName class name which must implement "ToolInterface".
-     * @return $this
-     */
-    public function unRegister($dataType, $toolName)
-    {
-        if ($this->hasTools($dataType, $toolName)) {
-            $toolPosition = array_search($toolName, $this->tools['*']);
-            if ($toolPosition !== false) {
-                unset($this->tools['*'][$toolPosition]);
-            }
-
-            $toolPosition = array_search($toolName, $this->tools[$dataType]);
-            if ($toolPosition !== false) {
-                unset($this->tools[$dataType][$toolPosition]);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Tell whether the given data type has any tools registered.
-     *
-     * @param string $dataType
-     * @return bool
-     */
-    public function hasAnyTools($dataType)
-    {
-        $tools = $this->getTools($dataType);
-        return !empty($tools);
-    }
-
-    /**
-     * Tell whether the given data type has this $tool.
-     *
-     * @param string $dataType
-     * @param string $tool
-     * @return bool
-     */
-    public function hasTools($dataType, $tool)
-    {
-        return in_array($tool, $this->tools['*']) || in_array($tool, $this->tools[$dataType]);
-    }
-
-    /**
-     * Tell whether the given tool is allowed for this data type.
-     *
-     * @param string $dataType
-     * @param string $toolName
-     * @return bool
-     */
-    public function isAllowed($dataType, $toolName)
-    {
-        $isAllowed = false;
-
-        if ($this->hasTools($dataType, $toolName)) {
-            $permission = $this->getOverriddenPermission($dataType, $toolName);
-            if (!is_null($permission)) {
-                $isAllowed = $permission();
-            } else {
-                /** @var ToolInterface $toolName */
-                $toolName = GeneralUtility::makeInstance($toolName);
-                $isAllowed = $toolName->isShown();
-            }
-        }
-        return $isAllowed;
-    }
-
-    /**
-     * Get Registered tools.
-     *
-     * @param string $dataType
-     * @return ToolInterface[]
-     */
-    public function getTools($dataType)
-    {
-        $tools = [];
-
-        foreach (array($dataType, '*') as $toolSource) {
-            if (isset($this->tools[$toolSource])) {
-                $toolNames = $this->tools[$toolSource];
-
-                foreach ($toolNames as $toolName) {
-                    /** @var ToolInterface $tool */
-                    if ($this->isAllowed($dataType, $toolName)) {
-                        $tools[] = GeneralUtility::makeInstance($toolName);
-                    }
-                }
-            }
-        }
-        return $tools;
-    }
-
-    /**
-     * Get the proper permission for a tool.
-     *
-     * @param string $dataType corresponds to the table name or can be "*" for all data types.
-     * @param string $toolName class name which must implement "ToolInterface".
-     * @return null|Closure
-     */
-    protected function getOverriddenPermission($dataType, $toolName)
-    {
-        $permission = null;
-        if (isset($this->overriddenPermissions[$dataType][$toolName])) {
-            $permission = $this->overriddenPermissions[$dataType][$toolName];
-        } elseif (isset($this->overriddenPermissions['*'][$toolName])) {
-            $permission = $this->overriddenPermissions['*'][$toolName];
-        }
-        return $permission;
-    }
+	/**
+	 * @var array
+	 */
+	protected $tools = [];
+
+	/**
+	 * @var array
+	 */
+	protected $overriddenPermissions = [];
+
+	/**
+	 * Returns a class instance.
+	 *
+	 * @return \Fab\Vidi\Tool\ToolRegistry|object
+	 */
+	public static function getInstance()
+	{
+		return GeneralUtility::makeInstance(\Fab\Vidi\Tool\ToolRegistry::class);
+	}
+
+	/**
+	 * Register a tool for a data type.
+	 *
+	 * @param string $dataType corresponds to the table name or can be "*" for all data types.
+	 * @param string $toolName class name which must implement "ToolInterface".
+	 * @return $this
+	 */
+	public function register($dataType, $toolName)
+	{
+		if (!isset($this->tools[$dataType])) {
+			$this->tools[$dataType] = [];
+		}
+
+		$this->tools[$dataType][] = $toolName;
+		return $this;
+	}
+
+	/**
+	 * Override permissions for a tool by passing a Closure that will be evaluated when checking permissions.
+	 *
+	 * @param string $dataType corresponds to the table name or can be "*" for all data types.
+	 * @param string $toolName class name which must implement "ToolInterface".
+	 * @param $permission
+	 * @return $this
+	 */
+	public function overridePermission($dataType, $toolName, Closure $permission)
+	{
+		if (empty($this->overriddenPermissions[$dataType])) {
+			$this->overriddenPermissions[$dataType] = [];
+		}
+
+		$this->overriddenPermissions[$dataType][$toolName] = $permission;
+		return $this;
+	}
+
+	/**
+	 * Un-Register a tool for a given data type.
+	 *
+	 * @param string $dataType corresponds to the table name or can be "*" for all data types.
+	 * @param string $toolName class name which must implement "ToolInterface".
+	 * @return $this
+	 */
+	public function unRegister($dataType, $toolName)
+	{
+		if ($this->hasTools($dataType, $toolName)) {
+			$toolPosition = array_search($toolName, $this->tools['*']);
+			if ($toolPosition !== false) {
+				unset($this->tools['*'][$toolPosition]);
+			}
+
+			$toolPosition = array_search($toolName, $this->tools[$dataType]);
+			if ($toolPosition !== false) {
+				unset($this->tools[$dataType][$toolPosition]);
+			}
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Tell whether the given data type has any tools registered.
+	 *
+	 * @param string $dataType
+	 * @return bool
+	 */
+	public function hasAnyTools($dataType)
+	{
+		$tools = $this->getTools($dataType);
+		return !empty($tools);
+	}
+
+	/**
+	 * Tell whether the given data type has this $tool.
+	 *
+	 * @param string $dataType
+	 * @param string $tool
+	 * @return bool
+	 */
+	public function hasTools($dataType, $tool)
+	{
+		return in_array($tool, $this->tools['*']) || in_array($tool, $this->tools[$dataType]);
+	}
+
+	/**
+	 * Tell whether the given tool is allowed for this data type.
+	 *
+	 * @param string $dataType
+	 * @param string $toolName
+	 * @return bool
+	 */
+	public function isAllowed($dataType, $toolName)
+	{
+		$isAllowed = false;
+
+		if ($this->hasTools($dataType, $toolName)) {
+			$permission = $this->getOverriddenPermission($dataType, $toolName);
+			if (!is_null($permission)) {
+				$isAllowed = $permission();
+			} else {
+				/** @var ToolInterface $toolName */
+				$toolName = GeneralUtility::makeInstance($toolName);
+				$isAllowed = $toolName->isShown();
+			}
+		}
+		return $isAllowed;
+	}
+
+	/**
+	 * Get Registered tools.
+	 *
+	 * @param string $dataType
+	 * @return ToolInterface[]
+	 */
+	public function getTools($dataType)
+	{
+		$tools = [];
+
+		foreach (array($dataType, '*') as $toolSource) {
+			if (isset($this->tools[$toolSource])) {
+				$toolNames = $this->tools[$toolSource];
+
+				foreach ($toolNames as $toolName) {
+					/** @var ToolInterface $tool */
+					if ($this->isAllowed($dataType, $toolName)) {
+						$tools[] = GeneralUtility::makeInstance($toolName);
+					}
+				}
+			}
+		}
+		return $tools;
+	}
+
+	/**
+	 * Get the proper permission for a tool.
+	 *
+	 * @param string $dataType corresponds to the table name or can be "*" for all data types.
+	 * @param string $toolName class name which must implement "ToolInterface".
+	 * @return null|Closure
+	 */
+	protected function getOverriddenPermission($dataType, $toolName)
+	{
+		$permission = null;
+		if (isset($this->overriddenPermissions[$dataType][$toolName])) {
+			$permission = $this->overriddenPermissions[$dataType][$toolName];
+		} elseif (isset($this->overriddenPermissions['*'][$toolName])) {
+			$permission = $this->overriddenPermissions['*'][$toolName];
+		}
+		return $permission;
+	}
 }

Classes/Tool/ConfiguredPidTool.php

Indentation +66 added lines, -66 removed lines

@@ -19,76 +19,76 @@
  */
 class ConfiguredPidTool extends AbstractTool
 {
-    /**
-     * Display the title of the tool on the welcome screen.
-     *
-     * @return string
-     */
-    public function getTitle(): string
-    {
-        return sprintf(
-            '%s (%s)',
-            LocalizationUtility::translate('tool.configured_pid', 'vidi'),
-            $this->getModulePidService()->getConfiguredNewRecordPid()
-        );
-    }
+	/**
+	 * Display the title of the tool on the welcome screen.
+	 *
+	 * @return string
+	 */
+	public function getTitle(): string
+	{
+		return sprintf(
+			'%s (%s)',
+			LocalizationUtility::translate('tool.configured_pid', 'vidi'),
+			$this->getModulePidService()->getConfiguredNewRecordPid()
+		);
+	}
 
-    /**
-     * Display the description of the tool in the welcome screen.
-     *
-     * @return string
-     */
-    public function getDescription(): string
-    {
-        $templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ConfiguredPid/Launcher.html';
-        $view = $this->initializeStandaloneView($templateNameAndPath);
-        $view->assignMultiple([
-            'sitePath' => Environment::getPublicPath() . '/',
-            'dataType' => $this->getModuleLoader()->getDataType(),
-            'configuredPid' => $this->getModulePidService()->getConfiguredNewRecordPid(),
-            'errors' => $this->getModulePidService()->validateConfiguredPid(),
-        ]);
+	/**
+	 * Display the description of the tool in the welcome screen.
+	 *
+	 * @return string
+	 */
+	public function getDescription(): string
+	{
+		$templateNameAndPath = 'EXT:vidi/Resources/Private/Standalone/Tool/ConfiguredPid/Launcher.html';
+		$view = $this->initializeStandaloneView($templateNameAndPath);
+		$view->assignMultiple([
+			'sitePath' => Environment::getPublicPath() . '/',
+			'dataType' => $this->getModuleLoader()->getDataType(),
+			'configuredPid' => $this->getModulePidService()->getConfiguredNewRecordPid(),
+			'errors' => $this->getModulePidService()->validateConfiguredPid(),
+		]);
 
-        return $view->render();
-    }
+		return $view->render();
+	}
 
-    /**
-     * Do the job
-     *
-     * @param array $arguments
-     * @return string
-     */
-    public function work(array $arguments = array()): string
-    {
-        return '';
-    }
+	/**
+	 * Do the job
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	public function work(array $arguments = array()): string
+	{
+		return '';
+	}
 
-    /**
-     * Tell whether the tools should be displayed according to the context.
-     *
-     * @return bool
-     */
-    public function isShown(): bool
-    {
-        return $this->getBackendUser()->isAdmin();
-    }
+	/**
+	 * Tell whether the tools should be displayed according to the context.
+	 *
+	 * @return bool
+	 */
+	public function isShown(): bool
+	{
+		return $this->getBackendUser()->isAdmin();
+	}
 
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader|object
-     */
-    protected function getModuleLoader(): ModuleLoader
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader|object
+	 */
+	protected function getModuleLoader(): ModuleLoader
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 
-    /**
-     * @return ModulePidService|object
-     */
-    public function getModulePidService()
-    {
-        /** @var ModulePidService $modulePidService */
-        return GeneralUtility::makeInstance(ModulePidService::class);
-    }
+	/**
+	 * @return ModulePidService|object
+	 */
+	public function getModulePidService()
+	{
+		/** @var ModulePidService $modulePidService */
+		return GeneralUtility::makeInstance(ModulePidService::class);
+	}
 }

Classes/Module/ModulePidService.php

Indentation +208 added lines, -208 removed lines

@@ -21,212 +21,212 @@
  */
 class ModulePidService
 {
-    /**
-     * The data type (table)
-     *
-     * @var string
-     */
-    protected $dataType = '';
-
-    /**
-     * A collection of speaking error messages why the pid is invalid.
-     *
-     * @var array
-     */
-    protected $errors = [];
-
-    /**
-     * ModulePidService constructor.
-     */
-    public function __construct()
-    {
-        $this->dataType = $this->getModuleLoader()->getDataType();
-    }
-
-    /**
-     * Returns a class instance
-     *
-     * @return \Fab\Vidi\Module\ModulePidService|object
-     */
-    public static function getInstance()
-    {
-        return GeneralUtility::makeInstance(self::class);
-    }
-
-    /**
-     * @return bool
-     */
-    public function isConfiguredPidValid(): bool
-    {
-        $errors = $this->validateConfiguredPid();
-        return empty($errors);
-    }
-
-    /**
-     * @return array
-     */
-    public function validateConfiguredPid(): array
-    {
-        $configuredPid = $this->getConfiguredNewRecordPid();
-        $this->validateRootLevel($configuredPid);
-        $this->validatePageExist($configuredPid);
-        $this->validateDoktype($configuredPid);
-        return $this->errors;
-    }
-
-    /**
-     * Return the default configured pid.
-     *
-     * @return int
-     */
-    public function getConfiguredNewRecordPid(): int
-    {
-        if (GeneralUtility::_GP(Parameter::PID)) {
-            $configuredPid = (int)GeneralUtility::_GP(Parameter::PID);
-        } else {
-            // Get pid from User TSConfig if any.
-            $tsConfigPath = sprintf('tx_vidi.dataType.%s.storagePid', $this->dataType);
-            $result = $this->getBackendUser()->getTSConfig($tsConfigPath);
-            $configuredPid = isset($result['value'])
-                ? $configuredPid = (int)$result['value']
-                : $this->getModuleLoader()->getDefaultPid();
-        }
-
-        return $configuredPid;
-    }
-
-    /**
-     * Check if pid is 0 and given table is allowed on root level.
-     *
-     * @param int $configuredPid
-     * @return void
-     */
-    protected function validateRootLevel(int $configuredPid): void
-    {
-        if ($configuredPid > 0) {
-            return;
-        }
-
-        $isRootLevel = (bool)Tca::table()->get('rootLevel');
-        if (!$isRootLevel) {
-            $this->errors[] = sprintf(
-                'You are not allowed to use page id "0" unless you set $GLOBALS[\'TCA\'][\'%1$s\'][\'ctrl\'][\'rootLevel\'] = 1;',
-                $this->dataType
-            );
-        }
-    }
-
-    /**
-     * Check if a page exists for the configured pid
-     *
-     * @param int $configuredPid
-     * @return void
-     */
-    protected function validatePageExist(int $configuredPid): void
-    {
-        if ($configuredPid === 0) {
-            return;
-        }
-
-        $page = $this->getPage($configuredPid);
-        if (empty($page)) {
-            $this->errors[] = sprintf(
-                'No page found for the configured page id "%s".',
-                $configuredPid
-            );
-        }
-    }
-
-    /**
-     * Check if configured page is a sysfolder and if it is allowed.
-     *
-     * @param int $configuredPid
-     * @return void
-     */
-    protected function validateDoktype(int $configuredPid): void
-    {
-        if ($configuredPid === 0) {
-            return;
-        }
-
-        $page = $this->getPage($configuredPid);
-        if (!empty($page)
-            && (int)$page['doktype'] !== PageRepository::DOKTYPE_SYSFOLDER
-            && !$this->isTableAllowedOnStandardPages()
-            && $this->getModuleLoader()->hasComponentInDocHeader(NewButton::class)) {
-            $this->errors[] = sprintf(
-                'The page with the id "%s" either has to be of the type "folder" (doktype=254) or the table "%s" has to be allowed on standard pages.',
-                $configuredPid,
-                $this->dataType
-            );
-        }
-    }
-
-    /**
-     * Check if given table is allowed on standard pages
-     *
-     * @return bool
-     * @see \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::allowTableOnStandardPages()
-     */
-    protected function isTableAllowedOnStandardPages(): bool
-    {
-        $allowedTables = explode(',', $GLOBALS['PAGES_TYPES']['default']['allowedTables']);
-        return in_array($this->dataType, $allowedTables, true);
-    }
-
-    /**
-     * Returns the page record of the configured pid
-     *
-     * @param int $configuredPid
-     * @return array
-     */
-    protected function getPage(int $configuredPid): ?array
-    {
-        $query = $this->getQueryBuilder('pages');
-        $query->getRestrictions()->removeAll(); // we are in BE context.
-
-        $page = $query->select('doktype')
-            ->from('pages')
-            ->where(
-                'deleted = 0',
-                'uid = ' . $configuredPid
-            )
-            ->execute()
-            ->fetch();
-
-        return is_array($page)
-            ? $page
-            : [];
-    }
-
-    /**
-     * @param string $tableName
-     * @return object|QueryBuilder
-     */
-    protected function getQueryBuilder($tableName): QueryBuilder
-    {
-        /** @var ConnectionPool $connectionPool */
-        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
-        return $connectionPool->getQueryBuilderForTable($tableName);
-    }
-
-    /**
-     * Returns an instance of the current Backend User.
-     *
-     * @return BackendUserAuthentication
-     */
-    protected function getBackendUser()
-    {
-        return $GLOBALS['BE_USER'];
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader|object
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * The data type (table)
+	 *
+	 * @var string
+	 */
+	protected $dataType = '';
+
+	/**
+	 * A collection of speaking error messages why the pid is invalid.
+	 *
+	 * @var array
+	 */
+	protected $errors = [];
+
+	/**
+	 * ModulePidService constructor.
+	 */
+	public function __construct()
+	{
+		$this->dataType = $this->getModuleLoader()->getDataType();
+	}
+
+	/**
+	 * Returns a class instance
+	 *
+	 * @return \Fab\Vidi\Module\ModulePidService|object
+	 */
+	public static function getInstance()
+	{
+		return GeneralUtility::makeInstance(self::class);
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isConfiguredPidValid(): bool
+	{
+		$errors = $this->validateConfiguredPid();
+		return empty($errors);
+	}
+
+	/**
+	 * @return array
+	 */
+	public function validateConfiguredPid(): array
+	{
+		$configuredPid = $this->getConfiguredNewRecordPid();
+		$this->validateRootLevel($configuredPid);
+		$this->validatePageExist($configuredPid);
+		$this->validateDoktype($configuredPid);
+		return $this->errors;
+	}
+
+	/**
+	 * Return the default configured pid.
+	 *
+	 * @return int
+	 */
+	public function getConfiguredNewRecordPid(): int
+	{
+		if (GeneralUtility::_GP(Parameter::PID)) {
+			$configuredPid = (int)GeneralUtility::_GP(Parameter::PID);
+		} else {
+			// Get pid from User TSConfig if any.
+			$tsConfigPath = sprintf('tx_vidi.dataType.%s.storagePid', $this->dataType);
+			$result = $this->getBackendUser()->getTSConfig($tsConfigPath);
+			$configuredPid = isset($result['value'])
+				? $configuredPid = (int)$result['value']
+				: $this->getModuleLoader()->getDefaultPid();
+		}
+
+		return $configuredPid;
+	}
+
+	/**
+	 * Check if pid is 0 and given table is allowed on root level.
+	 *
+	 * @param int $configuredPid
+	 * @return void
+	 */
+	protected function validateRootLevel(int $configuredPid): void
+	{
+		if ($configuredPid > 0) {
+			return;
+		}
+
+		$isRootLevel = (bool)Tca::table()->get('rootLevel');
+		if (!$isRootLevel) {
+			$this->errors[] = sprintf(
+				'You are not allowed to use page id "0" unless you set $GLOBALS[\'TCA\'][\'%1$s\'][\'ctrl\'][\'rootLevel\'] = 1;',
+				$this->dataType
+			);
+		}
+	}
+
+	/**
+	 * Check if a page exists for the configured pid
+	 *
+	 * @param int $configuredPid
+	 * @return void
+	 */
+	protected function validatePageExist(int $configuredPid): void
+	{
+		if ($configuredPid === 0) {
+			return;
+		}
+
+		$page = $this->getPage($configuredPid);
+		if (empty($page)) {
+			$this->errors[] = sprintf(
+				'No page found for the configured page id "%s".',
+				$configuredPid
+			);
+		}
+	}
+
+	/**
+	 * Check if configured page is a sysfolder and if it is allowed.
+	 *
+	 * @param int $configuredPid
+	 * @return void
+	 */
+	protected function validateDoktype(int $configuredPid): void
+	{
+		if ($configuredPid === 0) {
+			return;
+		}
+
+		$page = $this->getPage($configuredPid);
+		if (!empty($page)
+			&& (int)$page['doktype'] !== PageRepository::DOKTYPE_SYSFOLDER
+			&& !$this->isTableAllowedOnStandardPages()
+			&& $this->getModuleLoader()->hasComponentInDocHeader(NewButton::class)) {
+			$this->errors[] = sprintf(
+				'The page with the id "%s" either has to be of the type "folder" (doktype=254) or the table "%s" has to be allowed on standard pages.',
+				$configuredPid,
+				$this->dataType
+			);
+		}
+	}
+
+	/**
+	 * Check if given table is allowed on standard pages
+	 *
+	 * @return bool
+	 * @see \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::allowTableOnStandardPages()
+	 */
+	protected function isTableAllowedOnStandardPages(): bool
+	{
+		$allowedTables = explode(',', $GLOBALS['PAGES_TYPES']['default']['allowedTables']);
+		return in_array($this->dataType, $allowedTables, true);
+	}
+
+	/**
+	 * Returns the page record of the configured pid
+	 *
+	 * @param int $configuredPid
+	 * @return array
+	 */
+	protected function getPage(int $configuredPid): ?array
+	{
+		$query = $this->getQueryBuilder('pages');
+		$query->getRestrictions()->removeAll(); // we are in BE context.
+
+		$page = $query->select('doktype')
+			->from('pages')
+			->where(
+				'deleted = 0',
+				'uid = ' . $configuredPid
+			)
+			->execute()
+			->fetch();
+
+		return is_array($page)
+			? $page
+			: [];
+	}
+
+	/**
+	 * @param string $tableName
+	 * @return object|QueryBuilder
+	 */
+	protected function getQueryBuilder($tableName): QueryBuilder
+	{
+		/** @var ConnectionPool $connectionPool */
+		$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
+		return $connectionPool->getQueryBuilderForTable($tableName);
+	}
+
+	/**
+	 * Returns an instance of the current Backend User.
+	 *
+	 * @return BackendUserAuthentication
+	 */
+	protected function getBackendUser()
+	{
+		return $GLOBALS['BE_USER'];
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader|object
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 }

Classes/Module/ModulePreferences.php

Indentation +212 added lines, -212 removed lines

@@ -18,216 +18,216 @@
  */
 class ModulePreferences implements SingletonInterface
 {
-    /**
-     * @var array
-     */
-    protected $preferences;
-
-    /**
-     * @var string
-     */
-    protected $tableName = 'tx_vidi_preference';
-
-    /**
-     * @param string $key
-     * @param string $dataType
-     * @return mixed
-     */
-    public function get($key, $dataType = '')
-    {
-        if (empty($dataType)) {
-            $dataType = $this->getModuleLoader()->getDataType();
-        }
-
-        if (!$this->isLoaded($dataType)) {
-            $this->load($dataType);
-        }
-
-        $value = empty($this->preferences[$dataType][$key]) ? null : $this->preferences[$dataType][$key];
-        return $value;
-    }
-
-    /**
-     * Tell whether the module is loaded.
-     *
-     * @param string $dataType
-     * @return bool
-     */
-    public function isLoaded($dataType)
-    {
-        return !empty($this->preferences[$dataType]);
-    }
-
-    /**
-     * @param string $dataType
-     * @return array
-     */
-    public function getAll($dataType = '')
-    {
-        if (empty($dataType)) {
-            $dataType = $this->getModuleLoader()->getDataType();
-        }
-        $this->load($dataType);
-        return $this->preferences[$dataType];
-    }
-
-    /**
-     * Get the md5 signature of the preferences.
-     *
-     * @param string $dataType
-     * @return bool
-     */
-    public function getSignature($dataType = '')
-    {
-        $preferences = $this->getAll($dataType);
-        return md5(serialize($preferences));
-    }
-
-    /**
-     * Load preferences.
-     *
-     * @param string $dataType
-     * @return void
-     */
-    public function load($dataType)
-    {
-        // Fetch preferences from different sources and overlay them
-        $databasePreferences = $this->fetchPreferencesFromDatabase($dataType);
-        $generalPreferences = $this->fetchGlobalPreferencesFromTypoScript();
-        $specificPreferences = $this->fetchExtraPreferencesFromTypoScript($dataType);
-
-        $preferences = array_merge($generalPreferences, $specificPreferences, $databasePreferences);
-        $this->preferences[$dataType] = $preferences;
-    }
-
-    /**
-     * Save preferences
-     *
-     * @param array $preferences
-     * @return void
-     */
-    public function save($preferences)
-    {
-        $configurableParts = ConfigurablePart::getParts();
-
-        $dataType = $this->getModuleLoader()->getDataType();
-        $this->getDataService()->delete(
-            $this->tableName,
-            [
-                'data_type' => $dataType
-            ]
-        );
-
-        $sanitizedPreferences = [];
-        foreach ($preferences as $key => $value) {
-            if (in_array($key, $configurableParts)) {
-                $sanitizedPreferences[$key] = $value;
-            }
-        }
-
-        $this->getDataService()->insert(
-            $this->tableName,
-            [
-                'data_type' => $dataType,
-                'preferences' => serialize($sanitizedPreferences),
-            ]
-        );
-    }
-
-    /**
-     * @param $dataType
-     * @return array
-     */
-    public function fetchPreferencesFromDatabase($dataType)
-    {
-        $preferences = [];
-        $record = $this->getDataService()->getRecord(
-            $this->tableName,
-            [
-                'data_type' => $dataType
-            ]
-        );
-
-        if (!empty($record)) {
-            $preferences = unserialize($record['preferences']);
-        }
-
-        return $preferences;
-    }
-
-    /**
-     * Returns the module settings.
-     *
-     * @return array
-     */
-    protected function fetchGlobalPreferencesFromTypoScript()
-    {
-        $settings = $this->getSettings();
-
-        $configurableParts = ConfigurablePart::getParts();
-        $preferences = [];
-        foreach ($settings as $key => $value) {
-            if (in_array($key, $configurableParts)) {
-                $preferences[$key] = $value;
-            }
-        }
-
-        return $preferences;
-    }
-
-    /**
-     * Returns the module settings.
-     *
-     * @param string $dataType
-     * @return array
-     */
-    protected function fetchExtraPreferencesFromTypoScript($dataType)
-    {
-        $generalSettings = $this->getSettings();
-
-        $preferences = [];
-        if (isset($generalSettings[$dataType . '.'])) {
-            $settings = $generalSettings[$dataType . '.'];
-
-            $configurableParts = ConfigurablePart::getParts();
-            foreach ($settings as $key => $value) {
-                if (in_array($key, $configurableParts)) {
-                    $preferences[$key] = $value;
-                }
-            }
-        }
-
-        return $preferences;
-    }
-
-    /**
-     * Returns the module settings.
-     *
-     * @return array
-     */
-    protected function getSettings()
-    {
-        /** @var BackendConfigurationManager $backendConfigurationManager */
-        $backendConfigurationManager = GeneralUtility::makeInstance(BackendConfigurationManager::class);
-        $configuration = $backendConfigurationManager->getTypoScriptSetup();
-        return $configuration['module.']['tx_vidi.']['settings.'];
-    }
-
-    /**
-     * @return object|DataService
-     */
-    protected function getDataService(): DataService
-    {
-        return GeneralUtility::makeInstance(DataService::class);
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader|object
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * @var array
+	 */
+	protected $preferences;
+
+	/**
+	 * @var string
+	 */
+	protected $tableName = 'tx_vidi_preference';
+
+	/**
+	 * @param string $key
+	 * @param string $dataType
+	 * @return mixed
+	 */
+	public function get($key, $dataType = '')
+	{
+		if (empty($dataType)) {
+			$dataType = $this->getModuleLoader()->getDataType();
+		}
+
+		if (!$this->isLoaded($dataType)) {
+			$this->load($dataType);
+		}
+
+		$value = empty($this->preferences[$dataType][$key]) ? null : $this->preferences[$dataType][$key];
+		return $value;
+	}
+
+	/**
+	 * Tell whether the module is loaded.
+	 *
+	 * @param string $dataType
+	 * @return bool
+	 */
+	public function isLoaded($dataType)
+	{
+		return !empty($this->preferences[$dataType]);
+	}
+
+	/**
+	 * @param string $dataType
+	 * @return array
+	 */
+	public function getAll($dataType = '')
+	{
+		if (empty($dataType)) {
+			$dataType = $this->getModuleLoader()->getDataType();
+		}
+		$this->load($dataType);
+		return $this->preferences[$dataType];
+	}
+
+	/**
+	 * Get the md5 signature of the preferences.
+	 *
+	 * @param string $dataType
+	 * @return bool
+	 */
+	public function getSignature($dataType = '')
+	{
+		$preferences = $this->getAll($dataType);
+		return md5(serialize($preferences));
+	}
+
+	/**
+	 * Load preferences.
+	 *
+	 * @param string $dataType
+	 * @return void
+	 */
+	public function load($dataType)
+	{
+		// Fetch preferences from different sources and overlay them
+		$databasePreferences = $this->fetchPreferencesFromDatabase($dataType);
+		$generalPreferences = $this->fetchGlobalPreferencesFromTypoScript();
+		$specificPreferences = $this->fetchExtraPreferencesFromTypoScript($dataType);
+
+		$preferences = array_merge($generalPreferences, $specificPreferences, $databasePreferences);
+		$this->preferences[$dataType] = $preferences;
+	}
+
+	/**
+	 * Save preferences
+	 *
+	 * @param array $preferences
+	 * @return void
+	 */
+	public function save($preferences)
+	{
+		$configurableParts = ConfigurablePart::getParts();
+
+		$dataType = $this->getModuleLoader()->getDataType();
+		$this->getDataService()->delete(
+			$this->tableName,
+			[
+				'data_type' => $dataType
+			]
+		);
+
+		$sanitizedPreferences = [];
+		foreach ($preferences as $key => $value) {
+			if (in_array($key, $configurableParts)) {
+				$sanitizedPreferences[$key] = $value;
+			}
+		}
+
+		$this->getDataService()->insert(
+			$this->tableName,
+			[
+				'data_type' => $dataType,
+				'preferences' => serialize($sanitizedPreferences),
+			]
+		);
+	}
+
+	/**
+	 * @param $dataType
+	 * @return array
+	 */
+	public function fetchPreferencesFromDatabase($dataType)
+	{
+		$preferences = [];
+		$record = $this->getDataService()->getRecord(
+			$this->tableName,
+			[
+				'data_type' => $dataType
+			]
+		);
+
+		if (!empty($record)) {
+			$preferences = unserialize($record['preferences']);
+		}
+
+		return $preferences;
+	}
+
+	/**
+	 * Returns the module settings.
+	 *
+	 * @return array
+	 */
+	protected function fetchGlobalPreferencesFromTypoScript()
+	{
+		$settings = $this->getSettings();
+
+		$configurableParts = ConfigurablePart::getParts();
+		$preferences = [];
+		foreach ($settings as $key => $value) {
+			if (in_array($key, $configurableParts)) {
+				$preferences[$key] = $value;
+			}
+		}
+
+		return $preferences;
+	}
+
+	/**
+	 * Returns the module settings.
+	 *
+	 * @param string $dataType
+	 * @return array
+	 */
+	protected function fetchExtraPreferencesFromTypoScript($dataType)
+	{
+		$generalSettings = $this->getSettings();
+
+		$preferences = [];
+		if (isset($generalSettings[$dataType . '.'])) {
+			$settings = $generalSettings[$dataType . '.'];
+
+			$configurableParts = ConfigurablePart::getParts();
+			foreach ($settings as $key => $value) {
+				if (in_array($key, $configurableParts)) {
+					$preferences[$key] = $value;
+				}
+			}
+		}
+
+		return $preferences;
+	}
+
+	/**
+	 * Returns the module settings.
+	 *
+	 * @return array
+	 */
+	protected function getSettings()
+	{
+		/** @var BackendConfigurationManager $backendConfigurationManager */
+		$backendConfigurationManager = GeneralUtility::makeInstance(BackendConfigurationManager::class);
+		$configuration = $backendConfigurationManager->getTypoScriptSetup();
+		return $configuration['module.']['tx_vidi.']['settings.'];
+	}
+
+	/**
+	 * @return object|DataService
+	 */
+	protected function getDataService(): DataService
+	{
+		return GeneralUtility::makeInstance(DataService::class);
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader|object
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 }

Classes/Module/Access.php

Indentation +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@
  */
 class Access extends Enumeration
 {
-    public const USER = 'user,group';
+	public const USER = 'user,group';
 
-    public const ADMIN = 'admin';
+	public const ADMIN = 'admin';
 }

Classes/Module/Parameter.php

Indentation +3 added lines, -3 removed lines

@@ -16,9 +16,9 @@
  */
 class Parameter extends Enumeration
 {
-    public const PID = 'id';
+	public const PID = 'id';
 
-    public const SUBMODULE = 'vidiModuleCode';
+	public const SUBMODULE = 'vidiModuleCode';
 
-    public const MODULE = 'route';
+	public const MODULE = 'route';
 }

Classes/Module/ModuleName.php

Indentation +5 added lines, -5 removed lines

@@ -16,13 +16,13 @@
  */
 class ModuleName extends Enumeration
 {
-    public const WEB = 'web';
+	public const WEB = 'web';
 
-    public const FILE = 'file';
+	public const FILE = 'file';
 
-    public const USER = 'user';
+	public const USER = 'user';
 
-    public const ADMIN = 'admin';
+	public const ADMIN = 'admin';
 
-    public const SYSTEM = 'system';
+	public const SYSTEM = 'system';
 }