fabarea / vidi

Classes/Domain/Repository/ContentRepository.php

Doc Comments +3 added lines, -2 removed lines

@@ -279,7 +279,7 @@ 
      * Update a content with new information.
      *
      * @param Content $content
-     * @param $language
+     * @param integer $language
      * @return bool
      */
     public function localize($content, $language)
@@ -360,6 +360,7 @@ 
      * Copy a content within this repository.
      *
      * @param Content $content
+     * @param string $target
      * @return bool
      */
     public function copy($content, $target)
@@ -512,7 +513,7 @@ 
     /**
      * Sets the default query settings to be used in this repository
      *
-     * @param QuerySettingsInterface $defaultQuerySettings The query settings to be used by default
+     * @param QuerySettings $defaultQuerySettings The query settings to be used by default
      * @throws \BadMethodCallException
      * @return void
      * @api

Indentation +820 added lines, -820 removed lines

@@ -41,825 +41,825 @@
 class ContentRepository implements RepositoryInterface
 {
 
-    /**
-     * Tell whether it is a raw result (array) or object being returned.
-     *
-     * @var bool
-     */
-    protected $rawResult = false;
-
-    /**
-     * The data type to be returned, e.g fe_users, fe_groups, tt_content, etc...
-     *
-     * @var string
-     */
-    protected $dataType;
-
-    /**
-     * The source field is useful in the context of MM relations to know who is the caller
-     * e.g findByItems which eventually corresponds to a field name.
-     *
-     * @var string
-     */
-    protected $sourceFieldName = '';
-
-    /**
-     * @var array
-     */
-    protected $errorMessages = array();
-
-    /**
-     * @var QuerySettingsInterface
-     */
-    protected $defaultQuerySettings;
-
-    /**
-     * Constructor
-     *
-     * @param string $dataType
-     */
-    public function __construct($dataType)
-    {
-        $this->dataType = $dataType;
-    }
-
-    /**
-     * Returns all objects of this repository.
-     *
-     * @return Content[]
-     */
-    public function findAll()
-    {
-        $query = $this->createQuery();
-        return $query->execute();
-    }
-
-    /**
-     * Returns all "distinct" values for a given property.
-     *
-     * @param string $propertyName
-     * @param Matcher $matcher
-     * @return Content[]
-     */
-    public function findDistinctValues($propertyName, Matcher $matcher = null)
-    {
-        $query = $this->createQuery();
-        $query->setDistinct($propertyName);
-
-        // Remove empty values from selection.
-        $constraint = $query->logicalNot($query->equals($propertyName, ''));
-
-        // Add some additional constraints from the Matcher object.
-        $matcherConstraint = null;
-        if (!is_null($matcher)) {
-            $matcherConstraint = $this->computeConstraints($query, $matcher);
-        }
-
-        // Assemble the final constraints or not.
-        if ($matcherConstraint) {
-            $query->logicalAnd($matcherConstraint, $constraint);
-            $query->matching($query->logicalAnd($matcherConstraint, $constraint));
-        } else {
-            $query->matching($constraint);
-        }
-
-        return $query->execute();
-    }
-
-    /**
-     * Returns all "distinct" values for a given property.
-     *
-     * @param string $propertyName
-     * @param Matcher $matcher
-     * @return int
-     */
-    public function countDistinctValues($propertyName, Matcher $matcher = null)
-    {
-        $query = $this->createQuery();
-        $query->setDistinct($propertyName);
-
-        // Remove empty values from selection.
-        $constraint = $query->logicalNot($query->equals($propertyName, ''));
-
-        // Add some additional constraints from the Matcher object.
-        $matcherConstraint = null;
-        if (!is_null($matcher)) {
-            $matcherConstraint = $this->computeConstraints($query, $matcher);
-        }
-
-        // Assemble the final constraints or not.
-        if ($matcherConstraint) {
-            $query->logicalAnd($matcherConstraint, $constraint);
-            $query->matching($query->logicalAnd($matcherConstraint, $constraint));
-        } else {
-            $query->matching($constraint);
-        }
-
-        return $query->count();
-    }
-
-    /**
-     * Finds an object matching the given identifier.
-     *
-     * @param int $uid The identifier of the object to find
-     * @return Content|null
-     * @api
-     */
-    public function findByUid($uid)
-    {
-        return $this->findByIdentifier($uid);
-    }
-
-    /**
-     * Finds all Contents given specified matches.
-     *
-     * @param string $propertyName
-     * @param array $values
-     * @return Content[]
-     */
-    public function findIn($propertyName, array $values)
-    {
-        $query = $this->createQuery();
-        $query->matching($query->in($propertyName, $values));
-        return $query->execute();
-    }
-
-    /**
-     * Finds all Contents given specified matches.
-     *
-     * @param Matcher $matcher
-     * @param Order $order The order
-     * @param int $limit
-     * @param int $offset
-     * @return Content[]
-     */
-    public function findBy(Matcher $matcher, Order $order = null, $limit = null, $offset = null)
-    {
-
-        $query = $this->createQuery();
-
-        $limit = (int)$limit; // make sure to cast
-        if ($limit > 0) {
-            $query->setLimit($limit);
-        }
-
-        if ($order) {
-            $query->setOrderings($order->getOrderings());
-
-            // Loops around the orderings adding if necessary a dummy condition
-            // to make sure the relations can be resolved when transforming the query to plain SQL.
-            foreach ($order->getOrderings() as $ordering => $direction) {
-                if ($this->hasForeignRelationIn($ordering)) {
-                    $relationalField = $this->getForeignRelationFrom($ordering);
-                    $matcher->like($relationalField . '.uid', '');
-                }
-            }
-        }
-
-        if ($offset) {
-            $query->setOffset($offset);
-        }
-
-        $constraints = $this->computeConstraints($query, $matcher);
-
-        if ($constraints) {
-            $query->matching($constraints);
-        }
-
-        return $query->execute();
-    }
-
-    /**
-     * Find one Content object given specified matches.
-     *
-     * @param Matcher $matcher
-     * @return Content
-     */
-    public function findOneBy(Matcher $matcher)
-    {
-
-        $query = $this->createQuery();
-
-        $constraints = $this->computeConstraints($query, $matcher);
-
-        if ($constraints) {
-            $query->matching($constraints);
-        }
-
-        $query->setLimit(1); // only take one!
-
-        $resultSet = $query->execute();
-        if ($resultSet) {
-            $resultSet = current($resultSet);
-        }
-        return $resultSet;
-    }
-
-    /**
-     * Count all Contents given specified matches.
-     *
-     * @param Matcher $matcher
-     * @return int
-     */
-    public function countBy(Matcher $matcher)
-    {
-
-        $query = $this->createQuery();
-
-        $constraints = $this->computeConstraints($query, $matcher);
-
-        if ($constraints) {
-            $query->matching($constraints);
-        }
-
-        return $query->count();
-    }
-
-    /**
-     * Update a content with new information.
-     *
-     * @param Content $content
-     * @param $language
-     * @return bool
-     */
-    public function localize($content, $language)
-    {
-
-        // Security check
-        $this->getContentValidator()->validate($content);
-        $this->getLanguageValidator()->validate($language);
-
-        $dataType = $content->getDataType();
-        $handler = $this->getDataHandlerFactory()->action(ProcessAction::LOCALIZE)->forType($dataType)->getDataHandler();
-
-        $handlerResult = $handler->processLocalize($content, $language);
-        $this->errorMessages = $handler->getErrorMessages();
-        return $handlerResult;
-    }
-
-    /**
-     * Update a content with new information.
-     *
-     * @param Content $content
-     * @return bool
-     */
-    public function update($content)
-    {
-
-        // Security check.
-        $this->getContentValidator()->validate($content);
-
-        $dataType = $content->getDataType();
-        $handler = $this->getDataHandlerFactory()->action(ProcessAction::UPDATE)->forType($dataType)->getDataHandler();
-
-        $handlerResult = $handler->processUpdate($content);
-        $this->errorMessages = $handler->getErrorMessages();
-        return $handlerResult;
-    }
-
-    /**
-     * Removes an object from this repository.
-     *
-     * @param Content $content
-     * @return boolean
-     */
-    public function remove($content)
-    {
-        $dataType = $content->getDataType();
-        $handler = $this->getDataHandlerFactory()->action(ProcessAction::REMOVE)->forType($dataType)->getDataHandler();
-
-        $handlerResult = $handler->processRemove($content);
-        $this->errorMessages = $handler->getErrorMessages();
-        return $handlerResult;
-    }
-
-    /**
-     * Move a content within this repository.
-     * The $target corresponds to the pid to move the records to.
-     * It can also be a negative value in case of sorting. The negative value would be the uid of its predecessor.
-     *
-     * @param Content $content
-     * @param string $target
-     * @return bool
-     */
-    public function move($content, $target)
-    {
-
-        // Security check.
-        $this->getContentValidator()->validate($content);
-
-        $dataType = $content->getDataType();
-        $handler = $this->getDataHandlerFactory()->action(ProcessAction::MOVE)->forType($dataType)->getDataHandler();
-
-        $handlerResult = $handler->processMove($content, $target);
-        $this->errorMessages = $handler->getErrorMessages();
-        return $handlerResult;
-    }
-
-    /**
-     * Copy a content within this repository.
-     *
-     * @param Content $content
-     * @return bool
-     */
-    public function copy($content, $target)
-    {
-
-        // Security check.
-        $this->getContentValidator()->validate($content);
-
-        $dataType = $content->getDataType();
-        $handler = $this->getDataHandlerFactory()->action(ProcessAction::COPY)->forType($dataType)->getDataHandler();
-
-        $handlerResult = $handler->processCopy($content, $target);
-        $this->errorMessages = $handler->getErrorMessages();
-        return $handlerResult;
-    }
-
-    /**
-     * Adds an object to this repository.
-     *
-     * @param object $object The object to add
-     * @throws \BadMethodCallException
-     * @return void
-     * @api
-     */
-    public function add($object)
-    {
-        throw new \BadMethodCallException('Repository does not support the add() method.', 1375805599);
-    }
-
-    /**
-     * Returns the total number objects of this repository.
-     *
-     * @return integer The object count
-     * @api
-     */
-    public function countAll()
-    {
-        $query = $this->createQuery();
-        return $query->count();
-    }
-
-    /**
-     * Removes all objects of this repository as if remove() was called for
-     * all of them.
-     *
-     * @return void
-     * @api
-     */
-    public function removeAll()
-    {
-        // TODO: Implement removeAll() method.
-    }
-
-    /**
-     * Finds an object matching the given identifier.
-     *
-     * @param mixed $identifier The identifier of the object to find
-     * @return Content|null
-     * @api
-     */
-    public function findByIdentifier($identifier)
-    {
-        $query = $this->createQuery();
-
-        $result = $query->matching($query->equals('uid', $identifier))
-            ->execute();
-
-        if (is_array($result)) {
-            $result = current($result);
-        }
-
-        return $result;
-    }
-
-    /**
-     * Dispatches magic methods (findBy[Property]())
-     *
-     * @param string $methodName The name of the magic method
-     * @param string $arguments The arguments of the magic method
-     * @throws UnsupportedMethodException
-     * @return mixed
-     * @api
-     */
-    public function __call($methodName, $arguments)
-    {
-        if (substr($methodName, 0, 6) === 'findBy' && strlen($methodName) > 7) {
-            $propertyName = strtolower(substr(substr($methodName, 6), 0, 1)) . substr(substr($methodName, 6), 1);
-            $result = $this->processMagicCall($propertyName, $arguments[0]);
-        } elseif (substr($methodName, 0, 9) === 'findOneBy' && strlen($methodName) > 10) {
-            $propertyName = strtolower(substr(substr($methodName, 9), 0, 1)) . substr(substr($methodName, 9), 1);
-            $result = $this->processMagicCall($propertyName, $arguments[0], 'one');
-        } elseif (substr($methodName, 0, 7) === 'countBy' && strlen($methodName) > 8) {
-            $propertyName = strtolower(substr(substr($methodName, 7), 0, 1)) . substr(substr($methodName, 7), 1);
-            $result = $this->processMagicCall($propertyName, $arguments[0], 'count');
-        } else {
-            throw new UnsupportedMethodException('The method "' . $methodName . '" is not supported by the repository.', 1360838010);
-        }
-        return $result;
-    }
-
-    /**
-     * Returns a query for objects of this repository
-     *
-     * @return Query
-     * @api
-     */
-    public function createQuery()
-    {
-        /** @var Query $query */
-        $query = $this->getObjectManager()->get(Query::class, $this->dataType);
-        $query->setSourceFieldName($this->sourceFieldName);
-
-        if ($this->defaultQuerySettings) {
-            $query->setQuerySettings($this->defaultQuerySettings);
-        } else {
-
-            // Initialize and pass the query settings at this level.
-            /** @var QuerySettings $querySettings */
-            $querySettings = $this->getObjectManager()->get(QuerySettings::class);
-
-            // Default choice for the BE.
-            if ($this->isBackendMode()) {
-                $querySettings->setIgnoreEnableFields(true);
-            }
-
-            $query->setQuerySettings($querySettings);
-        }
-
-        return $query;
-    }
-
-    /**
-     * Sets the property names to order the result by per default.
-     * Expected like this:
-     * array(
-     * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
-     * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
-     * )
-     *
-     * @param array $defaultOrderings The property names to order by
-     * @throws \BadMethodCallException
-     * @return void
-     * @api
-     */
-    public function setDefaultOrderings(array $defaultOrderings)
-    {
-        throw new \BadMethodCallException('Repository does not support the setDefaultOrderings() method.', 1375805598);
-    }
-
-    /**
-     * Sets the default query settings to be used in this repository
-     *
-     * @param QuerySettingsInterface $defaultQuerySettings The query settings to be used by default
-     * @throws \BadMethodCallException
-     * @return void
-     * @api
-     */
-    public function setDefaultQuerySettings(QuerySettingsInterface $defaultQuerySettings)
-    {
-        $this->defaultQuerySettings = $defaultQuerySettings;
-    }
-
-    /**
-     * @return array
-     */
-    public function getErrorMessages()
-    {
-        return $this->errorMessages;
-    }
-
-    /**
-     * @param string $sourceFieldName
-     * @return $this
-     */
-    public function setSourceFieldName($sourceFieldName)
-    {
-        $this->sourceFieldName = $sourceFieldName;
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getDataType()
-    {
-        return $this->dataType;
-    }
-
-    /**
-     * Tell whether the order has a foreign table in its expression, e.g. "metadata.title".
-     *
-     * @param string $ordering
-     * @return bool
-     */
-    protected function hasForeignRelationIn($ordering)
-    {
-        return strpos($ordering, '.') !== false;
-    }
-
-    /**
-     * Extract the foreign relation of the ordering "metadata.title" -> "metadata"
-     *
-     * @param string $ordering
-     * @return string
-     */
-    protected function getForeignRelationFrom($ordering)
-    {
-        $parts = explode('.', $ordering);
-        return $parts[0];
-    }
-
-    /**
-     * Get the constraints
-     *
-     * @param Query $query
-     * @param Matcher $matcher
-     * @return ConstraintInterface|null
-     */
-    protected function computeConstraints(Query $query, Matcher $matcher)
-    {
-
-        $constraints = null;
-
-        $collectedConstraints = array();
-
-        // Search term
-        $constraint = $this->computeSearchTermConstraint($query, $matcher);
-        if ($constraint) {
-            $collectedConstraints[] = $constraint;
-        }
-
-        foreach ($matcher->getSupportedOperators() as $operator) {
-            $constraint = $this->computeConstraint($query, $matcher, $operator);
-            if ($constraint) {
-                $collectedConstraints[] = $constraint;
-            }
-        }
-
-        if (count($collectedConstraints) > 1) {
-            $logical = $matcher->getDefaultLogicalSeparator();
-            $constraints = $query->$logical($collectedConstraints);
-        } elseif (!empty($collectedConstraints)) {
-
-            // true means there is one constraint only and should become the result
-            $constraints = current($collectedConstraints);
-        }
-
-        // Trigger signal for post processing the computed constraints object.
-        $constraints = $this->emitPostProcessConstraintsSignal($query, $constraints);
-
-        return $constraints;
-    }
-
-    /**
-     * Computes the search constraint and returns it.
-     *
-     * @param Query $query
-     * @param Matcher $matcher
-     * @return ConstraintInterface|null
-     */
-    protected function computeSearchTermConstraint(Query $query, Matcher $matcher)
-    {
-
-        $result = null;
-
-        // Search term case
-        if ($matcher->getSearchTerm()) {
-
-            $fields = GeneralUtility::trimExplode(',', Tca::table($this->dataType)->getSearchFields(), true);
-
-            $constraints = array();
-            $likeClause = sprintf('%%%s%%', $matcher->getSearchTerm());
-            foreach ($fields as $fieldNameAndPath) {
-                if ($this->isSuitableForLike($fieldNameAndPath, $matcher->getSearchTerm())) {
-
-                    $dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
-                    $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
-
-                    if (Tca::table($dataType)->hasField($fieldName) && Tca::table($dataType)->field($fieldName)->hasRelation()) {
-                        $foreignTable = Tca::table($dataType)->field($fieldName)->getForeignTable();
-                        $fieldNameAndPath = $fieldNameAndPath . '.' . Tca::table($foreignTable)->getLabelField();
-                    }
-                    $constraints[] = $query->like($fieldNameAndPath, $likeClause);
-                }
-            }
-            $logical = $matcher->getLogicalSeparatorForSearchTerm();
-            $result = $query->$logical($constraints);
-        }
-
-        return $result;
-    }
-
-    /**
-     * It does not make sense to have a "like" in presence of numerical field, e.g "uid".
-     * Tell whether the given value makes sense for a "like" clause.
-     *
-     * @param string $fieldNameAndPath
-     * @param string $value
-     * @return bool
-     */
-    protected function isSuitableForLike($fieldNameAndPath, $value)
-    {
-        $isSuitable = true;
-
-        // true means it is a string
-        if (!MathUtility::canBeInterpretedAsInteger($value)) {
-
-            $dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
-            $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
-
-            if (Tca::table($dataType)->field($fieldName)->isNumerical()
-                && !Tca::table($dataType)->field($fieldName)->hasRelation()
-            ) {
-                $isSuitable = false;
-            }
-        }
-
-        return $isSuitable;
-    }
-
-    /**
-     * Computes the constraint for matches and returns it.
-     *
-     * @param Query $query
-     * @param Matcher $matcher
-     * @param string $operator
-     * @return ConstraintInterface|null
-     */
-    protected function computeConstraint(Query $query, Matcher $matcher, $operator)
-    {
-        $result = null;
-
-        $operatorName = ucfirst($operator);
-        $getCriteria = sprintf('get%s', $operatorName);
-        $criteria = $matcher->$getCriteria();
-
-        if (!empty($criteria)) {
-            $constraints = array();
-
-            foreach ($criteria as $criterion) {
-
-                $fieldNameAndPath = $criterion['fieldNameAndPath'];
-                $operand = $criterion['operand'];
-
-                // Compute a few variables...
-                // $dataType is generally equals to $this->dataType but not always... if fieldName is a path.
-                $dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
-                $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
-                $fieldPath = $this->getFieldPathResolver()->stripFieldName($fieldNameAndPath, $this->dataType);
-
-                if (Tca::table($dataType)->field($fieldName)->hasRelation()) {
-                    if (MathUtility::canBeInterpretedAsInteger($operand)) {
-                        $fieldNameAndPath = $fieldName . '.uid';
-                    } else {
-                        $foreignTableName = Tca::table($dataType)->field($fieldName)->getForeignTable();
-                        $foreignTable = Tca::table($foreignTableName);
-                        $fieldNameAndPath = $fieldName . '.' . $foreignTable->getLabelField();
-                    }
-
-                    // If different means we should restore the prepended path segment for proper SQL parser.
-                    // This is true for a composite field, e.g items.sys_file_metadata for categories.
-                    if ($fieldName !== $fieldPath) {
-                        $fieldNameAndPath = $fieldPath . '.' . $fieldNameAndPath;
-                    }
-                }
-
-                $constraints[] = $query->$operator($fieldNameAndPath, $criterion['operand']);
-            }
-
-            $getLogicalSeparator = sprintf('getLogicalSeparatorFor%s', $operatorName);
-            $logical = $matcher->$getLogicalSeparator();
-            $result = $query->$logical($constraints);
-        }
-
-        return $result;
-    }
-
-    /**
-     * @return DataHandler
-     */
-    protected function getDataHandler()
-    {
-        if (!$this->dataHandler) {
-            $this->dataHandler = GeneralUtility::makeInstance(DataHandler::class);
-        }
-        return $this->dataHandler;
-    }
-
-    /**
-     * Handle the magic call by properly creating a Query object and returning its result.
-     *
-     * @param string $propertyName
-     * @param string $value
-     * @param string $flag
-     * @return array
-     */
-    protected function processMagicCall($propertyName, $value, $flag = '')
-    {
-
-        $fieldName = Property::name($propertyName)->of($this->dataType)->toFieldName();
-
-        /** @var $matcher Matcher */
-        $matcher = GeneralUtility::makeInstance(Matcher::class, array(), $this->getDataType());
-
-        $table = Tca::table($this->dataType);
-        if ($table->field($fieldName)->isGroup()) {
-
-            $valueParts = explode('.', $value, 2);
-            $fieldName = $fieldName . '.' . $valueParts[0];
-            $value = $valueParts[1];
-        }
-
-        $matcher->equals($fieldName, $value);
-
-        if ($flag == 'count') {
-            $result = $this->countBy($matcher);
-        } else {
-            $result = $this->findBy($matcher);
-        }
-        return $flag == 'one' && !empty($result) ? reset($result) : $result;
-    }
-
-    /**
-     * @return DataHandlerFactory
-     */
-    protected function getDataHandlerFactory()
-    {
-        return GeneralUtility::makeInstance(DataHandlerFactory::class);
-    }
-
-    /**
-     * Returns whether the current mode is Backend
-     *
-     * @return bool
-     */
-    protected function isBackendMode()
-    {
-        return TYPO3_MODE == 'BE';
-    }
-
-    /**
-     * @return FieldPathResolver
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance(FieldPathResolver::class);
-    }
-
-    /**
-     * @return ObjectManager
-     */
-    protected function getObjectManager()
-    {
-        return GeneralUtility::makeInstance(ObjectManager::class);
-    }
-
-    /**
-     * @return ContentValidator
-     */
-    protected function getContentValidator()
-    {
-        return GeneralUtility::makeInstance(ContentValidator::class);
-    }
-
-    /**
-     * @return LanguageValidator
-     */
-    protected function getLanguageValidator()
-    {
-        return GeneralUtility::makeInstance(LanguageValidator::class);
-    }
-
-    /**
-     * Signal that is called for post-processing the computed constraints object.
-     *
-     * @param Query $query
-     * @param ConstraintInterface|null $constraints
-     * @return ConstraintInterface|null $constraints
-     * @signal
-     */
-    protected function emitPostProcessConstraintsSignal(Query $query, $constraints)
-    {
-        $result = $this->getSignalSlotDispatcher()->dispatch(
-            self::class,
-            'postProcessConstraintsObject',
-            array(
-                $query,
-                $constraints
-            )
-        );
-
-        return $result[1];
-    }
-
-    /**
-     * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
-     */
-    protected function getSignalSlotDispatcher()
-    {
-        return $this->getObjectManager()->get(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
-    }
+	/**
+	 * Tell whether it is a raw result (array) or object being returned.
+	 *
+	 * @var bool
+	 */
+	protected $rawResult = false;
+
+	/**
+	 * The data type to be returned, e.g fe_users, fe_groups, tt_content, etc...
+	 *
+	 * @var string
+	 */
+	protected $dataType;
+
+	/**
+	 * The source field is useful in the context of MM relations to know who is the caller
+	 * e.g findByItems which eventually corresponds to a field name.
+	 *
+	 * @var string
+	 */
+	protected $sourceFieldName = '';
+
+	/**
+	 * @var array
+	 */
+	protected $errorMessages = array();
+
+	/**
+	 * @var QuerySettingsInterface
+	 */
+	protected $defaultQuerySettings;
+
+	/**
+	 * Constructor
+	 *
+	 * @param string $dataType
+	 */
+	public function __construct($dataType)
+	{
+		$this->dataType = $dataType;
+	}
+
+	/**
+	 * Returns all objects of this repository.
+	 *
+	 * @return Content[]
+	 */
+	public function findAll()
+	{
+		$query = $this->createQuery();
+		return $query->execute();
+	}
+
+	/**
+	 * Returns all "distinct" values for a given property.
+	 *
+	 * @param string $propertyName
+	 * @param Matcher $matcher
+	 * @return Content[]
+	 */
+	public function findDistinctValues($propertyName, Matcher $matcher = null)
+	{
+		$query = $this->createQuery();
+		$query->setDistinct($propertyName);
+
+		// Remove empty values from selection.
+		$constraint = $query->logicalNot($query->equals($propertyName, ''));
+
+		// Add some additional constraints from the Matcher object.
+		$matcherConstraint = null;
+		if (!is_null($matcher)) {
+			$matcherConstraint = $this->computeConstraints($query, $matcher);
+		}
+
+		// Assemble the final constraints or not.
+		if ($matcherConstraint) {
+			$query->logicalAnd($matcherConstraint, $constraint);
+			$query->matching($query->logicalAnd($matcherConstraint, $constraint));
+		} else {
+			$query->matching($constraint);
+		}
+
+		return $query->execute();
+	}
+
+	/**
+	 * Returns all "distinct" values for a given property.
+	 *
+	 * @param string $propertyName
+	 * @param Matcher $matcher
+	 * @return int
+	 */
+	public function countDistinctValues($propertyName, Matcher $matcher = null)
+	{
+		$query = $this->createQuery();
+		$query->setDistinct($propertyName);
+
+		// Remove empty values from selection.
+		$constraint = $query->logicalNot($query->equals($propertyName, ''));
+
+		// Add some additional constraints from the Matcher object.
+		$matcherConstraint = null;
+		if (!is_null($matcher)) {
+			$matcherConstraint = $this->computeConstraints($query, $matcher);
+		}
+
+		// Assemble the final constraints or not.
+		if ($matcherConstraint) {
+			$query->logicalAnd($matcherConstraint, $constraint);
+			$query->matching($query->logicalAnd($matcherConstraint, $constraint));
+		} else {
+			$query->matching($constraint);
+		}
+
+		return $query->count();
+	}
+
+	/**
+	 * Finds an object matching the given identifier.
+	 *
+	 * @param int $uid The identifier of the object to find
+	 * @return Content|null
+	 * @api
+	 */
+	public function findByUid($uid)
+	{
+		return $this->findByIdentifier($uid);
+	}
+
+	/**
+	 * Finds all Contents given specified matches.
+	 *
+	 * @param string $propertyName
+	 * @param array $values
+	 * @return Content[]
+	 */
+	public function findIn($propertyName, array $values)
+	{
+		$query = $this->createQuery();
+		$query->matching($query->in($propertyName, $values));
+		return $query->execute();
+	}
+
+	/**
+	 * Finds all Contents given specified matches.
+	 *
+	 * @param Matcher $matcher
+	 * @param Order $order The order
+	 * @param int $limit
+	 * @param int $offset
+	 * @return Content[]
+	 */
+	public function findBy(Matcher $matcher, Order $order = null, $limit = null, $offset = null)
+	{
+
+		$query = $this->createQuery();
+
+		$limit = (int)$limit; // make sure to cast
+		if ($limit > 0) {
+			$query->setLimit($limit);
+		}
+
+		if ($order) {
+			$query->setOrderings($order->getOrderings());
+
+			// Loops around the orderings adding if necessary a dummy condition
+			// to make sure the relations can be resolved when transforming the query to plain SQL.
+			foreach ($order->getOrderings() as $ordering => $direction) {
+				if ($this->hasForeignRelationIn($ordering)) {
+					$relationalField = $this->getForeignRelationFrom($ordering);
+					$matcher->like($relationalField . '.uid', '');
+				}
+			}
+		}
+
+		if ($offset) {
+			$query->setOffset($offset);
+		}
+
+		$constraints = $this->computeConstraints($query, $matcher);
+
+		if ($constraints) {
+			$query->matching($constraints);
+		}
+
+		return $query->execute();
+	}
+
+	/**
+	 * Find one Content object given specified matches.
+	 *
+	 * @param Matcher $matcher
+	 * @return Content
+	 */
+	public function findOneBy(Matcher $matcher)
+	{
+
+		$query = $this->createQuery();
+
+		$constraints = $this->computeConstraints($query, $matcher);
+
+		if ($constraints) {
+			$query->matching($constraints);
+		}
+
+		$query->setLimit(1); // only take one!
+
+		$resultSet = $query->execute();
+		if ($resultSet) {
+			$resultSet = current($resultSet);
+		}
+		return $resultSet;
+	}
+
+	/**
+	 * Count all Contents given specified matches.
+	 *
+	 * @param Matcher $matcher
+	 * @return int
+	 */
+	public function countBy(Matcher $matcher)
+	{
+
+		$query = $this->createQuery();
+
+		$constraints = $this->computeConstraints($query, $matcher);
+
+		if ($constraints) {
+			$query->matching($constraints);
+		}
+
+		return $query->count();
+	}
+
+	/**
+	 * Update a content with new information.
+	 *
+	 * @param Content $content
+	 * @param $language
+	 * @return bool
+	 */
+	public function localize($content, $language)
+	{
+
+		// Security check
+		$this->getContentValidator()->validate($content);
+		$this->getLanguageValidator()->validate($language);
+
+		$dataType = $content->getDataType();
+		$handler = $this->getDataHandlerFactory()->action(ProcessAction::LOCALIZE)->forType($dataType)->getDataHandler();
+
+		$handlerResult = $handler->processLocalize($content, $language);
+		$this->errorMessages = $handler->getErrorMessages();
+		return $handlerResult;
+	}
+
+	/**
+	 * Update a content with new information.
+	 *
+	 * @param Content $content
+	 * @return bool
+	 */
+	public function update($content)
+	{
+
+		// Security check.
+		$this->getContentValidator()->validate($content);
+
+		$dataType = $content->getDataType();
+		$handler = $this->getDataHandlerFactory()->action(ProcessAction::UPDATE)->forType($dataType)->getDataHandler();
+
+		$handlerResult = $handler->processUpdate($content);
+		$this->errorMessages = $handler->getErrorMessages();
+		return $handlerResult;
+	}
+
+	/**
+	 * Removes an object from this repository.
+	 *
+	 * @param Content $content
+	 * @return boolean
+	 */
+	public function remove($content)
+	{
+		$dataType = $content->getDataType();
+		$handler = $this->getDataHandlerFactory()->action(ProcessAction::REMOVE)->forType($dataType)->getDataHandler();
+
+		$handlerResult = $handler->processRemove($content);
+		$this->errorMessages = $handler->getErrorMessages();
+		return $handlerResult;
+	}
+
+	/**
+	 * Move a content within this repository.
+	 * The $target corresponds to the pid to move the records to.
+	 * It can also be a negative value in case of sorting. The negative value would be the uid of its predecessor.
+	 *
+	 * @param Content $content
+	 * @param string $target
+	 * @return bool
+	 */
+	public function move($content, $target)
+	{
+
+		// Security check.
+		$this->getContentValidator()->validate($content);
+
+		$dataType = $content->getDataType();
+		$handler = $this->getDataHandlerFactory()->action(ProcessAction::MOVE)->forType($dataType)->getDataHandler();
+
+		$handlerResult = $handler->processMove($content, $target);
+		$this->errorMessages = $handler->getErrorMessages();
+		return $handlerResult;
+	}
+
+	/**
+	 * Copy a content within this repository.
+	 *
+	 * @param Content $content
+	 * @return bool
+	 */
+	public function copy($content, $target)
+	{
+
+		// Security check.
+		$this->getContentValidator()->validate($content);
+
+		$dataType = $content->getDataType();
+		$handler = $this->getDataHandlerFactory()->action(ProcessAction::COPY)->forType($dataType)->getDataHandler();
+
+		$handlerResult = $handler->processCopy($content, $target);
+		$this->errorMessages = $handler->getErrorMessages();
+		return $handlerResult;
+	}
+
+	/**
+	 * Adds an object to this repository.
+	 *
+	 * @param object $object The object to add
+	 * @throws \BadMethodCallException
+	 * @return void
+	 * @api
+	 */
+	public function add($object)
+	{
+		throw new \BadMethodCallException('Repository does not support the add() method.', 1375805599);
+	}
+
+	/**
+	 * Returns the total number objects of this repository.
+	 *
+	 * @return integer The object count
+	 * @api
+	 */
+	public function countAll()
+	{
+		$query = $this->createQuery();
+		return $query->count();
+	}
+
+	/**
+	 * Removes all objects of this repository as if remove() was called for
+	 * all of them.
+	 *
+	 * @return void
+	 * @api
+	 */
+	public function removeAll()
+	{
+		// TODO: Implement removeAll() method.
+	}
+
+	/**
+	 * Finds an object matching the given identifier.
+	 *
+	 * @param mixed $identifier The identifier of the object to find
+	 * @return Content|null
+	 * @api
+	 */
+	public function findByIdentifier($identifier)
+	{
+		$query = $this->createQuery();
+
+		$result = $query->matching($query->equals('uid', $identifier))
+			->execute();
+
+		if (is_array($result)) {
+			$result = current($result);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Dispatches magic methods (findBy[Property]())
+	 *
+	 * @param string $methodName The name of the magic method
+	 * @param string $arguments The arguments of the magic method
+	 * @throws UnsupportedMethodException
+	 * @return mixed
+	 * @api
+	 */
+	public function __call($methodName, $arguments)
+	{
+		if (substr($methodName, 0, 6) === 'findBy' && strlen($methodName) > 7) {
+			$propertyName = strtolower(substr(substr($methodName, 6), 0, 1)) . substr(substr($methodName, 6), 1);
+			$result = $this->processMagicCall($propertyName, $arguments[0]);
+		} elseif (substr($methodName, 0, 9) === 'findOneBy' && strlen($methodName) > 10) {
+			$propertyName = strtolower(substr(substr($methodName, 9), 0, 1)) . substr(substr($methodName, 9), 1);
+			$result = $this->processMagicCall($propertyName, $arguments[0], 'one');
+		} elseif (substr($methodName, 0, 7) === 'countBy' && strlen($methodName) > 8) {
+			$propertyName = strtolower(substr(substr($methodName, 7), 0, 1)) . substr(substr($methodName, 7), 1);
+			$result = $this->processMagicCall($propertyName, $arguments[0], 'count');
+		} else {
+			throw new UnsupportedMethodException('The method "' . $methodName . '" is not supported by the repository.', 1360838010);
+		}
+		return $result;
+	}
+
+	/**
+	 * Returns a query for objects of this repository
+	 *
+	 * @return Query
+	 * @api
+	 */
+	public function createQuery()
+	{
+		/** @var Query $query */
+		$query = $this->getObjectManager()->get(Query::class, $this->dataType);
+		$query->setSourceFieldName($this->sourceFieldName);
+
+		if ($this->defaultQuerySettings) {
+			$query->setQuerySettings($this->defaultQuerySettings);
+		} else {
+
+			// Initialize and pass the query settings at this level.
+			/** @var QuerySettings $querySettings */
+			$querySettings = $this->getObjectManager()->get(QuerySettings::class);
+
+			// Default choice for the BE.
+			if ($this->isBackendMode()) {
+				$querySettings->setIgnoreEnableFields(true);
+			}
+
+			$query->setQuerySettings($querySettings);
+		}
+
+		return $query;
+	}
+
+	/**
+	 * Sets the property names to order the result by per default.
+	 * Expected like this:
+	 * array(
+	 * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
+	 * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
+	 * )
+	 *
+	 * @param array $defaultOrderings The property names to order by
+	 * @throws \BadMethodCallException
+	 * @return void
+	 * @api
+	 */
+	public function setDefaultOrderings(array $defaultOrderings)
+	{
+		throw new \BadMethodCallException('Repository does not support the setDefaultOrderings() method.', 1375805598);
+	}
+
+	/**
+	 * Sets the default query settings to be used in this repository
+	 *
+	 * @param QuerySettingsInterface $defaultQuerySettings The query settings to be used by default
+	 * @throws \BadMethodCallException
+	 * @return void
+	 * @api
+	 */
+	public function setDefaultQuerySettings(QuerySettingsInterface $defaultQuerySettings)
+	{
+		$this->defaultQuerySettings = $defaultQuerySettings;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getErrorMessages()
+	{
+		return $this->errorMessages;
+	}
+
+	/**
+	 * @param string $sourceFieldName
+	 * @return $this
+	 */
+	public function setSourceFieldName($sourceFieldName)
+	{
+		$this->sourceFieldName = $sourceFieldName;
+		return $this;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDataType()
+	{
+		return $this->dataType;
+	}
+
+	/**
+	 * Tell whether the order has a foreign table in its expression, e.g. "metadata.title".
+	 *
+	 * @param string $ordering
+	 * @return bool
+	 */
+	protected function hasForeignRelationIn($ordering)
+	{
+		return strpos($ordering, '.') !== false;
+	}
+
+	/**
+	 * Extract the foreign relation of the ordering "metadata.title" -> "metadata"
+	 *
+	 * @param string $ordering
+	 * @return string
+	 */
+	protected function getForeignRelationFrom($ordering)
+	{
+		$parts = explode('.', $ordering);
+		return $parts[0];
+	}
+
+	/**
+	 * Get the constraints
+	 *
+	 * @param Query $query
+	 * @param Matcher $matcher
+	 * @return ConstraintInterface|null
+	 */
+	protected function computeConstraints(Query $query, Matcher $matcher)
+	{
+
+		$constraints = null;
+
+		$collectedConstraints = array();
+
+		// Search term
+		$constraint = $this->computeSearchTermConstraint($query, $matcher);
+		if ($constraint) {
+			$collectedConstraints[] = $constraint;
+		}
+
+		foreach ($matcher->getSupportedOperators() as $operator) {
+			$constraint = $this->computeConstraint($query, $matcher, $operator);
+			if ($constraint) {
+				$collectedConstraints[] = $constraint;
+			}
+		}
+
+		if (count($collectedConstraints) > 1) {
+			$logical = $matcher->getDefaultLogicalSeparator();
+			$constraints = $query->$logical($collectedConstraints);
+		} elseif (!empty($collectedConstraints)) {
+
+			// true means there is one constraint only and should become the result
+			$constraints = current($collectedConstraints);
+		}
+
+		// Trigger signal for post processing the computed constraints object.
+		$constraints = $this->emitPostProcessConstraintsSignal($query, $constraints);
+
+		return $constraints;
+	}
+
+	/**
+	 * Computes the search constraint and returns it.
+	 *
+	 * @param Query $query
+	 * @param Matcher $matcher
+	 * @return ConstraintInterface|null
+	 */
+	protected function computeSearchTermConstraint(Query $query, Matcher $matcher)
+	{
+
+		$result = null;
+
+		// Search term case
+		if ($matcher->getSearchTerm()) {
+
+			$fields = GeneralUtility::trimExplode(',', Tca::table($this->dataType)->getSearchFields(), true);
+
+			$constraints = array();
+			$likeClause = sprintf('%%%s%%', $matcher->getSearchTerm());
+			foreach ($fields as $fieldNameAndPath) {
+				if ($this->isSuitableForLike($fieldNameAndPath, $matcher->getSearchTerm())) {
+
+					$dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
+					$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
+
+					if (Tca::table($dataType)->hasField($fieldName) && Tca::table($dataType)->field($fieldName)->hasRelation()) {
+						$foreignTable = Tca::table($dataType)->field($fieldName)->getForeignTable();
+						$fieldNameAndPath = $fieldNameAndPath . '.' . Tca::table($foreignTable)->getLabelField();
+					}
+					$constraints[] = $query->like($fieldNameAndPath, $likeClause);
+				}
+			}
+			$logical = $matcher->getLogicalSeparatorForSearchTerm();
+			$result = $query->$logical($constraints);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * It does not make sense to have a "like" in presence of numerical field, e.g "uid".
+	 * Tell whether the given value makes sense for a "like" clause.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @param string $value
+	 * @return bool
+	 */
+	protected function isSuitableForLike($fieldNameAndPath, $value)
+	{
+		$isSuitable = true;
+
+		// true means it is a string
+		if (!MathUtility::canBeInterpretedAsInteger($value)) {
+
+			$dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
+			$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
+
+			if (Tca::table($dataType)->field($fieldName)->isNumerical()
+				&& !Tca::table($dataType)->field($fieldName)->hasRelation()
+			) {
+				$isSuitable = false;
+			}
+		}
+
+		return $isSuitable;
+	}
+
+	/**
+	 * Computes the constraint for matches and returns it.
+	 *
+	 * @param Query $query
+	 * @param Matcher $matcher
+	 * @param string $operator
+	 * @return ConstraintInterface|null
+	 */
+	protected function computeConstraint(Query $query, Matcher $matcher, $operator)
+	{
+		$result = null;
+
+		$operatorName = ucfirst($operator);
+		$getCriteria = sprintf('get%s', $operatorName);
+		$criteria = $matcher->$getCriteria();
+
+		if (!empty($criteria)) {
+			$constraints = array();
+
+			foreach ($criteria as $criterion) {
+
+				$fieldNameAndPath = $criterion['fieldNameAndPath'];
+				$operand = $criterion['operand'];
+
+				// Compute a few variables...
+				// $dataType is generally equals to $this->dataType but not always... if fieldName is a path.
+				$dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $this->dataType);
+				$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $this->dataType);
+				$fieldPath = $this->getFieldPathResolver()->stripFieldName($fieldNameAndPath, $this->dataType);
+
+				if (Tca::table($dataType)->field($fieldName)->hasRelation()) {
+					if (MathUtility::canBeInterpretedAsInteger($operand)) {
+						$fieldNameAndPath = $fieldName . '.uid';
+					} else {
+						$foreignTableName = Tca::table($dataType)->field($fieldName)->getForeignTable();
+						$foreignTable = Tca::table($foreignTableName);
+						$fieldNameAndPath = $fieldName . '.' . $foreignTable->getLabelField();
+					}
+
+					// If different means we should restore the prepended path segment for proper SQL parser.
+					// This is true for a composite field, e.g items.sys_file_metadata for categories.
+					if ($fieldName !== $fieldPath) {
+						$fieldNameAndPath = $fieldPath . '.' . $fieldNameAndPath;
+					}
+				}
+
+				$constraints[] = $query->$operator($fieldNameAndPath, $criterion['operand']);
+			}
+
+			$getLogicalSeparator = sprintf('getLogicalSeparatorFor%s', $operatorName);
+			$logical = $matcher->$getLogicalSeparator();
+			$result = $query->$logical($constraints);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @return DataHandler
+	 */
+	protected function getDataHandler()
+	{
+		if (!$this->dataHandler) {
+			$this->dataHandler = GeneralUtility::makeInstance(DataHandler::class);
+		}
+		return $this->dataHandler;
+	}
+
+	/**
+	 * Handle the magic call by properly creating a Query object and returning its result.
+	 *
+	 * @param string $propertyName
+	 * @param string $value
+	 * @param string $flag
+	 * @return array
+	 */
+	protected function processMagicCall($propertyName, $value, $flag = '')
+	{
+
+		$fieldName = Property::name($propertyName)->of($this->dataType)->toFieldName();
+
+		/** @var $matcher Matcher */
+		$matcher = GeneralUtility::makeInstance(Matcher::class, array(), $this->getDataType());
+
+		$table = Tca::table($this->dataType);
+		if ($table->field($fieldName)->isGroup()) {
+
+			$valueParts = explode('.', $value, 2);
+			$fieldName = $fieldName . '.' . $valueParts[0];
+			$value = $valueParts[1];
+		}
+
+		$matcher->equals($fieldName, $value);
+
+		if ($flag == 'count') {
+			$result = $this->countBy($matcher);
+		} else {
+			$result = $this->findBy($matcher);
+		}
+		return $flag == 'one' && !empty($result) ? reset($result) : $result;
+	}
+
+	/**
+	 * @return DataHandlerFactory
+	 */
+	protected function getDataHandlerFactory()
+	{
+		return GeneralUtility::makeInstance(DataHandlerFactory::class);
+	}
+
+	/**
+	 * Returns whether the current mode is Backend
+	 *
+	 * @return bool
+	 */
+	protected function isBackendMode()
+	{
+		return TYPO3_MODE == 'BE';
+	}
+
+	/**
+	 * @return FieldPathResolver
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance(FieldPathResolver::class);
+	}
+
+	/**
+	 * @return ObjectManager
+	 */
+	protected function getObjectManager()
+	{
+		return GeneralUtility::makeInstance(ObjectManager::class);
+	}
+
+	/**
+	 * @return ContentValidator
+	 */
+	protected function getContentValidator()
+	{
+		return GeneralUtility::makeInstance(ContentValidator::class);
+	}
+
+	/**
+	 * @return LanguageValidator
+	 */
+	protected function getLanguageValidator()
+	{
+		return GeneralUtility::makeInstance(LanguageValidator::class);
+	}
+
+	/**
+	 * Signal that is called for post-processing the computed constraints object.
+	 *
+	 * @param Query $query
+	 * @param ConstraintInterface|null $constraints
+	 * @return ConstraintInterface|null $constraints
+	 * @signal
+	 */
+	protected function emitPostProcessConstraintsSignal(Query $query, $constraints)
+	{
+		$result = $this->getSignalSlotDispatcher()->dispatch(
+			self::class,
+			'postProcessConstraintsObject',
+			array(
+				$query,
+				$constraints
+			)
+		);
+
+		return $result[1];
+	}
+
+	/**
+	 * @return \TYPO3\CMS\Extbase\SignalSlot\Dispatcher
+	 */
+	protected function getSignalSlotDispatcher()
+	{
+		return $this->getObjectManager()->get(\TYPO3\CMS\Extbase\SignalSlot\Dispatcher::class);
+	}
 
 }

Classes/Service/ContentService.php

Indentation +125 added lines, -125 removed lines

@@ -30,129 +30,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 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 AfterFindContentObjectsSignalArguments $signalArguments */
-        $signalArguments = GeneralUtility::makeInstance(AfterFindContentObjectsSignalArguments::class);
-        $signalArguments->setDataType($this->dataType)
-            ->setContentObjects($contentObjects)
-            ->setMatcher($matcher)
-            ->setOrder($order)
-            ->setLimit($limit)
-            ->setOffset($offset)
-            ->setHasBeenProcessed(FALSE);
-
-        $signalResult = $this->getSignalSlotDispatcher()->dispatch(ContentService::class, 'afterFindContentObjects', array($signalArguments));
-        return $signalResult[0];
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
-
-    /**
-     * Get the SignalSlot dispatcher.
-     *
-     * @return Dispatcher
-     */
-    protected function getSignalSlotDispatcher()
-    {
-        /** @var ObjectManager $objectManager */
-        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
-        return $objectManager->get(Dispatcher::class);
-    }
-
-    /**
-     * @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 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 AfterFindContentObjectsSignalArguments $signalArguments */
+		$signalArguments = GeneralUtility::makeInstance(AfterFindContentObjectsSignalArguments::class);
+		$signalArguments->setDataType($this->dataType)
+			->setContentObjects($contentObjects)
+			->setMatcher($matcher)
+			->setOrder($order)
+			->setLimit($limit)
+			->setOffset($offset)
+			->setHasBeenProcessed(FALSE);
+
+		$signalResult = $this->getSignalSlotDispatcher()->dispatch(ContentService::class, 'afterFindContentObjects', array($signalArguments));
+		return $signalResult[0];
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
+
+	/**
+	 * Get the SignalSlot dispatcher.
+	 *
+	 * @return Dispatcher
+	 */
+	protected function getSignalSlotDispatcher()
+	{
+		/** @var ObjectManager $objectManager */
+		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
+		return $objectManager->get(Dispatcher::class);
+	}
+
+	/**
+	 * @return \Fab\Vidi\Domain\Model\Content[]
+	 */
+	public function getObjects()
+	{
+		return $this->objects;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getNumberOfObjects()
+	{
+		return $this->numberOfObjects;
+	}
 }

Classes/Processor/MarkerProcessor.php

Indentation +109 added lines, -109 removed lines

@@ -26,114 +26,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 ContentObjectResolver
-     */
-    protected function getContentObjectResolver()
-    {
-        return GeneralUtility::makeInstance(ContentObjectResolver::class);
-    }
+	/**
+	 * @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 ContentObjectResolver
+	 */
+	protected function getContentObjectResolver()
+	{
+		return GeneralUtility::makeInstance(ContentObjectResolver::class);
+	}
 
 }

Classes/Persistence/MatcherObjectFactory.php

Indentation +218 added lines, -218 removed lines

@@ -30,222 +30,222 @@
 class MatcherObjectFactory implements SingletonInterface
 {
 
-    /**
-     * Gets a singleton instance of this class.
-     *
-     * @return $this
-     */
-    static public function getInstance()
-    {
-        return GeneralUtility::makeInstance(self::class);
-    }
-
-    /**
-     * Returns a matcher object.
-     *
-     * @param array $matches
-     * @param string $dataType
-     * @return Matcher
-     */
-    public function getMatcher(array $matches = array(), $dataType = '')
-    {
-
-        if (empty($dataType)) {
-            $dataType = $this->getModuleLoader()->getDataType();
-        }
-
-        /** @var $matcher Matcher */
-        $matcher = GeneralUtility::makeInstance(Matcher::class, array(), $dataType);
-
-        $matcher = $this->applyCriteriaFromDataTables($matcher, $dataType);
-        $matcher = $this->applyCriteriaFromMatchesArgument($matcher, $matches);
-
-        if ($this->isBackendMode()) {
-            $matcher = $this->applyCriteriaFromUrl($matcher);
-        }
-
-        // Trigger signal for post processing Matcher Object.
-        $this->emitPostProcessMatcherObjectSignal($matcher);
-
-        return $matcher;
-    }
-
-    /**
-     * Get a possible id from the URL and apply as filter criteria.
-     * Except if the main module belongs to the File. The id would be a combined identifier
-     * including the storage and a mount point.
-     *
-     * @param Matcher $matcher
-     * @return Matcher $matcher
-     */
-    protected function applyCriteriaFromUrl(Matcher $matcher)
-    {
-
-        if (GeneralUtility::_GP('id') && $this->getModuleLoader()->getMainModule() !== ModuleName::FILE) {
-            $matcher->equals('pid', GeneralUtility::_GP('id'));
-        }
-
-        return $matcher;
-    }
-
-    /**
-     * Apply criteria specific to jQuery plugin Datatable.
-     *
-     * @param Matcher $matcher
-     * @param array $matches
-     * @return Matcher $matcher
-     */
-    protected function applyCriteriaFromMatchesArgument(Matcher $matcher, $matches)
-    {
-        foreach ($matches as $fieldNameAndPath => $value) {
-            // CSV values should be considered as "in" operator in Query, otherwise "equals".
-            $explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
-            if (count($explodedValues) > 1) {
-                $matcher->in($fieldNameAndPath, $explodedValues);
-            } else {
-                $matcher->equals($fieldNameAndPath, $explodedValues[0]);
-            }
-        }
-
-        return $matcher;
-    }
-
-    /**
-     * Apply criteria specific to jQuery plugin DataTable.
-     *
-     * @param Matcher $matcher
-     * @param string $dataType
-     * @return Matcher $matcher
-     */
-    protected function applyCriteriaFromDataTables(Matcher $matcher, $dataType)
-    {
-
-        // Special case for Grid in the BE using jQuery DataTables plugin.
-        // Retrieve a possible search term from GP.
-        $query = GeneralUtility::_GP('search');
-        if (is_array($query)) {
-            if (!empty($query['value'])) {
-                $query = $query['value'];
-            } else {
-                $query = '';
-            }
-        }
-
-        if (strlen($query) > 0) {
-
-            // Parse the json query coming from the Visual Search.
-            $query = rawurldecode($query);
-            $queryParts = json_decode($query, TRUE);
-
-            if (is_array($queryParts)) {
-                foreach ($queryParts as $term) {
-                    $fieldNameAndPath = key($term);
-
-                    $resolvedDataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $dataType);
-                    $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $dataType);
-
-                    // Retrieve the value.
-                    $value = current($term);
-
-                    if (Tca::grid($resolvedDataType)->hasFacet($fieldName) && Tca::grid($resolvedDataType)->facet($fieldName)->canModifyMatcher()) {
-                        $matcher = Tca::grid($resolvedDataType)->facet($fieldName)->modifyMatcher($matcher, $value);
-                    } elseif (Tca::table($resolvedDataType)->hasField($fieldName)) {
-                        // Check whether the field exists and set it as "equal" or "like".
-                        if ($this->isOperatorEquals($fieldNameAndPath, $dataType, $value)) {
-                            $matcher->equals($fieldNameAndPath, $value);
-                        } else {
-                            $matcher->like($fieldNameAndPath, $value);
-                        }
-                    } elseif ($fieldNameAndPath === 'text') {
-                        // Special case if field is "text" which is a pseudo field in this case.
-                        // Set the search term which means Vidi will
-                        // search in various fields with operator "like". The fields come from key "searchFields" in the TCA.
-                        $matcher->setSearchTerm($value);
-                    }
-                }
-            } else {
-                $matcher->setSearchTerm($query);
-            }
-        }
-        return $matcher;
-    }
-
-    /**
-     * Tell whether the operator should be equals instead of like for a search, e.g. if the value is numerical.
-     *
-     * @param string $fieldName
-     * @param string $dataType
-     * @param string $value
-     * @return bool
-     */
-    protected function isOperatorEquals($fieldName, $dataType, $value)
-    {
-        return (Tca::table($dataType)->field($fieldName)->hasRelation() && MathUtility::canBeInterpretedAsInteger($value))
-        || Tca::table($dataType)->field($fieldName)->isNumerical();
-    }
-
-    /**
-     * Signal that is called for post-processing a matcher object.
-     *
-     * @param Matcher $matcher
-     * @signal
-     */
-    protected function emitPostProcessMatcherObjectSignal(Matcher $matcher)
-    {
-
-        if (strlen($matcher->getDataType()) <= 0) {
-
-            /** @var ModuleLoader $moduleLoader */
-            $moduleLoader = $this->getObjectManager()->get(ModuleLoader::class);
-            $matcher->setDataType($moduleLoader->getDataType());
-        }
-
-        $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\Controller\Backend\ContentController', 'postProcessMatcherObject', array($matcher, $matcher->getDataType()));
-    }
-
-    /**
-     * Get the SignalSlot dispatcher
-     *
-     * @return Dispatcher
-     */
-    protected function getSignalSlotDispatcher()
-    {
-        return $this->getObjectManager()->get(Dispatcher::class);
-    }
-
-    /**
-     * @return ObjectManager
-     */
-    protected function getObjectManager()
-    {
-        return GeneralUtility::makeInstance(ObjectManager::class);
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
-
-    /**
-     * @return FieldPathResolver
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance(FieldPathResolver::class);
-    }
-
-    /**
-     * Returns whether the current mode is Backend
-     *
-     * @return bool
-     */
-    protected function isBackendMode()
-    {
-        return TYPO3_MODE === 'BE';
-    }
+	/**
+	 * Gets a singleton instance of this class.
+	 *
+	 * @return $this
+	 */
+	static public function getInstance()
+	{
+		return GeneralUtility::makeInstance(self::class);
+	}
+
+	/**
+	 * Returns a matcher object.
+	 *
+	 * @param array $matches
+	 * @param string $dataType
+	 * @return Matcher
+	 */
+	public function getMatcher(array $matches = array(), $dataType = '')
+	{
+
+		if (empty($dataType)) {
+			$dataType = $this->getModuleLoader()->getDataType();
+		}
+
+		/** @var $matcher Matcher */
+		$matcher = GeneralUtility::makeInstance(Matcher::class, array(), $dataType);
+
+		$matcher = $this->applyCriteriaFromDataTables($matcher, $dataType);
+		$matcher = $this->applyCriteriaFromMatchesArgument($matcher, $matches);
+
+		if ($this->isBackendMode()) {
+			$matcher = $this->applyCriteriaFromUrl($matcher);
+		}
+
+		// Trigger signal for post processing Matcher Object.
+		$this->emitPostProcessMatcherObjectSignal($matcher);
+
+		return $matcher;
+	}
+
+	/**
+	 * Get a possible id from the URL and apply as filter criteria.
+	 * Except if the main module belongs to the File. The id would be a combined identifier
+	 * including the storage and a mount point.
+	 *
+	 * @param Matcher $matcher
+	 * @return Matcher $matcher
+	 */
+	protected function applyCriteriaFromUrl(Matcher $matcher)
+	{
+
+		if (GeneralUtility::_GP('id') && $this->getModuleLoader()->getMainModule() !== ModuleName::FILE) {
+			$matcher->equals('pid', GeneralUtility::_GP('id'));
+		}
+
+		return $matcher;
+	}
+
+	/**
+	 * Apply criteria specific to jQuery plugin Datatable.
+	 *
+	 * @param Matcher $matcher
+	 * @param array $matches
+	 * @return Matcher $matcher
+	 */
+	protected function applyCriteriaFromMatchesArgument(Matcher $matcher, $matches)
+	{
+		foreach ($matches as $fieldNameAndPath => $value) {
+			// CSV values should be considered as "in" operator in Query, otherwise "equals".
+			$explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
+			if (count($explodedValues) > 1) {
+				$matcher->in($fieldNameAndPath, $explodedValues);
+			} else {
+				$matcher->equals($fieldNameAndPath, $explodedValues[0]);
+			}
+		}
+
+		return $matcher;
+	}
+
+	/**
+	 * Apply criteria specific to jQuery plugin DataTable.
+	 *
+	 * @param Matcher $matcher
+	 * @param string $dataType
+	 * @return Matcher $matcher
+	 */
+	protected function applyCriteriaFromDataTables(Matcher $matcher, $dataType)
+	{
+
+		// Special case for Grid in the BE using jQuery DataTables plugin.
+		// Retrieve a possible search term from GP.
+		$query = GeneralUtility::_GP('search');
+		if (is_array($query)) {
+			if (!empty($query['value'])) {
+				$query = $query['value'];
+			} else {
+				$query = '';
+			}
+		}
+
+		if (strlen($query) > 0) {
+
+			// Parse the json query coming from the Visual Search.
+			$query = rawurldecode($query);
+			$queryParts = json_decode($query, TRUE);
+
+			if (is_array($queryParts)) {
+				foreach ($queryParts as $term) {
+					$fieldNameAndPath = key($term);
+
+					$resolvedDataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $dataType);
+					$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $dataType);
+
+					// Retrieve the value.
+					$value = current($term);
+
+					if (Tca::grid($resolvedDataType)->hasFacet($fieldName) && Tca::grid($resolvedDataType)->facet($fieldName)->canModifyMatcher()) {
+						$matcher = Tca::grid($resolvedDataType)->facet($fieldName)->modifyMatcher($matcher, $value);
+					} elseif (Tca::table($resolvedDataType)->hasField($fieldName)) {
+						// Check whether the field exists and set it as "equal" or "like".
+						if ($this->isOperatorEquals($fieldNameAndPath, $dataType, $value)) {
+							$matcher->equals($fieldNameAndPath, $value);
+						} else {
+							$matcher->like($fieldNameAndPath, $value);
+						}
+					} elseif ($fieldNameAndPath === 'text') {
+						// Special case if field is "text" which is a pseudo field in this case.
+						// Set the search term which means Vidi will
+						// search in various fields with operator "like". The fields come from key "searchFields" in the TCA.
+						$matcher->setSearchTerm($value);
+					}
+				}
+			} else {
+				$matcher->setSearchTerm($query);
+			}
+		}
+		return $matcher;
+	}
+
+	/**
+	 * Tell whether the operator should be equals instead of like for a search, e.g. if the value is numerical.
+	 *
+	 * @param string $fieldName
+	 * @param string $dataType
+	 * @param string $value
+	 * @return bool
+	 */
+	protected function isOperatorEquals($fieldName, $dataType, $value)
+	{
+		return (Tca::table($dataType)->field($fieldName)->hasRelation() && MathUtility::canBeInterpretedAsInteger($value))
+		|| Tca::table($dataType)->field($fieldName)->isNumerical();
+	}
+
+	/**
+	 * Signal that is called for post-processing a matcher object.
+	 *
+	 * @param Matcher $matcher
+	 * @signal
+	 */
+	protected function emitPostProcessMatcherObjectSignal(Matcher $matcher)
+	{
+
+		if (strlen($matcher->getDataType()) <= 0) {
+
+			/** @var ModuleLoader $moduleLoader */
+			$moduleLoader = $this->getObjectManager()->get(ModuleLoader::class);
+			$matcher->setDataType($moduleLoader->getDataType());
+		}
+
+		$this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\Controller\Backend\ContentController', 'postProcessMatcherObject', array($matcher, $matcher->getDataType()));
+	}
+
+	/**
+	 * Get the SignalSlot dispatcher
+	 *
+	 * @return Dispatcher
+	 */
+	protected function getSignalSlotDispatcher()
+	{
+		return $this->getObjectManager()->get(Dispatcher::class);
+	}
+
+	/**
+	 * @return ObjectManager
+	 */
+	protected function getObjectManager()
+	{
+		return GeneralUtility::makeInstance(ObjectManager::class);
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
+
+	/**
+	 * @return FieldPathResolver
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance(FieldPathResolver::class);
+	}
+
+	/**
+	 * Returns whether the current mode is Backend
+	 *
+	 * @return bool
+	 */
+	protected function isBackendMode()
+	{
+		return TYPO3_MODE === 'BE';
+	}
 }

Classes/ViewHelpers/Result/ToXmlViewHelper.php

Indentation +104 added lines, -104 removed lines

@@ -22,118 +22,118 @@
 class ToXmlViewHelper extends AbstractToFormatViewHelper
 {
 
-    /**
-     * Render an XML export.
-     *
-     * @return boolean
-     */
-    public function render()
-    {
-
-        $objects = $this->templateVariableContainer->get('objects');
-
-        // Make sure we have something to process...
-        if (!empty($objects)) {
-
-            // Initialization step.
-            $this->initializeEnvironment($objects);
-            $this->exportFileNameAndPath .= '.xml'; // add extension to the file.
-
-            // Write the exported data to a XML file.
-            $this->writeXmlFile($objects);
-
-            // We must generate a zip archive since there are files included.
-            if ($this->hasCollectedFiles()) {
-
-                $this->writeZipFile();
-                $this->sendZipHttpHeaders();
-
-                readfile($this->zipFileNameAndPath);
-            } else {
-                $this->sendXmlHttpHeaders();
-                readfile($this->exportFileNameAndPath);
-            }
-
-            GeneralUtility::rmdir($this->temporaryDirectory, TRUE);
-        }
-    }
-
-    /**
-     * Write the XML file to a temporary location.
-     *
-     * @param array $objects
-     * @return void
-     */
-    protected function writeXmlFile(array $objects)
-    {
-
-        // Get first object of $objects to check whether it contains possible files to include.
-        /** @var \Fab\Vidi\Domain\Model\Content $object */
-        $object = reset($objects);
-        $this->checkWhetherObjectMayIncludeFiles($object);
-
-        $items = array();
-        foreach ($objects as $object) {
-            if ($this->hasFileFields()) {
-                $this->collectFiles($object);
-            }
-            $items[] = $object->toValues();
-        }
-
-        $xml = new \SimpleXMLElement('<items/>');
-        $xml = $this->arrayToXml($items, $xml);
-        file_put_contents($this->exportFileNameAndPath, $this->formatXml($xml->asXML()));
-    }
-
-    /*
+	/**
+	 * Render an XML export.
+	 *
+	 * @return boolean
+	 */
+	public function render()
+	{
+
+		$objects = $this->templateVariableContainer->get('objects');
+
+		// Make sure we have something to process...
+		if (!empty($objects)) {
+
+			// Initialization step.
+			$this->initializeEnvironment($objects);
+			$this->exportFileNameAndPath .= '.xml'; // add extension to the file.
+
+			// Write the exported data to a XML file.
+			$this->writeXmlFile($objects);
+
+			// We must generate a zip archive since there are files included.
+			if ($this->hasCollectedFiles()) {
+
+				$this->writeZipFile();
+				$this->sendZipHttpHeaders();
+
+				readfile($this->zipFileNameAndPath);
+			} else {
+				$this->sendXmlHttpHeaders();
+				readfile($this->exportFileNameAndPath);
+			}
+
+			GeneralUtility::rmdir($this->temporaryDirectory, TRUE);
+		}
+	}
+
+	/**
+	 * Write the XML file to a temporary location.
+	 *
+	 * @param array $objects
+	 * @return void
+	 */
+	protected function writeXmlFile(array $objects)
+	{
+
+		// Get first object of $objects to check whether it contains possible files to include.
+		/** @var \Fab\Vidi\Domain\Model\Content $object */
+		$object = reset($objects);
+		$this->checkWhetherObjectMayIncludeFiles($object);
+
+		$items = array();
+		foreach ($objects as $object) {
+			if ($this->hasFileFields()) {
+				$this->collectFiles($object);
+			}
+			$items[] = $object->toValues();
+		}
+
+		$xml = new \SimpleXMLElement('<items/>');
+		$xml = $this->arrayToXml($items, $xml);
+		file_put_contents($this->exportFileNameAndPath, $this->formatXml($xml->asXML()));
+	}
+
+	/*
      * Convert an array to xml
      *
      * @return \SimpleXMLElement
      */
-    protected function arrayToXml($array, \SimpleXMLElement $xml)
-    {
-        foreach ($array as $key => $value) {
-            if (is_array($value)) {
-                $key = is_numeric($key) ? 'item' : $key;
-                $subNode = $xml->addChild($key);
-                $this->arrayToXml($value, $subNode);
-            } else {
-                $key = is_numeric($key) ? 'item' : $key;
-                $xml->addChild($key, "$value");
-            }
-        }
-        return $xml;
-    }
-
-    /*
+	protected function arrayToXml($array, \SimpleXMLElement $xml)
+	{
+		foreach ($array as $key => $value) {
+			if (is_array($value)) {
+				$key = is_numeric($key) ? 'item' : $key;
+				$subNode = $xml->addChild($key);
+				$this->arrayToXml($value, $subNode);
+			} else {
+				$key = is_numeric($key) ? 'item' : $key;
+				$xml->addChild($key, "$value");
+			}
+		}
+		return $xml;
+	}
+
+	/*
      * Format the XML so that is looks human friendly.
      *
      * @param string $xml
      * @return string
      */
-    protected function formatXml($xml)
-    {
-        $dom = new \DOMDocument("1.0");
-        $dom->preserveWhiteSpace = false;
-        $dom->formatOutput = true;
-        $dom->loadXML($xml);
-        return $dom->saveXML();
-    }
-
-    /**
-     * @return void
-     */
-    protected function sendXmlHttpHeaders()
-    {
-
-        /** @var \TYPO3\CMS\Extbase\Mvc\Web\Response $response */
-        $response = $this->templateVariableContainer->get('response');
-        $response->setHeader('Content-Type', 'application/xml');
-        $response->setHeader('Content-Disposition', 'attachment; filename="' . basename($this->exportFileNameAndPath) . '"');
-        $response->setHeader('Content-Length', filesize($this->exportFileNameAndPath));
-        $response->setHeader('Content-Description', 'File Transfer');
-
-        $response->sendHeaders();
-    }
+	protected function formatXml($xml)
+	{
+		$dom = new \DOMDocument("1.0");
+		$dom->preserveWhiteSpace = false;
+		$dom->formatOutput = true;
+		$dom->loadXML($xml);
+		return $dom->saveXML();
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function sendXmlHttpHeaders()
+	{
+
+		/** @var \TYPO3\CMS\Extbase\Mvc\Web\Response $response */
+		$response = $this->templateVariableContainer->get('response');
+		$response->setHeader('Content-Type', 'application/xml');
+		$response->setHeader('Content-Disposition', 'attachment; filename="' . basename($this->exportFileNameAndPath) . '"');
+		$response->setHeader('Content-Length', filesize($this->exportFileNameAndPath));
+		$response->setHeader('Content-Description', 'File Transfer');
+
+		$response->sendHeaders();
+	}
 
 }

Classes/ViewHelpers/Result/ToCsvViewHelper.php

Indentation +91 added lines, -91 removed lines

@@ -22,96 +22,96 @@
 class ToCsvViewHelper extends AbstractToFormatViewHelper
 {
 
-    /**
-     * Render a CSV export request.
-     *
-     * @return boolean
-     */
-    public function render()
-    {
-
-        $objects = $this->templateVariableContainer->get('objects');
-
-        // Make sure we have something to process...
-        if (!empty($objects)) {
-
-            // Initialization step.
-            $this->initializeEnvironment($objects);
-            $this->exportFileNameAndPath .= '.csv'; // add extension to the file.
-
-            // Write the exported data to a CSV file.
-            $this->writeCsvFile($objects);
-
-            // We must generate a zip archive since there are files included.
-            if ($this->hasCollectedFiles()) {
-
-                $this->writeZipFile();
-                $this->sendZipHttpHeaders();
-
-                readfile($this->zipFileNameAndPath);
-            } else {
-                $this->sendCsvHttpHeaders();
-                readfile($this->exportFileNameAndPath);
-            }
-
-            GeneralUtility::rmdir($this->temporaryDirectory, TRUE);
-        }
-    }
-
-    /**
-     * Write the CSV file to a temporary location.
-     *
-     * @param array $objects
-     * @return void
-     */
-    protected function writeCsvFile(array $objects)
-    {
-
-        // Create a file pointer
-        $output = fopen($this->exportFileNameAndPath, 'w');
-
-        // Handle CSV header, get the first object and get the list of fields.
-        /** @var \Fab\Vidi\Domain\Model\Content $object */
-        $object = reset($objects);
-        fputcsv($output, $object->toFields());
-        $this->checkWhetherObjectMayIncludeFiles($object);
-
-        foreach ($objects as $object) {
-            if ($this->hasFileFields()) {
-                $this->collectFiles($object);
-            }
-
-            // Make sure we have a flat array of values for the CSV purpose.
-            $flattenValues = array();
-            foreach ($object->toValues() as $fieldName => $value) {
-                if (is_array($value)) {
-                    $flattenValues[$fieldName] = implode(', ', $value);
-                } else {
-                    $flattenValues[$fieldName] = str_replace("\n", "\r", $value); // for Excel purpose.
-                }
-            }
-
-            fputcsv($output, $flattenValues);
-        }
-
-        // close file handler
-        fclose($output);
-    }
-
-    /**
-     * @return void
-     */
-    protected function sendCsvHttpHeaders()
-    {
-
-        /** @var \TYPO3\CMS\Extbase\Mvc\Web\Response $response */
-        $response = $this->templateVariableContainer->get('response');
-        $response->setHeader('Content-Type', 'application/csv');
-        $response->setHeader('Content-Disposition', 'attachment; filename="' . basename($this->exportFileNameAndPath) . '"');
-        $response->setHeader('Content-Length', filesize($this->exportFileNameAndPath));
-        $response->setHeader('Content-Description', 'File Transfer');
-
-        $response->sendHeaders();
-    }
+	/**
+	 * Render a CSV export request.
+	 *
+	 * @return boolean
+	 */
+	public function render()
+	{
+
+		$objects = $this->templateVariableContainer->get('objects');
+
+		// Make sure we have something to process...
+		if (!empty($objects)) {
+
+			// Initialization step.
+			$this->initializeEnvironment($objects);
+			$this->exportFileNameAndPath .= '.csv'; // add extension to the file.
+
+			// Write the exported data to a CSV file.
+			$this->writeCsvFile($objects);
+
+			// We must generate a zip archive since there are files included.
+			if ($this->hasCollectedFiles()) {
+
+				$this->writeZipFile();
+				$this->sendZipHttpHeaders();
+
+				readfile($this->zipFileNameAndPath);
+			} else {
+				$this->sendCsvHttpHeaders();
+				readfile($this->exportFileNameAndPath);
+			}
+
+			GeneralUtility::rmdir($this->temporaryDirectory, TRUE);
+		}
+	}
+
+	/**
+	 * Write the CSV file to a temporary location.
+	 *
+	 * @param array $objects
+	 * @return void
+	 */
+	protected function writeCsvFile(array $objects)
+	{
+
+		// Create a file pointer
+		$output = fopen($this->exportFileNameAndPath, 'w');
+
+		// Handle CSV header, get the first object and get the list of fields.
+		/** @var \Fab\Vidi\Domain\Model\Content $object */
+		$object = reset($objects);
+		fputcsv($output, $object->toFields());
+		$this->checkWhetherObjectMayIncludeFiles($object);
+
+		foreach ($objects as $object) {
+			if ($this->hasFileFields()) {
+				$this->collectFiles($object);
+			}
+
+			// Make sure we have a flat array of values for the CSV purpose.
+			$flattenValues = array();
+			foreach ($object->toValues() as $fieldName => $value) {
+				if (is_array($value)) {
+					$flattenValues[$fieldName] = implode(', ', $value);
+				} else {
+					$flattenValues[$fieldName] = str_replace("\n", "\r", $value); // for Excel purpose.
+				}
+			}
+
+			fputcsv($output, $flattenValues);
+		}
+
+		// close file handler
+		fclose($output);
+	}
+
+	/**
+	 * @return void
+	 */
+	protected function sendCsvHttpHeaders()
+	{
+
+		/** @var \TYPO3\CMS\Extbase\Mvc\Web\Response $response */
+		$response = $this->templateVariableContainer->get('response');
+		$response->setHeader('Content-Type', 'application/csv');
+		$response->setHeader('Content-Disposition', 'attachment; filename="' . basename($this->exportFileNameAndPath) . '"');
+		$response->setHeader('Content-Length', filesize($this->exportFileNameAndPath));
+		$response->setHeader('Content-Description', 'File Transfer');
+
+		$response->sendHeaders();
+	}
 
 }

Classes/ViewHelpers/Content/AbstractContentViewHelper.php

Indentation +210 added lines, -210 removed lines

@@ -31,215 +31,215 @@
 abstract class AbstractContentViewHelper extends AbstractViewHelper
 {
 
-    /**
-     * @return void
-     */
-    public function initializeArguments()
-    {
-        $this->registerArgument('type', 'string', 'Corresponds to the type of data to be fetched. It will basically be a table name e.g. fe_users.', FALSE, '');
-        $this->registerArgument('matches', 'array', 'Key / value array to be used as filter. The key corresponds to a field name.', FALSE, array());
-        $this->registerArgument('selection', 'int', 'A possible selection defined in the BE and stored in the database.', FALSE, 0);
-        $this->registerArgument('ignoreEnableFields', 'bool', 'Whether to ignore enable fields or not (AKA hidden, deleted, starttime, ...).', FALSE, FALSE);
-        $this->registerArgument('aliases', 'array', 'Attribute "matches" does not support certain character such as "." in field name. Use this to create aliases.', FALSE, array());
-    }
-
-    /**
-     * Generate a signature to be used for storing the result set.
-     *
-     * @param string $dataType
-     * @param array $matches
-     * @param array $orderings
-     * @param $limit
-     * @param $offset
-     * @return string
-     */
-    protected function getQuerySignature($dataType, array $matches, array $orderings, $limit, $offset)
-    {
-        $serializedMatches = serialize($matches);
-        $serializedOrderings = serialize($orderings);
-        return md5($dataType . $serializedMatches . $serializedOrderings . $limit . $offset);
-    }
-
-    /**
-     * Returns a matcher object.
-     *
-     * @param string $dataType
-     * @param array $matches
-     * @return Matcher
-     */
-    protected function getMatcher($dataType, $matches = array())
-    {
-
-        /** @var $matcher Matcher */
-        $matcher = GeneralUtility::makeInstance('Fab\Vidi\Persistence\Matcher', array(), $dataType);
-
-        // @todo implement advanced selection parsing {or: {usergroup.title: {like: foo}}, {tstamp: {greaterThan: 1234}}}
-        foreach ($matches as $fieldNameAndPath => $value) {
-
-            // CSV values should be considered as "in" operator in Query, otherwise "equals".
-            $explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
-
-            // The matching value contains a "1,2" as example
-            if (count($explodedValues) > 1) {
-
-                $resolvedDataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $dataType);
-                $resolvedFieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $dataType);
-
-                // "equals" if in presence of a relation.
-                // "in" if not a relation.
-                if (Tca::table($resolvedDataType)->field($resolvedFieldName)->hasRelation()) {
-                    foreach ($explodedValues as $explodedValue) {
-                        $matcher->equals($fieldNameAndPath, $explodedValue);
-                    }
-                } else {
-                    $matcher->in($fieldNameAndPath, $explodedValues);
-                }
-            } else {
-                $matcher->equals($fieldNameAndPath, $explodedValues[0]);
-            }
-        }
-
-        // Trigger signal for post processing Matcher Object.
-        $this->emitPostProcessMatcherObjectSignal($matcher->getDataType(), $matcher);
-
-        return $matcher;
-    }
-
-    /**
-     * Replace possible aliases.
-     *
-     * @param array $values
-     * @return array
-     */
-    protected function replacesAliases(array $values)
-    {
-
-        $aliases = $this->arguments['aliases'];
-
-        foreach ($aliases as $aliasName => $aliasValue) {
-            if (isset($values[$aliasName])) {
-                $values[$aliasValue] = $values[$aliasName];
-                unset($values[$aliasName]); // remove the alias.
-            }
-        }
-
-        return $values;
-    }
-
-    /**
-     * Returns an order object.
-     *
-     * @param string $dataType
-     * @param array $order
-     * @return Order
-     */
-    public function getOrder($dataType, array $order = array())
-    {
-        // Default orderings in case order is empty.
-        if (empty($order)) {
-            $order = Tca::table($dataType)->getDefaultOrderings();
-        }
-
-        $order = GeneralUtility::makeInstance(Order::class, $order);
-
-        // Trigger signal for post processing Order Object.
-        $this->emitPostProcessOrderObjectSignal($dataType, $order);
-
-        return $order;
-    }
-
-    /**
-     * @return ResultSetStorage
-     */
-    public function getResultSetStorage()
-    {
-        return GeneralUtility::makeInstance(ResultSetStorage::class);
-    }
-
-    /**
-     * Signal that is called for post-processing a "order" object.
-     *
-     * @param string $dataType
-     * @param Order $order
-     * @signal
-     */
-    protected function emitPostProcessOrderObjectSignal($dataType, Order $order)
-    {
-        $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessOrderObject', array($order, $dataType));
-    }
-
-    /**
-     * Signal that is called for post-processing a "matcher" object.
-     *
-     * @param string $dataType
-     * @param Matcher $matcher
-     * @signal
-     */
-    protected function emitPostProcessMatcherObjectSignal($dataType, Matcher $matcher)
-    {
-        $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessMatcherObject', array($matcher, $dataType));
-    }
-
-    /**
-     * Signal that is called for post-processing a "limit".
-     *
-     * @param string $dataType
-     * @param int $limit
-     * @signal
-     */
-    protected function emitPostProcessLimitSignal($dataType, $limit)
-    {
-        $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessLimit', array($limit, $dataType));
-    }
-
-    /**
-     * Signal that is called for post-processing a "offset".
-     *
-     * @param string $dataType
-     * @param int $offset
-     * @signal
-     */
-    protected function emitPostProcessOffsetSignal($dataType, $offset)
-    {
-        $this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessLimit', array($offset, $dataType));
-    }
-
-    /**
-     * Get the SignalSlot dispatcher
-     *
-     * @return Dispatcher
-     */
-    protected function getSignalSlotDispatcher()
-    {
-        return $this->getObjectManager()->get(Dispatcher::class);
-    }
-
-    /**
-     * @return ObjectManager
-     */
-    protected function getObjectManager()
-    {
-        return GeneralUtility::makeInstance(ObjectManager::class);
-    }
-
-    /**
-     * @param $ignoreEnableFields
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
-     */
-    protected function getDefaultQuerySettings($ignoreEnableFields)
-    {
-        /** @var QuerySettings $defaultQuerySettings */
-        $defaultQuerySettings = GeneralUtility::makeInstance(QuerySettings::class);
-        $defaultQuerySettings->setIgnoreEnableFields($ignoreEnableFields);
-        return $defaultQuerySettings;
-    }
-
-    /**
-     * @return FieldPathResolver
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance(FieldPathResolver::class);
-    }
+	/**
+	 * @return void
+	 */
+	public function initializeArguments()
+	{
+		$this->registerArgument('type', 'string', 'Corresponds to the type of data to be fetched. It will basically be a table name e.g. fe_users.', FALSE, '');
+		$this->registerArgument('matches', 'array', 'Key / value array to be used as filter. The key corresponds to a field name.', FALSE, array());
+		$this->registerArgument('selection', 'int', 'A possible selection defined in the BE and stored in the database.', FALSE, 0);
+		$this->registerArgument('ignoreEnableFields', 'bool', 'Whether to ignore enable fields or not (AKA hidden, deleted, starttime, ...).', FALSE, FALSE);
+		$this->registerArgument('aliases', 'array', 'Attribute "matches" does not support certain character such as "." in field name. Use this to create aliases.', FALSE, array());
+	}
+
+	/**
+	 * Generate a signature to be used for storing the result set.
+	 *
+	 * @param string $dataType
+	 * @param array $matches
+	 * @param array $orderings
+	 * @param $limit
+	 * @param $offset
+	 * @return string
+	 */
+	protected function getQuerySignature($dataType, array $matches, array $orderings, $limit, $offset)
+	{
+		$serializedMatches = serialize($matches);
+		$serializedOrderings = serialize($orderings);
+		return md5($dataType . $serializedMatches . $serializedOrderings . $limit . $offset);
+	}
+
+	/**
+	 * Returns a matcher object.
+	 *
+	 * @param string $dataType
+	 * @param array $matches
+	 * @return Matcher
+	 */
+	protected function getMatcher($dataType, $matches = array())
+	{
+
+		/** @var $matcher Matcher */
+		$matcher = GeneralUtility::makeInstance('Fab\Vidi\Persistence\Matcher', array(), $dataType);
+
+		// @todo implement advanced selection parsing {or: {usergroup.title: {like: foo}}, {tstamp: {greaterThan: 1234}}}
+		foreach ($matches as $fieldNameAndPath => $value) {
+
+			// CSV values should be considered as "in" operator in Query, otherwise "equals".
+			$explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
+
+			// The matching value contains a "1,2" as example
+			if (count($explodedValues) > 1) {
+
+				$resolvedDataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath, $dataType);
+				$resolvedFieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath, $dataType);
+
+				// "equals" if in presence of a relation.
+				// "in" if not a relation.
+				if (Tca::table($resolvedDataType)->field($resolvedFieldName)->hasRelation()) {
+					foreach ($explodedValues as $explodedValue) {
+						$matcher->equals($fieldNameAndPath, $explodedValue);
+					}
+				} else {
+					$matcher->in($fieldNameAndPath, $explodedValues);
+				}
+			} else {
+				$matcher->equals($fieldNameAndPath, $explodedValues[0]);
+			}
+		}
+
+		// Trigger signal for post processing Matcher Object.
+		$this->emitPostProcessMatcherObjectSignal($matcher->getDataType(), $matcher);
+
+		return $matcher;
+	}
+
+	/**
+	 * Replace possible aliases.
+	 *
+	 * @param array $values
+	 * @return array
+	 */
+	protected function replacesAliases(array $values)
+	{
+
+		$aliases = $this->arguments['aliases'];
+
+		foreach ($aliases as $aliasName => $aliasValue) {
+			if (isset($values[$aliasName])) {
+				$values[$aliasValue] = $values[$aliasName];
+				unset($values[$aliasName]); // remove the alias.
+			}
+		}
+
+		return $values;
+	}
+
+	/**
+	 * Returns an order object.
+	 *
+	 * @param string $dataType
+	 * @param array $order
+	 * @return Order
+	 */
+	public function getOrder($dataType, array $order = array())
+	{
+		// Default orderings in case order is empty.
+		if (empty($order)) {
+			$order = Tca::table($dataType)->getDefaultOrderings();
+		}
+
+		$order = GeneralUtility::makeInstance(Order::class, $order);
+
+		// Trigger signal for post processing Order Object.
+		$this->emitPostProcessOrderObjectSignal($dataType, $order);
+
+		return $order;
+	}
+
+	/**
+	 * @return ResultSetStorage
+	 */
+	public function getResultSetStorage()
+	{
+		return GeneralUtility::makeInstance(ResultSetStorage::class);
+	}
+
+	/**
+	 * Signal that is called for post-processing a "order" object.
+	 *
+	 * @param string $dataType
+	 * @param Order $order
+	 * @signal
+	 */
+	protected function emitPostProcessOrderObjectSignal($dataType, Order $order)
+	{
+		$this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessOrderObject', array($order, $dataType));
+	}
+
+	/**
+	 * Signal that is called for post-processing a "matcher" object.
+	 *
+	 * @param string $dataType
+	 * @param Matcher $matcher
+	 * @signal
+	 */
+	protected function emitPostProcessMatcherObjectSignal($dataType, Matcher $matcher)
+	{
+		$this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessMatcherObject', array($matcher, $dataType));
+	}
+
+	/**
+	 * Signal that is called for post-processing a "limit".
+	 *
+	 * @param string $dataType
+	 * @param int $limit
+	 * @signal
+	 */
+	protected function emitPostProcessLimitSignal($dataType, $limit)
+	{
+		$this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessLimit', array($limit, $dataType));
+	}
+
+	/**
+	 * Signal that is called for post-processing a "offset".
+	 *
+	 * @param string $dataType
+	 * @param int $offset
+	 * @signal
+	 */
+	protected function emitPostProcessOffsetSignal($dataType, $offset)
+	{
+		$this->getSignalSlotDispatcher()->dispatch('Fab\Vidi\ViewHelper\Content\AbstractContentViewHelper', 'postProcessLimit', array($offset, $dataType));
+	}
+
+	/**
+	 * Get the SignalSlot dispatcher
+	 *
+	 * @return Dispatcher
+	 */
+	protected function getSignalSlotDispatcher()
+	{
+		return $this->getObjectManager()->get(Dispatcher::class);
+	}
+
+	/**
+	 * @return ObjectManager
+	 */
+	protected function getObjectManager()
+	{
+		return GeneralUtility::makeInstance(ObjectManager::class);
+	}
+
+	/**
+	 * @param $ignoreEnableFields
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface
+	 */
+	protected function getDefaultQuerySettings($ignoreEnableFields)
+	{
+		/** @var QuerySettings $defaultQuerySettings */
+		$defaultQuerySettings = GeneralUtility::makeInstance(QuerySettings::class);
+		$defaultQuerySettings->setIgnoreEnableFields($ignoreEnableFields);
+		return $defaultQuerySettings;
+	}
+
+	/**
+	 * @return FieldPathResolver
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance(FieldPathResolver::class);
+	}
 
 }

Classes/Resolver/FieldPathResolver.php

Indentation +107 added lines, -107 removed lines

@@ -25,111 +25,111 @@
 class FieldPathResolver implements SingletonInterface
 {
 
-    /**
-     * Remove the prefixing path from the file name.
-     *
-     * @param string $fieldNameAndPath
-     * @param string $dataType
-     * @return string
-     */
-    public function stripFieldPath($fieldNameAndPath, $dataType = '')
-    {
-
-        $dataType = $this->getContextualDataType($dataType);
-
-        if ($this->containsPath($fieldNameAndPath, $dataType)) {
-
-            // Corresponds to the field name of the foreign table.
-            $fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
-            $fieldName = $fieldParts[1];
-        } else {
-            $fieldName = $fieldNameAndPath;
-        }
-        return $fieldName;
-    }
-
-    /**
-     * Remove the suffixing field name
-     *
-     * @param string $fieldNameAndPath
-     * @param string $dataType
-     * @return string
-     */
-    public function stripFieldName($fieldNameAndPath, $dataType = '')
-    {
-
-        $dataType = $this->getContextualDataType($dataType);
-
-        if ($this->containsPath($fieldNameAndPath, $dataType)) {
-
-            // Corresponds to the field name of the foreign table.
-            $fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
-            $fieldName = $fieldParts[0];
-        } else {
-            $fieldName = $fieldNameAndPath;
-        }
-        return $fieldName;
-    }
-
-    /**
-     * Returns the class names to be applied to a cell ("td").
-     *
-     * @param string $fieldNameAndPath
-     * @param string $dataType
-     * @return string
-     */
-    public function getDataType($fieldNameAndPath, $dataType = '')
-    {
-
-        $dataType = $this->getContextualDataType($dataType);
-
-        if ($this->containsPath($fieldNameAndPath, $dataType)) {
-
-            // Compute the foreign data type.
-            $fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
-            $fieldNameAndPath = $fieldParts[0];
-            $dataType = Tca::table($dataType)->field($fieldNameAndPath)->getForeignTable();
-        }
-        return $dataType;
-    }
-
-    /**
-     * Return the data type according to the context.
-     *
-     * @param $dataType
-     * @return string
-     */
-    public function getContextualDataType($dataType)
-    {
-
-        if (!$dataType) {
-            $dataType = $this->getModuleLoader()->getDataType();
-        }
-        return $dataType;
-    }
-
-    /**
-     * Tell whether the field name contains a path, e.g. metadata.title
-     * But resolves the case when the field is composite e.g "items.sys_file_metadata" and looks as field path but is not!
-     * A composite field = a field for a MM relation  of type "group" where the table name is appended.
-     *
-     * @param string $fieldNameAndPath
-     * @param string $dataType
-     * @return boolean
-     */
-    public function containsPath($fieldNameAndPath, $dataType)
-    {
-        $doesContainPath = strpos($fieldNameAndPath, '.') > 0 && !Tca::table($dataType)->hasField($fieldNameAndPath); // -> will make sure it is not a composite field name.
-        return $doesContainPath;
-    }
-
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return ModuleLoader
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(ModuleLoader::class);
-    }
+	/**
+	 * Remove the prefixing path from the file name.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @param string $dataType
+	 * @return string
+	 */
+	public function stripFieldPath($fieldNameAndPath, $dataType = '')
+	{
+
+		$dataType = $this->getContextualDataType($dataType);
+
+		if ($this->containsPath($fieldNameAndPath, $dataType)) {
+
+			// Corresponds to the field name of the foreign table.
+			$fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
+			$fieldName = $fieldParts[1];
+		} else {
+			$fieldName = $fieldNameAndPath;
+		}
+		return $fieldName;
+	}
+
+	/**
+	 * Remove the suffixing field name
+	 *
+	 * @param string $fieldNameAndPath
+	 * @param string $dataType
+	 * @return string
+	 */
+	public function stripFieldName($fieldNameAndPath, $dataType = '')
+	{
+
+		$dataType = $this->getContextualDataType($dataType);
+
+		if ($this->containsPath($fieldNameAndPath, $dataType)) {
+
+			// Corresponds to the field name of the foreign table.
+			$fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
+			$fieldName = $fieldParts[0];
+		} else {
+			$fieldName = $fieldNameAndPath;
+		}
+		return $fieldName;
+	}
+
+	/**
+	 * Returns the class names to be applied to a cell ("td").
+	 *
+	 * @param string $fieldNameAndPath
+	 * @param string $dataType
+	 * @return string
+	 */
+	public function getDataType($fieldNameAndPath, $dataType = '')
+	{
+
+		$dataType = $this->getContextualDataType($dataType);
+
+		if ($this->containsPath($fieldNameAndPath, $dataType)) {
+
+			// Compute the foreign data type.
+			$fieldParts = GeneralUtility::trimExplode('.', $fieldNameAndPath);
+			$fieldNameAndPath = $fieldParts[0];
+			$dataType = Tca::table($dataType)->field($fieldNameAndPath)->getForeignTable();
+		}
+		return $dataType;
+	}
+
+	/**
+	 * Return the data type according to the context.
+	 *
+	 * @param $dataType
+	 * @return string
+	 */
+	public function getContextualDataType($dataType)
+	{
+
+		if (!$dataType) {
+			$dataType = $this->getModuleLoader()->getDataType();
+		}
+		return $dataType;
+	}
+
+	/**
+	 * Tell whether the field name contains a path, e.g. metadata.title
+	 * But resolves the case when the field is composite e.g "items.sys_file_metadata" and looks as field path but is not!
+	 * A composite field = a field for a MM relation  of type "group" where the table name is appended.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @param string $dataType
+	 * @return boolean
+	 */
+	public function containsPath($fieldNameAndPath, $dataType)
+	{
+		$doesContainPath = strpos($fieldNameAndPath, '.') > 0 && !Tca::table($dataType)->hasField($fieldNameAndPath); // -> will make sure it is not a composite field name.
+		return $doesContainPath;
+	}
+
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return ModuleLoader
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(ModuleLoader::class);
+	}
 }

Classes/Tca/GridService.php

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