fabarea / vidi

Classes/Processor/MarkerProcessor.php

Doc Comments +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
 
     /**
      * @param ProcessContentDataSignalArguments $signalArguments
-     * @return array
+     * @return ProcessContentDataSignalArguments[]
      */
     public function processMarkers(ProcessContentDataSignalArguments $signalArguments)
     {
@@ -72,7 +72,7 @@ 
      * @param string $updateValue
      * @param string $currentValue
      * @param int $counter
-     * @param $creationTime
+     * @param integer $creationTime
      * @return string
      */
     protected function replaceWellKnownMarkers($updateValue, $currentValue, $counter, $creationTime)

Indentation +109 added lines, -109 removed lines

@@ -25,114 +25,114 @@
 class MarkerProcessor implements SingletonInterface
 {
 
-    /**
-     * @var array
-     */
-    protected $wellKnownMarkers = array(
-        '{*}',
-        '{counter}',
-        '{date}',
-        '{creation_date}'
-    );
-
-    /**
-     * @param ProcessContentDataSignalArguments $signalArguments
-     * @return array
-     */
-    public function processMarkers(ProcessContentDataSignalArguments $signalArguments)
-    {
-
-        $contentData = $signalArguments->getContentData();
-        $creationTime = $this->getCreationTime($signalArguments);
-
-        // Process markers
-        foreach ($signalArguments->getContentData() as $fieldName => $updateValue) {
-            if (is_scalar($updateValue)) {
-
-                $currentValue = $this->getContentObjectResolver()->getValue(
-                    $signalArguments->getContentObject(),
-                    $signalArguments->getFieldNameAndPath(),
-                    $fieldName,
-                    $signalArguments->getLanguage()
-                );
-                $counter = $signalArguments->getCounter();
-
-                $updateValue = $this->searchAndReplace($updateValue, $currentValue);
-                $updateValue = $this->replaceWellKnownMarkers($updateValue, $currentValue, $counter, $creationTime);
-
-                $contentData[$fieldName] = $updateValue;
-            }
-        }
-
-        $signalArguments->setContentData($contentData);
-        return array($signalArguments);
-    }
-
-    /**
-     * @param string $updateValue
-     * @param string $currentValue
-     * @param int $counter
-     * @param $creationTime
-     * @return string
-     */
-    protected function replaceWellKnownMarkers($updateValue, $currentValue, $counter, $creationTime)
-    {
-
-        // Replaces values.
-        $replaces = array(
-            $currentValue,
-            $counter,
-            date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy']),
-            date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], $creationTime),
-        );
-
-        // Replace me!
-        return str_replace($this->wellKnownMarkers, $replaces, $updateValue);
-    }
-
-    /**
-     * @param string $updateValue
-     * @param string $currentValue
-     * @return string
-     */
-    protected function searchAndReplace($updateValue, $currentValue)
-    {
-
-        if (strpos($updateValue, 's/') !== FALSE) {
-            $structure = explode('/', $updateValue);
-            $search = $structure[1];
-            $replace = $structure[2];
-
-            // Perhaps needs to be improved here if $search contains "/" precisely.
-            $updateValue = preg_replace('/' . $search . '/isU', $replace, $currentValue);
-        }
-        return $updateValue;
-    }
-
-    /**
-     * @param ProcessContentDataSignalArguments $signalArguments
-     * @return int
-     */
-    protected function getCreationTime(ProcessContentDataSignalArguments $signalArguments)
-    {
-        $creationTime = 0;
-        $creationTimeField = Tca::table($signalArguments->getContentObject()->getDataType())->getTimeCreationField();
-        if ($creationTimeField) {
-            $creationTime = $this->getContentObjectResolver()->getValue(
-                $signalArguments->getContentObject(),
-                $signalArguments->getFieldNameAndPath(),
-                $creationTimeField
-            );
-        }
-        return $creationTime;
-    }
-
-    /**
-     * @return \Fab\Vidi\Resolver\ContentObjectResolver
-     */
-    protected function getContentObjectResolver()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Resolver\ContentObjectResolver');
-    }
+	/**
+	 * @var array
+	 */
+	protected $wellKnownMarkers = array(
+		'{*}',
+		'{counter}',
+		'{date}',
+		'{creation_date}'
+	);
+
+	/**
+	 * @param ProcessContentDataSignalArguments $signalArguments
+	 * @return array
+	 */
+	public function processMarkers(ProcessContentDataSignalArguments $signalArguments)
+	{
+
+		$contentData = $signalArguments->getContentData();
+		$creationTime = $this->getCreationTime($signalArguments);
+
+		// Process markers
+		foreach ($signalArguments->getContentData() as $fieldName => $updateValue) {
+			if (is_scalar($updateValue)) {
+
+				$currentValue = $this->getContentObjectResolver()->getValue(
+					$signalArguments->getContentObject(),
+					$signalArguments->getFieldNameAndPath(),
+					$fieldName,
+					$signalArguments->getLanguage()
+				);
+				$counter = $signalArguments->getCounter();
+
+				$updateValue = $this->searchAndReplace($updateValue, $currentValue);
+				$updateValue = $this->replaceWellKnownMarkers($updateValue, $currentValue, $counter, $creationTime);
+
+				$contentData[$fieldName] = $updateValue;
+			}
+		}
+
+		$signalArguments->setContentData($contentData);
+		return array($signalArguments);
+	}
+
+	/**
+	 * @param string $updateValue
+	 * @param string $currentValue
+	 * @param int $counter
+	 * @param $creationTime
+	 * @return string
+	 */
+	protected function replaceWellKnownMarkers($updateValue, $currentValue, $counter, $creationTime)
+	{
+
+		// Replaces values.
+		$replaces = array(
+			$currentValue,
+			$counter,
+			date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy']),
+			date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], $creationTime),
+		);
+
+		// Replace me!
+		return str_replace($this->wellKnownMarkers, $replaces, $updateValue);
+	}
+
+	/**
+	 * @param string $updateValue
+	 * @param string $currentValue
+	 * @return string
+	 */
+	protected function searchAndReplace($updateValue, $currentValue)
+	{
+
+		if (strpos($updateValue, 's/') !== FALSE) {
+			$structure = explode('/', $updateValue);
+			$search = $structure[1];
+			$replace = $structure[2];
+
+			// Perhaps needs to be improved here if $search contains "/" precisely.
+			$updateValue = preg_replace('/' . $search . '/isU', $replace, $currentValue);
+		}
+		return $updateValue;
+	}
+
+	/**
+	 * @param ProcessContentDataSignalArguments $signalArguments
+	 * @return int
+	 */
+	protected function getCreationTime(ProcessContentDataSignalArguments $signalArguments)
+	{
+		$creationTime = 0;
+		$creationTimeField = Tca::table($signalArguments->getContentObject()->getDataType())->getTimeCreationField();
+		if ($creationTimeField) {
+			$creationTime = $this->getContentObjectResolver()->getValue(
+				$signalArguments->getContentObject(),
+				$signalArguments->getFieldNameAndPath(),
+				$creationTimeField
+			);
+		}
+		return $creationTime;
+	}
+
+	/**
+	 * @return \Fab\Vidi\Resolver\ContentObjectResolver
+	 */
+	protected function getContentObjectResolver()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Resolver\ContentObjectResolver');
+	}
 
 }

Classes/Service/ContentService.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
     /**
      * Signal that is called after the content objects have been found.
      *
-     * @param array $contentObjects
+     * @param \Fab\Vidi\Domain\Model\Content[] $contentObjects
      * @param \Fab\Vidi\Persistence\Matcher $matcher
      * @param Order $order
      * @param int $limit

Indentation +125 added lines, -125 removed lines

@@ -27,129 +27,129 @@
 class ContentService
 {
 
-    /**
-     * @var string
-     */
-    protected $dataType;
-
-    /**
-     * @var \Fab\Vidi\Domain\Model\Content[]
-     */
-    protected $objects = array();
-
-    /**
-     * @var int
-     */
-    protected $numberOfObjects = 0;
-
-    /**
-     * Constructor
-     *
-     * @param string $dataType
-     * @return \Fab\Vidi\Service\ContentService
-     */
-    public function __construct($dataType = '')
-    {
-        if (empty($dataType)) {
-            $dataType = $this->getModuleLoader()->getDataType();
-        }
-        $this->dataType = $dataType;
-    }
-
-    /**
-     * Fetch the files given an object assuming
-     *
-     * @param Matcher $matcher
-     * @param Order $order The order
-     * @param int $limit
-     * @param int $offset
-     * @return $this
-     */
-    public function findBy(Matcher $matcher, Order $order = NULL, $limit = NULL, $offset = NULL)
-    {
-
-        // Query the repository.
-        $objects = ContentRepositoryFactory::getInstance($this->dataType)->findBy($matcher, $order, $limit, $offset);
-        $signalResult = $this->emitAfterFindContentObjectsSignal($objects, $matcher, $order, $limit, $offset);
-
-        // Reset objects variable after possible signal / slot processing.
-        $this->objects = $signalResult->getContentObjects();
-
-        // Count number of content objects.
-        if ($signalResult->getHasBeenProcessed()) {
-            $this->numberOfObjects = $signalResult->getNumberOfObjects();
-        } else {
-            $this->numberOfObjects = ContentRepositoryFactory::getInstance($this->dataType)->countBy($matcher);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Signal that is called after the content objects have been found.
-     *
-     * @param array $contentObjects
-     * @param \Fab\Vidi\Persistence\Matcher $matcher
-     * @param Order $order
-     * @param int $limit
-     * @param int $offset
-     * @return AfterFindContentObjectsSignalArguments
-     * @throws \TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotException
-     * @throws \TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotReturnException
-     * @signal
-     */
-    protected function emitAfterFindContentObjectsSignal($contentObjects, Matcher $matcher, Order $order = NULL, $limit = 0, $offset = 0)
-    {
-
-        /** @var \Fab\Vidi\Signal\AfterFindContentObjectsSignalArguments $signalArguments */
-        $signalArguments = GeneralUtility::makeInstance('Fab\Vidi\Signal\AfterFindContentObjectsSignalArguments');
-        $signalArguments->setDataType($this->dataType)
-            ->setContentObjects($contentObjects)
-            ->setMatcher($matcher)
-            ->setOrder($order)
-            ->setLimit($limit)
-            ->setOffset($offset)
-            ->setHasBeenProcessed(FALSE);
-
-        $signalResult = $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\Service\ContentService', 'afterFindContentObjects', array($signalArguments));
-        return $signalResult[0];
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return \Fab\Vidi\Module\ModuleLoader
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Module\ModuleLoader');
-    }
-
-    /**
-     * Get the SignalSlot dispatcher.
-     *
-     * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
-     */
-    protected function getSignalSlotDispatcher()
-    {
-        /** @var \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager */
-        $objectManager = GeneralUtility::makeInstance('TYPO3\CMS\Extbase\Object\ObjectManager');
-        return $objectManager->get('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher');
-    }
-
-    /**
-     * @return \Fab\Vidi\Domain\Model\Content[]
-     */
-    public function getObjects()
-    {
-        return $this->objects;
-    }
-
-    /**
-     * @return int
-     */
-    public function getNumberOfObjects()
-    {
-        return $this->numberOfObjects;
-    }
+	/**
+	 * @var string
+	 */
+	protected $dataType;
+
+	/**
+	 * @var \Fab\Vidi\Domain\Model\Content[]
+	 */
+	protected $objects = array();
+
+	/**
+	 * @var int
+	 */
+	protected $numberOfObjects = 0;
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $dataType
+	 * @return \Fab\Vidi\Service\ContentService
+	 */
+	public function __construct($dataType = '')
+	{
+		if (empty($dataType)) {
+			$dataType = $this->getModuleLoader()->getDataType();
+		}
+		$this->dataType = $dataType;
+	}
+
+	/**
+	 * Fetch the files given an object assuming
+	 *
+	 * @param Matcher $matcher
+	 * @param Order $order The order
+	 * @param int $limit
+	 * @param int $offset
+	 * @return $this
+	 */
+	public function findBy(Matcher $matcher, Order $order = NULL, $limit = NULL, $offset = NULL)
+	{
+
+		// Query the repository.
+		$objects = ContentRepositoryFactory::getInstance($this->dataType)->findBy($matcher, $order, $limit, $offset);
+		$signalResult = $this->emitAfterFindContentObjectsSignal($objects, $matcher, $order, $limit, $offset);
+
+		// Reset objects variable after possible signal / slot processing.
+		$this->objects = $signalResult->getContentObjects();
+
+		// Count number of content objects.
+		if ($signalResult->getHasBeenProcessed()) {
+			$this->numberOfObjects = $signalResult->getNumberOfObjects();
+		} else {
+			$this->numberOfObjects = ContentRepositoryFactory::getInstance($this->dataType)->countBy($matcher);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Signal that is called after the content objects have been found.
+	 *
+	 * @param array $contentObjects
+	 * @param \Fab\Vidi\Persistence\Matcher $matcher
+	 * @param Order $order
+	 * @param int $limit
+	 * @param int $offset
+	 * @return AfterFindContentObjectsSignalArguments
+	 * @throws \TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotException
+	 * @throws \TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotReturnException
+	 * @signal
+	 */
+	protected function emitAfterFindContentObjectsSignal($contentObjects, Matcher $matcher, Order $order = NULL, $limit = 0, $offset = 0)
+	{
+
+		/** @var \Fab\Vidi\Signal\AfterFindContentObjectsSignalArguments $signalArguments */
+		$signalArguments = GeneralUtility::makeInstance('Fab\Vidi\Signal\AfterFindContentObjectsSignalArguments');
+		$signalArguments->setDataType($this->dataType)
+			->setContentObjects($contentObjects)
+			->setMatcher($matcher)
+			->setOrder($order)
+			->setLimit($limit)
+			->setOffset($offset)
+			->setHasBeenProcessed(FALSE);
+
+		$signalResult = $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\Service\ContentService', 'afterFindContentObjects', array($signalArguments));
+		return $signalResult[0];
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return \Fab\Vidi\Module\ModuleLoader
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Module\ModuleLoader');
+	}
+
+	/**
+	 * Get the SignalSlot dispatcher.
+	 *
+	 * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
+	 */
+	protected function getSignalSlotDispatcher()
+	{
+		/** @var \TYPO3\CMS\Extbase\Object\ObjectManager $objectManager */
+		$objectManager = GeneralUtility::makeInstance('TYPO3\CMS\Extbase\Object\ObjectManager');
+		return $objectManager->get('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher');
+	}
+
+	/**
+	 * @return \Fab\Vidi\Domain\Model\Content[]
+	 */
+	public function getObjects()
+	{
+		return $this->objects;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getNumberOfObjects()
+	{
+		return $this->numberOfObjects;
+	}
 }

Classes/Tca/GridService.php

Doc Comments +2 added lines, -2 removed lines

@@ -460,7 +460,7 @@ 
      *
      * @param string $fieldName
      * @param string $key
-     * @param mixed $defaultValue
+     * @param boolean|string $defaultValue
      * @return NULL|mixed
      */
     public function get($fieldName, $key, $defaultValue = NULL)
@@ -652,7 +652,7 @@ 
     /**
      * Returns a "facet" service instance.
      *
-     * @param string|FacetInterface $facetName
+     * @param string $facetName
      * @return FacetInterface
      */
     public function facet($facetName = '')

Indentation +645 added lines, -645 removed lines

@@ -31,650 +31,650 @@
 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
-     *
-     * @throws InvalidKeyInArrayException
-     * @param string $tableName
-     * @return \Fab\Vidi\Tca\GridService
-     */
-    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()
-    {
-        $fields = $this->getFields();
-        return array_keys($fields);
-    }
-
-    /**
-     * Returns an array containing column names.
-     *
-     * @return array
-     */
-    public function getAllFieldNames()
-    {
-        $allFields = $this->getAllFields();
-        return array_keys($allFields);
-    }
-
-    /**
-     * Get the label key.
-     *
-     * @param string $fieldNameAndPath
-     * @return string
-     */
-    public function getLabelKey($fieldNameAndPath)
-    {
-
-        $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);
-            $label = LocalizationUtility::translate($labelKey, '');
-            if (is_null($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
-     * @throws InvalidKeyInArrayException
-     * @return int
-     */
-    public function getFieldNameByPosition($position)
-    {
-        $fields = array_keys($this->getFields());
-        if (empty($fields[$position])) {
-            throw new InvalidKeyInArrayException('No field exist for position: ' . $position, 1356945119);
-        }
-
-        return $fields[$position];
-    }
-
-    /**
-     * Returns a field name.
-     *
-     * @param string $fieldName
-     * @return array
-     * @throws InvalidKeyInArrayException
-     */
-    public function getField($fieldName)
-    {
-        $fields = $this->getFields();
-        return $fields[$fieldName];
-    }
-
-    /**
-     * Returns an array containing column names for the Grid.
-     *
-     * @return array
-     */
-    public function getFields()
-    {
-        // Cache this operation since it can take some time.
-        if (is_null($this->fields)) {
-
-            // Fetch all available fields first.
-            $fields = $this->getAllFields();
-
-            if ($this->isBackendMode()) {
-                // Then remove the not allowed.
-                $fields = $this->filterForBackendUser($fields);
-                $fields = $this->filterForConfiguration($fields);
-            }
-
-            $this->fields = $fields;
-        }
-
-        return $this->fields;
-    }
-
-    /**
-     * Remove fields according to BE User permission.
-     *
-     * @param $fields
-     * @return array
-     * @throws \Exception
-     */
-    protected function filterForBackendUser($fields)
-    {
-        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 filterForConfiguration($fields)
-    {
-
-        // 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()
-    {
-
-        // Cache this operation since it can take some time.
-        if (is_null($this->allFields)) {
-
-            $fields = is_array($this->tca['columns']) ? $this->tca['columns'] : array();
-            $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)
-    {
-        $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)
-    {
-        $facets = $this->getFacets();
-        return isset($facets[$facetName]);
-    }
-
-    /**
-     * Returns an array containing facets fields.
-     *
-     * @return FacetInterface[]
-     */
-    public function getFacets()
-    {
-        if (is_null($this->facets)) {
-            $this->facets = array();
-
-            if (is_array($this->tca['facets'])) {
-                foreach ($this->tca['facets'] as $facetNameOrObject) {
-                    if ($facetNameOrObject instanceof FacetInterface) {
-                        $this->facets[$facetNameOrObject->getName()] = $facetNameOrObject;
-                    } else {
-                        $this->facets[$facetNameOrObject] = $this->instantiateStandardFacet($facetNameOrObject);
-                    }
-                }
-            }
-        }
-        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)
-    {
-        $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)
-    {
-        $defaultValue = TRUE;
-        return $this->get($fieldName, 'visible', $defaultValue);
-    }
-
-    /**
-     * Returns the "editable" value of the column.
-     *
-     * @param string $columnName
-     * @return bool
-     */
-    public function isEditable($columnName)
-    {
-        $defaultValue = FALSE;
-        return $this->get($columnName, 'editable', $defaultValue);
-    }
-
-    /**
-     * Returns the "localized" value of the column.
-     *
-     * @param string $columnName
-     * @return bool
-     */
-    public function isLocalized($columnName)
-    {
-        $defaultValue = TRUE;
-        return $this->get($columnName, 'localized', $defaultValue);
-    }
-
-    /**
-     *
-     * Returns the "html" value of the column.
-     *
-     * @param string $fieldName
-     * @return string
-     */
-    public function getHeader($fieldName)
-    {
-        $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)
-    {
-        $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)
-    {
-        $field = $this->getField($fieldName);
-        $renderers = array();
-        if (!empty($field['renderer'])) {
-            $renderers = $this->convertRendererToArray($field['renderer']);
-        } elseif (!empty($field['renderers']) && is_array($field['renderers'])) {
-            foreach ($field['renderers'] as $renderer) {
-                $rendererNameAndConfiguration = $this->convertRendererToArray($renderer);
-                $renderers = array_merge($renderers, $rendererNameAndConfiguration);
-            }
-        }
-
-        return $renderers;
-    }
-
-    /**
-     * @param string|GenericColumn $renderer
-     * @return array
-     */
-    public function convertRendererToArray($renderer)
-    {
-        $result = array();
-        if (is_string($renderer)) {
-            $result[$renderer] = array();
-        } elseif ($renderer instanceof ColumnInterface || $renderer instanceof ColumnRendererInterface) {
-            /** @var GenericColumn $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)
-    {
-        $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)
-    {
-        $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()
-    {
-        return $this->tca;
-    }
-
-    /**
-     * Return excluded fields from configuration + preferences.
-     *
-     * @return array
-     */
-    public function getExcludedFields()
-    {
-        $configurationFields = $this->getExcludedFieldsFromConfiguration();
-        $preferencesFields = $this->getExcludedFieldsFromPreferences();
-
-        return array_merge($configurationFields, $preferencesFields);
-    }
-
-    /**
-     * Fetch excluded fields from configuration.
-     *
-     * @return array
-     */
-    protected function getExcludedFieldsFromConfiguration()
-    {
-        $excludedFields = array();
-        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()
-    {
-        $excludedFields = $this->getModulePreferences()->get(ConfigurablePart::EXCLUDED_FIELDS, $this->tableName);
-        return is_array($excludedFields) ? $excludedFields : array();
-    }
-
-    /**
-     * @return array
-     */
-    public function areFilesIncludedInExport()
-    {
-        $isIncluded = TRUE;
-
-        if (isset($this->tca['export']['include_files'])) {
-            $isIncluded = $this->tca['export']['include_files'];
-        }
-        return $isIncluded;
-    }
-
-    /**
-     * Returns a "facet" service instance.
-     *
-     * @param string|FacetInterface $facetName
-     * @return StandardFacet
-     */
-    protected function instantiateStandardFacet($facetName)
-    {
-        $label = $this->getLabel($facetName);
-
-        /** @var StandardFacet $facetName */
-        $facet = GeneralUtility::makeInstance('Fab\Vidi\Facet\StandardFacet', $facetName, $label);
-
-        if (!$facet instanceof StandardFacet) {
-            throw new \RuntimeException('I could not instantiate a facet for facet name "' . (string)$facet . '""', 1445856345);
-        }
-        return $facet;
-    }
-
-    /**
-     * Returns a "facet" service instance.
-     *
-     * @param string|FacetInterface $facetName
-     * @return FacetInterface
-     */
-    public function facet($facetName = '')
-    {
-        $facets = $this->getFacets();
-        return $facets[$facetName];
-    }
-
-    /**
-     * @return \Fab\Vidi\Resolver\FieldPathResolver
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Resolver\FieldPathResolver');
-    }
-
-    /**
-     * @return ModulePreferences
-     */
-    protected function getModulePreferences()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Module\ModulePreferences');
-    }
+	/**
+	 * @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
+	 *
+	 * @throws InvalidKeyInArrayException
+	 * @param string $tableName
+	 * @return \Fab\Vidi\Tca\GridService
+	 */
+	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()
+	{
+		$fields = $this->getFields();
+		return array_keys($fields);
+	}
+
+	/**
+	 * Returns an array containing column names.
+	 *
+	 * @return array
+	 */
+	public function getAllFieldNames()
+	{
+		$allFields = $this->getAllFields();
+		return array_keys($allFields);
+	}
+
+	/**
+	 * Get the label key.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @return string
+	 */
+	public function getLabelKey($fieldNameAndPath)
+	{
+
+		$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);
+			$label = LocalizationUtility::translate($labelKey, '');
+			if (is_null($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
+	 * @throws InvalidKeyInArrayException
+	 * @return int
+	 */
+	public function getFieldNameByPosition($position)
+	{
+		$fields = array_keys($this->getFields());
+		if (empty($fields[$position])) {
+			throw new InvalidKeyInArrayException('No field exist for position: ' . $position, 1356945119);
+		}
+
+		return $fields[$position];
+	}
+
+	/**
+	 * Returns a field name.
+	 *
+	 * @param string $fieldName
+	 * @return array
+	 * @throws InvalidKeyInArrayException
+	 */
+	public function getField($fieldName)
+	{
+		$fields = $this->getFields();
+		return $fields[$fieldName];
+	}
+
+	/**
+	 * Returns an array containing column names for the Grid.
+	 *
+	 * @return array
+	 */
+	public function getFields()
+	{
+		// Cache this operation since it can take some time.
+		if (is_null($this->fields)) {
+
+			// Fetch all available fields first.
+			$fields = $this->getAllFields();
+
+			if ($this->isBackendMode()) {
+				// Then remove the not allowed.
+				$fields = $this->filterForBackendUser($fields);
+				$fields = $this->filterForConfiguration($fields);
+			}
+
+			$this->fields = $fields;
+		}
+
+		return $this->fields;
+	}
+
+	/**
+	 * Remove fields according to BE User permission.
+	 *
+	 * @param $fields
+	 * @return array
+	 * @throws \Exception
+	 */
+	protected function filterForBackendUser($fields)
+	{
+		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 filterForConfiguration($fields)
+	{
+
+		// 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()
+	{
+
+		// Cache this operation since it can take some time.
+		if (is_null($this->allFields)) {
+
+			$fields = is_array($this->tca['columns']) ? $this->tca['columns'] : array();
+			$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)
+	{
+		$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)
+	{
+		$facets = $this->getFacets();
+		return isset($facets[$facetName]);
+	}
+
+	/**
+	 * Returns an array containing facets fields.
+	 *
+	 * @return FacetInterface[]
+	 */
+	public function getFacets()
+	{
+		if (is_null($this->facets)) {
+			$this->facets = array();
+
+			if (is_array($this->tca['facets'])) {
+				foreach ($this->tca['facets'] as $facetNameOrObject) {
+					if ($facetNameOrObject instanceof FacetInterface) {
+						$this->facets[$facetNameOrObject->getName()] = $facetNameOrObject;
+					} else {
+						$this->facets[$facetNameOrObject] = $this->instantiateStandardFacet($facetNameOrObject);
+					}
+				}
+			}
+		}
+		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)
+	{
+		$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)
+	{
+		$defaultValue = TRUE;
+		return $this->get($fieldName, 'visible', $defaultValue);
+	}
+
+	/**
+	 * Returns the "editable" value of the column.
+	 *
+	 * @param string $columnName
+	 * @return bool
+	 */
+	public function isEditable($columnName)
+	{
+		$defaultValue = FALSE;
+		return $this->get($columnName, 'editable', $defaultValue);
+	}
+
+	/**
+	 * Returns the "localized" value of the column.
+	 *
+	 * @param string $columnName
+	 * @return bool
+	 */
+	public function isLocalized($columnName)
+	{
+		$defaultValue = TRUE;
+		return $this->get($columnName, 'localized', $defaultValue);
+	}
+
+	/**
+	 *
+	 * Returns the "html" value of the column.
+	 *
+	 * @param string $fieldName
+	 * @return string
+	 */
+	public function getHeader($fieldName)
+	{
+		$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)
+	{
+		$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)
+	{
+		$field = $this->getField($fieldName);
+		$renderers = array();
+		if (!empty($field['renderer'])) {
+			$renderers = $this->convertRendererToArray($field['renderer']);
+		} elseif (!empty($field['renderers']) && is_array($field['renderers'])) {
+			foreach ($field['renderers'] as $renderer) {
+				$rendererNameAndConfiguration = $this->convertRendererToArray($renderer);
+				$renderers = array_merge($renderers, $rendererNameAndConfiguration);
+			}
+		}
+
+		return $renderers;
+	}
+
+	/**
+	 * @param string|GenericColumn $renderer
+	 * @return array
+	 */
+	public function convertRendererToArray($renderer)
+	{
+		$result = array();
+		if (is_string($renderer)) {
+			$result[$renderer] = array();
+		} elseif ($renderer instanceof ColumnInterface || $renderer instanceof ColumnRendererInterface) {
+			/** @var GenericColumn $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)
+	{
+		$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)
+	{
+		$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()
+	{
+		return $this->tca;
+	}
+
+	/**
+	 * Return excluded fields from configuration + preferences.
+	 *
+	 * @return array
+	 */
+	public function getExcludedFields()
+	{
+		$configurationFields = $this->getExcludedFieldsFromConfiguration();
+		$preferencesFields = $this->getExcludedFieldsFromPreferences();
+
+		return array_merge($configurationFields, $preferencesFields);
+	}
+
+	/**
+	 * Fetch excluded fields from configuration.
+	 *
+	 * @return array
+	 */
+	protected function getExcludedFieldsFromConfiguration()
+	{
+		$excludedFields = array();
+		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()
+	{
+		$excludedFields = $this->getModulePreferences()->get(ConfigurablePart::EXCLUDED_FIELDS, $this->tableName);
+		return is_array($excludedFields) ? $excludedFields : array();
+	}
+
+	/**
+	 * @return array
+	 */
+	public function areFilesIncludedInExport()
+	{
+		$isIncluded = TRUE;
+
+		if (isset($this->tca['export']['include_files'])) {
+			$isIncluded = $this->tca['export']['include_files'];
+		}
+		return $isIncluded;
+	}
+
+	/**
+	 * Returns a "facet" service instance.
+	 *
+	 * @param string|FacetInterface $facetName
+	 * @return StandardFacet
+	 */
+	protected function instantiateStandardFacet($facetName)
+	{
+		$label = $this->getLabel($facetName);
+
+		/** @var StandardFacet $facetName */
+		$facet = GeneralUtility::makeInstance('Fab\Vidi\Facet\StandardFacet', $facetName, $label);
+
+		if (!$facet instanceof StandardFacet) {
+			throw new \RuntimeException('I could not instantiate a facet for facet name "' . (string)$facet . '""', 1445856345);
+		}
+		return $facet;
+	}
+
+	/**
+	 * Returns a "facet" service instance.
+	 *
+	 * @param string|FacetInterface $facetName
+	 * @return FacetInterface
+	 */
+	public function facet($facetName = '')
+	{
+		$facets = $this->getFacets();
+		return $facets[$facetName];
+	}
+
+	/**
+	 * @return \Fab\Vidi\Resolver\FieldPathResolver
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Resolver\FieldPathResolver');
+	}
+
+	/**
+	 * @return ModulePreferences
+	 */
+	protected function getModulePreferences()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Module\ModulePreferences');
+	}
 
 }

Classes/Tca/TableService.php

Doc Comments +6 added lines, -6 removed lines

@@ -64,7 +64,7 @@ 
      * Tell whether the table has a label field.
      *
      * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string
+     * @return boolean
      */
     public function hasLabelField()
     {
@@ -302,7 +302,7 @@ 
     /**
      * Tell whether we have a field "sorting".
      *
-     * @return array
+     * @return boolean
      */
     public function hasSortableField()
     {
@@ -313,7 +313,7 @@ 
      * Tell whether the field exists or not.
      *
      * @param string $fieldName
-     * @return array
+     * @return boolean
      */
     public function hasField($fieldName)
     {
@@ -349,7 +349,7 @@ 
      * Tells whether the $key exists.
      *
      * @param string $key
-     * @return string
+     * @return boolean
      */
     public function has($key)
     {
@@ -359,7 +359,7 @@ 
     /**
      * Tells whether the table name has "workspace" support.
      *
-     * @return string
+     * @return boolean
      */
     public function hasWorkspaceSupport()
     {
@@ -369,7 +369,7 @@ 
     /**
      * Tells whether the table name has "language" support.
      *
-     * @return string
+     * @return boolean
      */
     public function hasLanguageSupport()
     {

Indentation +434 added lines, -434 removed lines

@@ -25,439 +25,439 @@
 class TableService extends AbstractTca
 {
 
-    /**
-     * @var array
-     */
-    protected $tca;
-
-    /**
-     * @var array
-     */
-    protected $columnTca;
-
-    /**
-     * @var string
-     */
-    protected $tableName;
-
-    /**
-     * @var array
-     */
-    protected $instances;
-
-    /**
-     * @throws InvalidKeyInArrayException
-     * @param string $tableName
-     * @return \Fab\Vidi\Tca\TableService
-     */
-    public function __construct($tableName)
-    {
-        $this->tableName = $tableName;
-        if (empty($GLOBALS['TCA'][$this->tableName])) {
-            throw new InvalidKeyInArrayException(sprintf('No TCA existence for table "%s"', $this->tableName), 1356945106);
-        }
-        $this->tca = $GLOBALS['TCA'][$this->tableName]['ctrl'];
-        $this->columnTca = $GLOBALS['TCA'][$this->tableName]['columns'];
-    }
-
-    /**
-     * Tell whether the table has a label field.
-     *
-     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string
-     */
-    public function hasLabelField()
-    {
-        return $this->has('label');
-    }
-
-    /**
-     * Get the label name of table name.
-     *
-     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string
-     */
-    public function getLabelField()
-    {
-        $labelField = $this->get('label');
-        if (empty($labelField)) {
-            throw new InvalidKeyInArrayException(sprintf('No label configured for table "%s"', $this->tableName), 1385586726);
-        }
-        return $labelField;
-    }
-
-    /**
-     * Returns the translated label of the table name.
-     *
-     * @return string
-     */
-    public function getLabel()
-    {
-        $result = LocalizationUtility::translate($this->getLabelField(), '');
-        if (!$result) {
-            $result = $this->getLabelField();
-        }
-        return $result;
-    }
-
-    /**
-     * Returns the title of the table.
-     *
-     * @return string
-     */
-    public function getTitle()
-    {
-        $result = LocalizationUtility::translate($this->get('title'), '');
-        if (!$result) {
-            $result = $this->get('title');
-        }
-        return $result;
-    }
-
-    /**
-     * Return the "disabled" field.
-     *
-     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string|NULL
-     */
-    public function getHiddenField()
-    {
-        $hiddenField = NULL;
-        $enableColumns = $this->get('enablecolumns');
-        if (is_array($enableColumns) && !empty($enableColumns['disabled'])) {
-            $hiddenField = $enableColumns['disabled'];
-        }
-        return $hiddenField;
-    }
-
-    /**
-     * Return the "starttime" field.
-     *
-     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string|NULL
-     */
-    public function getStartTimeField()
-    {
-        $startTimeField = NULL;
-        $enableColumns = $this->get('enablecolumns');
-        if (is_array($enableColumns) && !empty($enableColumns['starttime'])) {
-            $startTimeField = $enableColumns['starttime'];
-        }
-        return $startTimeField;
-    }
-
-    /**
-     * Return the "endtime" field.
-     *
-     * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
-     * @return string|NULL
-     */
-    public function getEndTimeField()
-    {
-        $endTimeField = NULL;
-        $enableColumns = $this->get('enablecolumns');
-        if (is_array($enableColumns) && !empty($enableColumns['endtime'])) {
-            $endTimeField = $enableColumns['endtime'];
-        }
-        return $endTimeField;
-    }
-
-    /**
-     * Tells whether the table is hidden.
-     *
-     * @return bool
-     */
-    public function isHidden()
-    {
-        return isset($this->tca['hideTable']) ? $this->tca['hideTable'] : FALSE;
-    }
-
-    /**
-     * Tells whether the table is not hidden.
-     *
-     * @return bool
-     */
-    public function isNotHidden()
-    {
-        return !$this->isHidden();
-    }
-
-    /**
-     * Get the "deleted" field for the table.
-     *
-     * @return string|NULL
-     */
-    public function getDeletedField()
-    {
-        return $this->get('delete');
-    }
-
-    /**
-     * Get the modification time stamp field.
-     *
-     * @return string|NULL
-     */
-    public function getTimeModificationField()
-    {
-        return $this->get('tstamp');
-    }
-
-    /**
-     * Get the creation time stamp field.
-     *
-     * @return string|NULL
-     */
-    public function getTimeCreationField()
-    {
-        return $this->get('crdate');
-    }
-
-    /**
-     * Get the language field for the table.
-     *
-     * @return string|NULL
-     */
-    public function getLanguageField()
-    {
-        return $this->get('languageField');
-    }
-
-    /**
-     * Get the field which points to the parent.
-     *
-     * @return string|NULL
-     */
-    public function getLanguageParentField()
-    {
-        return $this->get('transOrigPointerField');
-    }
-
-    /**
-     * Returns the default order in the form of a SQL segment.
-     *
-     * @return string|NULL
-     */
-    public function getDefaultOrderSql()
-    {
-        // "sortby" typically has "sorting" as value.
-        $order = $this->get('sortby') ? $this->get('sortby') . ' ASC' : $this->get('default_sortby');
-        return $order;
-    }
-
-    /**
-     * Returns the parsed default orderings.
-     * Returns array looks like array('title' => 'ASC');
-     *
-     * @return array
-     */
-    public function getDefaultOrderings()
-    {
-
-        // first clean up the sql segment
-        $defaultOrder = str_replace('ORDER BY', '', $this->getDefaultOrderSql());
-        $defaultOrderParts = GeneralUtility::trimExplode(',', $defaultOrder, TRUE);
-
-        $orderings = array();
-        foreach ($defaultOrderParts as $defaultOrderPart) {
-            $parts = GeneralUtility::trimExplode(' ', $defaultOrderPart);
-            if (empty($parts[1])) {
-                $parts[1] = QueryInterface::ORDER_DESCENDING;
-            }
-            $orderings[$parts[0]] = $parts[1];
-        }
-
-        return $orderings;
-    }
-
-    /**
-     * Returns the searchable fields.
-     *
-     * @return string|NULL
-     */
-    public function getSearchFields()
-    {
-        return $this->get('searchFields');
-    }
-
-    /**
-     * Returns an array containing the field names.
-     *
-     * @return array
-     */
-    public function getFields()
-    {
-        return array_keys($this->columnTca);
-    }
-
-    /**
-     * Returns an array containing the fields and their configuration.
-     *
-     * @return array
-     */
-    public function getFieldsAndConfiguration()
-    {
-        return $this->columnTca;
-    }
-
-    /**
-     * Tell whether we have a field "sorting".
-     *
-     * @return array
-     */
-    public function hasSortableField()
-    {
-        return $this->has('sortby');
-    }
-
-    /**
-     * Tell whether the field exists or not.
-     *
-     * @param string $fieldName
-     * @return array
-     */
-    public function hasField($fieldName)
-    {
-        if ($this->isComposite($fieldName)) {
-            $parts = explode('.', $fieldName);
-            $strippedFieldName = $parts[0];
-            $tableName = $parts[1];
-
-            $hasField = $this->columnTca[$strippedFieldName] && isset($GLOBALS['TCA'][$tableName]);
-
-            // Continue checking that the $strippedFieldName is of type "group"
-            if (isset($GLOBALS['TCA'][$this->tableName]['columns'][$strippedFieldName])) {
-                $hasField = Tca::table($this->tableName)->field($strippedFieldName)->isGroup(); // Group
-            }
-        } else {
-            $hasField = isset($this->columnTca[$fieldName]) || in_array($fieldName, Tca::getSystemFields());
-        }
-        return $hasField;
-    }
-
-    /**
-     * Tell whether the field name contains a path, e.g. metadata.title
-     *
-     * @param string $fieldName
-     * @return boolean
-     */
-    public function isComposite($fieldName)
-    {
-        return strpos($fieldName, '.') > 0;
-    }
-
-    /**
-     * Tells whether the $key exists.
-     *
-     * @param string $key
-     * @return string
-     */
-    public function has($key)
-    {
-        return isset($this->tca[$key]);
-    }
-
-    /**
-     * Tells whether the table name has "workspace" support.
-     *
-     * @return string
-     */
-    public function hasWorkspaceSupport()
-    {
-        return isset($this->tca['versioningWS']);
-    }
-
-    /**
-     * Tells whether the table name has "language" support.
-     *
-     * @return string
-     */
-    public function hasLanguageSupport()
-    {
-        return isset($this->tca['languageField']);
-    }
-
-    /**
-     * Return configuration value given a key.
-     *
-     * @param string $key
-     * @return string|NULL
-     */
-    public function get($key)
-    {
-        return $this->has($key) ? $this->tca[$key] : NULL;
-    }
-
-    /**
-     * @return array
-     */
-    public function getTca()
-    {
-        return $this->tca;
-    }
-
-    /**
-     * Tell whether the current BE User has access to this field.
-     *
-     * @return bool
-     */
-    public function hasAccess()
-    {
-        $hasAccess = TRUE;
-        if ($this->isBackendMode()) {
-            $hasAccess = $this->getBackendUser()->check('tables_modify', $this->tableName);
-        }
-        return $hasAccess;
-    }
-
-    /**
-     * @param string $fieldName
-     * @throws \Exception
-     * @return \Fab\Vidi\Tca\FieldService
-     */
-    public function field($fieldName)
-    {
-
-        // In case field contains items.tx_table for field type "group"
-        $compositeField = '';
-        if (strpos($fieldName, '.') !== FALSE) {
-            $compositeField = $fieldName;
-            $fieldParts = explode('.', $compositeField, 2);
-            $fieldName = $fieldParts[0];
-
-            // Special when field has been instantiated without the field name and path.
-            if (!empty($this->instances[$fieldName])) {
-                /** @var FieldService $field */
-                $field = $this->instances[$fieldName];
-                $field->setCompositeField($compositeField);
-            }
-        }
-
-        // True for system fields such as uid, pid that don't necessarily have a TCA.
-        if (empty($this->columnTca[$fieldName]) && in_array($fieldName, Tca::getSystemFields())) {
-            $this->columnTca[$fieldName] = array();
-        } elseif (empty($this->columnTca[$fieldName])) {
-            $message = sprintf(
-                'Does the field really exist? No TCA entry found for field "%s" for table "%s"',
-                $fieldName,
-                $this->tableName
-            );
-            throw new \Exception($message, 1385554481);
-        }
-
-
-        if (empty($this->instances[$fieldName])) {
-
-            $instance = GeneralUtility::makeInstance(
-                'Fab\Vidi\Tca\FieldService',
-                $fieldName,
-                $this->columnTca[$fieldName],
-                $this->tableName,
-                $compositeField
-            );
-
-            $this->instances[$fieldName] = $instance;
-        }
-        return $this->instances[$fieldName];
-    }
+	/**
+	 * @var array
+	 */
+	protected $tca;
+
+	/**
+	 * @var array
+	 */
+	protected $columnTca;
+
+	/**
+	 * @var string
+	 */
+	protected $tableName;
+
+	/**
+	 * @var array
+	 */
+	protected $instances;
+
+	/**
+	 * @throws InvalidKeyInArrayException
+	 * @param string $tableName
+	 * @return \Fab\Vidi\Tca\TableService
+	 */
+	public function __construct($tableName)
+	{
+		$this->tableName = $tableName;
+		if (empty($GLOBALS['TCA'][$this->tableName])) {
+			throw new InvalidKeyInArrayException(sprintf('No TCA existence for table "%s"', $this->tableName), 1356945106);
+		}
+		$this->tca = $GLOBALS['TCA'][$this->tableName]['ctrl'];
+		$this->columnTca = $GLOBALS['TCA'][$this->tableName]['columns'];
+	}
+
+	/**
+	 * Tell whether the table has a label field.
+	 *
+	 * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
+	 * @return string
+	 */
+	public function hasLabelField()
+	{
+		return $this->has('label');
+	}
+
+	/**
+	 * Get the label name of table name.
+	 *
+	 * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
+	 * @return string
+	 */
+	public function getLabelField()
+	{
+		$labelField = $this->get('label');
+		if (empty($labelField)) {
+			throw new InvalidKeyInArrayException(sprintf('No label configured for table "%s"', $this->tableName), 1385586726);
+		}
+		return $labelField;
+	}
+
+	/**
+	 * Returns the translated label of the table name.
+	 *
+	 * @return string
+	 */
+	public function getLabel()
+	{
+		$result = LocalizationUtility::translate($this->getLabelField(), '');
+		if (!$result) {
+			$result = $this->getLabelField();
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns the title of the table.
+	 *
+	 * @return string
+	 */
+	public function getTitle()
+	{
+		$result = LocalizationUtility::translate($this->get('title'), '');
+		if (!$result) {
+			$result = $this->get('title');
+		}
+		return $result;
+	}
+
+	/**
+	 * Return the "disabled" field.
+	 *
+	 * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
+	 * @return string|NULL
+	 */
+	public function getHiddenField()
+	{
+		$hiddenField = NULL;
+		$enableColumns = $this->get('enablecolumns');
+		if (is_array($enableColumns) && !empty($enableColumns['disabled'])) {
+			$hiddenField = $enableColumns['disabled'];
+		}
+		return $hiddenField;
+	}
+
+	/**
+	 * Return the "starttime" field.
+	 *
+	 * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
+	 * @return string|NULL
+	 */
+	public function getStartTimeField()
+	{
+		$startTimeField = NULL;
+		$enableColumns = $this->get('enablecolumns');
+		if (is_array($enableColumns) && !empty($enableColumns['starttime'])) {
+			$startTimeField = $enableColumns['starttime'];
+		}
+		return $startTimeField;
+	}
+
+	/**
+	 * Return the "endtime" field.
+	 *
+	 * @throws \Fab\Vidi\Exception\InvalidKeyInArrayException
+	 * @return string|NULL
+	 */
+	public function getEndTimeField()
+	{
+		$endTimeField = NULL;
+		$enableColumns = $this->get('enablecolumns');
+		if (is_array($enableColumns) && !empty($enableColumns['endtime'])) {
+			$endTimeField = $enableColumns['endtime'];
+		}
+		return $endTimeField;
+	}
+
+	/**
+	 * Tells whether the table is hidden.
+	 *
+	 * @return bool
+	 */
+	public function isHidden()
+	{
+		return isset($this->tca['hideTable']) ? $this->tca['hideTable'] : FALSE;
+	}
+
+	/**
+	 * Tells whether the table is not hidden.
+	 *
+	 * @return bool
+	 */
+	public function isNotHidden()
+	{
+		return !$this->isHidden();
+	}
+
+	/**
+	 * Get the "deleted" field for the table.
+	 *
+	 * @return string|NULL
+	 */
+	public function getDeletedField()
+	{
+		return $this->get('delete');
+	}
+
+	/**
+	 * Get the modification time stamp field.
+	 *
+	 * @return string|NULL
+	 */
+	public function getTimeModificationField()
+	{
+		return $this->get('tstamp');
+	}
+
+	/**
+	 * Get the creation time stamp field.
+	 *
+	 * @return string|NULL
+	 */
+	public function getTimeCreationField()
+	{
+		return $this->get('crdate');
+	}
+
+	/**
+	 * Get the language field for the table.
+	 *
+	 * @return string|NULL
+	 */
+	public function getLanguageField()
+	{
+		return $this->get('languageField');
+	}
+
+	/**
+	 * Get the field which points to the parent.
+	 *
+	 * @return string|NULL
+	 */
+	public function getLanguageParentField()
+	{
+		return $this->get('transOrigPointerField');
+	}
+
+	/**
+	 * Returns the default order in the form of a SQL segment.
+	 *
+	 * @return string|NULL
+	 */
+	public function getDefaultOrderSql()
+	{
+		// "sortby" typically has "sorting" as value.
+		$order = $this->get('sortby') ? $this->get('sortby') . ' ASC' : $this->get('default_sortby');
+		return $order;
+	}
+
+	/**
+	 * Returns the parsed default orderings.
+	 * Returns array looks like array('title' => 'ASC');
+	 *
+	 * @return array
+	 */
+	public function getDefaultOrderings()
+	{
+
+		// first clean up the sql segment
+		$defaultOrder = str_replace('ORDER BY', '', $this->getDefaultOrderSql());
+		$defaultOrderParts = GeneralUtility::trimExplode(',', $defaultOrder, TRUE);
+
+		$orderings = array();
+		foreach ($defaultOrderParts as $defaultOrderPart) {
+			$parts = GeneralUtility::trimExplode(' ', $defaultOrderPart);
+			if (empty($parts[1])) {
+				$parts[1] = QueryInterface::ORDER_DESCENDING;
+			}
+			$orderings[$parts[0]] = $parts[1];
+		}
+
+		return $orderings;
+	}
+
+	/**
+	 * Returns the searchable fields.
+	 *
+	 * @return string|NULL
+	 */
+	public function getSearchFields()
+	{
+		return $this->get('searchFields');
+	}
+
+	/**
+	 * Returns an array containing the field names.
+	 *
+	 * @return array
+	 */
+	public function getFields()
+	{
+		return array_keys($this->columnTca);
+	}
+
+	/**
+	 * Returns an array containing the fields and their configuration.
+	 *
+	 * @return array
+	 */
+	public function getFieldsAndConfiguration()
+	{
+		return $this->columnTca;
+	}
+
+	/**
+	 * Tell whether we have a field "sorting".
+	 *
+	 * @return array
+	 */
+	public function hasSortableField()
+	{
+		return $this->has('sortby');
+	}
+
+	/**
+	 * Tell whether the field exists or not.
+	 *
+	 * @param string $fieldName
+	 * @return array
+	 */
+	public function hasField($fieldName)
+	{
+		if ($this->isComposite($fieldName)) {
+			$parts = explode('.', $fieldName);
+			$strippedFieldName = $parts[0];
+			$tableName = $parts[1];
+
+			$hasField = $this->columnTca[$strippedFieldName] && isset($GLOBALS['TCA'][$tableName]);
+
+			// Continue checking that the $strippedFieldName is of type "group"
+			if (isset($GLOBALS['TCA'][$this->tableName]['columns'][$strippedFieldName])) {
+				$hasField = Tca::table($this->tableName)->field($strippedFieldName)->isGroup(); // Group
+			}
+		} else {
+			$hasField = isset($this->columnTca[$fieldName]) || in_array($fieldName, Tca::getSystemFields());
+		}
+		return $hasField;
+	}
+
+	/**
+	 * Tell whether the field name contains a path, e.g. metadata.title
+	 *
+	 * @param string $fieldName
+	 * @return boolean
+	 */
+	public function isComposite($fieldName)
+	{
+		return strpos($fieldName, '.') > 0;
+	}
+
+	/**
+	 * Tells whether the $key exists.
+	 *
+	 * @param string $key
+	 * @return string
+	 */
+	public function has($key)
+	{
+		return isset($this->tca[$key]);
+	}
+
+	/**
+	 * Tells whether the table name has "workspace" support.
+	 *
+	 * @return string
+	 */
+	public function hasWorkspaceSupport()
+	{
+		return isset($this->tca['versioningWS']);
+	}
+
+	/**
+	 * Tells whether the table name has "language" support.
+	 *
+	 * @return string
+	 */
+	public function hasLanguageSupport()
+	{
+		return isset($this->tca['languageField']);
+	}
+
+	/**
+	 * Return configuration value given a key.
+	 *
+	 * @param string $key
+	 * @return string|NULL
+	 */
+	public function get($key)
+	{
+		return $this->has($key) ? $this->tca[$key] : NULL;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getTca()
+	{
+		return $this->tca;
+	}
+
+	/**
+	 * Tell whether the current BE User has access to this field.
+	 *
+	 * @return bool
+	 */
+	public function hasAccess()
+	{
+		$hasAccess = TRUE;
+		if ($this->isBackendMode()) {
+			$hasAccess = $this->getBackendUser()->check('tables_modify', $this->tableName);
+		}
+		return $hasAccess;
+	}
+
+	/**
+	 * @param string $fieldName
+	 * @throws \Exception
+	 * @return \Fab\Vidi\Tca\FieldService
+	 */
+	public function field($fieldName)
+	{
+
+		// In case field contains items.tx_table for field type "group"
+		$compositeField = '';
+		if (strpos($fieldName, '.') !== FALSE) {
+			$compositeField = $fieldName;
+			$fieldParts = explode('.', $compositeField, 2);
+			$fieldName = $fieldParts[0];
+
+			// Special when field has been instantiated without the field name and path.
+			if (!empty($this->instances[$fieldName])) {
+				/** @var FieldService $field */
+				$field = $this->instances[$fieldName];
+				$field->setCompositeField($compositeField);
+			}
+		}
+
+		// True for system fields such as uid, pid that don't necessarily have a TCA.
+		if (empty($this->columnTca[$fieldName]) && in_array($fieldName, Tca::getSystemFields())) {
+			$this->columnTca[$fieldName] = array();
+		} elseif (empty($this->columnTca[$fieldName])) {
+			$message = sprintf(
+				'Does the field really exist? No TCA entry found for field "%s" for table "%s"',
+				$fieldName,
+				$this->tableName
+			);
+			throw new \Exception($message, 1385554481);
+		}
+
+
+		if (empty($this->instances[$fieldName])) {
+
+			$instance = GeneralUtility::makeInstance(
+				'Fab\Vidi\Tca\FieldService',
+				$fieldName,
+				$this->columnTca[$fieldName],
+				$this->tableName,
+				$compositeField
+			);
+
+			$this->instances[$fieldName] = $instance;
+		}
+		return $this->instances[$fieldName];
+	}
 
 }

Classes/View/Grid/Row.php

Doc Comments +1 added lines, -1 removed lines

@@ -136,7 +136,7 @@
      * Flatten the localized structure to render the final value
      *
      * @param array $localizedStructure
-     * @return array
+     * @return string
      */
     protected function flattenStructure(array $localizedStructure)
     {

Indentation +617 added lines, -617 removed lines

@@ -29,622 +29,622 @@
 class Row extends AbstractComponentView
 {
 
-    /**
-     * @var array
-     */
-    protected $columns = array();
-
-    /**
-     * Registry for storing variable values and speed up the processing.
-     *
-     * @var array
-     */
-    protected $variables = array();
-
-    /**
-     * @param array $columns
-     */
-    public function __construct($columns = array())
-    {
-        $this->columns = $columns;
-    }
-
-    /**
-     * Render a row to be displayed in the Grid given an Content Object.
-     *
-     * @param \Fab\Vidi\Domain\Model\Content $object
-     * @param int $rowIndex
-     * @return array
-     */
-    public function render(Content $object = NULL, $rowIndex = 0)
-    {
-
-        // Initialize returned array
-        $output = array();
-
-        foreach (Tca::grid()->getFields() as $fieldNameAndPath => $configuration) {
-
-            $value = ''; // default is empty at first.
-
-            $this->computeVariables($object, $fieldNameAndPath);
-
-            // Only compute the value if it is going to be shown in the Grid. Lost time otherwise!
-            if (in_array($fieldNameAndPath, $this->columns)) {
-
-                // Fetch value
-                if (Tca::grid()->hasRenderers($fieldNameAndPath)) {
-
-                    $value = '';
-                    $renderers = Tca::grid()->getRenderers($fieldNameAndPath);
-
-                    // if is relation has one
-                    foreach ($renderers as $rendererClassName => $rendererConfiguration) {
-
-                        // @todo when removing ColumnInterface in v2.0 + 2 version, GeneralUtility::makeInstance is not always necessary as it could be an object already
-                        /** @var $rendererObject \Fab\Vidi\Grid\ColumnRendererInterface */
-                        $rendererObject = GeneralUtility::makeInstance($rendererClassName);
-                        $value .= $rendererObject
-                            ->setObject($object)
-                            ->setFieldName($fieldNameAndPath)
-                            ->setRowIndex($rowIndex)
-                            ->setFieldConfiguration($configuration)
-                            ->setGridRendererConfiguration($rendererConfiguration)
-                            ->render();
-                    }
-                } else {
-                    $value = $this->resolveValue($object, $fieldNameAndPath);
-                    $value = $this->processValue($value, $object, $fieldNameAndPath); // post resolve processing.
-                }
-
-                // Possible formatting given by configuration. @see TCA['grid']
-                $value = $this->formatValue($value, $configuration);
-
-                // Here, there is the chance to further "decorate" the value for inline editing, localization, ...
-                if ($this->willBeEnriched()) {
-
-                    $localizedStructure = $this->initializeLocalizedStructure($value);
-
-                    if ($this->isEditable()) {
-                        $localizedStructure = $this->addEditableMarkup($localizedStructure);
-                    }
-
-                    if ($this->isLocalized()) {
-                        $localizedStructure = $this->addLocalizationMarkup($localizedStructure);
-                    }
-
-                    if ($this->hasIcon()) {
-                        $localizedStructure = $this->addSpriteIconMarkup($localizedStructure);
-                    }
-
-                    $value = $this->flattenStructure($localizedStructure);
-                }
-
-                // Final wrap given by configuration. @see TCA['grid']
-                $value = $this->wrapValue($value, $configuration);
-            }
-
-            $output[$this->getFieldName()] = $value;
-        }
-
-        $output['DT_RowId'] = 'row-' . $object->getUid();
-        $output['DT_RowClass'] = sprintf('%s_%s', $object->getDataType(), $object->getUid());
-
-        return $output;
-    }
-
-    /**
-     * Flatten the localized structure to render the final value
-     *
-     * @param array $localizedStructure
-     * @return array
-     */
-    protected function flattenStructure(array $localizedStructure)
-    {
-
-        // Flatten the structure.
-        $value = '';
-        foreach ($localizedStructure as $structure) {
-            $value .= sprintf('<div class="%s">%s</div>',
-                $structure['status'] !== LocalizationStatus::LOCALIZED ? 'invisible' : '',
-                $structure['value']
-            );
-        }
-        return $value;
-    }
-
-    /**
-     * Store some often used variable values and speed up the processing.
-     *
-     * @param \Fab\Vidi\Domain\Model\Content $object
-     * @param string $fieldNameAndPath
-     * @return array
-     */
-    protected function computeVariables(Content $object, $fieldNameAndPath)
-    {
-        $this->variables = array();
-        $this->variables['dataType'] = $this->getFieldPathResolver()->getDataType($fieldNameAndPath);
-        $this->variables['fieldName'] = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
-        $this->variables['fieldNameAndPath'] = $fieldNameAndPath;
-        $this->variables['object'] = $object;
-    }
-
-    /**
-     * Tell whether the object will be decorated / wrapped such as
-     *
-     * @param string $value
-     * @return array
-     */
-    protected function initializeLocalizedStructure($value)
-    {
-
-        $localizedStructure[] = array(
-            'value' => empty($value) && $this->isEditable() ? $this->getEmptyValuePlaceholder() : $value,
-            'status' => empty($value) ? LocalizationStatus::EMPTY_VALUE : LocalizationStatus::LOCALIZED,
-            'language' => 0,
-            'languageFlag' => $defaultLanguage = $this->getLanguageService()->getDefaultFlag(),
-        );
-
-        if ($this->isLocalized()) {
-
-            foreach ($this->getLanguageService()->getLanguages() as $language) {
-
-                // Make sure the language is allowed for the current Backend User.
-                if ($this->isLanguageAllowedForBackendUser($language)) {
-
-                    $resolvedObject = $this->getResolvedObject();
-                    $fieldName = $this->getFieldName();
-
-                    if ($this->getLanguageService()->hasLocalization($resolvedObject, $language['uid'])) {
-                        $localizedValue = $this->getLanguageService()->getLocalizedFieldName($resolvedObject, $language['uid'], $fieldName);
-                        $status = LocalizationStatus::LOCALIZED;
-
-                        // Replace blank value by something more meaningful for the End User.
-                        if (empty($localizedValue)) {
-                            $status = LocalizationStatus::EMPTY_VALUE;
-                            $localizedValue = $this->isEditable() ? $this->getEmptyValuePlaceholder() : '';
-                        }
-                    } else {
-                        $localizedValue = sprintf('<a href="%s" style="color: black">%s</a>',
-                            $this->getLocalizedUri($language['uid']),
-                            $this->getLabelService()->sL('LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:create_translation')
-                        );
-                        $status = LocalizationStatus::NOT_YET_LOCALIZED;
-                    }
-
-                    // Feed structure.
-                    $localizedStructure[] = array(
-                        'value' => $localizedValue,
-                        'status' => $status,
-                        'language' => (int)$language['uid'],
-                        'languageFlag' => $language['flag'],
-                    );
-                }
-            }
-        }
-
-        return $localizedStructure;
-    }
-
-    /**
-     * @param array $language
-     * @return bool
-     */
-    protected function isLanguageAllowedForBackendUser(array $language)
-    {
-        return $this->getBackendUser()->checkLanguageAccess($language['uid']);
-    }
-
-    /**
-     * Returns a placeholder when the value is empty.
-     *
-     * @return string
-     */
-    protected function getEmptyValuePlaceholder()
-    {
-        return sprintf('<i>%s</i>',
-            $this->getLabelService()->sL('LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:start_editing')
-        );
-    }
-
-    /**
-     * Tell whether the object will be decorated (or wrapped) for inline editing, localization purpose.
-     *
-     * @return bool
-     */
-    protected function willBeEnriched()
-    {
-
-        $willBeEnriched = FALSE;
-
-        if ($this->fieldExists()) {
-            $willBeEnriched = $this->isEditable() || $this->hasIcon() || $this->isLocalized();
-        }
-
-        return $willBeEnriched;
-    }
-
-    /**
-     * Tell whether the field in the context will be prepended by an icon.
-     *
-     * @return bool
-     */
-    protected function hasIcon()
-    {
-        $dataType = $this->getDataType();
-        return Tca::table($dataType)->getLabelField() === $this->getFieldName();
-    }
-
-    /**
-     * Tell whether the field in the context will be prepended by an icon.
-     *
-     * @return bool
-     */
-    protected function isLocalized()
-    {
-        $object = $this->getObject();
-        $fieldName = $this->getFieldName();
-        $dataType = $this->getDataType();
-        $fieldNameAndPath = $this->getFieldNameAndPath();
-
-        return $this->getLanguageService()->hasLanguages()
-        && Tca::grid($object)->isLocalized($fieldNameAndPath)
-        && Tca::table($dataType)->field($fieldName)->isLocalized();
-    }
-
-    /**
-     * Add some markup to have the content editable in the Grid.
-     *
-     * @param array $localizedStructure
-     * @return array
-     */
-    protected function addEditableMarkup(array $localizedStructure)
-    {
-
-        $dataType = $this->getDataType();
-        $fieldName = $this->getFieldName();
-
-        foreach ($localizedStructure as $index => $structure) {
-            if ($structure['status'] !== LocalizationStatus::NOT_YET_LOCALIZED) {
-                $localizedStructure[$index]['value'] = sprintf('<span class="%s" data-language="%s">%s</span>',
-                    Tca::table($dataType)->field($fieldName)->isTextArea() ? 'editable-textarea' : 'editable-textfield',
-                    $structure['language'],
-                    $structure['value']
-                );
-            }
-        }
-        return $localizedStructure;
-    }
-
-    /**
-     * Add some markup related to the localization.
-     *
-     * @param array $localizedStructure
-     * @return array
-     */
-    protected function addLocalizationMarkup(array $localizedStructure)
-    {
-
-        foreach ($localizedStructure as $index => $structure) {
-
-            $localizedStructure[$index]['value'] = sprintf('<span>%s %s</span>',
-                empty($structure['languageFlag']) ? '' : $this->getIconFactory()->getIcon('flags-' . $structure['languageFlag'], Icon::SIZE_SMALL),
-                $structure['value']
-            );
-        }
-        return $localizedStructure;
-    }
-
-    /**
-     * Add some markup related to the prepended icon.
-     *
-     * @param array $localizedStructure
-     * @return array
-     */
-    protected function addSpriteIconMarkup(array $localizedStructure)
-    {
-
-        $object = $this->getObject();
-
-        foreach ($localizedStructure as $index => $structure) {
-
-            $recordData = array();
-
-            $enablesMethods = array('Hidden', 'Deleted', 'StartTime', 'EndTime');
-            foreach ($enablesMethods as $enableMethod) {
-
-                $methodName = 'get' . $enableMethod . 'Field';
-
-                // Fetch possible hidden filed.
-                $enableField = Tca::table($object)->$methodName();
-                if ($enableField) {
-                    $recordData[$enableField] = $object[$enableField];
-                }
-            }
-
-            // Get Enable Fields of the object to render the sprite with overlays.
-            $localizedStructure[$index]['value'] = sprintf('%s %s',
-                $this->getIconFactory()->getIconForRecord($object->getDataType(), $recordData, Icon::SIZE_SMALL),
-                $structure['value']
-            );
-        }
-
-        return $localizedStructure;
-    }
-
-    /**
-     * Return whether the field given by the context is editable.
-     *
-     * @return boolean
-     */
-    protected function isEditable()
-    {
-        $fieldNameAndPath = $this->getFieldNameAndPath();
-        $dataType = $this->getDataType();
-        $fieldName = $this->getFieldName();
-
-        return Tca::grid()->isEditable($fieldNameAndPath)
-        && Tca::table($dataType)->hasField($fieldName)
-        && Tca::table($dataType)->field($fieldName)->hasNoRelation(); // relation are editable through Renderers only.
-    }
-
-    /**
-     * Return the appropriate URI to create the translation.
-     *
-     * @param int $language
-     * @return string
-     */
-    protected function getLocalizedUri($language)
-    {
-
-        // Transmit recursive selection parameter.
-        $parameterPrefix = $this->getModuleLoader()->getParameterPrefix();
-        $parameters = GeneralUtility::_GP($parameterPrefix);
-
-        $additionalParameters = array(
-            $this->getModuleLoader()->getParameterPrefix() => array(
-                'controller' => 'Content',
-                'action' => 'localize',
-                'format' => 'json',
-                'hasRecursiveSelection' => isset($parameters['hasRecursiveSelection']) ? (int)$parameters['hasRecursiveSelection'] : 0,
-                'fieldNameAndPath' => $this->getFieldNameAndPath(),
-                'language' => $language,
-                'matches' => array(
-                    'uid' => $this->getObject()->getUid(),
-                ),
-            ),
-        );
-
-        return $this->getModuleLoader()->getModuleUrl($additionalParameters);
-    }
-
-    /**
-     * Compute the value for the Content object according to a field name.
-     *
-     * @param \Fab\Vidi\Domain\Model\Content $object
-     * @param string $fieldNameAndPath
-     * @return string
-     */
-    protected function resolveValue(Content $object, $fieldNameAndPath)
-    {
-
-        // Get the first part of the field name and
-        $fieldName = $this->getFieldPathResolver()->stripFieldName($fieldNameAndPath);
-
-        $value = $object[$fieldName];
-
-        // Relation but contains no data.
-        if (is_array($value) && empty($value)) {
-            $value = '';
-        } elseif ($value instanceof Content) {
-
-            $fieldNameOfForeignTable = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
-
-            // TRUE means the field name does not contains a path. "title" vs "metadata.title"
-            // Fetch the default label
-            if ($fieldNameOfForeignTable === $fieldName) {
-                $foreignTable = Tca::table($object->getDataType())->field($fieldName)->getForeignTable();
-                $fieldNameOfForeignTable = Tca::table($foreignTable)->getLabelField();
-            }
-
-            $value = $object[$fieldName][$fieldNameOfForeignTable];
-        }
-
-        return $value;
-    }
-
-    /**
-     * Check whether a string contains HTML tags.
-     *
-     * @param string $string the content to be analyzed
-     * @return boolean
-     */
-    protected function hasHtml($string)
-    {
-        $result = FALSE;
-
-        // We compare the length of the string with html tags and without html tags.
-        if (strlen($string) != strlen(strip_tags($string))) {
-            $result = TRUE;
-        }
-        return $result;
-    }
-
-    /**
-     * Check whether a string contains potential XSS.
-     *
-     * @param string $string the content to be analyzed
-     * @return boolean
-     */
-    protected function isClean($string)
-    {
-
-        // @todo implement me!
-        $result = TRUE;
-        return $result;
-    }
-
-    /**
-     * Process the value
-     *
-     * @todo implement me as a processor chain to be cleaner implementation wise. Look out at the performance however!
-     *       e.g DefaultValueGridProcessor, TextAreaGridProcessor, ...
-     *
-     * @param string $value
-     * @param \Fab\Vidi\Domain\Model\Content $object
-     * @param string $fieldNameAndPath
-     * @return string
-     */
-    protected function processValue($value, Content $object, $fieldNameAndPath)
-    {
-
-        // Set default value if $field name correspond to the label of the table
-        $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
-        if (Tca::table($object->getDataType())->getLabelField() === $fieldName && empty($value)) {
-            $value = sprintf('[%s]', $this->getLabelService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title', 1));
-        }
-
-        // Sanitize the value in case of "select" or "radio button".
-        if (is_scalar($value)) {
-            $fieldType = Tca::table($object->getDataType())->field($fieldNameAndPath)->getType();
-            if ($fieldType !== FieldType::TEXTAREA) {
-                $value = htmlspecialchars($value);
-            } elseif ($fieldType === FieldType::TEXTAREA && !$this->isClean($value)) {
-                $value = htmlspecialchars($value); // Avoid bad surprise, converts characters to HTML.
-            } elseif ($fieldType === FieldType::TEXTAREA && !$this->hasHtml($value)) {
-                $value = nl2br($value);
-            }
-        }
-
-        return $value;
-    }
-
-    /**
-     * Possible value formatting.
-     *
-     * @param string $value
-     * @param array $configuration
-     * @return string
-     */
-    protected function formatValue($value, array $configuration)
-    {
-        if (empty($configuration['format'])) {
-            return $value;
-        }
-        $className = $configuration['format'];
-
-        /** @var \Fab\Vidi\Formatter\FormatterInterface $formatter */
-        $formatter = GeneralUtility::makeInstance($className);
-        $value = $formatter->format($value);
-
-        return $value;
-    }
-
-    /**
-     * Possible value wrapping.
-     *
-     * @param string $value
-     * @param array $configuration
-     * @return string
-     */
-    protected function wrapValue($value, array $configuration)
-    {
-        if (!empty($configuration['wrap'])) {
-            $parts = explode('|', $configuration['wrap']);
-            $value = implode($value, $parts);
-        }
-        return $value;
-    }
-
-    /**
-     * Tell whether the field in the context really exists.
-     *
-     * @return bool
-     */
-    protected function fieldExists()
-    {
-        if (is_null($this->variables['hasField'])) {
-            $dataType = $this->getDataType();
-            $fieldName = $this->getFieldName();
-            $this->variables['hasField'] = Tca::table($dataType)->hasField($fieldName);
-        }
-        return $this->variables['hasField'];
-    }
-
-    /**
-     * @return string
-     */
-    protected function getDataType()
-    {
-        return $this->variables['dataType'];
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldName()
-    {
-        return $this->variables['fieldName'];
-    }
-
-    /**
-     * @return string
-     */
-    protected function getFieldNameAndPath()
-    {
-        return $this->variables['fieldNameAndPath'];
-    }
-
-    /**
-     * @return Content
-     */
-    protected function getObject()
-    {
-        return $this->variables['object'];
-    }
-
-    /**
-     * @return Content
-     */
-    protected function getResolvedObject()
-    {
-        if (empty($this->variables['resolvedObject'])) {
-            $object = $this->getObject();
-            $fieldNameAndPath = $this->getFieldNameAndPath();
-            $this->variables['resolvedObject'] = $this->getContentObjectResolver()->getObject($object, $fieldNameAndPath);
-        }
-        return $this->variables['resolvedObject'];
-    }
-
-    /**
-     * @return \Fab\Vidi\Resolver\FieldPathResolver
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Resolver\FieldPathResolver');
-    }
-
-    /**
-     * @return \Fab\Vidi\Resolver\ContentObjectResolver
-     */
-    protected function getContentObjectResolver()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Resolver\ContentObjectResolver');
-    }
-
-    /**
-     * @return \TYPO3\CMS\Lang\LanguageService
-     */
-    protected function getLabelService()
-    {
-        return $GLOBALS['LANG'];
-    }
-
-    /**
-     * @return LanguageService
-     */
-    protected function getLanguageService()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Language\LanguageService');
-    }
+	/**
+	 * @var array
+	 */
+	protected $columns = array();
+
+	/**
+	 * Registry for storing variable values and speed up the processing.
+	 *
+	 * @var array
+	 */
+	protected $variables = array();
+
+	/**
+	 * @param array $columns
+	 */
+	public function __construct($columns = array())
+	{
+		$this->columns = $columns;
+	}
+
+	/**
+	 * Render a row to be displayed in the Grid given an Content Object.
+	 *
+	 * @param \Fab\Vidi\Domain\Model\Content $object
+	 * @param int $rowIndex
+	 * @return array
+	 */
+	public function render(Content $object = NULL, $rowIndex = 0)
+	{
+
+		// Initialize returned array
+		$output = array();
+
+		foreach (Tca::grid()->getFields() as $fieldNameAndPath => $configuration) {
+
+			$value = ''; // default is empty at first.
+
+			$this->computeVariables($object, $fieldNameAndPath);
+
+			// Only compute the value if it is going to be shown in the Grid. Lost time otherwise!
+			if (in_array($fieldNameAndPath, $this->columns)) {
+
+				// Fetch value
+				if (Tca::grid()->hasRenderers($fieldNameAndPath)) {
+
+					$value = '';
+					$renderers = Tca::grid()->getRenderers($fieldNameAndPath);
+
+					// if is relation has one
+					foreach ($renderers as $rendererClassName => $rendererConfiguration) {
+
+						// @todo when removing ColumnInterface in v2.0 + 2 version, GeneralUtility::makeInstance is not always necessary as it could be an object already
+						/** @var $rendererObject \Fab\Vidi\Grid\ColumnRendererInterface */
+						$rendererObject = GeneralUtility::makeInstance($rendererClassName);
+						$value .= $rendererObject
+							->setObject($object)
+							->setFieldName($fieldNameAndPath)
+							->setRowIndex($rowIndex)
+							->setFieldConfiguration($configuration)
+							->setGridRendererConfiguration($rendererConfiguration)
+							->render();
+					}
+				} else {
+					$value = $this->resolveValue($object, $fieldNameAndPath);
+					$value = $this->processValue($value, $object, $fieldNameAndPath); // post resolve processing.
+				}
+
+				// Possible formatting given by configuration. @see TCA['grid']
+				$value = $this->formatValue($value, $configuration);
+
+				// Here, there is the chance to further "decorate" the value for inline editing, localization, ...
+				if ($this->willBeEnriched()) {
+
+					$localizedStructure = $this->initializeLocalizedStructure($value);
+
+					if ($this->isEditable()) {
+						$localizedStructure = $this->addEditableMarkup($localizedStructure);
+					}
+
+					if ($this->isLocalized()) {
+						$localizedStructure = $this->addLocalizationMarkup($localizedStructure);
+					}
+
+					if ($this->hasIcon()) {
+						$localizedStructure = $this->addSpriteIconMarkup($localizedStructure);
+					}
+
+					$value = $this->flattenStructure($localizedStructure);
+				}
+
+				// Final wrap given by configuration. @see TCA['grid']
+				$value = $this->wrapValue($value, $configuration);
+			}
+
+			$output[$this->getFieldName()] = $value;
+		}
+
+		$output['DT_RowId'] = 'row-' . $object->getUid();
+		$output['DT_RowClass'] = sprintf('%s_%s', $object->getDataType(), $object->getUid());
+
+		return $output;
+	}
+
+	/**
+	 * Flatten the localized structure to render the final value
+	 *
+	 * @param array $localizedStructure
+	 * @return array
+	 */
+	protected function flattenStructure(array $localizedStructure)
+	{
+
+		// Flatten the structure.
+		$value = '';
+		foreach ($localizedStructure as $structure) {
+			$value .= sprintf('<div class="%s">%s</div>',
+				$structure['status'] !== LocalizationStatus::LOCALIZED ? 'invisible' : '',
+				$structure['value']
+			);
+		}
+		return $value;
+	}
+
+	/**
+	 * Store some often used variable values and speed up the processing.
+	 *
+	 * @param \Fab\Vidi\Domain\Model\Content $object
+	 * @param string $fieldNameAndPath
+	 * @return array
+	 */
+	protected function computeVariables(Content $object, $fieldNameAndPath)
+	{
+		$this->variables = array();
+		$this->variables['dataType'] = $this->getFieldPathResolver()->getDataType($fieldNameAndPath);
+		$this->variables['fieldName'] = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
+		$this->variables['fieldNameAndPath'] = $fieldNameAndPath;
+		$this->variables['object'] = $object;
+	}
+
+	/**
+	 * Tell whether the object will be decorated / wrapped such as
+	 *
+	 * @param string $value
+	 * @return array
+	 */
+	protected function initializeLocalizedStructure($value)
+	{
+
+		$localizedStructure[] = array(
+			'value' => empty($value) && $this->isEditable() ? $this->getEmptyValuePlaceholder() : $value,
+			'status' => empty($value) ? LocalizationStatus::EMPTY_VALUE : LocalizationStatus::LOCALIZED,
+			'language' => 0,
+			'languageFlag' => $defaultLanguage = $this->getLanguageService()->getDefaultFlag(),
+		);
+
+		if ($this->isLocalized()) {
+
+			foreach ($this->getLanguageService()->getLanguages() as $language) {
+
+				// Make sure the language is allowed for the current Backend User.
+				if ($this->isLanguageAllowedForBackendUser($language)) {
+
+					$resolvedObject = $this->getResolvedObject();
+					$fieldName = $this->getFieldName();
+
+					if ($this->getLanguageService()->hasLocalization($resolvedObject, $language['uid'])) {
+						$localizedValue = $this->getLanguageService()->getLocalizedFieldName($resolvedObject, $language['uid'], $fieldName);
+						$status = LocalizationStatus::LOCALIZED;
+
+						// Replace blank value by something more meaningful for the End User.
+						if (empty($localizedValue)) {
+							$status = LocalizationStatus::EMPTY_VALUE;
+							$localizedValue = $this->isEditable() ? $this->getEmptyValuePlaceholder() : '';
+						}
+					} else {
+						$localizedValue = sprintf('<a href="%s" style="color: black">%s</a>',
+							$this->getLocalizedUri($language['uid']),
+							$this->getLabelService()->sL('LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:create_translation')
+						);
+						$status = LocalizationStatus::NOT_YET_LOCALIZED;
+					}
+
+					// Feed structure.
+					$localizedStructure[] = array(
+						'value' => $localizedValue,
+						'status' => $status,
+						'language' => (int)$language['uid'],
+						'languageFlag' => $language['flag'],
+					);
+				}
+			}
+		}
+
+		return $localizedStructure;
+	}
+
+	/**
+	 * @param array $language
+	 * @return bool
+	 */
+	protected function isLanguageAllowedForBackendUser(array $language)
+	{
+		return $this->getBackendUser()->checkLanguageAccess($language['uid']);
+	}
+
+	/**
+	 * Returns a placeholder when the value is empty.
+	 *
+	 * @return string
+	 */
+	protected function getEmptyValuePlaceholder()
+	{
+		return sprintf('<i>%s</i>',
+			$this->getLabelService()->sL('LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:start_editing')
+		);
+	}
+
+	/**
+	 * Tell whether the object will be decorated (or wrapped) for inline editing, localization purpose.
+	 *
+	 * @return bool
+	 */
+	protected function willBeEnriched()
+	{
+
+		$willBeEnriched = FALSE;
+
+		if ($this->fieldExists()) {
+			$willBeEnriched = $this->isEditable() || $this->hasIcon() || $this->isLocalized();
+		}
+
+		return $willBeEnriched;
+	}
+
+	/**
+	 * Tell whether the field in the context will be prepended by an icon.
+	 *
+	 * @return bool
+	 */
+	protected function hasIcon()
+	{
+		$dataType = $this->getDataType();
+		return Tca::table($dataType)->getLabelField() === $this->getFieldName();
+	}
+
+	/**
+	 * Tell whether the field in the context will be prepended by an icon.
+	 *
+	 * @return bool
+	 */
+	protected function isLocalized()
+	{
+		$object = $this->getObject();
+		$fieldName = $this->getFieldName();
+		$dataType = $this->getDataType();
+		$fieldNameAndPath = $this->getFieldNameAndPath();
+
+		return $this->getLanguageService()->hasLanguages()
+		&& Tca::grid($object)->isLocalized($fieldNameAndPath)
+		&& Tca::table($dataType)->field($fieldName)->isLocalized();
+	}
+
+	/**
+	 * Add some markup to have the content editable in the Grid.
+	 *
+	 * @param array $localizedStructure
+	 * @return array
+	 */
+	protected function addEditableMarkup(array $localizedStructure)
+	{
+
+		$dataType = $this->getDataType();
+		$fieldName = $this->getFieldName();
+
+		foreach ($localizedStructure as $index => $structure) {
+			if ($structure['status'] !== LocalizationStatus::NOT_YET_LOCALIZED) {
+				$localizedStructure[$index]['value'] = sprintf('<span class="%s" data-language="%s">%s</span>',
+					Tca::table($dataType)->field($fieldName)->isTextArea() ? 'editable-textarea' : 'editable-textfield',
+					$structure['language'],
+					$structure['value']
+				);
+			}
+		}
+		return $localizedStructure;
+	}
+
+	/**
+	 * Add some markup related to the localization.
+	 *
+	 * @param array $localizedStructure
+	 * @return array
+	 */
+	protected function addLocalizationMarkup(array $localizedStructure)
+	{
+
+		foreach ($localizedStructure as $index => $structure) {
+
+			$localizedStructure[$index]['value'] = sprintf('<span>%s %s</span>',
+				empty($structure['languageFlag']) ? '' : $this->getIconFactory()->getIcon('flags-' . $structure['languageFlag'], Icon::SIZE_SMALL),
+				$structure['value']
+			);
+		}
+		return $localizedStructure;
+	}
+
+	/**
+	 * Add some markup related to the prepended icon.
+	 *
+	 * @param array $localizedStructure
+	 * @return array
+	 */
+	protected function addSpriteIconMarkup(array $localizedStructure)
+	{
+
+		$object = $this->getObject();
+
+		foreach ($localizedStructure as $index => $structure) {
+
+			$recordData = array();
+
+			$enablesMethods = array('Hidden', 'Deleted', 'StartTime', 'EndTime');
+			foreach ($enablesMethods as $enableMethod) {
+
+				$methodName = 'get' . $enableMethod . 'Field';
+
+				// Fetch possible hidden filed.
+				$enableField = Tca::table($object)->$methodName();
+				if ($enableField) {
+					$recordData[$enableField] = $object[$enableField];
+				}
+			}
+
+			// Get Enable Fields of the object to render the sprite with overlays.
+			$localizedStructure[$index]['value'] = sprintf('%s %s',
+				$this->getIconFactory()->getIconForRecord($object->getDataType(), $recordData, Icon::SIZE_SMALL),
+				$structure['value']
+			);
+		}
+
+		return $localizedStructure;
+	}
+
+	/**
+	 * Return whether the field given by the context is editable.
+	 *
+	 * @return boolean
+	 */
+	protected function isEditable()
+	{
+		$fieldNameAndPath = $this->getFieldNameAndPath();
+		$dataType = $this->getDataType();
+		$fieldName = $this->getFieldName();
+
+		return Tca::grid()->isEditable($fieldNameAndPath)
+		&& Tca::table($dataType)->hasField($fieldName)
+		&& Tca::table($dataType)->field($fieldName)->hasNoRelation(); // relation are editable through Renderers only.
+	}
+
+	/**
+	 * Return the appropriate URI to create the translation.
+	 *
+	 * @param int $language
+	 * @return string
+	 */
+	protected function getLocalizedUri($language)
+	{
+
+		// Transmit recursive selection parameter.
+		$parameterPrefix = $this->getModuleLoader()->getParameterPrefix();
+		$parameters = GeneralUtility::_GP($parameterPrefix);
+
+		$additionalParameters = array(
+			$this->getModuleLoader()->getParameterPrefix() => array(
+				'controller' => 'Content',
+				'action' => 'localize',
+				'format' => 'json',
+				'hasRecursiveSelection' => isset($parameters['hasRecursiveSelection']) ? (int)$parameters['hasRecursiveSelection'] : 0,
+				'fieldNameAndPath' => $this->getFieldNameAndPath(),
+				'language' => $language,
+				'matches' => array(
+					'uid' => $this->getObject()->getUid(),
+				),
+			),
+		);
+
+		return $this->getModuleLoader()->getModuleUrl($additionalParameters);
+	}
+
+	/**
+	 * Compute the value for the Content object according to a field name.
+	 *
+	 * @param \Fab\Vidi\Domain\Model\Content $object
+	 * @param string $fieldNameAndPath
+	 * @return string
+	 */
+	protected function resolveValue(Content $object, $fieldNameAndPath)
+	{
+
+		// Get the first part of the field name and
+		$fieldName = $this->getFieldPathResolver()->stripFieldName($fieldNameAndPath);
+
+		$value = $object[$fieldName];
+
+		// Relation but contains no data.
+		if (is_array($value) && empty($value)) {
+			$value = '';
+		} elseif ($value instanceof Content) {
+
+			$fieldNameOfForeignTable = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
+
+			// TRUE means the field name does not contains a path. "title" vs "metadata.title"
+			// Fetch the default label
+			if ($fieldNameOfForeignTable === $fieldName) {
+				$foreignTable = Tca::table($object->getDataType())->field($fieldName)->getForeignTable();
+				$fieldNameOfForeignTable = Tca::table($foreignTable)->getLabelField();
+			}
+
+			$value = $object[$fieldName][$fieldNameOfForeignTable];
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Check whether a string contains HTML tags.
+	 *
+	 * @param string $string the content to be analyzed
+	 * @return boolean
+	 */
+	protected function hasHtml($string)
+	{
+		$result = FALSE;
+
+		// We compare the length of the string with html tags and without html tags.
+		if (strlen($string) != strlen(strip_tags($string))) {
+			$result = TRUE;
+		}
+		return $result;
+	}
+
+	/**
+	 * Check whether a string contains potential XSS.
+	 *
+	 * @param string $string the content to be analyzed
+	 * @return boolean
+	 */
+	protected function isClean($string)
+	{
+
+		// @todo implement me!
+		$result = TRUE;
+		return $result;
+	}
+
+	/**
+	 * Process the value
+	 *
+	 * @todo implement me as a processor chain to be cleaner implementation wise. Look out at the performance however!
+	 *       e.g DefaultValueGridProcessor, TextAreaGridProcessor, ...
+	 *
+	 * @param string $value
+	 * @param \Fab\Vidi\Domain\Model\Content $object
+	 * @param string $fieldNameAndPath
+	 * @return string
+	 */
+	protected function processValue($value, Content $object, $fieldNameAndPath)
+	{
+
+		// Set default value if $field name correspond to the label of the table
+		$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
+		if (Tca::table($object->getDataType())->getLabelField() === $fieldName && empty($value)) {
+			$value = sprintf('[%s]', $this->getLabelService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title', 1));
+		}
+
+		// Sanitize the value in case of "select" or "radio button".
+		if (is_scalar($value)) {
+			$fieldType = Tca::table($object->getDataType())->field($fieldNameAndPath)->getType();
+			if ($fieldType !== FieldType::TEXTAREA) {
+				$value = htmlspecialchars($value);
+			} elseif ($fieldType === FieldType::TEXTAREA && !$this->isClean($value)) {
+				$value = htmlspecialchars($value); // Avoid bad surprise, converts characters to HTML.
+			} elseif ($fieldType === FieldType::TEXTAREA && !$this->hasHtml($value)) {
+				$value = nl2br($value);
+			}
+		}
+
+		return $value;
+	}
+
+	/**
+	 * Possible value formatting.
+	 *
+	 * @param string $value
+	 * @param array $configuration
+	 * @return string
+	 */
+	protected function formatValue($value, array $configuration)
+	{
+		if (empty($configuration['format'])) {
+			return $value;
+		}
+		$className = $configuration['format'];
+
+		/** @var \Fab\Vidi\Formatter\FormatterInterface $formatter */
+		$formatter = GeneralUtility::makeInstance($className);
+		$value = $formatter->format($value);
+
+		return $value;
+	}
+
+	/**
+	 * Possible value wrapping.
+	 *
+	 * @param string $value
+	 * @param array $configuration
+	 * @return string
+	 */
+	protected function wrapValue($value, array $configuration)
+	{
+		if (!empty($configuration['wrap'])) {
+			$parts = explode('|', $configuration['wrap']);
+			$value = implode($value, $parts);
+		}
+		return $value;
+	}
+
+	/**
+	 * Tell whether the field in the context really exists.
+	 *
+	 * @return bool
+	 */
+	protected function fieldExists()
+	{
+		if (is_null($this->variables['hasField'])) {
+			$dataType = $this->getDataType();
+			$fieldName = $this->getFieldName();
+			$this->variables['hasField'] = Tca::table($dataType)->hasField($fieldName);
+		}
+		return $this->variables['hasField'];
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getDataType()
+	{
+		return $this->variables['dataType'];
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldName()
+	{
+		return $this->variables['fieldName'];
+	}
+
+	/**
+	 * @return string
+	 */
+	protected function getFieldNameAndPath()
+	{
+		return $this->variables['fieldNameAndPath'];
+	}
+
+	/**
+	 * @return Content
+	 */
+	protected function getObject()
+	{
+		return $this->variables['object'];
+	}
+
+	/**
+	 * @return Content
+	 */
+	protected function getResolvedObject()
+	{
+		if (empty($this->variables['resolvedObject'])) {
+			$object = $this->getObject();
+			$fieldNameAndPath = $this->getFieldNameAndPath();
+			$this->variables['resolvedObject'] = $this->getContentObjectResolver()->getObject($object, $fieldNameAndPath);
+		}
+		return $this->variables['resolvedObject'];
+	}
+
+	/**
+	 * @return \Fab\Vidi\Resolver\FieldPathResolver
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Resolver\FieldPathResolver');
+	}
+
+	/**
+	 * @return \Fab\Vidi\Resolver\ContentObjectResolver
+	 */
+	protected function getContentObjectResolver()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Resolver\ContentObjectResolver');
+	}
+
+	/**
+	 * @return \TYPO3\CMS\Lang\LanguageService
+	 */
+	protected function getLabelService()
+	{
+		return $GLOBALS['LANG'];
+	}
+
+	/**
+	 * @return LanguageService
+	 */
+	protected function getLanguageService()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Language\LanguageService');
+	}
 
 }

Classes/Persistence/PagerObjectFactory.php

Indentation +37 added lines, -37 removed lines

@@ -23,48 +23,48 @@
 class PagerObjectFactory implements SingletonInterface
 {
 
-    /**
-     * Gets a singleton instance of this class.
-     *
-     * @return \Fab\Vidi\Persistence\PagerObjectFactory
-     */
-    static public function getInstance()
-    {
-        return GeneralUtility::makeInstance('Fab\Vidi\Persistence\PagerObjectFactory');
-    }
+	/**
+	 * Gets a singleton instance of this class.
+	 *
+	 * @return \Fab\Vidi\Persistence\PagerObjectFactory
+	 */
+	static public function getInstance()
+	{
+		return GeneralUtility::makeInstance('Fab\Vidi\Persistence\PagerObjectFactory');
+	}
 
-    /**
-     * Returns a pager object.
-     *
-     * @return \Fab\Vidi\Persistence\Pager
-     */
-    public function getPager()
-    {
+	/**
+	 * Returns a pager object.
+	 *
+	 * @return \Fab\Vidi\Persistence\Pager
+	 */
+	public function getPager()
+	{
 
-        /** @var $pager \Fab\Vidi\Persistence\Pager */
-        $pager = GeneralUtility::makeInstance('Fab\Vidi\Persistence\Pager');
+		/** @var $pager \Fab\Vidi\Persistence\Pager */
+		$pager = GeneralUtility::makeInstance('Fab\Vidi\Persistence\Pager');
 
-        // Set items per page
-        if (GeneralUtility::_GET('length') !== NULL) {
-            $limit = (int)GeneralUtility::_GET('length');
-            $pager->setLimit($limit);
-        }
+		// Set items per page
+		if (GeneralUtility::_GET('length') !== NULL) {
+			$limit = (int)GeneralUtility::_GET('length');
+			$pager->setLimit($limit);
+		}
 
-        // Set offset
-        $offset = 0;
-        if (GeneralUtility::_GET('start') !== NULL) {
-            $offset = (int)GeneralUtility::_GET('start');
-        }
-        $pager->setOffset($offset);
+		// Set offset
+		$offset = 0;
+		if (GeneralUtility::_GET('start') !== NULL) {
+			$offset = (int)GeneralUtility::_GET('start');
+		}
+		$pager->setOffset($offset);
 
-        // set page
-        $page = 1;
-        if ($pager->getLimit() > 0) {
-            $page = round($pager->getOffset() / $pager->getLimit());
-        }
-        $pager->setPage($page);
+		// set page
+		$page = 1;
+		if ($pager->getLimit() > 0) {
+			$page = round($pager->getOffset() / $pager->getLimit());
+		}
+		$pager->setPage($page);
 
-        return $pager;
-    }
+		return $pager;
+	}
 
 }

Classes/Persistence/ResultSetStorage.php

Indentation +25 added lines, -25 removed lines

@@ -22,32 +22,32 @@
 class ResultSetStorage implements SingletonInterface
 {
 
-    /**
-     * @var array
-     */
-    protected $resultSets = array();
+	/**
+	 * @var array
+	 */
+	protected $resultSets = array();
 
-    /**
-     * @param string $querySignature
-     * @return array
-     */
-    public function get($querySignature)
-    {
-        $resultSet = NULL;
-        if (isset($this->resultSets[$querySignature])) {
-            $resultSet = $this->resultSets[$querySignature];
-        }
-        return $resultSet;
-    }
+	/**
+	 * @param string $querySignature
+	 * @return array
+	 */
+	public function get($querySignature)
+	{
+		$resultSet = NULL;
+		if (isset($this->resultSets[$querySignature])) {
+			$resultSet = $this->resultSets[$querySignature];
+		}
+		return $resultSet;
+	}
 
-    /**
-     * @param $querySignature
-     * @param array $resultSet
-     * @internal param array $resultSets
-     */
-    public function set($querySignature, array $resultSet)
-    {
-        $this->resultSets[$querySignature] = $resultSet;
-    }
+	/**
+	 * @param $querySignature
+	 * @param array $resultSet
+	 * @internal param array $resultSets
+	 */
+	public function set($querySignature, array $resultSet)
+	{
+		$this->resultSets[$querySignature] = $resultSet;
+	}
 
 }

Classes/Persistence/Order.php

Indentation +38 added lines, -38 removed lines

@@ -20,45 +20,45 @@
 class Order
 {
 
-    /**
-     * The orderings
-     *
-     * @var array
-     */
-    protected $orderings = array();
+	/**
+	 * The orderings
+	 *
+	 * @var array
+	 */
+	protected $orderings = array();
 
-    /**
-     * Constructs a new Order
-     *
-     * @para array $orders
-     * @param array $orders
-     */
-    public function __construct($orders = array())
-    {
-        foreach ($orders as $order => $direction) {
-            $this->addOrdering($order, $direction);
-        }
-    }
+	/**
+	 * Constructs a new Order
+	 *
+	 * @para array $orders
+	 * @param array $orders
+	 */
+	public function __construct($orders = array())
+	{
+		foreach ($orders as $order => $direction) {
+			$this->addOrdering($order, $direction);
+		}
+	}
 
-    /**
-     * Add ordering
-     *
-     * @param string $order The order
-     * @param string $direction ASC / DESC
-     * @return void
-     */
-    public function addOrdering($order, $direction)
-    {
-        $this->orderings[$order] = $direction;
-    }
+	/**
+	 * Add ordering
+	 *
+	 * @param string $order The order
+	 * @param string $direction ASC / DESC
+	 * @return void
+	 */
+	public function addOrdering($order, $direction)
+	{
+		$this->orderings[$order] = $direction;
+	}
 
-    /**
-     * Returns the order
-     *
-     * @return array The order
-     */
-    public function getOrderings()
-    {
-        return $this->orderings;
-    }
+	/**
+	 * Returns the order
+	 *
+	 * @return array The order
+	 */
+	public function getOrderings()
+	{
+		return $this->orderings;
+	}
 }

Classes/Persistence/QuerySettings.php

Indentation +14 added lines, -14 removed lines

@@ -24,19 +24,19 @@
 class QuerySettings extends Typo3QuerySettings
 {
 
-    /**
-     * Flag if the storage page should be respected for the query.
-     *
-     * @var boolean
-     */
-    protected $respectStoragePage = FALSE;
+	/**
+	 * Flag if the storage page should be respected for the query.
+	 *
+	 * @var boolean
+	 */
+	protected $respectStoragePage = FALSE;
 
-    /**
-     * As long as we use a feature flag ignoreAllEnableFieldsInBe to determine the default behavior, the
-     * initializeObject is responsible for handling that.
-     */
-    public function initializeObject()
-    {
-        parent::initializeObject();
-    }
+	/**
+	 * As long as we use a feature flag ignoreAllEnableFieldsInBe to determine the default behavior, the
+	 * initializeObject is responsible for handling that.
+	 */
+	public function initializeObject()
+	{
+		parent::initializeObject();
+	}
 }