fabarea / vidi

Classes/Tca/FieldType.php

Indentation +12 added lines, -12 removed lines

@@ -16,27 +16,27 @@
  */
 class FieldType extends Enumeration
 {
-    public const TEXT = 'text';
+	public const TEXT = 'text';
 
-    public const NUMBER = 'number';
+	public const NUMBER = 'number';
 
-    public const EMAIL = 'email';
+	public const EMAIL = 'email';
 
-    public const DATE = 'date';
+	public const DATE = 'date';
 
-    public const DATETIME = 'datetime';
+	public const DATETIME = 'datetime';
 
-    public const TEXTAREA = 'textarea';
+	public const TEXTAREA = 'textarea';
 
-    public const SELECT = 'select';
+	public const SELECT = 'select';
 
-    public const RADIO = 'radio';
+	public const RADIO = 'radio';
 
-    public const CHECKBOX = 'check';
+	public const CHECKBOX = 'check';
 
-    public const FILE = 'file';
+	public const FILE = 'file';
 
-    public const MULTISELECT = 'multiselect';
+	public const MULTISELECT = 'multiselect';
 
-    public const TREE = 'tree';
+	public const TREE = 'tree';
 }

Classes/Tca/FieldService.php

Indentation +761 added lines, -761 removed lines

@@ -18,765 +18,765 @@
  */
 class FieldService extends AbstractTca
 {
-    /**
-     * @var string
-     */
-    protected $fieldName;
-
-    /**
-     * @var string
-     */
-    protected $compositeField;
-
-    /**
-     * @var string
-     */
-    protected $tableName;
-
-    /**
-     * @var array
-     */
-    protected $tca;
-
-    /**
-     * @param string $fieldName
-     * @param array $tca
-     * @param string $tableName
-     * @param string $compositeField
-     * @return \Fab\Vidi\Tca\FieldService
-     */
-    public function __construct($fieldName, array $tca, $tableName, $compositeField = '')
-    {
-        $this->fieldName = $fieldName;
-        $this->tca = $tca;
-        $this->tableName = $tableName;
-        $this->compositeField = $compositeField;
-    }
-
-    /**
-     * Tells whether the field is considered as system field, e.g. uid, crdate, tstamp, etc...
-     *
-     * @return bool
-     */
-    public function isSystem()
-    {
-        return in_array($this->fieldName, Tca::getSystemFields());
-    }
-
-    /**
-     * Tells the opposition of isSystem()
-     *
-     * @return bool
-     */
-    public function isNotSystem()
-    {
-        return !$this->isSystem();
-    }
-
-    /**
-     * Returns the configuration for a $field
-     *
-     * @throws \Exception
-     * @return array
-     */
-    public function getConfiguration()
-    {
-        return empty($this->tca['config']) ? [] : $this->tca['config'];
-    }
-
-    /**
-     * Returns a key of the configuration.
-     * If the key can not to be found, returns null.
-     *
-     * @param string $key
-     * @return mixed
-     */
-    public function get($key)
-    {
-        $configuration = $this->getConfiguration();
-        return empty($configuration[$key]) ? null : $configuration[$key];
-    }
-
-    /**
-     * Returns the foreign field of a given field (opposite relational field).
-     * If no relation exists, returns null.
-     *
-     * @return string|null
-     */
-    public function getForeignField()
-    {
-        $result = null;
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['foreign_field'])) {
-            $result = $configuration['foreign_field'];
-        } elseif ($this->hasRelationManyToMany()) {
-            $foreignTable = $this->getForeignTable();
-            $manyToManyTable = $this->getManyToManyTable();
-
-            // Load TCA service of foreign field.
-            $tcaForeignTableService = Tca::table($foreignTable);
-
-            // Look into the MM relations checking for the opposite field
-            foreach ($tcaForeignTableService->getFields() as $fieldName) {
-                if ($manyToManyTable == $tcaForeignTableService->field($fieldName)->getManyToManyTable()) {
-                    $result = $fieldName;
-                    break;
-                }
-            }
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the foreign table of a given field (opposite relational table).
-     * If no relation exists, returns null.
-     *
-     * @return string|null
-     */
-    public function getForeignTable()
-    {
-        $result = null;
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['foreign_table'])) {
-            $result = $configuration['foreign_table'];
-        } elseif ($this->isGroup()) {
-            $fieldParts = explode('.', $this->compositeField, 2);
-            $result = $fieldParts[1];
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the foreign clause.
-     * If no foreign order exists, returns empty string.
-     *
-     * @return string
-     */
-    public function getForeignClause()
-    {
-        $result = '';
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['foreign_table_where'])) {
-            $parts = explode('ORDER BY', $configuration['foreign_table_where']);
-            if (!empty($parts[0])) {
-                $result = $parts[0];
-            }
-        }
-
-        // Substitute some variables
-        return $this->substituteKnownMarkers($result);
-    }
-
-    /**
-     * Substitute some known markers from the where clause in the Frontend Context.
-     *
-     * @param string $clause
-     * @return string
-     */
-    protected function substituteKnownMarkers($clause)
-    {
-        if ($clause && $this->isFrontendMode()) {
-            $searches = array(
-                '###CURRENT_PID###',
-                '###REC_FIELD_sys_language_uid###'
-            );
-
-            $replaces = array(
-                $this->getFrontendObject()->id,
-                GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('language', 'id'),
-            );
-
-            $clause = str_replace($searches, $replaces, $clause);
-        }
-        return $clause;
-    }
-
-    /**
-     * Returns the foreign order of the current field.
-     * If no foreign order exists, returns empty string.
-     *
-     * @return string
-     */
-    public function getForeignOrder()
-    {
-        $result = '';
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['foreign_table_where'])) {
-            $parts = explode('ORDER BY', $configuration['foreign_table_where']);
-            if (!empty($parts[1])) {
-                $result = $parts[1];
-            }
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the MM table of a field.
-     * If no relation exists, returns null.
-     *
-     * @return string|null
-     */
-    public function getManyToManyTable()
-    {
-        $configuration = $this->getConfiguration();
-        return empty($configuration['MM']) ? null : $configuration['MM'];
-    }
-
-    /**
-     * Returns a possible additional table name used in MM relations.
-     * If no table name exists, returns null.
-     *
-     * @return string|null
-     */
-    public function getAdditionalTableNameCondition()
-    {
-        $result = null;
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['MM_match_fields']['tablenames'])) {
-            $result = $configuration['MM_match_fields']['tablenames'];
-        } elseif ($this->isGroup()) {
-            // @todo check if $this->fieldName could be simply used as $result
-            $fieldParts = explode('.', $this->compositeField, 2);
-            $result = $fieldParts[1];
-        }
-
-        return $result;
-    }
-
-    /**
-     * Returns a possible additional conditions for MM tables such as "tablenames", "fieldname", etc...
-     *
-     * @return array
-     */
-    public function getAdditionalMMCondition()
-    {
-        $additionalMMConditions = [];
-        $configuration = $this->getConfiguration();
-
-        if (!empty($configuration['MM_match_fields'])) {
-            $additionalMMConditions = $configuration['MM_match_fields'];
-        }
-
-        // Add in any case a table name for "group"
-        if ($this->isGroup()) {
-            // @todo check if $this->fieldName could be simply used as $result
-            $fieldParts = explode('.', $this->compositeField, 2);
-            $additionalMMConditions = array(
-                'tablenames' => $fieldParts[1],
-            );
-        }
-        return $additionalMMConditions;
-    }
-
-    /**
-     * Returns whether the field name is the opposite in MM relation.
-     *
-     * @return bool
-     */
-    public function isOppositeRelation()
-    {
-        $configuration = $this->getConfiguration();
-        return isset($configuration['MM_opposite_field']);
-    }
-
-    /**
-     * Returns the configuration for a $field.
-     *
-     * @throws \Exception
-     * @return string
-     */
-    public function getType()
-    {
-        if ($this->isSystem()) {
-            $fieldType = FieldType::NUMBER;
-        } else {
-            $configuration = $this->getConfiguration();
-
-            if (empty($configuration['type'])) {
-                throw new \Exception(sprintf('No field type found for "%s" in table "%s"', $this->fieldName, $this->tableName), 1385556627);
-            }
-
-            $fieldType = $configuration['type'];
-
-            if ($configuration['type'] === FieldType::SELECT && !empty($configuration['size']) && $configuration['size'] > 1) {
-                $fieldType = FieldType::MULTISELECT;
-            } elseif (!empty($configuration['foreign_table'])
-                && ($configuration['foreign_table'] == 'sys_file_reference' || $configuration['foreign_table'] == 'sys_file')
-            ) {
-                $fieldType = FieldType::FILE;
-            } elseif (!empty($configuration['eval'])) {
-                $parts = GeneralUtility::trimExplode(',', $configuration['eval']);
-                if (in_array('datetime', $parts)) {
-                    $fieldType = FieldType::DATETIME;
-                } elseif (in_array('date', $parts)) {
-                    $fieldType = FieldType::DATE;
-                } elseif (in_array('email', $parts)) {
-                    $fieldType = FieldType::EMAIL;
-                } elseif (in_array('int', $parts) || in_array('double2', $parts)) {
-                    $fieldType = FieldType::NUMBER;
-                }
-            }
-
-            // Do some legacy conversion
-            if ($fieldType === 'input') {
-                $fieldType = FieldType::TEXT;
-            } elseif ($fieldType === 'text') {
-                $fieldType = FieldType::TEXTAREA;
-            }
-        }
-        return $fieldType;
-    }
-
-    /**
-     * Return the default value.
-     *
-     * @return bool
-     */
-    public function getDefaultValue()
-    {
-        $configuration = $this->getConfiguration();
-        return isset($configuration['default']) ? $configuration['default'] : null;
-    }
-
-    /**
-     * Get the translation of a label given a column.
-     *
-     * @return string
-     */
-    public function getLabel()
-    {
-        $label = '';
-        if ($this->hasLabel()) {
-            try {
-                $label = LocalizationUtility::translate($this->tca['label'], '');
-            } catch (\InvalidArgumentException $e) {
-            }
-            if (empty($label)) {
-                $label = $this->tca['label'];
-            }
-        }
-        return $label;
-    }
-
-    /**
-     * Get the translation of a label given a column.
-     *
-     * @param string $itemValue the item value to search for.
-     * @return string
-     */
-    public function getLabelForItem($itemValue)
-    {
-        // Early return whether there is nothing to be translated as label.
-        if (is_null($itemValue)) {
-            return '';
-        } elseif (is_string($itemValue) && $itemValue === '') {
-            return $itemValue;
-        }
-
-        $configuration = $this->getConfiguration();
-        if (!empty($configuration['items']) && is_array($configuration['items'])) {
-            foreach ($configuration['items'] as $item) {
-                if ($item[1] == $itemValue) {
-                    try {
-                        $label = LocalizationUtility::translate($item[0], '');
-                    } catch (\InvalidArgumentException $e) {
-                    }
-                    if (empty($label)) {
-                        $label = $item[0];
-                    }
-                    break;
-                }
-            }
-        }
-
-        // Try fetching a label from a possible itemsProcFunc
-        if (!isset($label) && is_scalar($itemValue)) {
-            $items = $this->fetchItemsFromUserFunction();
-            if (!empty($items[$itemValue])) {
-                $label = $items[$itemValue];
-            }
-        }
-
-        // Returns a label if it has been found, otherwise returns the item value as fallback.
-        return isset($label) ? $label : $itemValue;
-    }
-
-    /**
-     * Retrieve items from User Function.
-     *
-     * @return array
-     */
-    protected function fetchItemsFromUserFunction()
-    {
-        $values = [];
-
-        $configuration = $this->getConfiguration();
-        if (!empty($configuration['itemsProcFunc'])) {
-            $parts = explode('php:', $configuration['itemsProcFunc']);
-            if (!empty($parts[1])) {
-                list($class, $method) = explode('->', $parts[1]);
-
-                $parameters['items'] = [];
-                $object = GeneralUtility::makeInstance($class);
-                $object->$method($parameters);
-
-                foreach ($parameters['items'] as $items) {
-                    $values[$items[1]] = $items[0];
-                }
-            }
-        }
-        return $values;
-    }
-
-    /**
-     * Get a possible icon given a field name an an item.
-     *
-     * @param string $itemValue the item value to search for.
-     * @return string
-     */
-    public function getIconForItem($itemValue)
-    {
-        $result = '';
-        $configuration = $this->getConfiguration();
-        if (!empty($configuration['items']) && is_array($configuration['items'])) {
-            foreach ($configuration['items'] as $item) {
-                if ($item[1] == $itemValue) {
-                    $result = empty($item[2]) ? '' : $item[2];
-                    break;
-                }
-            }
-        }
-        return $result;
-    }
-
-    /**
-     * Returns whether the field has a label.
-     *
-     * @return bool
-     */
-    public function hasLabel()
-    {
-        return empty($this->tca['label']) ? false : true;
-    }
-
-    /**
-     * Tell whether the current BE User has access to this field.
-     *
-     * @return bool
-     */
-    public function hasAccess()
-    {
-        $hasAccess = true;
-        if ($this->isBackendMode()
-            && Tca::table($this->tableName)->hasAccess()
-            && isset($this->tca['exclude'])
-            && $this->tca['exclude']
-        ) {
-            $hasAccess = $this->getBackendUser()->check('non_exclude_fields', $this->tableName . ':' . $this->fieldName);
-        }
-        return $hasAccess;
-    }
-
-    /**
-     * Returns whether the field is numerical.
-     *
-     * @return bool
-     */
-    public function isNumerical()
-    {
-        $result = $this->isSystem();
-        if ($result === false) {
-            $configuration = $this->getConfiguration();
-            $parts = [];
-            if (!empty($configuration['eval'])) {
-                $parts = GeneralUtility::trimExplode(',', $configuration['eval']);
-            }
-            $result = in_array('int', $parts) || in_array('float', $parts);
-        }
-        return $result;
-    }
-
-    /**
-     * Returns whether the field is of type text area.
-     *
-     * @return bool
-     */
-    public function isTextArea()
-    {
-        return $this->getType() === FieldType::TEXTAREA;
-    }
-    /**
-     * Returns whether the field is of type text area.
-     *
-     * @return bool
-     */
-    public function isText()
-    {
-        return $this->getType() === FieldType::TEXT;
-    }
-
-    /**
-     * Returns whether the field is displayed as a tree.
-     *
-     * @return bool
-     */
-    public function isRenderModeTree()
-    {
-        $configuration = $this->getConfiguration();
-        return isset($configuration['renderMode']) && $configuration['renderMode'] == FieldType::TREE;
-    }
-
-    /**
-     * Returns whether the field is of type select.
-     *
-     * @return bool
-     */
-    public function isSelect()
-    {
-        return $this->getType() === FieldType::SELECT;
-    }
-
-    /**
-     * Returns whether the field is of type select.
-     *
-     * @return bool
-     */
-    public function isMultipleSelect()
-    {
-        return $this->getType() === FieldType::MULTISELECT;
-    }
-
-    /**
-     * Returns whether the field is of type select.
-     *
-     * @return bool
-     */
-    public function isCheckBox()
-    {
-        return $this->getType() === FieldType::CHECKBOX;
-    }
-
-    /**
-     * Returns whether the field is of type db.
-     *
-     * @return bool
-     */
-    public function isGroup()
-    {
-        return $this->getType() === 'group';
-    }
-
-    /**
-     * Returns whether the field is language aware.
-     *
-     * @return bool
-     */
-    public function isLocalized()
-    {
-        $isLocalized = false;
-        if (isset($this->tca['l10n_mode'])) {
-            if ($this->tca['l10n_mode'] == 'prefixLangTitle' || $this->tca['l10n_mode'] == 'mergeIfNotBlank') {
-                $isLocalized = true;
-            }
-        }
-        return $isLocalized;
-    }
-
-    /**
-     * Returns whether the field is required.
-     *
-     * @return bool
-     */
-    public function isRequired()
-    {
-        $configuration = $this->getConfiguration();
-
-        $isRequired = false;
-        if (isset($configuration['minitems'])) {
-            // is required of a select?
-            $isRequired = $configuration['minitems'] == 1 ? true : false;
-        } elseif (isset($configuration['eval'])) {
-            $parts = GeneralUtility::trimExplode(',', $configuration['eval'], true);
-            $isRequired = in_array('required', $parts);
-        }
-        return $isRequired;
-    }
-
-    /**
-     * Returns an array containing the configuration of a column.
-     *
-     * @return array
-     */
-    public function getField()
-    {
-        return $this->tca;
-    }
-
-    /**
-     * Returns the relation type
-     *
-     * @return string
-     */
-    public function relationDataType()
-    {
-        $configuration = $this->getConfiguration();
-        return empty($configuration['foreign_table']) ? '' : $configuration['foreign_table'];
-    }
-
-    /**
-     * Returns whether the field has relation (one to many, many to many)
-     *
-     * @return bool
-     */
-    public function hasRelation()
-    {
-        return null !== $this->getForeignTable();
-    }
-
-    /**
-     * Returns whether the field has no relation (one to many, many to many)
-     *
-     * @return bool
-     */
-    public function hasNoRelation()
-    {
-        return !$this->hasRelation();
-    }
-
-    /**
-     * Returns whether the field has a "many" objects connected including "many-to-many" or "one-to-many".
-     *
-     * @return bool
-     */
-    public function hasMany()
-    {
-        $configuration = $this->getConfiguration();
-        return $this->hasRelation() && ($configuration['maxitems'] > 1 || isset($configuration['foreign_table_field']));
-    }
-
-    /**
-     * Returns whether the field has relation "one" object connected including of "one-to-one" or "many-to-one".
-     *
-     * @return bool
-     */
-    public function hasOne()
-    {
-        $configuration = $this->getConfiguration();
-        return !isset($configuration['MM']) && $this->hasRelation() && ($configuration['maxitems'] == 1 || !isset($configuration['maxitems']));
-    }
-
-    /**
-     * Returns whether the field has many-to-one relation.
-     *
-     * @return bool
-     */
-    public function hasRelationManyToOne()
-    {
-        $result = false;
-
-        $foreignField = $this->getForeignField();
-        if (!empty($foreignField)) {
-            // Load TCA service of the foreign field.
-            $foreignTable = $this->getForeignTable();
-            $result = $this->hasOne() && Tca::table($foreignTable)->field($foreignField)->hasMany();
-        }
-        return $result;
-    }
-
-    /**
-     * Returns whether the field has one-to-many relation.
-     *
-     * @return bool
-     */
-    public function hasRelationOneToMany()
-    {
-        $result = false;
-
-        $foreignField = $this->getForeignField();
-        if (!empty($foreignField)) {
-            // Load TCA service of the foreign field.
-            $foreignTable = $this->getForeignTable();
-            $result = $this->hasMany() && Tca::table($foreignTable)->field($foreignField)->hasOne();
-        }
-        return $result;
-    }
-
-    /**
-     * Returns whether the field has one-to-one relation.
-     *
-     * @return bool
-     */
-    public function hasRelationOneToOne()
-    {
-        $result = false;
-
-        $foreignField = $this->getForeignField();
-        if (!empty($foreignField)) {
-            // Load TCA service of foreign field.
-            $foreignTable = $this->getForeignTable();
-            $result = $this->hasOne() && Tca::table($foreignTable)->field($foreignField)->hasOne();
-        }
-        return $result;
-    }
-
-    /**
-     * Returns whether the field has many to many relation.
-     *
-     * @return bool
-     */
-    public function hasRelationManyToMany()
-    {
-        $configuration = $this->getConfiguration();
-        return $this->hasRelation() && (isset($configuration['MM']) || isset($configuration['foreign_table_field']));
-    }
-
-    /**
-     * Returns whether the field has many to many relation using comma separated values (legacy).
-     *
-     * @return bool
-     */
-    public function hasRelationWithCommaSeparatedValues()
-    {
-        $configuration = $this->getConfiguration();
-        return $this->hasRelation() && !isset($configuration['MM']) && !isset($configuration['foreign_field']) && $configuration['maxitems'] > 1;
-    }
-
-    /**
-     * @return array
-     */
-    public function getTca()
-    {
-        return $this->tca['columns'];
-    }
-
-    /**
-     * @return string
-     */
-    public function getCompositeField()
-    {
-        return $this->compositeField;
-    }
-
-    /**
-     * @param string $compositeField
-     */
-    public function setCompositeField($compositeField)
-    {
-        $this->compositeField = $compositeField;
-    }
-
-    /**
-     * Returns an instance of the Frontend object.
-     *
-     * @return TypoScriptFrontendController
-     */
-    protected function getFrontendObject()
-    {
-        return $GLOBALS['TSFE'];
-    }
+	/**
+	 * @var string
+	 */
+	protected $fieldName;
+
+	/**
+	 * @var string
+	 */
+	protected $compositeField;
+
+	/**
+	 * @var string
+	 */
+	protected $tableName;
+
+	/**
+	 * @var array
+	 */
+	protected $tca;
+
+	/**
+	 * @param string $fieldName
+	 * @param array $tca
+	 * @param string $tableName
+	 * @param string $compositeField
+	 * @return \Fab\Vidi\Tca\FieldService
+	 */
+	public function __construct($fieldName, array $tca, $tableName, $compositeField = '')
+	{
+		$this->fieldName = $fieldName;
+		$this->tca = $tca;
+		$this->tableName = $tableName;
+		$this->compositeField = $compositeField;
+	}
+
+	/**
+	 * Tells whether the field is considered as system field, e.g. uid, crdate, tstamp, etc...
+	 *
+	 * @return bool
+	 */
+	public function isSystem()
+	{
+		return in_array($this->fieldName, Tca::getSystemFields());
+	}
+
+	/**
+	 * Tells the opposition of isSystem()
+	 *
+	 * @return bool
+	 */
+	public function isNotSystem()
+	{
+		return !$this->isSystem();
+	}
+
+	/**
+	 * Returns the configuration for a $field
+	 *
+	 * @throws \Exception
+	 * @return array
+	 */
+	public function getConfiguration()
+	{
+		return empty($this->tca['config']) ? [] : $this->tca['config'];
+	}
+
+	/**
+	 * Returns a key of the configuration.
+	 * If the key can not to be found, returns null.
+	 *
+	 * @param string $key
+	 * @return mixed
+	 */
+	public function get($key)
+	{
+		$configuration = $this->getConfiguration();
+		return empty($configuration[$key]) ? null : $configuration[$key];
+	}
+
+	/**
+	 * Returns the foreign field of a given field (opposite relational field).
+	 * If no relation exists, returns null.
+	 *
+	 * @return string|null
+	 */
+	public function getForeignField()
+	{
+		$result = null;
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['foreign_field'])) {
+			$result = $configuration['foreign_field'];
+		} elseif ($this->hasRelationManyToMany()) {
+			$foreignTable = $this->getForeignTable();
+			$manyToManyTable = $this->getManyToManyTable();
+
+			// Load TCA service of foreign field.
+			$tcaForeignTableService = Tca::table($foreignTable);
+
+			// Look into the MM relations checking for the opposite field
+			foreach ($tcaForeignTableService->getFields() as $fieldName) {
+				if ($manyToManyTable == $tcaForeignTableService->field($fieldName)->getManyToManyTable()) {
+					$result = $fieldName;
+					break;
+				}
+			}
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the foreign table of a given field (opposite relational table).
+	 * If no relation exists, returns null.
+	 *
+	 * @return string|null
+	 */
+	public function getForeignTable()
+	{
+		$result = null;
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['foreign_table'])) {
+			$result = $configuration['foreign_table'];
+		} elseif ($this->isGroup()) {
+			$fieldParts = explode('.', $this->compositeField, 2);
+			$result = $fieldParts[1];
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the foreign clause.
+	 * If no foreign order exists, returns empty string.
+	 *
+	 * @return string
+	 */
+	public function getForeignClause()
+	{
+		$result = '';
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['foreign_table_where'])) {
+			$parts = explode('ORDER BY', $configuration['foreign_table_where']);
+			if (!empty($parts[0])) {
+				$result = $parts[0];
+			}
+		}
+
+		// Substitute some variables
+		return $this->substituteKnownMarkers($result);
+	}
+
+	/**
+	 * Substitute some known markers from the where clause in the Frontend Context.
+	 *
+	 * @param string $clause
+	 * @return string
+	 */
+	protected function substituteKnownMarkers($clause)
+	{
+		if ($clause && $this->isFrontendMode()) {
+			$searches = array(
+				'###CURRENT_PID###',
+				'###REC_FIELD_sys_language_uid###'
+			);
+
+			$replaces = array(
+				$this->getFrontendObject()->id,
+				GeneralUtility::makeInstance(Context::class)->getPropertyFromAspect('language', 'id'),
+			);
+
+			$clause = str_replace($searches, $replaces, $clause);
+		}
+		return $clause;
+	}
+
+	/**
+	 * Returns the foreign order of the current field.
+	 * If no foreign order exists, returns empty string.
+	 *
+	 * @return string
+	 */
+	public function getForeignOrder()
+	{
+		$result = '';
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['foreign_table_where'])) {
+			$parts = explode('ORDER BY', $configuration['foreign_table_where']);
+			if (!empty($parts[1])) {
+				$result = $parts[1];
+			}
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the MM table of a field.
+	 * If no relation exists, returns null.
+	 *
+	 * @return string|null
+	 */
+	public function getManyToManyTable()
+	{
+		$configuration = $this->getConfiguration();
+		return empty($configuration['MM']) ? null : $configuration['MM'];
+	}
+
+	/**
+	 * Returns a possible additional table name used in MM relations.
+	 * If no table name exists, returns null.
+	 *
+	 * @return string|null
+	 */
+	public function getAdditionalTableNameCondition()
+	{
+		$result = null;
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['MM_match_fields']['tablenames'])) {
+			$result = $configuration['MM_match_fields']['tablenames'];
+		} elseif ($this->isGroup()) {
+			// @todo check if $this->fieldName could be simply used as $result
+			$fieldParts = explode('.', $this->compositeField, 2);
+			$result = $fieldParts[1];
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Returns a possible additional conditions for MM tables such as "tablenames", "fieldname", etc...
+	 *
+	 * @return array
+	 */
+	public function getAdditionalMMCondition()
+	{
+		$additionalMMConditions = [];
+		$configuration = $this->getConfiguration();
+
+		if (!empty($configuration['MM_match_fields'])) {
+			$additionalMMConditions = $configuration['MM_match_fields'];
+		}
+
+		// Add in any case a table name for "group"
+		if ($this->isGroup()) {
+			// @todo check if $this->fieldName could be simply used as $result
+			$fieldParts = explode('.', $this->compositeField, 2);
+			$additionalMMConditions = array(
+				'tablenames' => $fieldParts[1],
+			);
+		}
+		return $additionalMMConditions;
+	}
+
+	/**
+	 * Returns whether the field name is the opposite in MM relation.
+	 *
+	 * @return bool
+	 */
+	public function isOppositeRelation()
+	{
+		$configuration = $this->getConfiguration();
+		return isset($configuration['MM_opposite_field']);
+	}
+
+	/**
+	 * Returns the configuration for a $field.
+	 *
+	 * @throws \Exception
+	 * @return string
+	 */
+	public function getType()
+	{
+		if ($this->isSystem()) {
+			$fieldType = FieldType::NUMBER;
+		} else {
+			$configuration = $this->getConfiguration();
+
+			if (empty($configuration['type'])) {
+				throw new \Exception(sprintf('No field type found for "%s" in table "%s"', $this->fieldName, $this->tableName), 1385556627);
+			}
+
+			$fieldType = $configuration['type'];
+
+			if ($configuration['type'] === FieldType::SELECT && !empty($configuration['size']) && $configuration['size'] > 1) {
+				$fieldType = FieldType::MULTISELECT;
+			} elseif (!empty($configuration['foreign_table'])
+				&& ($configuration['foreign_table'] == 'sys_file_reference' || $configuration['foreign_table'] == 'sys_file')
+			) {
+				$fieldType = FieldType::FILE;
+			} elseif (!empty($configuration['eval'])) {
+				$parts = GeneralUtility::trimExplode(',', $configuration['eval']);
+				if (in_array('datetime', $parts)) {
+					$fieldType = FieldType::DATETIME;
+				} elseif (in_array('date', $parts)) {
+					$fieldType = FieldType::DATE;
+				} elseif (in_array('email', $parts)) {
+					$fieldType = FieldType::EMAIL;
+				} elseif (in_array('int', $parts) || in_array('double2', $parts)) {
+					$fieldType = FieldType::NUMBER;
+				}
+			}
+
+			// Do some legacy conversion
+			if ($fieldType === 'input') {
+				$fieldType = FieldType::TEXT;
+			} elseif ($fieldType === 'text') {
+				$fieldType = FieldType::TEXTAREA;
+			}
+		}
+		return $fieldType;
+	}
+
+	/**
+	 * Return the default value.
+	 *
+	 * @return bool
+	 */
+	public function getDefaultValue()
+	{
+		$configuration = $this->getConfiguration();
+		return isset($configuration['default']) ? $configuration['default'] : null;
+	}
+
+	/**
+	 * Get the translation of a label given a column.
+	 *
+	 * @return string
+	 */
+	public function getLabel()
+	{
+		$label = '';
+		if ($this->hasLabel()) {
+			try {
+				$label = LocalizationUtility::translate($this->tca['label'], '');
+			} catch (\InvalidArgumentException $e) {
+			}
+			if (empty($label)) {
+				$label = $this->tca['label'];
+			}
+		}
+		return $label;
+	}
+
+	/**
+	 * Get the translation of a label given a column.
+	 *
+	 * @param string $itemValue the item value to search for.
+	 * @return string
+	 */
+	public function getLabelForItem($itemValue)
+	{
+		// Early return whether there is nothing to be translated as label.
+		if (is_null($itemValue)) {
+			return '';
+		} elseif (is_string($itemValue) && $itemValue === '') {
+			return $itemValue;
+		}
+
+		$configuration = $this->getConfiguration();
+		if (!empty($configuration['items']) && is_array($configuration['items'])) {
+			foreach ($configuration['items'] as $item) {
+				if ($item[1] == $itemValue) {
+					try {
+						$label = LocalizationUtility::translate($item[0], '');
+					} catch (\InvalidArgumentException $e) {
+					}
+					if (empty($label)) {
+						$label = $item[0];
+					}
+					break;
+				}
+			}
+		}
+
+		// Try fetching a label from a possible itemsProcFunc
+		if (!isset($label) && is_scalar($itemValue)) {
+			$items = $this->fetchItemsFromUserFunction();
+			if (!empty($items[$itemValue])) {
+				$label = $items[$itemValue];
+			}
+		}
+
+		// Returns a label if it has been found, otherwise returns the item value as fallback.
+		return isset($label) ? $label : $itemValue;
+	}
+
+	/**
+	 * Retrieve items from User Function.
+	 *
+	 * @return array
+	 */
+	protected function fetchItemsFromUserFunction()
+	{
+		$values = [];
+
+		$configuration = $this->getConfiguration();
+		if (!empty($configuration['itemsProcFunc'])) {
+			$parts = explode('php:', $configuration['itemsProcFunc']);
+			if (!empty($parts[1])) {
+				list($class, $method) = explode('->', $parts[1]);
+
+				$parameters['items'] = [];
+				$object = GeneralUtility::makeInstance($class);
+				$object->$method($parameters);
+
+				foreach ($parameters['items'] as $items) {
+					$values[$items[1]] = $items[0];
+				}
+			}
+		}
+		return $values;
+	}
+
+	/**
+	 * Get a possible icon given a field name an an item.
+	 *
+	 * @param string $itemValue the item value to search for.
+	 * @return string
+	 */
+	public function getIconForItem($itemValue)
+	{
+		$result = '';
+		$configuration = $this->getConfiguration();
+		if (!empty($configuration['items']) && is_array($configuration['items'])) {
+			foreach ($configuration['items'] as $item) {
+				if ($item[1] == $itemValue) {
+					$result = empty($item[2]) ? '' : $item[2];
+					break;
+				}
+			}
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns whether the field has a label.
+	 *
+	 * @return bool
+	 */
+	public function hasLabel()
+	{
+		return empty($this->tca['label']) ? false : true;
+	}
+
+	/**
+	 * Tell whether the current BE User has access to this field.
+	 *
+	 * @return bool
+	 */
+	public function hasAccess()
+	{
+		$hasAccess = true;
+		if ($this->isBackendMode()
+			&& Tca::table($this->tableName)->hasAccess()
+			&& isset($this->tca['exclude'])
+			&& $this->tca['exclude']
+		) {
+			$hasAccess = $this->getBackendUser()->check('non_exclude_fields', $this->tableName . ':' . $this->fieldName);
+		}
+		return $hasAccess;
+	}
+
+	/**
+	 * Returns whether the field is numerical.
+	 *
+	 * @return bool
+	 */
+	public function isNumerical()
+	{
+		$result = $this->isSystem();
+		if ($result === false) {
+			$configuration = $this->getConfiguration();
+			$parts = [];
+			if (!empty($configuration['eval'])) {
+				$parts = GeneralUtility::trimExplode(',', $configuration['eval']);
+			}
+			$result = in_array('int', $parts) || in_array('float', $parts);
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns whether the field is of type text area.
+	 *
+	 * @return bool
+	 */
+	public function isTextArea()
+	{
+		return $this->getType() === FieldType::TEXTAREA;
+	}
+	/**
+	 * Returns whether the field is of type text area.
+	 *
+	 * @return bool
+	 */
+	public function isText()
+	{
+		return $this->getType() === FieldType::TEXT;
+	}
+
+	/**
+	 * Returns whether the field is displayed as a tree.
+	 *
+	 * @return bool
+	 */
+	public function isRenderModeTree()
+	{
+		$configuration = $this->getConfiguration();
+		return isset($configuration['renderMode']) && $configuration['renderMode'] == FieldType::TREE;
+	}
+
+	/**
+	 * Returns whether the field is of type select.
+	 *
+	 * @return bool
+	 */
+	public function isSelect()
+	{
+		return $this->getType() === FieldType::SELECT;
+	}
+
+	/**
+	 * Returns whether the field is of type select.
+	 *
+	 * @return bool
+	 */
+	public function isMultipleSelect()
+	{
+		return $this->getType() === FieldType::MULTISELECT;
+	}
+
+	/**
+	 * Returns whether the field is of type select.
+	 *
+	 * @return bool
+	 */
+	public function isCheckBox()
+	{
+		return $this->getType() === FieldType::CHECKBOX;
+	}
+
+	/**
+	 * Returns whether the field is of type db.
+	 *
+	 * @return bool
+	 */
+	public function isGroup()
+	{
+		return $this->getType() === 'group';
+	}
+
+	/**
+	 * Returns whether the field is language aware.
+	 *
+	 * @return bool
+	 */
+	public function isLocalized()
+	{
+		$isLocalized = false;
+		if (isset($this->tca['l10n_mode'])) {
+			if ($this->tca['l10n_mode'] == 'prefixLangTitle' || $this->tca['l10n_mode'] == 'mergeIfNotBlank') {
+				$isLocalized = true;
+			}
+		}
+		return $isLocalized;
+	}
+
+	/**
+	 * Returns whether the field is required.
+	 *
+	 * @return bool
+	 */
+	public function isRequired()
+	{
+		$configuration = $this->getConfiguration();
+
+		$isRequired = false;
+		if (isset($configuration['minitems'])) {
+			// is required of a select?
+			$isRequired = $configuration['minitems'] == 1 ? true : false;
+		} elseif (isset($configuration['eval'])) {
+			$parts = GeneralUtility::trimExplode(',', $configuration['eval'], true);
+			$isRequired = in_array('required', $parts);
+		}
+		return $isRequired;
+	}
+
+	/**
+	 * Returns an array containing the configuration of a column.
+	 *
+	 * @return array
+	 */
+	public function getField()
+	{
+		return $this->tca;
+	}
+
+	/**
+	 * Returns the relation type
+	 *
+	 * @return string
+	 */
+	public function relationDataType()
+	{
+		$configuration = $this->getConfiguration();
+		return empty($configuration['foreign_table']) ? '' : $configuration['foreign_table'];
+	}
+
+	/**
+	 * Returns whether the field has relation (one to many, many to many)
+	 *
+	 * @return bool
+	 */
+	public function hasRelation()
+	{
+		return null !== $this->getForeignTable();
+	}
+
+	/**
+	 * Returns whether the field has no relation (one to many, many to many)
+	 *
+	 * @return bool
+	 */
+	public function hasNoRelation()
+	{
+		return !$this->hasRelation();
+	}
+
+	/**
+	 * Returns whether the field has a "many" objects connected including "many-to-many" or "one-to-many".
+	 *
+	 * @return bool
+	 */
+	public function hasMany()
+	{
+		$configuration = $this->getConfiguration();
+		return $this->hasRelation() && ($configuration['maxitems'] > 1 || isset($configuration['foreign_table_field']));
+	}
+
+	/**
+	 * Returns whether the field has relation "one" object connected including of "one-to-one" or "many-to-one".
+	 *
+	 * @return bool
+	 */
+	public function hasOne()
+	{
+		$configuration = $this->getConfiguration();
+		return !isset($configuration['MM']) && $this->hasRelation() && ($configuration['maxitems'] == 1 || !isset($configuration['maxitems']));
+	}
+
+	/**
+	 * Returns whether the field has many-to-one relation.
+	 *
+	 * @return bool
+	 */
+	public function hasRelationManyToOne()
+	{
+		$result = false;
+
+		$foreignField = $this->getForeignField();
+		if (!empty($foreignField)) {
+			// Load TCA service of the foreign field.
+			$foreignTable = $this->getForeignTable();
+			$result = $this->hasOne() && Tca::table($foreignTable)->field($foreignField)->hasMany();
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns whether the field has one-to-many relation.
+	 *
+	 * @return bool
+	 */
+	public function hasRelationOneToMany()
+	{
+		$result = false;
+
+		$foreignField = $this->getForeignField();
+		if (!empty($foreignField)) {
+			// Load TCA service of the foreign field.
+			$foreignTable = $this->getForeignTable();
+			$result = $this->hasMany() && Tca::table($foreignTable)->field($foreignField)->hasOne();
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns whether the field has one-to-one relation.
+	 *
+	 * @return bool
+	 */
+	public function hasRelationOneToOne()
+	{
+		$result = false;
+
+		$foreignField = $this->getForeignField();
+		if (!empty($foreignField)) {
+			// Load TCA service of foreign field.
+			$foreignTable = $this->getForeignTable();
+			$result = $this->hasOne() && Tca::table($foreignTable)->field($foreignField)->hasOne();
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns whether the field has many to many relation.
+	 *
+	 * @return bool
+	 */
+	public function hasRelationManyToMany()
+	{
+		$configuration = $this->getConfiguration();
+		return $this->hasRelation() && (isset($configuration['MM']) || isset($configuration['foreign_table_field']));
+	}
+
+	/**
+	 * Returns whether the field has many to many relation using comma separated values (legacy).
+	 *
+	 * @return bool
+	 */
+	public function hasRelationWithCommaSeparatedValues()
+	{
+		$configuration = $this->getConfiguration();
+		return $this->hasRelation() && !isset($configuration['MM']) && !isset($configuration['foreign_field']) && $configuration['maxitems'] > 1;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getTca()
+	{
+		return $this->tca['columns'];
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getCompositeField()
+	{
+		return $this->compositeField;
+	}
+
+	/**
+	 * @param string $compositeField
+	 */
+	public function setCompositeField($compositeField)
+	{
+		$this->compositeField = $compositeField;
+	}
+
+	/**
+	 * Returns an instance of the Frontend object.
+	 *
+	 * @return TypoScriptFrontendController
+	 */
+	protected function getFrontendObject()
+	{
+		return $GLOBALS['TSFE'];
+	}
 }

Classes/Tca/GridService.php

Indentation +691 added lines, -691 removed lines

@@ -23,695 +23,695 @@
  */
 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 = isset($this->tca['columns']) && 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 = isset($this->tca['columns']) && 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/View/AbstractComponentView.php

Indentation +39 added lines, -39 removed lines

@@ -20,47 +20,47 @@
  */
 abstract class AbstractComponentView implements ViewComponentInterface
 {
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader|object
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader|object
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 
-    /**
-     * Returns an instance of the current Backend User.
-     *
-     * @return BackendUserAuthentication
-     */
-    protected function getBackendUser()
-    {
-        return $GLOBALS['BE_USER'];
-    }
+	/**
+	 * Returns an instance of the current Backend User.
+	 *
+	 * @return BackendUserAuthentication
+	 */
+	protected function getBackendUser()
+	{
+		return $GLOBALS['BE_USER'];
+	}
 
-    /**
-     * @return LanguageService|object
-     */
-    protected function getLanguageService()
-    {
-        return GeneralUtility::makeInstance(LanguageService::class);
-    }
+	/**
+	 * @return LanguageService|object
+	 */
+	protected function getLanguageService()
+	{
+		return GeneralUtility::makeInstance(LanguageService::class);
+	}
 
-    /**
-     * @return IconFactory|object
-     */
-    protected function getIconFactory()
-    {
-        return GeneralUtility::makeInstance(IconFactory::class);
-    }
+	/**
+	 * @return IconFactory|object
+	 */
+	protected function getIconFactory()
+	{
+		return GeneralUtility::makeInstance(IconFactory::class);
+	}
 
-    /**
-     * @return LinkButton|object
-     */
-    protected function makeLinkButton()
-    {
-        return GeneralUtility::makeInstance(LinkButton::class);
-    }
+	/**
+	 * @return LinkButton|object
+	 */
+	protected function makeLinkButton()
+	{
+		return GeneralUtility::makeInstance(LinkButton::class);
+	}
 }

Classes/View/ViewComponentInterface.php

Indentation +6 added lines, -6 removed lines

@@ -14,10 +14,10 @@
  */
 interface ViewComponentInterface
 {
-    /**
-     * Renders something to be printed out to the browser.
-     *
-     * @return string
-     */
-    public function render();
+	/**
+	 * Renders something to be printed out to the browser.
+	 *
+	 * @return string
+	 */
+	public function render();
 }

Classes/View/System/CheckboxSystem.php

Indentation +11 added lines, -11 removed lines

@@ -18,15 +18,15 @@
  */
 class CheckboxSystem extends AbstractComponentView
 {
-    /**
-     * Returns a checkbox for the grids.
-     *
-     * @param Content $object
-     * @param  int $offset
-     * @return string
-     */
-    public function render(Content $object = null, $offset = 0)
-    {
-        return '';
-    }
+	/**
+	 * Returns a checkbox for the grids.
+	 *
+	 * @param Content $object
+	 * @param  int $offset
+	 * @return string
+	 */
+	public function render(Content $object = null, $offset = 0)
+	{
+		return '';
+	}
 }

Classes/View/System/ButtonsSystem.php

Indentation +10 added lines, -10 removed lines

@@ -18,14 +18,14 @@
  */
 class ButtonsSystem extends AbstractComponentView
 {
-    /**
-     * Rendering buttons in the grids given a Content object.
-     *
-     * @param Content $object
-     * @return string
-     */
-    public function render(Content $object = null)
-    {
-        return '';
-    }
+	/**
+	 * Rendering buttons in the grids given a Content object.
+	 *
+	 * @param Content $object
+	 * @return string
+	 */
+	public function render(Content $object = null)
+	{
+		return '';
+	}
 }

Classes/View/Check/RelationsCheck.php

Indentation +77 added lines, -77 removed lines

@@ -17,36 +17,36 @@ 
  */
 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.
@@ -61,19 +61,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>
@@ -107,38 +107,38 @@ 
 
 </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/View/Uri/EditUri.php

Indentation +29 added lines, -29 removed lines

@@ -18,34 +18,34 @@
  */
 class EditUri extends AbstractComponentView
 {
-    /**
-     * Renders a "edit" button to be placed in the grid.
-     *
-     * @param Content $object
-     * @return string
-     */
-    public function render(Content $object = null)
-    {
-        $uri = BackendUtility::getModuleUrl(
-            'record_edit',
-            array(
-                $this->getEditParameterName($object) => 'edit',
-                'returnUrl' => $this->getModuleLoader()->getModuleUrl()
-            )
-        );
-        return $uri;
-    }
+	/**
+	 * Renders a "edit" button to be placed in the grid.
+	 *
+	 * @param Content $object
+	 * @return string
+	 */
+	public function render(Content $object = null)
+	{
+		$uri = BackendUtility::getModuleUrl(
+			'record_edit',
+			array(
+				$this->getEditParameterName($object) => 'edit',
+				'returnUrl' => $this->getModuleLoader()->getModuleUrl()
+			)
+		);
+		return $uri;
+	}
 
-    /**
-     * @param Content $object
-     * @return string
-     */
-    protected function getEditParameterName(Content $object)
-    {
-        return sprintf(
-            'edit[%s][%s]',
-            $object->getDataType(),
-            $object->getUid()
-        );
-    }
+	/**
+	 * @param Content $object
+	 * @return string
+	 */
+	protected function getEditParameterName(Content $object)
+	{
+		return sprintf(
+			'edit[%s][%s]',
+			$object->getDataType(),
+			$object->getUid()
+		);
+	}
 }