fabarea / vidi

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);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -189,7 +189,7 @@
             ->from('pages')
             ->where(
                 'deleted = 0',
-                'uid = ' . $configuredPid
+                'uid = '.$configuredPid
             )
             ->execute()
             ->fetch();

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';
 }

Classes/Module/ModulePosition.php

Indentation +8 added lines, -8 removed lines

@@ -16,19 +16,19 @@
  */
 class ModulePosition extends Enumeration
 {
-    public const DOC_HEADER = 'doc-header';
+	public const DOC_HEADER = 'doc-header';
 
-    public const TOP = 'top';
+	public const TOP = 'top';
 
-    public const BOTTOM = 'bottom';
+	public const BOTTOM = 'bottom';
 
-    public const LEFT = 'left';
+	public const LEFT = 'left';
 
-    public const RIGHT = 'right';
+	public const RIGHT = 'right';
 
-    public const GRID = 'grid';
+	public const GRID = 'grid';
 
-    public const BUTTONS = 'buttons';
+	public const BUTTONS = 'buttons';
 
-    public const MENU_MASS_ACTION = 'menu-mass-action';
+	public const MENU_MASS_ACTION = 'menu-mass-action';
 }

Classes/Module/ConfigurablePart.php

Indentation +18 added lines, -18 removed lines

@@ -14,23 +14,23 @@
  */
 class ConfigurablePart
 {
-    public const __default = '';
-    public const EXCLUDED_FIELDS = 'excluded_fields';
-    public const MENU_VISIBLE_ITEMS = 'menuVisibleItems';
-    public const MENU_VISIBLE_ITEMS_DEFAULT = 'menuVisibleItemsDefault';
+	public const __default = '';
+	public const EXCLUDED_FIELDS = 'excluded_fields';
+	public const MENU_VISIBLE_ITEMS = 'menuVisibleItems';
+	public const MENU_VISIBLE_ITEMS_DEFAULT = 'menuVisibleItemsDefault';
 
-    /**
-     * Get the valid values for this enum.
-     *
-     * @param boolean $include_default
-     * @return array
-     */
-    public static function getParts($include_default = false)
-    {
-        return array(
-            'EXCLUDED_FIELDS' => self::EXCLUDED_FIELDS,
-            'MENU_VISIBLE_ITEMS' => self::MENU_VISIBLE_ITEMS,
-            'MENU_VISIBLE_ITEMS_DEFAULT' => self::MENU_VISIBLE_ITEMS_DEFAULT,
-        );
-    }
+	/**
+	 * Get the valid values for this enum.
+	 *
+	 * @param boolean $include_default
+	 * @return array
+	 */
+	public static function getParts($include_default = false)
+	{
+		return array(
+			'EXCLUDED_FIELDS' => self::EXCLUDED_FIELDS,
+			'MENU_VISIBLE_ITEMS' => self::MENU_VISIBLE_ITEMS,
+			'MENU_VISIBLE_ITEMS_DEFAULT' => self::MENU_VISIBLE_ITEMS_DEFAULT,
+		);
+	}
 }

Classes/DataHandler/DataHandlerFactory.php

Indentation +56 added lines, -56 removed lines

@@ -17,68 +17,68 @@
  */
 class DataHandlerFactory implements SingletonInterface
 {
-    /**
-     * @var string
-     */
-    protected $actionName = '';
+	/**
+	 * @var string
+	 */
+	protected $actionName = '';
 
-    /**
-     * @var string
-     */
-    protected $dataType = '';
+	/**
+	 * @var string
+	 */
+	protected $dataType = '';
 
-    /**
-     * Default is CoreDataHandler which wraps the Core DataHandler.
-     *
-     * @var string
-     */
-    protected $defaultDataHandler = 'Fab\Vidi\DataHandler\CoreDataHandler';
+	/**
+	 * Default is CoreDataHandler which wraps the Core DataHandler.
+	 *
+	 * @var string
+	 */
+	protected $defaultDataHandler = 'Fab\Vidi\DataHandler\CoreDataHandler';
 
-    /**
-     * @param string $actionName
-     * @return $this
-     */
-    public function action($actionName)
-    {
-        $this->actionName = $actionName;
-        return $this;
-    }
+	/**
+	 * @param string $actionName
+	 * @return $this
+	 */
+	public function action($actionName)
+	{
+		$this->actionName = $actionName;
+		return $this;
+	}
 
-    /**
-     * @param string $dataType
-     * @return $this
-     */
-    public function forType($dataType)
-    {
-        $this->dataType = $dataType;
-        return $this;
-    }
+	/**
+	 * @param string $dataType
+	 * @return $this
+	 */
+	public function forType($dataType)
+	{
+		$this->dataType = $dataType;
+		return $this;
+	}
 
-    /**
-     * Returns a Data Handler instance.
-     *
-     * @throws \Exception
-     * @return DataHandlerInterface
-     */
-    public function getDataHandler()
-    {
-        if (empty($this->dataType)) {
-            throw new \Exception('Attribute $this->dataType can not be empty', 1410001035);
-        }
+	/**
+	 * Returns a Data Handler instance.
+	 *
+	 * @throws \Exception
+	 * @return DataHandlerInterface
+	 */
+	public function getDataHandler()
+	{
+		if (empty($this->dataType)) {
+			throw new \Exception('Attribute $this->dataType can not be empty', 1410001035);
+		}
 
-        if (empty($this->actionName)) {
-            throw new \Exception('Attribute $this->actionName can not be empty', 1410001036);
-        }
+		if (empty($this->actionName)) {
+			throw new \Exception('Attribute $this->actionName can not be empty', 1410001036);
+		}
 
-        if (isset($GLOBALS['TCA'][$this->dataType]['vidi']['data_handler'][$this->actionName])) {
-            $className = $GLOBALS['TCA'][$this->dataType]['vidi']['data_handler'][$this->actionName];
-        } elseif (isset($GLOBALS['TCA'][$this->dataType]['vidi']['data_handler']['*'])) {
-            $className = $GLOBALS['TCA'][$this->dataType]['vidi']['data_handler']['*'];
-        } else {
-            $className = $this->defaultDataHandler;
-        }
+		if (isset($GLOBALS['TCA'][$this->dataType]['vidi']['data_handler'][$this->actionName])) {
+			$className = $GLOBALS['TCA'][$this->dataType]['vidi']['data_handler'][$this->actionName];
+		} elseif (isset($GLOBALS['TCA'][$this->dataType]['vidi']['data_handler']['*'])) {
+			$className = $GLOBALS['TCA'][$this->dataType]['vidi']['data_handler']['*'];
+		} else {
+			$className = $this->defaultDataHandler;
+		}
 
-        $dataHandler = GeneralUtility::makeInstance($className);
-        return $dataHandler;
-    }
+		$dataHandler = GeneralUtility::makeInstance($className);
+		return $dataHandler;
+	}
 }

Classes/DataHandler/AbstractDataHandler.php

Indentation +13 added lines, -13 removed lines

@@ -15,18 +15,18 @@
  */
 abstract class AbstractDataHandler implements DataHandlerInterface, SingletonInterface
 {
-    /**
-     * @var array
-     */
-    protected $errorMessages = [];
+	/**
+	 * @var array
+	 */
+	protected $errorMessages = [];
 
-    /**
-     * Return error that have occurred while processing the data.
-     *
-     * @return array
-     */
-    public function getErrorMessages()
-    {
-        return $this->errorMessages;
-    }
+	/**
+	 * Return error that have occurred while processing the data.
+	 *
+	 * @return array
+	 */
+	public function getErrorMessages()
+	{
+		return $this->errorMessages;
+	}
 }

Classes/DataHandler/DataHandlerInterface.php

Indentation +44 added lines, -44 removed lines

@@ -16,53 +16,53 @@
  */
 interface DataHandlerInterface
 {
-    /**
-     * Process Content with action "update".
-     *
-     * @param Content $content
-     * @return bool
-     */
-    public function processUpdate(Content $content);
+	/**
+	 * Process Content with action "update".
+	 *
+	 * @param Content $content
+	 * @return bool
+	 */
+	public function processUpdate(Content $content);
 
-    /**
-     * Process Content with action "remove".
-     *
-     * @param Content $content
-     * @return bool
-     */
-    public function processRemove(Content $content);
+	/**
+	 * Process Content with action "remove".
+	 *
+	 * @param Content $content
+	 * @return bool
+	 */
+	public function processRemove(Content $content);
 
-    /**
-     * Process Content with action "copy".
-     *
-     * @param Content $content
-     * @param string $target
-     * @return bool
-     */
-    public function processCopy(Content $content, $target);
+	/**
+	 * Process Content with action "copy".
+	 *
+	 * @param Content $content
+	 * @param string $target
+	 * @return bool
+	 */
+	public function processCopy(Content $content, $target);
 
-    /**
-     * Process Content with action "move".
-     *
-     * @param Content $content
-     * @param mixed $target
-     * @return bool
-     */
-    public function processMove(Content $content, $target);
+	/**
+	 * Process Content with action "move".
+	 *
+	 * @param Content $content
+	 * @param mixed $target
+	 * @return bool
+	 */
+	public function processMove(Content $content, $target);
 
-    /**
-     * Process Content with action "localize".
-     *
-     * @param Content $content
-     * @param int $language
-     * @return bool
-     */
-    public function processLocalize(Content $content, $language);
+	/**
+	 * Process Content with action "localize".
+	 *
+	 * @param Content $content
+	 * @param int $language
+	 * @return bool
+	 */
+	public function processLocalize(Content $content, $language);
 
-    /**
-     * Return error that have occurred while processing the data.
-     *
-     * @return array
-     */
-    public function getErrorMessages();
+	/**
+	 * Return error that have occurred while processing the data.
+	 *
+	 * @return array
+	 */
+	public function getErrorMessages();
 }