fabarea / vidi

Classes/View/Check/RelationsCheck.php

Indentation +81 added lines, -81 removed lines

@@ -17,37 +17,37 @@ 
 class RelationsCheck extends AbstractComponentView
 {
 
-    /**
-     * @var array
-     */
-    protected $invalidFields = [];
-
-    /**
-     * Renders a button for uploading assets.
-     *
-     * @return string
-     */
-    public function render()
-    {
-
-        $result = '';
-
-        // Check whether storage is configured or not.
-        if (!$this->isTcaValid()) {
-            $result .= $this->formatMessageTcaIsNotValid();
-        }
-
-        return $result;
-    }
-
-    /**
-     * Format a message whenever the storage is offline.
-     *
-     * @return string
-     */
-    protected function formatMessageTcaIsNotValid()
-    {
-        $result = <<< EOF
+	/**
+	 * @var array
+	 */
+	protected $invalidFields = [];
+
+	/**
+	 * Renders a button for uploading assets.
+	 *
+	 * @return string
+	 */
+	public function render()
+	{
+
+		$result = '';
+
+		// Check whether storage is configured or not.
+		if (!$this->isTcaValid()) {
+			$result .= $this->formatMessageTcaIsNotValid();
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Format a message whenever the storage is offline.
+	 *
+	 * @return string
+	 */
+	protected function formatMessageTcaIsNotValid()
+	{
+		$result = <<< EOF
 			<div class="-warning alert alert-warning">
 				<div class="alert-title">
 					Grid may have trouble to render because of wrong / missing TCA.
@@ -62,19 +62,19 @@ 
 				</div>
 			</div>
 EOF;
-        return $result;
-    }
-
-    /**
-     * Check relations of current data type in the Grid.
-     *
-     * @return string
-     */
-    protected function formatMessageHelperText()
-    {
-        $helperText = '';
-        foreach ($this->invalidFields as $invalidField) {
-            $helperText .= <<<EOF
+		return $result;
+	}
+
+	/**
+	 * Check relations of current data type in the Grid.
+	 *
+	 * @return string
+	 */
+	protected function formatMessageHelperText()
+	{
+		$helperText = '';
+		foreach ($this->invalidFields as $invalidField) {
+			$helperText .= <<<EOF
 				<br />
 				In file EXT:my_ext/Configuration/TCA/{$this->getModuleLoader()->getDataType()}.php
 <pre>
@@ -108,42 +108,42 @@ 
 
 </pre>
 EOF;
-        }
-        return $helperText;
-    }
-
-    /**
-     * Check relations of current data type in the Grid.
-     *
-     * @return boolean
-     */
-    protected function isTcaValid()
-    {
-
-        $dataType = $this->getModuleLoader()->getDataType();
-        $table = Tca::table($dataType);
-
-        foreach (Tca::grid($dataType)->getFields() as $fieldName => $configuration) {
-
-            if ($table->hasField($fieldName) && $table->field($fieldName)->hasMany()) {
-                if ($table->field($fieldName)->hasRelationManyToMany()) {
-
-                    $foreignTable = $table->field($fieldName)->getForeignTable();
-                    $manyToManyTable = $table->field($fieldName)->getManyToManyTable();
-                    $foreignField = $table->field($fieldName)->getForeignField();
-
-                    if (!$foreignField) {
-                        $this->invalidFields[] = $fieldName;
-                    } elseif (!$foreignTable) {
-                        $this->invalidFields[] = $fieldName;
-                    } elseif (!$manyToManyTable) {
-                        $this->invalidFields[] = $fieldName;
-                    }
-                }
-            }
-        }
-
-        return empty($this->invalidFields);
-    }
+		}
+		return $helperText;
+	}
+
+	/**
+	 * Check relations of current data type in the Grid.
+	 *
+	 * @return boolean
+	 */
+	protected function isTcaValid()
+	{
+
+		$dataType = $this->getModuleLoader()->getDataType();
+		$table = Tca::table($dataType);
+
+		foreach (Tca::grid($dataType)->getFields() as $fieldName => $configuration) {
+
+			if ($table->hasField($fieldName) && $table->field($fieldName)->hasMany()) {
+				if ($table->field($fieldName)->hasRelationManyToMany()) {
+
+					$foreignTable = $table->field($fieldName)->getForeignTable();
+					$manyToManyTable = $table->field($fieldName)->getManyToManyTable();
+					$foreignField = $table->field($fieldName)->getForeignField();
+
+					if (!$foreignField) {
+						$this->invalidFields[] = $fieldName;
+					} elseif (!$foreignTable) {
+						$this->invalidFields[] = $fieldName;
+					} elseif (!$manyToManyTable) {
+						$this->invalidFields[] = $fieldName;
+					}
+				}
+			}
+		}
+
+		return empty($this->invalidFields);
+	}
 
 }

Classes/Utility/BackendUtility.php

Spacing +6 added lines, -6 removed lines

@@ -45,8 +45,8 @@ 
         $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable($table)
             ->expr();
-        return $withLogicalSeparator . ' ' . $expressionBuilder->eq(
-                $table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
+        return $withLogicalSeparator.' '.$expressionBuilder->eq(
+                $table.'.'.$GLOBALS['TCA'][$table]['ctrl']['delete'],
                 0
             );
     }
@@ -72,12 +72,12 @@ 
         if (is_array($ctrl)) {
             if (is_array($ctrl['enablecolumns'])) {
                 if ($ctrl['enablecolumns']['disabled'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['disabled'];
+                    $field = $table.'.'.$ctrl['enablecolumns']['disabled'];
                     $query->add($expressionBuilder->eq($field, 0));
                     $invQuery->add($expressionBuilder->neq($field, 0));
                 }
                 if ($ctrl['enablecolumns']['starttime'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['starttime'];
+                    $field = $table.'.'.$ctrl['enablecolumns']['starttime'];
                     $query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
                     $invQuery->add(
                         $expressionBuilder->andX(
@@ -87,7 +87,7 @@ 
                     );
                 }
                 if ($ctrl['enablecolumns']['endtime'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['endtime'];
+                    $field = $table.'.'.$ctrl['enablecolumns']['endtime'];
                     $query->add(
                         $expressionBuilder->orX(
                             $expressionBuilder->eq($field, 0),
@@ -108,7 +108,7 @@ 
             return '';
         }
 
-        return ' AND ' . ($inv ? $invQuery : $query);
+        return ' AND '.($inv ? $invQuery : $query);
     }
 
     /**

Indentation +102 added lines, -102 removed lines

@@ -18,115 +18,115 @@
 class BackendUtility
 {
 
-    /*******************************************
+	/*******************************************
      *
      * SQL-related, selecting records, searching
      *
      *******************************************/
-    /**
-     * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
-     * is configured in $GLOBALS['TCA'] for the tablename, $table
-     * This function should ALWAYS be called in the backend for selection on tables which
-     * are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
-     * even if they are marked deleted (in which case the system must always treat them as non-existent!)
-     * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
-     * and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
-     * on those fields as well in the backend you can use ->BEenableFields() though.
-     *
-     * @param string $table Table name present in $GLOBALS['TCA']
-     * @param string $withLogicalSeparator Table alias if any
-     * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
-     */
-    public static function deleteClause($table, $withLogicalSeparator = ' AND')
-    {
-        if (empty($GLOBALS['TCA'][$table]['ctrl']['delete'])) {
-            return '';
-        }
-        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
-            ->getQueryBuilderForTable($table)
-            ->expr();
-        return $withLogicalSeparator . ' ' . $expressionBuilder->eq(
-                $table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
-                0
-            );
-    }
-    /**
-     * Backend implementation of enableFields()
-     * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
-     * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
-     * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
-     *
-     * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
-     * @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
-     * @return string WHERE clause part
-     */
-    public static function BEenableFields($table, $inv = false)
-    {
-        $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
-        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
-            ->getConnectionForTable($table)
-            ->getExpressionBuilder();
-        $query = $expressionBuilder->andX();
-        $invQuery = $expressionBuilder->orX();
+	/**
+	 * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
+	 * is configured in $GLOBALS['TCA'] for the tablename, $table
+	 * This function should ALWAYS be called in the backend for selection on tables which
+	 * are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
+	 * even if they are marked deleted (in which case the system must always treat them as non-existent!)
+	 * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
+	 * and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
+	 * on those fields as well in the backend you can use ->BEenableFields() though.
+	 *
+	 * @param string $table Table name present in $GLOBALS['TCA']
+	 * @param string $withLogicalSeparator Table alias if any
+	 * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
+	 */
+	public static function deleteClause($table, $withLogicalSeparator = ' AND')
+	{
+		if (empty($GLOBALS['TCA'][$table]['ctrl']['delete'])) {
+			return '';
+		}
+		$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
+			->getQueryBuilderForTable($table)
+			->expr();
+		return $withLogicalSeparator . ' ' . $expressionBuilder->eq(
+				$table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'],
+				0
+			);
+	}
+	/**
+	 * Backend implementation of enableFields()
+	 * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
+	 * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
+	 * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
+	 *
+	 * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
+	 * @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
+	 * @return string WHERE clause part
+	 */
+	public static function BEenableFields($table, $inv = false)
+	{
+		$ctrl = $GLOBALS['TCA'][$table]['ctrl'];
+		$expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
+			->getConnectionForTable($table)
+			->getExpressionBuilder();
+		$query = $expressionBuilder->andX();
+		$invQuery = $expressionBuilder->orX();
 
-        if (is_array($ctrl)) {
-            if (is_array($ctrl['enablecolumns'])) {
-                if ($ctrl['enablecolumns']['disabled'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['disabled'];
-                    $query->add($expressionBuilder->eq($field, 0));
-                    $invQuery->add($expressionBuilder->neq($field, 0));
-                }
-                if ($ctrl['enablecolumns']['starttime'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['starttime'];
-                    $query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
-                    $invQuery->add(
-                        $expressionBuilder->andX(
-                            $expressionBuilder->neq($field, 0),
-                            $expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
-                        )
-                    );
-                }
-                if ($ctrl['enablecolumns']['endtime'] ?? false) {
-                    $field = $table . '.' . $ctrl['enablecolumns']['endtime'];
-                    $query->add(
-                        $expressionBuilder->orX(
-                            $expressionBuilder->eq($field, 0),
-                            $expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
-                        )
-                    );
-                    $invQuery->add(
-                        $expressionBuilder->andX(
-                            $expressionBuilder->neq($field, 0),
-                            $expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
-                        )
-                    );
-                }
-            }
-        }
+		if (is_array($ctrl)) {
+			if (is_array($ctrl['enablecolumns'])) {
+				if ($ctrl['enablecolumns']['disabled'] ?? false) {
+					$field = $table . '.' . $ctrl['enablecolumns']['disabled'];
+					$query->add($expressionBuilder->eq($field, 0));
+					$invQuery->add($expressionBuilder->neq($field, 0));
+				}
+				if ($ctrl['enablecolumns']['starttime'] ?? false) {
+					$field = $table . '.' . $ctrl['enablecolumns']['starttime'];
+					$query->add($expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME']));
+					$invQuery->add(
+						$expressionBuilder->andX(
+							$expressionBuilder->neq($field, 0),
+							$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
+						)
+					);
+				}
+				if ($ctrl['enablecolumns']['endtime'] ?? false) {
+					$field = $table . '.' . $ctrl['enablecolumns']['endtime'];
+					$query->add(
+						$expressionBuilder->orX(
+							$expressionBuilder->eq($field, 0),
+							$expressionBuilder->gt($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
+						)
+					);
+					$invQuery->add(
+						$expressionBuilder->andX(
+							$expressionBuilder->neq($field, 0),
+							$expressionBuilder->lte($field, (int)$GLOBALS['SIM_ACCESS_TIME'])
+						)
+					);
+				}
+			}
+		}
 
-        if ($query->count() === 0) {
-            return '';
-        }
+		if ($query->count() === 0) {
+			return '';
+		}
 
-        return ' AND ' . ($inv ? $invQuery : $query);
-    }
+		return ' AND ' . ($inv ? $invQuery : $query);
+	}
 
-    /**
-     * Returns the URL to a given module
-     *
-     * @param string $moduleName Name of the module
-     * @param array $urlParameters URL parameters that should be added as key value pairs
-     * @return string Calculated URL
-     */
-    public static function getModuleUrl($moduleName, $urlParameters = [])
-    {
-        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
-        try {
-            $uri = $uriBuilder->buildUriFromRoute($moduleName, $urlParameters);
-        } catch (RouteNotFoundException $e) {
-            $uri = $uriBuilder->buildUriFromRoutePath($moduleName, $urlParameters);
-        }
-        return (string)$uri;
-    }
+	/**
+	 * Returns the URL to a given module
+	 *
+	 * @param string $moduleName Name of the module
+	 * @param array $urlParameters URL parameters that should be added as key value pairs
+	 * @return string Calculated URL
+	 */
+	public static function getModuleUrl($moduleName, $urlParameters = [])
+	{
+		$uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
+		try {
+			$uri = $uriBuilder->buildUriFromRoute($moduleName, $urlParameters);
+		} catch (RouteNotFoundException $e) {
+			$uri = $uriBuilder->buildUriFromRoutePath($moduleName, $urlParameters);
+		}
+		return (string)$uri;
+	}
 
 }

Classes/Persistence/Matcher.php

Indentation +495 added lines, -495 removed lines

@@ -13,499 +13,499 @@
  */
 class Matcher
 {
-    /**
-     * The logical OR
-     */
-    const LOGICAL_OR = 'logicalOr';
-
-    /**
-     * The logical AND
-     */
-    const LOGICAL_AND = 'logicalAnd';
-
-    /**
-     * @var string
-     */
-    protected $dataType = '';
-
-    /**
-     * @var string
-     */
-    protected $searchTerm = '';
-
-    /**
-     * @var array
-     */
-    protected $supportedOperators = [
-        '=' => 'equals',
-        '!=' => 'notEquals',
-        'in' => 'in',
-        'like' => 'like',
-        '>' => 'greaterThan',
-        '>=' => 'greaterThanOrEqual',
-        '<' => 'lessThan',
-        '<=' => 'lessThanOrEqual',
-    ];
-
-    /**
-     * @var array
-     */
-    protected $equals = [];
-
-    /**
-     * @var array
-     */
-    protected $notEquals = [];
-
-    /**
-     * @var array
-     */
-    protected $greaterThan = [];
-
-    /**
-     * @var array
-     */
-    protected $greaterThanOrEqual = [];
-
-    /**
-     * @var array
-     */
-    protected $lessThan = [];
-
-    /**
-     * @var array
-     */
-    protected $lessThanOrEqual = [];
-
-    /**
-     * @var array
-     */
-    protected $in = [];
-
-    /**
-     * @var array
-     */
-    protected $like = [];
-
-    /**
-     * @var array
-     */
-    protected $matches = [];
-
-    /**
-     * @var string
-     */
-    protected $defaultLogicalSeparator = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForEquals = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForGreaterThan = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForGreaterThanOrEqual = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForLessThan = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForLessThanOrEqual = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForIn = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForLike = self::LOGICAL_AND;
-
-    /**
-     * @var string
-     */
-    protected $logicalSeparatorForSearchTerm = self::LOGICAL_OR;
-
-    /**
-     * Constructs a new Matcher
-     *
-     * @param array $matches associative [$field => $value]
-     * @param string $dataType which corresponds to an entry of the TCA (table name).
-     */
-    public function __construct($matches = [], $dataType = '')
-    {
-        $this->dataType = $dataType;
-        $this->matches = $matches;
-    }
-
-    /**
-     * @param string $searchTerm
-     * @return \Fab\Vidi\Persistence\Matcher
-     */
-    public function setSearchTerm($searchTerm): Matcher
-    {
-        $this->searchTerm = $searchTerm;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getSearchTerm(): string
-    {
-        return $this->searchTerm;
-    }
-
-    /**
-     * @return array
-     */
-    public function getEquals(): array
-    {
-        return $this->equals;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function equals($fieldNameAndPath, $operand): self
-    {
-        $this->equals[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getNotEquals(): array
-    {
-        return $this->notEquals;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function notEquals($fieldNameAndPath, $operand): self
-    {
-        $this->notEquals[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getGreaterThan(): array
-    {
-        return $this->greaterThan;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function greaterThan($fieldNameAndPath, $operand): self
-    {
-        $this->greaterThan[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getGreaterThanOrEqual(): array
-    {
-        return $this->greaterThanOrEqual;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function greaterThanOrEqual($fieldNameAndPath, $operand): self
-    {
-        $this->greaterThanOrEqual[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getLessThan(): array
-    {
-        return $this->lessThan;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function lessThan($fieldNameAndPath, $operand): self
-    {
-        $this->lessThan[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getLessThanOrEqual(): array
-    {
-        return $this->lessThanOrEqual;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function lessThanOrEqual($fieldNameAndPath, $operand): self
-    {
-        $this->lessThanOrEqual[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getLike(): array
-    {
-        return $this->like;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @return $this
-     */
-    public function in($fieldNameAndPath, $operand): self
-    {
-        $this->in[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getIn(): array
-    {
-        return $this->in;
-    }
-
-    /**
-     * @param $fieldNameAndPath
-     * @param $operand
-     * @param bool $addWildCard
-     * @return $this
-     */
-    public function like($fieldNameAndPath, $operand, $addWildCard = true): self
-    {
-        $wildCardSymbol = $addWildCard ? '%' : '';
-        $this->like[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $wildCardSymbol . $operand . $wildCardSymbol];
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDefaultLogicalSeparator(): string
-    {
-        return $this->defaultLogicalSeparator;
-    }
-
-    /**
-     * @param string $defaultLogicalSeparator
-     * @return $this
-     */
-    public function setDefaultLogicalSeparator($defaultLogicalSeparator): self
-    {
-        $this->defaultLogicalSeparator = $defaultLogicalSeparator;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForEquals(): string
-    {
-        return $this->logicalSeparatorForEquals;
-    }
-
-    /**
-     * @param string $logicalSeparatorForEquals
-     * @return $this
-     */
-    public function setLogicalSeparatorForEquals($logicalSeparatorForEquals): self
-    {
-        $this->logicalSeparatorForEquals = $logicalSeparatorForEquals;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForGreaterThan(): string
-    {
-        return $this->logicalSeparatorForGreaterThan;
-    }
-
-    /**
-     * @param string $logicalSeparatorForGreaterThan
-     * @return $this
-     */
-    public function setLogicalSeparatorForGreaterThan($logicalSeparatorForGreaterThan): self
-    {
-        $this->logicalSeparatorForGreaterThan = $logicalSeparatorForGreaterThan;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForGreaterThanOrEqual(): string
-    {
-        return $this->logicalSeparatorForGreaterThanOrEqual;
-    }
-
-    /**
-     * @param string $logicalSeparatorForGreaterThanOrEqual
-     * @return $this
-     */
-    public function setLogicalSeparatorForGreaterThanOrEqual($logicalSeparatorForGreaterThanOrEqual): self
-    {
-        $this->logicalSeparatorForGreaterThanOrEqual = $logicalSeparatorForGreaterThanOrEqual;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForLessThan(): string
-    {
-        return $this->logicalSeparatorForLessThan;
-    }
-
-    /**
-     * @param string $logicalSeparatorForLessThan
-     * @return $this
-     */
-    public function setLogicalSeparatorForLessThan($logicalSeparatorForLessThan): self
-    {
-        $this->logicalSeparatorForLessThan = $logicalSeparatorForLessThan;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForLessThanOrEqual(): string
-    {
-        return $this->logicalSeparatorForLessThanOrEqual;
-    }
-
-    /**
-     * @param string $logicalSeparatorForLessThanOrEqual
-     * @return $this
-     */
-    public function setLogicalSeparatorForLessThanOrEqual($logicalSeparatorForLessThanOrEqual): self
-    {
-        $this->logicalSeparatorForLessThanOrEqual = $logicalSeparatorForLessThanOrEqual;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForIn(): string
-    {
-        return $this->logicalSeparatorForIn;
-    }
-
-    /**
-     * @param string $logicalSeparatorForIn
-     * @return $this
-     */
-    public function setLogicalSeparatorForIn($logicalSeparatorForIn): self
-    {
-        $this->logicalSeparatorForIn = $logicalSeparatorForIn;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForLike(): string
-    {
-        return $this->logicalSeparatorForLike;
-    }
-
-    /**
-     * @param string $logicalSeparatorForLike
-     * @return $this
-     */
-    public function setLogicalSeparatorForLike($logicalSeparatorForLike): self
-    {
-        $this->logicalSeparatorForLike = $logicalSeparatorForLike;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLogicalSeparatorForSearchTerm(): string
-    {
-        return $this->logicalSeparatorForSearchTerm;
-    }
-
-    /**
-     * @param string $logicalSeparatorForSearchTerm
-     * @return $this
-     */
-    public function setLogicalSeparatorForSearchTerm($logicalSeparatorForSearchTerm): self
-    {
-        $this->logicalSeparatorForSearchTerm = $logicalSeparatorForSearchTerm;
-        return $this;
-    }
-
-    /**
-     * @return array
-     */
-    public function getSupportedOperators(): array
-    {
-        return $this->supportedOperators;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDataType(): string
-    {
-        return $this->dataType;
-    }
-
-    /**
-     * @param string $dataType
-     * @return $this
-     */
-    public function setDataType($dataType): self
-    {
-        $this->dataType = $dataType;
-        return $this;
-    }
+	/**
+	 * The logical OR
+	 */
+	const LOGICAL_OR = 'logicalOr';
+
+	/**
+	 * The logical AND
+	 */
+	const LOGICAL_AND = 'logicalAnd';
+
+	/**
+	 * @var string
+	 */
+	protected $dataType = '';
+
+	/**
+	 * @var string
+	 */
+	protected $searchTerm = '';
+
+	/**
+	 * @var array
+	 */
+	protected $supportedOperators = [
+		'=' => 'equals',
+		'!=' => 'notEquals',
+		'in' => 'in',
+		'like' => 'like',
+		'>' => 'greaterThan',
+		'>=' => 'greaterThanOrEqual',
+		'<' => 'lessThan',
+		'<=' => 'lessThanOrEqual',
+	];
+
+	/**
+	 * @var array
+	 */
+	protected $equals = [];
+
+	/**
+	 * @var array
+	 */
+	protected $notEquals = [];
+
+	/**
+	 * @var array
+	 */
+	protected $greaterThan = [];
+
+	/**
+	 * @var array
+	 */
+	protected $greaterThanOrEqual = [];
+
+	/**
+	 * @var array
+	 */
+	protected $lessThan = [];
+
+	/**
+	 * @var array
+	 */
+	protected $lessThanOrEqual = [];
+
+	/**
+	 * @var array
+	 */
+	protected $in = [];
+
+	/**
+	 * @var array
+	 */
+	protected $like = [];
+
+	/**
+	 * @var array
+	 */
+	protected $matches = [];
+
+	/**
+	 * @var string
+	 */
+	protected $defaultLogicalSeparator = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForEquals = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForGreaterThan = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForGreaterThanOrEqual = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForLessThan = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForLessThanOrEqual = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForIn = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForLike = self::LOGICAL_AND;
+
+	/**
+	 * @var string
+	 */
+	protected $logicalSeparatorForSearchTerm = self::LOGICAL_OR;
+
+	/**
+	 * Constructs a new Matcher
+	 *
+	 * @param array $matches associative [$field => $value]
+	 * @param string $dataType which corresponds to an entry of the TCA (table name).
+	 */
+	public function __construct($matches = [], $dataType = '')
+	{
+		$this->dataType = $dataType;
+		$this->matches = $matches;
+	}
+
+	/**
+	 * @param string $searchTerm
+	 * @return \Fab\Vidi\Persistence\Matcher
+	 */
+	public function setSearchTerm($searchTerm): Matcher
+	{
+		$this->searchTerm = $searchTerm;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSearchTerm(): string
+	{
+		return $this->searchTerm;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getEquals(): array
+	{
+		return $this->equals;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function equals($fieldNameAndPath, $operand): self
+	{
+		$this->equals[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getNotEquals(): array
+	{
+		return $this->notEquals;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function notEquals($fieldNameAndPath, $operand): self
+	{
+		$this->notEquals[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getGreaterThan(): array
+	{
+		return $this->greaterThan;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function greaterThan($fieldNameAndPath, $operand): self
+	{
+		$this->greaterThan[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getGreaterThanOrEqual(): array
+	{
+		return $this->greaterThanOrEqual;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function greaterThanOrEqual($fieldNameAndPath, $operand): self
+	{
+		$this->greaterThanOrEqual[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getLessThan(): array
+	{
+		return $this->lessThan;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function lessThan($fieldNameAndPath, $operand): self
+	{
+		$this->lessThan[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getLessThanOrEqual(): array
+	{
+		return $this->lessThanOrEqual;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function lessThanOrEqual($fieldNameAndPath, $operand): self
+	{
+		$this->lessThanOrEqual[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getLike(): array
+	{
+		return $this->like;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @return $this
+	 */
+	public function in($fieldNameAndPath, $operand): self
+	{
+		$this->in[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $operand];
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getIn(): array
+	{
+		return $this->in;
+	}
+
+	/**
+	 * @param $fieldNameAndPath
+	 * @param $operand
+	 * @param bool $addWildCard
+	 * @return $this
+	 */
+	public function like($fieldNameAndPath, $operand, $addWildCard = true): self
+	{
+		$wildCardSymbol = $addWildCard ? '%' : '';
+		$this->like[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $wildCardSymbol . $operand . $wildCardSymbol];
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDefaultLogicalSeparator(): string
+	{
+		return $this->defaultLogicalSeparator;
+	}
+
+	/**
+	 * @param string $defaultLogicalSeparator
+	 * @return $this
+	 */
+	public function setDefaultLogicalSeparator($defaultLogicalSeparator): self
+	{
+		$this->defaultLogicalSeparator = $defaultLogicalSeparator;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForEquals(): string
+	{
+		return $this->logicalSeparatorForEquals;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForEquals
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForEquals($logicalSeparatorForEquals): self
+	{
+		$this->logicalSeparatorForEquals = $logicalSeparatorForEquals;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForGreaterThan(): string
+	{
+		return $this->logicalSeparatorForGreaterThan;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForGreaterThan
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForGreaterThan($logicalSeparatorForGreaterThan): self
+	{
+		$this->logicalSeparatorForGreaterThan = $logicalSeparatorForGreaterThan;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForGreaterThanOrEqual(): string
+	{
+		return $this->logicalSeparatorForGreaterThanOrEqual;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForGreaterThanOrEqual
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForGreaterThanOrEqual($logicalSeparatorForGreaterThanOrEqual): self
+	{
+		$this->logicalSeparatorForGreaterThanOrEqual = $logicalSeparatorForGreaterThanOrEqual;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForLessThan(): string
+	{
+		return $this->logicalSeparatorForLessThan;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForLessThan
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForLessThan($logicalSeparatorForLessThan): self
+	{
+		$this->logicalSeparatorForLessThan = $logicalSeparatorForLessThan;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForLessThanOrEqual(): string
+	{
+		return $this->logicalSeparatorForLessThanOrEqual;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForLessThanOrEqual
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForLessThanOrEqual($logicalSeparatorForLessThanOrEqual): self
+	{
+		$this->logicalSeparatorForLessThanOrEqual = $logicalSeparatorForLessThanOrEqual;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForIn(): string
+	{
+		return $this->logicalSeparatorForIn;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForIn
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForIn($logicalSeparatorForIn): self
+	{
+		$this->logicalSeparatorForIn = $logicalSeparatorForIn;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForLike(): string
+	{
+		return $this->logicalSeparatorForLike;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForLike
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForLike($logicalSeparatorForLike): self
+	{
+		$this->logicalSeparatorForLike = $logicalSeparatorForLike;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLogicalSeparatorForSearchTerm(): string
+	{
+		return $this->logicalSeparatorForSearchTerm;
+	}
+
+	/**
+	 * @param string $logicalSeparatorForSearchTerm
+	 * @return $this
+	 */
+	public function setLogicalSeparatorForSearchTerm($logicalSeparatorForSearchTerm): self
+	{
+		$this->logicalSeparatorForSearchTerm = $logicalSeparatorForSearchTerm;
+		return $this;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getSupportedOperators(): array
+	{
+		return $this->supportedOperators;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDataType(): string
+	{
+		return $this->dataType;
+	}
+
+	/**
+	 * @param string $dataType
+	 * @return $this
+	 */
+	public function setDataType($dataType): self
+	{
+		$this->dataType = $dataType;
+		return $this;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -317,7 +317,7 @@
     public function like($fieldNameAndPath, $operand, $addWildCard = true): self
     {
         $wildCardSymbol = $addWildCard ? '%' : '';
-        $this->like[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $wildCardSymbol . $operand . $wildCardSymbol];
+        $this->like[] = ['fieldNameAndPath' => $fieldNameAndPath, 'operand' => $wildCardSymbol.$operand.$wildCardSymbol];
         return $this;
     }
 

Classes/Facet/StandardFacet.php

Indentation +139 added lines, -139 removed lines

@@ -20,144 +20,144 @@
 class StandardFacet implements FacetInterface
 {
 
-    /**
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * @var string
-     */
-    protected $label;
-
-    /**
-     * @var array
-     */
-    protected $suggestions = [];
-
-    /**
-     * @var string
-     */
-    protected $dataType;
-
-    /**
-     * @var bool
-     */
-    protected $canModifyMatcher = false;
-
-    /**
-     * Constructor of a Generic Facet in Vidi.
-     *
-     * @param string $name
-     * @param string $label
-     * @param array $suggestions
-     */
-    public function __construct($name, $label = '', array $suggestions = [])
-    {
-        $this->name = $name;
-        if (empty($label)) {
-            $label = $this->name;
-        }
-        $this->label = $label;
-        $this->suggestions = $suggestions;
-    }
-
-    /**
-     * @return string
-     */
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLabel(): string
-    {
-        if ($this->label === $this->name) {
-            $label = Tca::table($this->dataType)->field($this->getName())->getLabel();
-        } else {
-            try {
-                $label = LocalizationUtility::translate($this->label, '');
-            } catch (\InvalidArgumentException $e) {
-            }
-            if (empty($label)) {
-                $label = $this->label;
-            }
-        }
-
-        return $label;
-    }
-
-    /**
-     * @return array
-     */
-    public function getSuggestions(): array
-    {
-
-        $values = [];
-        foreach ($this->suggestions as $key => $label) {
-            $localizedLabel = $this->getLanguageService()->sL($label);
-            if (!empty($localizedLabel)) {
-                $label = $localizedLabel;
-            }
-
-            $values[] = [$key => $label];
-        }
-
-        return $values;
-    }
-
-    /**
-     * @return LanguageService
-     */
-    protected function getLanguageService(): LanguageService
-    {
-        /** @var LanguageService $langService */
-        $langService = $GLOBALS['LANG'];
-        if (!$langService) {
-            $langService = GeneralUtility::makeInstance(LanguageService::class);
-            $langService->init('en');
-        }
-
-        return $langService;
-    }
-
-    /**
-     * @return bool
-     */
-    public function hasSuggestions(): bool
-    {
-        return !empty($this->suggestions);
-    }
-
-    /**
-     * @param string $dataType
-     * @return $this
-     */
-    public function setDataType($dataType): self
-    {
-        $this->dataType = $dataType;
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function canModifyMatcher(): bool
-    {
-        return $this->canModifyMatcher;
-    }
-
-    /**
-     * @param Matcher $matcher
-     * @param $value
-     * @return Matcher
-     */
-    public function modifyMatcher(Matcher $matcher, $value): Matcher
-    {
-        return $matcher;
-    }
+	/**
+	 * @var string
+	 */
+	protected $name;
+
+	/**
+	 * @var string
+	 */
+	protected $label;
+
+	/**
+	 * @var array
+	 */
+	protected $suggestions = [];
+
+	/**
+	 * @var string
+	 */
+	protected $dataType;
+
+	/**
+	 * @var bool
+	 */
+	protected $canModifyMatcher = false;
+
+	/**
+	 * Constructor of a Generic Facet in Vidi.
+	 *
+	 * @param string $name
+	 * @param string $label
+	 * @param array $suggestions
+	 */
+	public function __construct($name, $label = '', array $suggestions = [])
+	{
+		$this->name = $name;
+		if (empty($label)) {
+			$label = $this->name;
+		}
+		$this->label = $label;
+		$this->suggestions = $suggestions;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLabel(): string
+	{
+		if ($this->label === $this->name) {
+			$label = Tca::table($this->dataType)->field($this->getName())->getLabel();
+		} else {
+			try {
+				$label = LocalizationUtility::translate($this->label, '');
+			} catch (\InvalidArgumentException $e) {
+			}
+			if (empty($label)) {
+				$label = $this->label;
+			}
+		}
+
+		return $label;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getSuggestions(): array
+	{
+
+		$values = [];
+		foreach ($this->suggestions as $key => $label) {
+			$localizedLabel = $this->getLanguageService()->sL($label);
+			if (!empty($localizedLabel)) {
+				$label = $localizedLabel;
+			}
+
+			$values[] = [$key => $label];
+		}
+
+		return $values;
+	}
+
+	/**
+	 * @return LanguageService
+	 */
+	protected function getLanguageService(): LanguageService
+	{
+		/** @var LanguageService $langService */
+		$langService = $GLOBALS['LANG'];
+		if (!$langService) {
+			$langService = GeneralUtility::makeInstance(LanguageService::class);
+			$langService->init('en');
+		}
+
+		return $langService;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function hasSuggestions(): bool
+	{
+		return !empty($this->suggestions);
+	}
+
+	/**
+	 * @param string $dataType
+	 * @return $this
+	 */
+	public function setDataType($dataType): self
+	{
+		$this->dataType = $dataType;
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function canModifyMatcher(): bool
+	{
+		return $this->canModifyMatcher;
+	}
+
+	/**
+	 * @param Matcher $matcher
+	 * @param $value
+	 * @return Matcher
+	 */
+	public function modifyMatcher(Matcher $matcher, $value): Matcher
+	{
+		return $matcher;
+	}
 
 }

Classes/Facet/CompositeFacet.php

Indentation +159 added lines, -159 removed lines

@@ -20,164 +20,164 @@
 class CompositeFacet implements FacetInterface
 {
 
-    /**
-     * @var string
-     */
-    protected $name;
-
-    /**
-     * @var string
-     */
-    protected $label;
-
-    /**
-     * @var array
-     */
-    protected $suggestions = [
-        '0' => 'LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:active.0',
-    ];
-
-    /**
-     * @var array
-     */
-    protected $configuration = [];
-
-    /**
-     * @var string
-     */
-    protected $dataType;
-
-    /**
-     * @var bool
-     */
-    protected $canModifyMatcher = true;
-
-    /**
-     * Constructor of a Generic Facet in Vidi.
-     *
-     * @param string $name
-     * @param string $label
-     * @param array $suggestions
-     * @param array $configuration
-     */
-    public function __construct($name, $label = '', array $suggestions = [], $configuration = [])
-    {
-        $this->name = $name;
-        if (empty($label)) {
-            $label = $this->name;
-        }
-        $this->label = $label;
-        if ($suggestions) {
-            $this->suggestions = $suggestions;
-        }
-        if ($configuration) {
-            $this->configuration = $configuration;
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    /**
-     * @return string
-     */
-    public function getLabel(): string
-    {
-        if ($this->label === $this->name) {
-            $label = Tca::table($this->dataType)->field($this->getName())->getLabel();
-        } else {
-            try {
-                $label = LocalizationUtility::translate($this->label, '');
-            } catch (\InvalidArgumentException $e) {
-            }
-            if (empty($label)) {
-                $label = $this->label;
-            }
-        }
-
-        return $label;
-    }
-
-    /**
-     * @return array
-     */
-    public function getSuggestions(): array
-    {
-
-        $values = [];
-        foreach ($this->suggestions as $key => $label) {
-            $localizedLabel = $this->getLanguageService()->sL($label);
-            if (!empty($localizedLabel)) {
-                $label = $localizedLabel;
-            }
-
-            $values[] = [$key => $label];
-        }
-
-        return $values;
-    }
-
-    /**
-     * @return LanguageService
-     */
-    protected function getLanguageService(): LanguageService
-    {
-        /** @var LanguageService $langService */
-        $langService = $GLOBALS['LANG'];
-        if (!$langService) {
-            $langService = GeneralUtility::makeInstance(LanguageService::class);
-            $langService->init('en');
-        }
-
-        return $langService;
-    }
-
-    /**
-     * @return bool
-     */
-    public function hasSuggestions(): bool
-    {
-        return !empty($this->suggestions);
-    }
-
-    /**
-     * @param string $dataType
-     * @return $this
-     */
-    public function setDataType($dataType): self
-    {
-        $this->dataType = $dataType;
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function canModifyMatcher(): bool
-    {
-        return $this->canModifyMatcher;
-    }
-
-    /**
-     * @param Matcher $matcher
-     * @param $value
-     * @return Matcher
-     */
-    public function modifyMatcher(Matcher $matcher, $value): Matcher
-    {
-        foreach ($this->configuration as $fieldNameAndPath => $operand) {
-            if ($operand === '*') {
-                $matcher->notEquals($fieldNameAndPath, '');
-            } else {
-                $matcher->equals($fieldNameAndPath, $operand);
-            }
-        }
-        return $matcher;
-    }
+	/**
+	 * @var string
+	 */
+	protected $name;
+
+	/**
+	 * @var string
+	 */
+	protected $label;
+
+	/**
+	 * @var array
+	 */
+	protected $suggestions = [
+		'0' => 'LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:active.0',
+	];
+
+	/**
+	 * @var array
+	 */
+	protected $configuration = [];
+
+	/**
+	 * @var string
+	 */
+	protected $dataType;
+
+	/**
+	 * @var bool
+	 */
+	protected $canModifyMatcher = true;
+
+	/**
+	 * Constructor of a Generic Facet in Vidi.
+	 *
+	 * @param string $name
+	 * @param string $label
+	 * @param array $suggestions
+	 * @param array $configuration
+	 */
+	public function __construct($name, $label = '', array $suggestions = [], $configuration = [])
+	{
+		$this->name = $name;
+		if (empty($label)) {
+			$label = $this->name;
+		}
+		$this->label = $label;
+		if ($suggestions) {
+			$this->suggestions = $suggestions;
+		}
+		if ($configuration) {
+			$this->configuration = $configuration;
+		}
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLabel(): string
+	{
+		if ($this->label === $this->name) {
+			$label = Tca::table($this->dataType)->field($this->getName())->getLabel();
+		} else {
+			try {
+				$label = LocalizationUtility::translate($this->label, '');
+			} catch (\InvalidArgumentException $e) {
+			}
+			if (empty($label)) {
+				$label = $this->label;
+			}
+		}
+
+		return $label;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getSuggestions(): array
+	{
+
+		$values = [];
+		foreach ($this->suggestions as $key => $label) {
+			$localizedLabel = $this->getLanguageService()->sL($label);
+			if (!empty($localizedLabel)) {
+				$label = $localizedLabel;
+			}
+
+			$values[] = [$key => $label];
+		}
+
+		return $values;
+	}
+
+	/**
+	 * @return LanguageService
+	 */
+	protected function getLanguageService(): LanguageService
+	{
+		/** @var LanguageService $langService */
+		$langService = $GLOBALS['LANG'];
+		if (!$langService) {
+			$langService = GeneralUtility::makeInstance(LanguageService::class);
+			$langService->init('en');
+		}
+
+		return $langService;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function hasSuggestions(): bool
+	{
+		return !empty($this->suggestions);
+	}
+
+	/**
+	 * @param string $dataType
+	 * @return $this
+	 */
+	public function setDataType($dataType): self
+	{
+		$this->dataType = $dataType;
+		return $this;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function canModifyMatcher(): bool
+	{
+		return $this->canModifyMatcher;
+	}
+
+	/**
+	 * @param Matcher $matcher
+	 * @param $value
+	 * @return Matcher
+	 */
+	public function modifyMatcher(Matcher $matcher, $value): Matcher
+	{
+		foreach ($this->configuration as $fieldNameAndPath => $operand) {
+			if ($operand === '*') {
+				$matcher->notEquals($fieldNameAndPath, '');
+			} else {
+				$matcher->equals($fieldNameAndPath, $operand);
+			}
+		}
+		return $matcher;
+	}
 
 }

Classes/Module/ModulePidService.php

Spacing +1 added lines, -1 removed lines

@@ -208,7 +208,7 @@
         $page = $query->select('doktype')
             ->from('pages')
             ->where('deleted = 0',
-                'uid = ' . $configuredPid)
+                'uid = '.$configuredPid)
             ->execute()
             ->fetch();
 

Indentation +207 added lines, -207 removed lines

@@ -20,212 +20,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
-     */
-    static public 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
+	 */
+	static public 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/View/Check/PidCheck.php

Indentation +34 added lines, -34 removed lines

@@ -19,33 +19,33 @@ 
  */
 class PidCheck extends AbstractComponentView
 {
-    /**
-     * Renders warnings if storagePid is not properly configured.
-     *
-     * @return string
-     */
-    public function render(): string
-    {
-        $errors = $this->getModulePidService()->validateConfiguredPid();
+	/**
+	 * Renders warnings if storagePid is not properly configured.
+	 *
+	 * @return string
+	 */
+	public function render(): string
+	{
+		$errors = $this->getModulePidService()->validateConfiguredPid();
 
-        return empty($errors)
-            ? ''
-            : $this->formatMessagePidIsNotValid($errors);
-    }
+		return empty($errors)
+			? ''
+			: $this->formatMessagePidIsNotValid($errors);
+	}
 
-    /**
-     * Format a message whenever the storage is offline.
-     *
-     * @param array $errors
-     * @return string
-     */
-    protected function formatMessagePidIsNotValid(array $errors): string
-    {
-        $configuredPid = $this->getModulePidService()->getConfiguredNewRecordPid();
+	/**
+	 * Format a message whenever the storage is offline.
+	 *
+	 * @param array $errors
+	 * @return string
+	 */
+	protected function formatMessagePidIsNotValid(array $errors): string
+	{
+		$configuredPid = $this->getModulePidService()->getConfiguredNewRecordPid();
 
-        $error = implode('<br />', $errors);
-        $dataType = $this->getModuleLoader()->getDataType();
-        $result = <<< EOF
+		$error = implode('<br />', $errors);
+		$dataType = $this->getModuleLoader()->getDataType();
+		$result = <<< EOF
 			<div class="alert alert-warning">
 				<div class="alert-title">
 					Page id "{$configuredPid}" has found to be a wrong configuration for "{$dataType}"
@@ -73,16 +73,16 @@ 
 			</div>
 EOF;
 
-        return $result;
-    }
+		return $result;
+	}
 
-    /**
-     * @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/Tca/GridService.php

Spacing +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
         $this->tableName = $tableName;
 
         if (empty($GLOBALS['TCA'][$this->tableName])) {
-            throw new InvalidKeyInArrayException('No TCA existence for table name: ' . $this->tableName, 1356945108);
+            throw new InvalidKeyInArrayException('No TCA existence for table name: '.$this->tableName, 1356945108);
         }
 
         $this->tca = $GLOBALS['TCA'][$this->tableName]['grid'];
@@ -170,7 +170,7 @@ 
     {
         $fields = array_keys($this->getFields());
         if (empty($fields[$position])) {
-            throw new InvalidKeyInArrayException('No field exist for position: ' . $position, 1356945119);
+            throw new InvalidKeyInArrayException('No field exist for position: '.$position, 1356945119);
         }
 
         return (string)$fields[$position];
@@ -686,7 +686,7 @@ 
         $facet = GeneralUtility::makeInstance(StandardFacet::class, $facetName, $label);
 
         if (!$facet instanceof StandardFacet) {
-            throw new \RuntimeException('I could not instantiate a facet for facet name "' . $facetName . '""', 1445856345);
+            throw new \RuntimeException('I could not instantiate a facet for facet name "'.$facetName.'""', 1445856345);
         }
         return $facet;
     }

Indentation +703 added lines, -703 removed lines

@@ -24,708 +24,708 @@
 class GridService extends AbstractTca
 {
 
-    /**
-     * @var array
-     */
-    protected $tca;
-
-    /**
-     * @var string
-     */
-    protected $tableName;
-
-    /**
-     * All fields available in the Grid.
-     *
-     * @var array
-     */
-    protected $fields;
-
-    /**
-     * All fields regardless whether they have been excluded or not.
-     *
-     * @var array
-     */
-    protected $allFields;
-
-    /**
-     * @var array
-     */
-    protected $instances;
-
-    /**
-     * @var array
-     */
-    protected $facets;
-
-    /**
-     * __construct
-     *
-     * @param string $tableName
-     */
-    public function __construct($tableName)
-    {
-
-        $this->tableName = $tableName;
-
-        if (empty($GLOBALS['TCA'][$this->tableName])) {
-            throw new InvalidKeyInArrayException('No TCA existence for table name: ' . $this->tableName, 1356945108);
-        }
-
-        $this->tca = $GLOBALS['TCA'][$this->tableName]['grid'];
-    }
-
-    /**
-     * Returns an array containing column names.
-     *
-     * @return array
-     */
-    public function getFieldNames(): array
-    {
-        $fields = $this->getFields();
-        return array_keys($fields) ?: [];
-    }
-
-    /**
-     * Returns an array containing column names.
-     *
-     * @return array
-     */
-    public function getAllFieldNames(): array
-    {
-        $allFields = $this->getAllFields();
-        return array_keys($allFields);
-    }
-
-    /**
-     * Get the label key.
-     *
-     * @param string $fieldNameAndPath
-     * @return string
-     */
-    public function getLabelKey($fieldNameAndPath): string
-    {
-
-        $field = $this->getField($fieldNameAndPath);
-
-        // First option is to get the label from the Grid TCA.
-        $rawLabel = '';
-        if (isset($field['label'])) {
-            $rawLabel = $field['label'];
-        }
-
-        // Second option is to fetch the label from the Column Renderer object.
-        if (!$rawLabel && $this->hasRenderers($fieldNameAndPath)) {
-            $renderers = $this->getRenderers($fieldNameAndPath);
-            /** @var $renderer ColumnRendererInterface */
-            foreach ($renderers as $renderer) {
-                if (isset($renderer['label'])) {
-                    $rawLabel = $renderer['label'];
-                    break;
-                }
-            }
-        }
-        return $rawLabel;
-    }
-
-    /**
-     * Get the translation of a label given a column name.
-     *
-     * @param string $fieldNameAndPath
-     * @return string
-     */
-    public function getLabel($fieldNameAndPath)
-    {
-        $label = '';
-        if ($this->hasLabel($fieldNameAndPath)) {
-            $labelKey = $this->getLabelKey($fieldNameAndPath);
-            try {
-                $label = $this->getLanguageService()->sL($labelKey);
-            } catch (\InvalidArgumentException $e) {
-            }
-            if (empty($label)) {
-                $label = $labelKey;
-            }
-        } else {
-
-            // Important to notice the label can contains a path, e.g. metadata.categories and must be resolved.
-            $dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->tableName);
-            $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->tableName);
-            $table = Tca::table($dataType);
-
-            if ($table->hasField($fieldName) && $table->field($fieldName)->hasLabel()) {
-                $label = $table->field($fieldName)->getLabel();
-            }
-        }
-
-        return $label;
-    }
-
-    /**
-     * Returns the field name given its position.
-     *
-     * @param string $position the position of the field in the grid
-     * @return string
-     */
-    public function getFieldNameByPosition($position): string
-    {
-        $fields = array_keys($this->getFields());
-        if (empty($fields[$position])) {
-            throw new InvalidKeyInArrayException('No field exist for position: ' . $position, 1356945119);
-        }
-
-        return (string)$fields[$position];
-    }
-
-    /**
-     * Returns a field name.
-     *
-     * @param string $fieldName
-     * @return array
-     */
-    public function getField($fieldName): array
-    {
-        $fields = $this->getFields();
-        return $fields[$fieldName] ?: [];
-    }
-
-    /**
-     * Returns an array containing column names for the Grid.
-     *
-     * @return array
-     */
-    public function getFields(): array
-    {
-        // Cache this operation since it can take some time.
-        if ($this->fields === null) {
-
-            // Fetch all available fields first.
-            $fields = $this->getAllFields();
-
-            if ($this->isBackendMode()) {
-
-                // Then remove the not allowed.
-                $fields = $this->filterByIncludedFields($fields);
-                $fields = $this->filterByBackendUser($fields);
-                $fields = $this->filterByExcludedFields($fields);
-            }
-
-            $this->fields = $fields;
-        }
-
-        return $this->fields;
-    }
-
-    /**
-     * Remove fields according to Grid configuration.
-     *
-     * @param $fields
-     * @return array
-     */
-    protected function filterByIncludedFields($fields): array
-    {
-
-        $filteredFields = $fields;
-        $includedFields = $this->getIncludedFields();
-        if (count($includedFields) > 0) {
-            $filteredFields = [];
-            foreach ($fields as $fieldNameAndPath => $configuration) {
-                if (in_array($fieldNameAndPath, $includedFields, true) || !Tca::table($this->tableName)->hasField($fieldNameAndPath)) {
-                    $filteredFields[$fieldNameAndPath] = $configuration;
-                }
-            }
-        }
-        return $filteredFields;
-    }
-
-    /**
-     * Remove fields according to BE User permission.
-     *
-     * @param $fields
-     * @return array
-     */
-    protected function filterByBackendUser($fields): array
-    {
-        if (!$this->getBackendUser()->isAdmin()) {
-            foreach ($fields as $fieldName => $field) {
-                if (Tca::table($this->tableName)->hasField($fieldName) && !Tca::table($this->tableName)->field($fieldName)->hasAccess()) {
-                    unset($fields[$fieldName]);
-                }
-            }
-        }
-        return $fields;
-    }
-
-    /**
-     * Remove fields according to Grid configuration.
-     *
-     * @param $fields
-     * @return array
-     */
-    protected function filterByExcludedFields($fields): array
-    {
-
-        // Unset excluded fields.
-        foreach ($this->getExcludedFields() as $excludedField) {
-            if (isset($fields[$excludedField])) {
-                unset($fields[$excludedField]);
-            }
-        }
-
-        return $fields;
-    }
-
-    /**
-     * Returns an array containing column names for the Grid.
-     *
-     * @return array
-     */
-    public function getAllFields(): array
-    {
-
-        // Cache this operation since it can take some time.
-        if ($this->allFields === null) {
-
-            $fields = is_array($this->tca['columns']) ? $this->tca['columns'] : [];
-            $gridFieldNames = array_keys($fields);
-
-            // Fetch all fields of the TCA and merge it back to the fields configured for Grid.
-            $tableFieldNames = Tca::table($this->tableName)->getFields();
-
-            // Just remove system fields from the Grid.
-            foreach ($tableFieldNames as $key => $fieldName) {
-                if (in_array($fieldName, Tca::getSystemFields())) {
-                    unset($tableFieldNames[$key]);
-                }
-            }
-
-            $additionalFields = array_diff($tableFieldNames, $gridFieldNames);
-
-            if (!empty($additionalFields)) {
-
-                // Pop out last element of the key
-                // Idea is to place new un-configured columns in between. By default, they will be hidden.
-                end($fields);
-                $lastColumnKey = key($fields);
-                $lastColumn = array_pop($fields);
-
-                // Feed up the grid fields with un configured elements
-                foreach ($additionalFields as $additionalField) {
-                    $fields[$additionalField] = array(
-                        'visible' => false
-                    );
-
-                    // Try to guess the format of the field.
-                    $fieldType = Tca::table($this->tableName)->field($additionalField)->getType();
-                    if ($fieldType === FieldType::DATE) {
-                        $fields[$additionalField]['format'] = 'Fab\Vidi\Formatter\Date';
-                    } elseif ($fieldType === FieldType::DATETIME) {
-                        $fields[$additionalField]['format'] = 'Fab\Vidi\Formatter\Datetime';
-                    }
-                }
-                $fields[$lastColumnKey] = $lastColumn;
-            }
-
-            $this->allFields = $fields;
-        }
-
-        return $this->allFields;
-    }
-
-    /**
-     * Tell whether the field exists in the grid or not.
-     *
-     * @param string $fieldName
-     * @return bool
-     */
-    public function hasField($fieldName): bool
-    {
-        $fields = $this->getFields();
-        return isset($fields[$fieldName]);
-    }
-
-    /**
-     * Tell whether the facet exists in the grid or not.
-     *
-     * @param string $facetName
-     * @return bool
-     */
-    public function hasFacet($facetName): bool
-    {
-        $facets = $this->getFacets();
-        return isset($facets[$facetName]);
-    }
-
-    /**
-     * Returns an array containing facets fields.
-     *
-     * @return FacetInterface[]
-     */
-    public function getFacets(): array
-    {
-        if ($this->facets === null) {
-            $this->facets = [];
-
-            if (is_array($this->tca['facets'])) {
-                foreach ($this->tca['facets'] as $key => $facetNameOrArray) {
-                    if (is_array($facetNameOrArray)) {
-
-                        $name = $facetNameOrArray['name'] ?? '';
-
-                        $label = isset($facetNameOrArray['label'])
-                            ? $this->getLanguageService()->sL($facetNameOrArray['label'])
-                            : '';
-
-                        $suggestions = $facetNameOrArray['suggestions'] ?? [];
-                        $configuration = $facetNameOrArray['configuration'] ?? [];
-
-                        /** @var FacetInterface $facetObject */
-                        $facetObject = GeneralUtility::makeInstance($key, $name, $label, $suggestions, $configuration);
-                        $this->facets[$facetObject->getName()] = $facetObject;
-                    } else {
-                        $this->facets[$facetNameOrArray] = $this->instantiateStandardFacet($facetNameOrArray);
-                    }
-                }
-            }
-        }
-        return $this->facets;
-    }
-
-    /**
-     * Returns the "sortable" value of the column.
-     *
-     * @param string $fieldName
-     * @return int|string
-     */
-    public function isSortable($fieldName)
-    {
-        $defaultValue = true;
-        $hasSortableField = Tca::table($this->tableName)->hasSortableField();
-        if ($hasSortableField) {
-            $isSortable = false;
-        } else {
-            $isSortable = $this->get($fieldName, 'sortable', $defaultValue);
-        }
-        return $isSortable;
-    }
-
-    /**
-     * Returns the "canBeHidden" value of the column.
-     *
-     * @param string $fieldName
-     * @return bool
-     */
-    public function canBeHidden($fieldName): bool
-    {
-        $defaultValue = true;
-        return $this->get($fieldName, 'canBeHidden', $defaultValue);
-    }
-
-    /**
-     * Returns the "width" value of the column.
-     *
-     * @param string $fieldName
-     * @return int|string
-     */
-    public function getWidth($fieldName)
-    {
-        $defaultValue = 'auto';
-        return $this->get($fieldName, 'width', $defaultValue);
-    }
-
-    /**
-     * Returns the "visible" value of the column.
-     *
-     * @param string $fieldName
-     * @return bool
-     */
-    public function isVisible($fieldName): bool
-    {
-        $defaultValue = true;
-        return $this->get($fieldName, 'visible', $defaultValue);
-    }
-
-    /**
-     * Returns the "editable" value of the column.
-     *
-     * @param string $columnName
-     * @return bool
-     */
-    public function isEditable($columnName): bool
-    {
-        $defaultValue = false;
-        return $this->get($columnName, 'editable', $defaultValue);
-    }
-
-    /**
-     * Returns the "localized" value of the column.
-     *
-     * @param string $columnName
-     * @return bool
-     */
-    public function isLocalized($columnName): bool
-    {
-        $defaultValue = true;
-        return $this->get($columnName, 'localized', $defaultValue);
-    }
-
-    /**
-     *
-     * Returns the "html" value of the column.
-     *
-     * @param string $fieldName
-     * @return string
-     */
-    public function getHeader($fieldName): string
-    {
-        $defaultValue = '';
-        return $this->get($fieldName, 'html', $defaultValue);
-    }
-
-    /**
-     * Fetch a possible from a Grid Renderer. If no value is found, returns null
-     *
-     * @param string $fieldName
-     * @param string $key
-     * @param mixed $defaultValue
-     * @return null|mixed
-     */
-    public function get($fieldName, $key, $defaultValue = null)
-    {
-        $value = $defaultValue;
-
-        $field = $this->getField($fieldName);
-        if (isset($field[$key])) {
-            $value = $field[$key];
-        } elseif ($this->hasRenderers($fieldName)) {
-            $renderers = $this->getRenderers($fieldName);
-            foreach ($renderers as $rendererConfiguration) {
-                if (isset($rendererConfiguration[$key])) {
-                    $value = $rendererConfiguration[$key];
-                }
-            }
-        }
-        return $value;
-    }
-
-    /**
-     * Returns whether the column has a renderer.
-     *
-     * @param string $fieldName
-     * @return bool
-     */
-    public function hasRenderers($fieldName): bool
-    {
-        $field = $this->getField($fieldName);
-        return empty($field['renderer']) && empty($field['renderers']) ? false : true;
-    }
-
-    /**
-     * Returns a renderer.
-     *
-     * @param string $fieldName
-     * @return array
-     */
-    public function getRenderers($fieldName): array
-    {
-        $field = $this->getField($fieldName);
-        $renderers = [];
-        if (!empty($field['renderer'])) {
-            $renderers = $this->convertRendererToArray($field['renderer'], $field);
-        } elseif (!empty($field['renderers']) && is_array($field['renderers'])) {
-            foreach ($field['renderers'] as $renderer) {
-                $rendererNameAndConfiguration = $this->convertRendererToArray($renderer, $field);
-                $renderers = array_merge($renderers, $rendererNameAndConfiguration);
-            }
-        }
-
-        return $renderers;
-    }
-
-    /**
-     * @param string $renderer
-     * @return array
-     */
-    protected function convertRendererToArray($renderer, array $field): array
-    {
-        $result = [];
-        if (is_string($renderer)) {
-            $configuration = empty($field['rendererConfiguration'])
-                ? []
-                : $field['rendererConfiguration'];
-
-            /** @var ColumnRendererInterface $rendererObject */
-            $rendererObject = GeneralUtility::makeInstance($renderer);
-
-            $result[$renderer] = array_merge($rendererObject->getConfiguration(), $configuration);
-            // TODO: throw alert message because this is not compatible anymore as of TYPO3 8.7.7
-        } elseif ($renderer instanceof ColumnRendererInterface) {
-            /** @var ColumnRendererInterface $renderer */
-            $result[get_class($renderer)] = $renderer->getConfiguration();
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the class names applied to a cell
-     *
-     * @param string $fieldName
-     * @return bool
-     */
-    public function getClass($fieldName): bool
-    {
-        $field = $this->getField($fieldName);
-        return isset($field['class']) ? $field['class'] : '';
-    }
-
-    /**
-     * Returns whether the column has a label.
-     *
-     * @param string $fieldNameAndPath
-     * @return bool
-     */
-    public function hasLabel($fieldNameAndPath): bool
-    {
-        $field = $this->getField($fieldNameAndPath);
-
-        $hasLabel = empty($field['label']) ? false : true;
-
-        if (!$hasLabel && $this->hasRenderers($fieldNameAndPath)) {
-            $renderers = $this->getRenderers($fieldNameAndPath);
-            /** @var $renderer ColumnRendererInterface */
-            foreach ($renderers as $renderer) {
-                if (isset($renderer['label'])) {
-                    $hasLabel = true;
-                    break;
-                }
-            }
-        }
-        return $hasLabel;
-    }
-
-    /**
-     * @return array
-     */
-    public function getTca(): array
-    {
-        return $this->tca;
-    }
-
-    /**
-     * @return array
-     */
-    public function getIncludedFields(): array
-    {
-        return empty($this->tca['included_fields']) ? [] : GeneralUtility::trimExplode(',', $this->tca['included_fields'], true);
-    }
-
-    /**
-     * Return excluded fields from configuration + preferences.
-     *
-     * @return array
-     */
-    public function getExcludedFields(): array
-    {
-        $configurationFields = $this->getExcludedFieldsFromConfiguration();
-        $preferencesFields = $this->getExcludedFieldsFromPreferences();
-
-        return array_merge($configurationFields, $preferencesFields);
-    }
-
-    /**
-     * Fetch excluded fields from configuration.
-     *
-     * @return array
-     */
-    protected function getExcludedFieldsFromConfiguration(): array
-    {
-        $excludedFields = [];
-        if (!empty($this->tca['excluded_fields'])) {
-            $excludedFields = GeneralUtility::trimExplode(',', $this->tca['excluded_fields'], true);
-        } elseif (!empty($this->tca['export']['excluded_fields'])) { // only for export for legacy reason.
-            $excludedFields = GeneralUtility::trimExplode(',', $this->tca['export']['excluded_fields'], true);
-        }
-        return $excludedFields;
-
-    }
-
-    /**
-     * Fetch excluded fields from preferences.
-     *
-     * @return array
-     */
-    protected function getExcludedFieldsFromPreferences(): array
-    {
-        $excludedFields = $this->getModulePreferences()->get(ConfigurablePart::EXCLUDED_FIELDS, $this->tableName);
-        return is_array($excludedFields) ? $excludedFields : [];
-    }
-
-    /**
-     * @return bool
-     */
-    public function areFilesIncludedInExport(): bool
-    {
-        $isIncluded = true;
-
-        if (isset($this->tca['export']['include_files'])) {
-            $isIncluded = (bool)$this->tca['export']['include_files'];
-        }
-        return $isIncluded;
-    }
-
-    /**
-     * Returns a "facet" service instance.
-     *
-     * @param string|FacetInterface $facetName
-     * @return StandardFacet
-     */
-    protected function instantiateStandardFacet($facetName): StandardFacet
-    {
-        $label = $this->getLabel($facetName);
-
-        /** @var StandardFacet $facetName */
-        $facet = GeneralUtility::makeInstance(StandardFacet::class, $facetName, $label);
-
-        if (!$facet instanceof StandardFacet) {
-            throw new \RuntimeException('I could not instantiate a facet for facet name "' . $facetName . '""', 1445856345);
-        }
-        return $facet;
-    }
-
-    /**
-     * Returns a "facet" service instance.
-     *
-     * @param string|FacetInterface $facetName
-     * @return FacetInterface
-     */
-    public function facet($facetName = ''): FacetInterface
-    {
-        $facets = $this->getFacets();
-        return $facets[$facetName];
-    }
-
-    /**
-     * @return FieldPathResolver|object
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance(FieldPathResolver::class);
-    }
-
-    /**
-     * @return ModulePreferences|object
-     */
-    protected function getModulePreferences()
-    {
-        return GeneralUtility::makeInstance(ModulePreferences::class);
-    }
-
-    /**
-     * @return LanguageService|object
-     */
-    protected function getLanguageService()
-    {
-        return GeneralUtility::makeInstance(LanguageService::class);
-    }
+	/**
+	 * @var array
+	 */
+	protected $tca;
+
+	/**
+	 * @var string
+	 */
+	protected $tableName;
+
+	/**
+	 * All fields available in the Grid.
+	 *
+	 * @var array
+	 */
+	protected $fields;
+
+	/**
+	 * All fields regardless whether they have been excluded or not.
+	 *
+	 * @var array
+	 */
+	protected $allFields;
+
+	/**
+	 * @var array
+	 */
+	protected $instances;
+
+	/**
+	 * @var array
+	 */
+	protected $facets;
+
+	/**
+	 * __construct
+	 *
+	 * @param string $tableName
+	 */
+	public function __construct($tableName)
+	{
+
+		$this->tableName = $tableName;
+
+		if (empty($GLOBALS['TCA'][$this->tableName])) {
+			throw new InvalidKeyInArrayException('No TCA existence for table name: ' . $this->tableName, 1356945108);
+		}
+
+		$this->tca = $GLOBALS['TCA'][$this->tableName]['grid'];
+	}
+
+	/**
+	 * Returns an array containing column names.
+	 *
+	 * @return array
+	 */
+	public function getFieldNames(): array
+	{
+		$fields = $this->getFields();
+		return array_keys($fields) ?: [];
+	}
+
+	/**
+	 * Returns an array containing column names.
+	 *
+	 * @return array
+	 */
+	public function getAllFieldNames(): array
+	{
+		$allFields = $this->getAllFields();
+		return array_keys($allFields);
+	}
+
+	/**
+	 * Get the label key.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @return string
+	 */
+	public function getLabelKey($fieldNameAndPath): string
+	{
+
+		$field = $this->getField($fieldNameAndPath);
+
+		// First option is to get the label from the Grid TCA.
+		$rawLabel = '';
+		if (isset($field['label'])) {
+			$rawLabel = $field['label'];
+		}
+
+		// Second option is to fetch the label from the Column Renderer object.
+		if (!$rawLabel && $this->hasRenderers($fieldNameAndPath)) {
+			$renderers = $this->getRenderers($fieldNameAndPath);
+			/** @var $renderer ColumnRendererInterface */
+			foreach ($renderers as $renderer) {
+				if (isset($renderer['label'])) {
+					$rawLabel = $renderer['label'];
+					break;
+				}
+			}
+		}
+		return $rawLabel;
+	}
+
+	/**
+	 * Get the translation of a label given a column name.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @return string
+	 */
+	public function getLabel($fieldNameAndPath)
+	{
+		$label = '';
+		if ($this->hasLabel($fieldNameAndPath)) {
+			$labelKey = $this->getLabelKey($fieldNameAndPath);
+			try {
+				$label = $this->getLanguageService()->sL($labelKey);
+			} catch (\InvalidArgumentException $e) {
+			}
+			if (empty($label)) {
+				$label = $labelKey;
+			}
+		} else {
+
+			// Important to notice the label can contains a path, e.g. metadata.categories and must be resolved.
+			$dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->tableName);
+			$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->tableName);
+			$table = Tca::table($dataType);
+
+			if ($table->hasField($fieldName) && $table->field($fieldName)->hasLabel()) {
+				$label = $table->field($fieldName)->getLabel();
+			}
+		}
+
+		return $label;
+	}
+
+	/**
+	 * Returns the field name given its position.
+	 *
+	 * @param string $position the position of the field in the grid
+	 * @return string
+	 */
+	public function getFieldNameByPosition($position): string
+	{
+		$fields = array_keys($this->getFields());
+		if (empty($fields[$position])) {
+			throw new InvalidKeyInArrayException('No field exist for position: ' . $position, 1356945119);
+		}
+
+		return (string)$fields[$position];
+	}
+
+	/**
+	 * Returns a field name.
+	 *
+	 * @param string $fieldName
+	 * @return array
+	 */
+	public function getField($fieldName): array
+	{
+		$fields = $this->getFields();
+		return $fields[$fieldName] ?: [];
+	}
+
+	/**
+	 * Returns an array containing column names for the Grid.
+	 *
+	 * @return array
+	 */
+	public function getFields(): array
+	{
+		// Cache this operation since it can take some time.
+		if ($this->fields === null) {
+
+			// Fetch all available fields first.
+			$fields = $this->getAllFields();
+
+			if ($this->isBackendMode()) {
+
+				// Then remove the not allowed.
+				$fields = $this->filterByIncludedFields($fields);
+				$fields = $this->filterByBackendUser($fields);
+				$fields = $this->filterByExcludedFields($fields);
+			}
+
+			$this->fields = $fields;
+		}
+
+		return $this->fields;
+	}
+
+	/**
+	 * Remove fields according to Grid configuration.
+	 *
+	 * @param $fields
+	 * @return array
+	 */
+	protected function filterByIncludedFields($fields): array
+	{
+
+		$filteredFields = $fields;
+		$includedFields = $this->getIncludedFields();
+		if (count($includedFields) > 0) {
+			$filteredFields = [];
+			foreach ($fields as $fieldNameAndPath => $configuration) {
+				if (in_array($fieldNameAndPath, $includedFields, true) || !Tca::table($this->tableName)->hasField($fieldNameAndPath)) {
+					$filteredFields[$fieldNameAndPath] = $configuration;
+				}
+			}
+		}
+		return $filteredFields;
+	}
+
+	/**
+	 * Remove fields according to BE User permission.
+	 *
+	 * @param $fields
+	 * @return array
+	 */
+	protected function filterByBackendUser($fields): array
+	{
+		if (!$this->getBackendUser()->isAdmin()) {
+			foreach ($fields as $fieldName => $field) {
+				if (Tca::table($this->tableName)->hasField($fieldName) && !Tca::table($this->tableName)->field($fieldName)->hasAccess()) {
+					unset($fields[$fieldName]);
+				}
+			}
+		}
+		return $fields;
+	}
+
+	/**
+	 * Remove fields according to Grid configuration.
+	 *
+	 * @param $fields
+	 * @return array
+	 */
+	protected function filterByExcludedFields($fields): array
+	{
+
+		// Unset excluded fields.
+		foreach ($this->getExcludedFields() as $excludedField) {
+			if (isset($fields[$excludedField])) {
+				unset($fields[$excludedField]);
+			}
+		}
+
+		return $fields;
+	}
+
+	/**
+	 * Returns an array containing column names for the Grid.
+	 *
+	 * @return array
+	 */
+	public function getAllFields(): array
+	{
+
+		// Cache this operation since it can take some time.
+		if ($this->allFields === null) {
+
+			$fields = is_array($this->tca['columns']) ? $this->tca['columns'] : [];
+			$gridFieldNames = array_keys($fields);
+
+			// Fetch all fields of the TCA and merge it back to the fields configured for Grid.
+			$tableFieldNames = Tca::table($this->tableName)->getFields();
+
+			// Just remove system fields from the Grid.
+			foreach ($tableFieldNames as $key => $fieldName) {
+				if (in_array($fieldName, Tca::getSystemFields())) {
+					unset($tableFieldNames[$key]);
+				}
+			}
+
+			$additionalFields = array_diff($tableFieldNames, $gridFieldNames);
+
+			if (!empty($additionalFields)) {
+
+				// Pop out last element of the key
+				// Idea is to place new un-configured columns in between. By default, they will be hidden.
+				end($fields);
+				$lastColumnKey = key($fields);
+				$lastColumn = array_pop($fields);
+
+				// Feed up the grid fields with un configured elements
+				foreach ($additionalFields as $additionalField) {
+					$fields[$additionalField] = array(
+						'visible' => false
+					);
+
+					// Try to guess the format of the field.
+					$fieldType = Tca::table($this->tableName)->field($additionalField)->getType();
+					if ($fieldType === FieldType::DATE) {
+						$fields[$additionalField]['format'] = 'Fab\Vidi\Formatter\Date';
+					} elseif ($fieldType === FieldType::DATETIME) {
+						$fields[$additionalField]['format'] = 'Fab\Vidi\Formatter\Datetime';
+					}
+				}
+				$fields[$lastColumnKey] = $lastColumn;
+			}
+
+			$this->allFields = $fields;
+		}
+
+		return $this->allFields;
+	}
+
+	/**
+	 * Tell whether the field exists in the grid or not.
+	 *
+	 * @param string $fieldName
+	 * @return bool
+	 */
+	public function hasField($fieldName): bool
+	{
+		$fields = $this->getFields();
+		return isset($fields[$fieldName]);
+	}
+
+	/**
+	 * Tell whether the facet exists in the grid or not.
+	 *
+	 * @param string $facetName
+	 * @return bool
+	 */
+	public function hasFacet($facetName): bool
+	{
+		$facets = $this->getFacets();
+		return isset($facets[$facetName]);
+	}
+
+	/**
+	 * Returns an array containing facets fields.
+	 *
+	 * @return FacetInterface[]
+	 */
+	public function getFacets(): array
+	{
+		if ($this->facets === null) {
+			$this->facets = [];
+
+			if (is_array($this->tca['facets'])) {
+				foreach ($this->tca['facets'] as $key => $facetNameOrArray) {
+					if (is_array($facetNameOrArray)) {
+
+						$name = $facetNameOrArray['name'] ?? '';
+
+						$label = isset($facetNameOrArray['label'])
+							? $this->getLanguageService()->sL($facetNameOrArray['label'])
+							: '';
+
+						$suggestions = $facetNameOrArray['suggestions'] ?? [];
+						$configuration = $facetNameOrArray['configuration'] ?? [];
+
+						/** @var FacetInterface $facetObject */
+						$facetObject = GeneralUtility::makeInstance($key, $name, $label, $suggestions, $configuration);
+						$this->facets[$facetObject->getName()] = $facetObject;
+					} else {
+						$this->facets[$facetNameOrArray] = $this->instantiateStandardFacet($facetNameOrArray);
+					}
+				}
+			}
+		}
+		return $this->facets;
+	}
+
+	/**
+	 * Returns the "sortable" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return int|string
+	 */
+	public function isSortable($fieldName)
+	{
+		$defaultValue = true;
+		$hasSortableField = Tca::table($this->tableName)->hasSortableField();
+		if ($hasSortableField) {
+			$isSortable = false;
+		} else {
+			$isSortable = $this->get($fieldName, 'sortable', $defaultValue);
+		}
+		return $isSortable;
+	}
+
+	/**
+	 * Returns the "canBeHidden" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return bool
+	 */
+	public function canBeHidden($fieldName): bool
+	{
+		$defaultValue = true;
+		return $this->get($fieldName, 'canBeHidden', $defaultValue);
+	}
+
+	/**
+	 * Returns the "width" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return int|string
+	 */
+	public function getWidth($fieldName)
+	{
+		$defaultValue = 'auto';
+		return $this->get($fieldName, 'width', $defaultValue);
+	}
+
+	/**
+	 * Returns the "visible" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return bool
+	 */
+	public function isVisible($fieldName): bool
+	{
+		$defaultValue = true;
+		return $this->get($fieldName, 'visible', $defaultValue);
+	}
+
+	/**
+	 * Returns the "editable" value of the column.
+	 *
+	 * @param string $columnName
+	 * @return bool
+	 */
+	public function isEditable($columnName): bool
+	{
+		$defaultValue = false;
+		return $this->get($columnName, 'editable', $defaultValue);
+	}
+
+	/**
+	 * Returns the "localized" value of the column.
+	 *
+	 * @param string $columnName
+	 * @return bool
+	 */
+	public function isLocalized($columnName): bool
+	{
+		$defaultValue = true;
+		return $this->get($columnName, 'localized', $defaultValue);
+	}
+
+	/**
+	 *
+	 * Returns the "html" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return string
+	 */
+	public function getHeader($fieldName): string
+	{
+		$defaultValue = '';
+		return $this->get($fieldName, 'html', $defaultValue);
+	}
+
+	/**
+	 * Fetch a possible from a Grid Renderer. If no value is found, returns null
+	 *
+	 * @param string $fieldName
+	 * @param string $key
+	 * @param mixed $defaultValue
+	 * @return null|mixed
+	 */
+	public function get($fieldName, $key, $defaultValue = null)
+	{
+		$value = $defaultValue;
+
+		$field = $this->getField($fieldName);
+		if (isset($field[$key])) {
+			$value = $field[$key];
+		} elseif ($this->hasRenderers($fieldName)) {
+			$renderers = $this->getRenderers($fieldName);
+			foreach ($renderers as $rendererConfiguration) {
+				if (isset($rendererConfiguration[$key])) {
+					$value = $rendererConfiguration[$key];
+				}
+			}
+		}
+		return $value;
+	}
+
+	/**
+	 * Returns whether the column has a renderer.
+	 *
+	 * @param string $fieldName
+	 * @return bool
+	 */
+	public function hasRenderers($fieldName): bool
+	{
+		$field = $this->getField($fieldName);
+		return empty($field['renderer']) && empty($field['renderers']) ? false : true;
+	}
+
+	/**
+	 * Returns a renderer.
+	 *
+	 * @param string $fieldName
+	 * @return array
+	 */
+	public function getRenderers($fieldName): array
+	{
+		$field = $this->getField($fieldName);
+		$renderers = [];
+		if (!empty($field['renderer'])) {
+			$renderers = $this->convertRendererToArray($field['renderer'], $field);
+		} elseif (!empty($field['renderers']) && is_array($field['renderers'])) {
+			foreach ($field['renderers'] as $renderer) {
+				$rendererNameAndConfiguration = $this->convertRendererToArray($renderer, $field);
+				$renderers = array_merge($renderers, $rendererNameAndConfiguration);
+			}
+		}
+
+		return $renderers;
+	}
+
+	/**
+	 * @param string $renderer
+	 * @return array
+	 */
+	protected function convertRendererToArray($renderer, array $field): array
+	{
+		$result = [];
+		if (is_string($renderer)) {
+			$configuration = empty($field['rendererConfiguration'])
+				? []
+				: $field['rendererConfiguration'];
+
+			/** @var ColumnRendererInterface $rendererObject */
+			$rendererObject = GeneralUtility::makeInstance($renderer);
+
+			$result[$renderer] = array_merge($rendererObject->getConfiguration(), $configuration);
+			// TODO: throw alert message because this is not compatible anymore as of TYPO3 8.7.7
+		} elseif ($renderer instanceof ColumnRendererInterface) {
+			/** @var ColumnRendererInterface $renderer */
+			$result[get_class($renderer)] = $renderer->getConfiguration();
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the class names applied to a cell
+	 *
+	 * @param string $fieldName
+	 * @return bool
+	 */
+	public function getClass($fieldName): bool
+	{
+		$field = $this->getField($fieldName);
+		return isset($field['class']) ? $field['class'] : '';
+	}
+
+	/**
+	 * Returns whether the column has a label.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @return bool
+	 */
+	public function hasLabel($fieldNameAndPath): bool
+	{
+		$field = $this->getField($fieldNameAndPath);
+
+		$hasLabel = empty($field['label']) ? false : true;
+
+		if (!$hasLabel && $this->hasRenderers($fieldNameAndPath)) {
+			$renderers = $this->getRenderers($fieldNameAndPath);
+			/** @var $renderer ColumnRendererInterface */
+			foreach ($renderers as $renderer) {
+				if (isset($renderer['label'])) {
+					$hasLabel = true;
+					break;
+				}
+			}
+		}
+		return $hasLabel;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getTca(): array
+	{
+		return $this->tca;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getIncludedFields(): array
+	{
+		return empty($this->tca['included_fields']) ? [] : GeneralUtility::trimExplode(',', $this->tca['included_fields'], true);
+	}
+
+	/**
+	 * Return excluded fields from configuration + preferences.
+	 *
+	 * @return array
+	 */
+	public function getExcludedFields(): array
+	{
+		$configurationFields = $this->getExcludedFieldsFromConfiguration();
+		$preferencesFields = $this->getExcludedFieldsFromPreferences();
+
+		return array_merge($configurationFields, $preferencesFields);
+	}
+
+	/**
+	 * Fetch excluded fields from configuration.
+	 *
+	 * @return array
+	 */
+	protected function getExcludedFieldsFromConfiguration(): array
+	{
+		$excludedFields = [];
+		if (!empty($this->tca['excluded_fields'])) {
+			$excludedFields = GeneralUtility::trimExplode(',', $this->tca['excluded_fields'], true);
+		} elseif (!empty($this->tca['export']['excluded_fields'])) { // only for export for legacy reason.
+			$excludedFields = GeneralUtility::trimExplode(',', $this->tca['export']['excluded_fields'], true);
+		}
+		return $excludedFields;
+
+	}
+
+	/**
+	 * Fetch excluded fields from preferences.
+	 *
+	 * @return array
+	 */
+	protected function getExcludedFieldsFromPreferences(): array
+	{
+		$excludedFields = $this->getModulePreferences()->get(ConfigurablePart::EXCLUDED_FIELDS, $this->tableName);
+		return is_array($excludedFields) ? $excludedFields : [];
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function areFilesIncludedInExport(): bool
+	{
+		$isIncluded = true;
+
+		if (isset($this->tca['export']['include_files'])) {
+			$isIncluded = (bool)$this->tca['export']['include_files'];
+		}
+		return $isIncluded;
+	}
+
+	/**
+	 * Returns a "facet" service instance.
+	 *
+	 * @param string|FacetInterface $facetName
+	 * @return StandardFacet
+	 */
+	protected function instantiateStandardFacet($facetName): StandardFacet
+	{
+		$label = $this->getLabel($facetName);
+
+		/** @var StandardFacet $facetName */
+		$facet = GeneralUtility::makeInstance(StandardFacet::class, $facetName, $label);
+
+		if (!$facet instanceof StandardFacet) {
+			throw new \RuntimeException('I could not instantiate a facet for facet name "' . $facetName . '""', 1445856345);
+		}
+		return $facet;
+	}
+
+	/**
+	 * Returns a "facet" service instance.
+	 *
+	 * @param string|FacetInterface $facetName
+	 * @return FacetInterface
+	 */
+	public function facet($facetName = ''): FacetInterface
+	{
+		$facets = $this->getFacets();
+		return $facets[$facetName];
+	}
+
+	/**
+	 * @return FieldPathResolver|object
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance(FieldPathResolver::class);
+	}
+
+	/**
+	 * @return ModulePreferences|object
+	 */
+	protected function getModulePreferences()
+	{
+		return GeneralUtility::makeInstance(ModulePreferences::class);
+	}
+
+	/**
+	 * @return LanguageService|object
+	 */
+	protected function getLanguageService()
+	{
+		return GeneralUtility::makeInstance(LanguageService::class);
+	}
 
 }

Classes/DataHandler/AbstractDataHandler.php

Indentation +13 added lines, -13 removed lines

@@ -15,19 +15,19 @@
 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;
+	}
 
 }