fabarea / vidi

Classes/ViewHelpers/Grid/Column/ConfigurationViewHelper.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
             // -------------------
             // mData: internal name of DataTable plugin and can not contains a path, e.g. metadata.title
             // columnName: whole field name with path
-            $output .= sprintf('Vidi._columns.push({ "data": "%s", "sortable": %s, "visible": %s, "width": "%s", "class": "%s", "columnName": "%s" });' . PHP_EOL,
+            $output .= sprintf('Vidi._columns.push({ "data": "%s", "sortable": %s, "visible": %s, "width": "%s", "class": "%s", "columnName": "%s" });'.PHP_EOL,
                 $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath), // Suitable field name for the DataTable plugin.
                 Tca::grid()->isSortable($fieldNameAndPath) ? 'true' : 'false',
                 Tca::grid()->isVisible($fieldNameAndPath) ? 'true' : 'false',

Indentation +55 added lines, -55 removed lines

@@ -19,67 +19,67 @@
 class ConfigurationViewHelper extends AbstractViewHelper
 {
 
-    /**
-     * Render the columns of the grid.
-     *
-     * @throws NotExistingFieldException
-     * @return string
-     */
-    public function render()
-    {
-        $output = '';
+	/**
+	 * Render the columns of the grid.
+	 *
+	 * @throws NotExistingFieldException
+	 * @return string
+	 */
+	public function render()
+	{
+		$output = '';
 
-        foreach (Tca::grid()->getFields() as $fieldNameAndPath => $configuration) {
+		foreach (Tca::grid()->getFields() as $fieldNameAndPath => $configuration) {
 
-            // Early failure if field does not exist.
-            if (!$this->isAllowed($fieldNameAndPath)) {
-                $message = sprintf('Property "%s" does not exist!', $fieldNameAndPath);
-                throw new NotExistingFieldException($message, 1375369594);
-            }
+			// Early failure if field does not exist.
+			if (!$this->isAllowed($fieldNameAndPath)) {
+				$message = sprintf('Property "%s" does not exist!', $fieldNameAndPath);
+				throw new NotExistingFieldException($message, 1375369594);
+			}
 
-            // mData vs columnName
-            // -------------------
-            // mData: internal name of DataTable plugin and can not contains a path, e.g. metadata.title
-            // columnName: whole field name with path
-            $output .= sprintf('Vidi._columns.push({ "data": "%s", "sortable": %s, "visible": %s, "width": "%s", "class": "%s", "columnName": "%s" });' . PHP_EOL,
-                $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath), // Suitable field name for the DataTable plugin.
-                Tca::grid()->isSortable($fieldNameAndPath) ? 'true' : 'false',
-                Tca::grid()->isVisible($fieldNameAndPath) ? 'true' : 'false',
-                Tca::grid()->getWidth($fieldNameAndPath),
-                Tca::grid()->getClass($fieldNameAndPath),
-                $fieldNameAndPath
-            );
-        }
+			// mData vs columnName
+			// -------------------
+			// mData: internal name of DataTable plugin and can not contains a path, e.g. metadata.title
+			// columnName: whole field name with path
+			$output .= sprintf('Vidi._columns.push({ "data": "%s", "sortable": %s, "visible": %s, "width": "%s", "class": "%s", "columnName": "%s" });' . PHP_EOL,
+				$this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath), // Suitable field name for the DataTable plugin.
+				Tca::grid()->isSortable($fieldNameAndPath) ? 'true' : 'false',
+				Tca::grid()->isVisible($fieldNameAndPath) ? 'true' : 'false',
+				Tca::grid()->getWidth($fieldNameAndPath),
+				Tca::grid()->getClass($fieldNameAndPath),
+				$fieldNameAndPath
+			);
+		}
 
-        return $output;
-    }
+		return $output;
+	}
 
-    /**
-     * Tell whether the field looks ok to be displayed within the Grid.
-     *
-     * @param string $fieldNameAndPath
-     * @return boolean
-     */
-    protected function isAllowed($fieldNameAndPath)
-    {
-        $dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath);
-        $fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
+	/**
+	 * Tell whether the field looks ok to be displayed within the Grid.
+	 *
+	 * @param string $fieldNameAndPath
+	 * @return boolean
+	 */
+	protected function isAllowed($fieldNameAndPath)
+	{
+		$dataType = $this->getFieldPathResolver()->getDataType($fieldNameAndPath);
+		$fieldName = $this->getFieldPathResolver()->stripFieldPath($fieldNameAndPath);
 
-        $isAllowed = false;
-        if (Tca::grid()->hasRenderers($fieldNameAndPath)) {
-            $isAllowed = true;
-        } elseif (Tca::table()->field($fieldNameAndPath)->isSystem() || Tca::table($dataType)->hasField($fieldName)) {
-            $isAllowed = true;
-        }
+		$isAllowed = false;
+		if (Tca::grid()->hasRenderers($fieldNameAndPath)) {
+			$isAllowed = true;
+		} elseif (Tca::table()->field($fieldNameAndPath)->isSystem() || Tca::table($dataType)->hasField($fieldName)) {
+			$isAllowed = true;
+		}
 
-        return $isAllowed;
-    }
+		return $isAllowed;
+	}
 
-    /**
-     * @return \Fab\Vidi\Resolver\FieldPathResolver|object
-     */
-    protected function getFieldPathResolver()
-    {
-        return GeneralUtility::makeInstance(\Fab\Vidi\Resolver\FieldPathResolver::class);
-    }
+	/**
+	 * @return \Fab\Vidi\Resolver\FieldPathResolver|object
+	 */
+	protected function getFieldPathResolver()
+	{
+		return GeneralUtility::makeInstance(\Fab\Vidi\Resolver\FieldPathResolver::class);
+	}
 }

Classes/ViewHelpers/Content/AbstractContentViewHelper.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
     {
         $serializedMatches = serialize($matches);
         $serializedOrderings = serialize($orderings);
-        return md5($dataType . $serializedMatches . $serializedOrderings . $limit . $offset);
+        return md5($dataType.$serializedMatches.$serializedOrderings.$limit.$offset);
     }
 
     /**

Indentation +209 added lines, -209 removed lines

@@ -25,214 +25,214 @@
 abstract class AbstractContentViewHelper extends AbstractViewHelper
 {
 
-    /**
-     * @return void
-     * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception
-     */
-    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
-     * @throws \Fab\Vidi\Exception\NotExistingClassException
-     * @throws \InvalidArgumentException
-     */
-    protected function getMatcher($dataType, $matches = array())
-    {
-
-        /** @var $matcher Matcher */
-        $matcher = GeneralUtility::makeInstance(Matcher::class, [], $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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
+	 * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception
+	 */
+	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
+	 * @throws \Fab\Vidi\Exception\NotExistingClassException
+	 * @throws \InvalidArgumentException
+	 */
+	protected function getMatcher($dataType, $matches = array())
+	{
+
+		/** @var $matcher Matcher */
+		$matcher = GeneralUtility::makeInstance(Matcher::class, [], $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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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/Grid/VisibilityRenderer.php

Spacing +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
                 ->setDataAttributes([
                     'toggle' => 'tooltip',
                 ])
-                ->setTitle($this->getLabelService()->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:' . $label))
+                ->setTitle($this->getLabelService()->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:'.$label))
                 ->setIcon($this->getIconFactory()->getIcon($spriteName, Icon::SIZE_SMALL))
                 ->render();
         }

Indentation +78 added lines, -78 removed lines

@@ -21,83 +21,83 @@
 class VisibilityRenderer extends ColumnRendererAbstract
 {
 
-    /**
-     * Render visibility for the Grid.
-     *
-     * @return string
-     */
-    public function render()
-    {
-
-        $output = '';
-        $hiddenField = Tca::table()->getHiddenField();
-
-        if ($hiddenField) {
-
-            $spriteName = $this->object[$hiddenField] ? 'actions-edit-unhide' : 'actions-edit-hide';
-
-            $label = $this->object[$hiddenField] ? 'unHide' : 'hide';
-
-            $output = $this->makeLinkButton()
-                ->setHref($this->getEditUri($this->object))
-                ->setClasses('btn-visibility-toggle')
-                ->setDataAttributes([
-                    'toggle' => 'tooltip',
-                ])
-                ->setTitle($this->getLabelService()->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:' . $label))
-                ->setIcon($this->getIconFactory()->getIcon($spriteName, Icon::SIZE_SMALL))
-                ->render();
-        }
-        return $output;
-    }
-
-    /**
-     * @param Content $object
-     * @return string
-     */
-    protected function getEditUri(Content $object)
-    {
-        $hiddenField = Tca::table()->getHiddenField();
-
-        $additionalParameters = array(
-            $this->getModuleLoader()->getParameterPrefix() => [
-                'controller' => 'Content',
-                'action' => 'update',
-                'format' => 'json',
-                'fieldNameAndPath' => Tca::table()->getHiddenField(),
-                'matches' => [
-                    'uid' => $object->getUid(),
-                ],
-                'content' => [$hiddenField => (int)!$this->object[$hiddenField]],
-            ],
-        );
-
-        return $this->getModuleLoader()->getModuleUrl($additionalParameters);
-    }
-
-    /**
-     * @return LinkButton
-     */
-    protected function makeLinkButton()
-    {
-        return GeneralUtility::makeInstance(LinkButton::class);
-    }
-
-
-    /**
-     * @return IconFactory
-     */
-    protected function getIconFactory()
-    {
-        return GeneralUtility::makeInstance(IconFactory::class);
-    }
-
-    /**
-     * @return \TYPO3\CMS\Core\Localization\LanguageService
-     */
-    protected function getLabelService()
-    {
-        return $GLOBALS['LANG'];
-    }
+	/**
+	 * Render visibility for the Grid.
+	 *
+	 * @return string
+	 */
+	public function render()
+	{
+
+		$output = '';
+		$hiddenField = Tca::table()->getHiddenField();
+
+		if ($hiddenField) {
+
+			$spriteName = $this->object[$hiddenField] ? 'actions-edit-unhide' : 'actions-edit-hide';
+
+			$label = $this->object[$hiddenField] ? 'unHide' : 'hide';
+
+			$output = $this->makeLinkButton()
+				->setHref($this->getEditUri($this->object))
+				->setClasses('btn-visibility-toggle')
+				->setDataAttributes([
+					'toggle' => 'tooltip',
+				])
+				->setTitle($this->getLabelService()->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:' . $label))
+				->setIcon($this->getIconFactory()->getIcon($spriteName, Icon::SIZE_SMALL))
+				->render();
+		}
+		return $output;
+	}
+
+	/**
+	 * @param Content $object
+	 * @return string
+	 */
+	protected function getEditUri(Content $object)
+	{
+		$hiddenField = Tca::table()->getHiddenField();
+
+		$additionalParameters = array(
+			$this->getModuleLoader()->getParameterPrefix() => [
+				'controller' => 'Content',
+				'action' => 'update',
+				'format' => 'json',
+				'fieldNameAndPath' => Tca::table()->getHiddenField(),
+				'matches' => [
+					'uid' => $object->getUid(),
+				],
+				'content' => [$hiddenField => (int)!$this->object[$hiddenField]],
+			],
+		);
+
+		return $this->getModuleLoader()->getModuleUrl($additionalParameters);
+	}
+
+	/**
+	 * @return LinkButton
+	 */
+	protected function makeLinkButton()
+	{
+		return GeneralUtility::makeInstance(LinkButton::class);
+	}
+
+
+	/**
+	 * @return IconFactory
+	 */
+	protected function getIconFactory()
+	{
+		return GeneralUtility::makeInstance(IconFactory::class);
+	}
+
+	/**
+	 * @return \TYPO3\CMS\Core\Localization\LanguageService
+	 */
+	protected function getLabelService()
+	{
+		return $GLOBALS['LANG'];
+	}
 
 }

Classes/Persistence/Query.php

Spacing +2 added lines, -2 removed lines

@@ -193,8 +193,8 @@
             $configuration = $backendConfigurationManager->getTypoScriptSetup();
             $querySettings = array('respectSysLanguage');
             foreach ($querySettings as $setting) {
-                if (isset($configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting])) {
-                    $value = (bool)$configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting];
+                if (isset($configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type.'.'][$setting])) {
+                    $value = (bool)$configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type.'.'][$setting];
                     ObjectAccess::setProperty($this->querySettings, $setting, $value);
                 }
             }

Indentation +637 added lines, -637 removed lines

@@ -26,642 +26,642 @@
 class Query implements QueryInterface
 {
 
-    /**
-     * An inner join.
-     */
-    const JCR_JOIN_TYPE_INNER = '{http://www.jcp.org/jcr/1.0}joinTypeInner';
-
-    /**
-     * A left-outer join.
-     */
-    const JCR_JOIN_TYPE_LEFT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeLeftOuter';
-
-    /**
-     * A right-outer join.
-     */
-    const JCR_JOIN_TYPE_RIGHT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeRightOuter';
-
-    /**
-     * Charset of strings in QOM
-     */
-    const CHARSET = 'utf-8';
-
-    /**
-     * @var string
-     */
-    protected $sourceFieldName;
-
-    /**
-     * @var string
-     */
-    protected $type;
-
-    /**
-     * @var \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface
-     */
-    protected $persistenceManager;
-
-    /**
-     * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory
-     */
-    protected $qomFactory;
-
-    /**
-     * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface
-     */
-    protected $source;
-
-    /**
-     * @var ConstraintInterface
-     */
-    protected $constraint;
-
-    /**
-     * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\Statement
-     */
-    protected $statement;
-
-    /**
-     * @var array
-     */
-    protected $orderings = [];
-
-    /**
-     * @var int
-     */
-    protected $limit;
-
-    /**
-     * @var int
-     */
-    protected $offset;
-
-    /**
-     * Apply DISTINCT upon property.
-     *
-     * @var string
-     */
-    protected $distinct;
-
-    /**
-     * The query settings.
-     *
-     * @var \Fab\Vidi\Persistence\QuerySettings
-     * @Inject
-     */
-    public $querySettings;
-
-    /**
-     * Constructs a query object working on the given class name
-     *
-     * @param string $type
-     */
-    public function __construct($type)
-    {
-        $this->type = $type;
-    }
-
-    /**
-     * Injects the persistence manager, used to fetch the CR session
-     *
-     * @param \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager
-     * @return void
-     */
-    public function injectPersistenceManager(\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager)
-    {
-        $this->persistenceManager = $persistenceManager;
-    }
-
-    /**
-     * Injects the Query Object Model Factory
-     *
-     * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory $qomFactory
-     * @return void
-     */
-    public function injectQomFactory(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory $qomFactory)
-    {
-        $this->qomFactory = $qomFactory;
-    }
-
-    /**
-     * Sets the Query Settings. These Query settings must match the settings expected by
-     * the specific Storage Backend.
-     *
-     * @param \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings The Query Settings
-     * @return void
-     * @api This method is not part of FLOW3 API
-     */
-    public function setQuerySettings(\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings)
-    {
-        $this->querySettings = $querySettings;
-    }
-
-    /**
-     * Returns the Query Settings.
-     *
-     * @throws \Exception
-     * @return \Fab\Vidi\Persistence\QuerySettings $querySettings The Query Settings
-     * @api This method is not part of FLOW3 API
-     */
-    public function getQuerySettings()
-    {
-        if (!$this->querySettings instanceof \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface) {
-            throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception('Tried to get the query settings without setting them before.', 1248689115);
-        }
-
-        // Apply possible settings to the query.
-        if ($this->isBackendMode()) {
-            /** @var \TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager $backendConfigurationManager */
-            $backendConfigurationManager = $this->getObjectManager()->get('TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager');
-            $configuration = $backendConfigurationManager->getTypoScriptSetup();
-            $querySettings = array('respectSysLanguage');
-            foreach ($querySettings as $setting) {
-                if (isset($configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting])) {
-                    $value = (bool)$configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting];
-                    ObjectAccess::setProperty($this->querySettings, $setting, $value);
-                }
-            }
-        }
-
-        return $this->querySettings;
-    }
-
-    /**
-     * Returns the type this query cares for.
-     *
-     * @return string
-     * @api
-     */
-    public function getType()
-    {
-        return $this->type;
-    }
-
-    /**
-     * Sets the source to fetch the result from
-     *
-     * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $source
-     */
-    public function setSource(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $source)
-    {
-        $this->source = $source;
-    }
-
-    /**
-     * Returns the selectorn name or an empty string, if the source is not a selector
-     * TODO This has to be checked at another place
-     *
-     * @return string The selector name
-     */
-    protected function getSelectorName()
-    {
-        if ($this->getSource() instanceof \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SelectorInterface) {
-            return $this->source->getSelectorName();
-        } else {
-            return '';
-        }
-    }
-
-    /**
-     * Gets the node-tuple source for this query.
-     *
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface the node-tuple source; non-null
-     */
-    public function getSource()
-    {
-        if ($this->source === null) {
-            $this->source = $this->qomFactory->selector($this->getType());
-        }
-        return $this->source;
-    }
-
-    /**
-     * Executes the query against the database and returns the result
-     *
-     * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $this->getQuerySettings()->getReturnRawQueryResult() is true
-     * @api
-     */
-    public function execute($returnRawQueryResult = false)
-    {
-        /** @var VidiDbBackend $backend */
-        $backend = $this->getObjectManager()->get(VidiDbBackend::class, $this);
-        return $backend->fetchResult();
-    }
-
-    /**
-     * Sets the property names to order the result by. Expected like this:
-     * array(
-     * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
-     * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
-     * )
-     * where 'foo' and 'bar' are property names.
-     *
-     * @param array $orderings The property names to order by
-     * @return QueryInterface
-     * @api
-     */
-    public function setOrderings(array $orderings)
-    {
-        $this->orderings = $orderings;
-        return $this;
-    }
-
-    /**
-     * Returns the property names to order the result by. Like this:
-     * array(
-     * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
-     * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
-     * )
-     *
-     * @return array
-     */
-    public function getOrderings()
-    {
-        return $this->orderings;
-    }
-
-    /**
-     * Sets the maximum size of the result set to limit. Returns $this to allow
-     * for chaining (fluid interface)
-     *
-     * @param integer $limit
-     * @throws \InvalidArgumentException
-     * @return QueryInterface
-     * @api
-     */
-    public function setLimit($limit)
-    {
-        if (!is_int($limit) || $limit < 1) {
-            throw new \InvalidArgumentException('The limit must be an integer >= 1', 1245071870);
-        }
-        $this->limit = $limit;
-        return $this;
-    }
-
-    /**
-     * Resets a previously set maximum size of the result set. Returns $this to allow
-     * for chaining (fluid interface)
-     *
-     * @return QueryInterface
-     * @api
-     */
-    public function unsetLimit()
-    {
-        unset($this->limit);
-        return $this;
-    }
-
-    /**
-     * Returns the maximum size of the result set to limit.
-     *
-     * @return integer
-     * @api
-     */
-    public function getLimit()
-    {
-        return $this->limit;
-    }
-
-    /**
-     * Sets the start offset of the result set to offset. Returns $this to
-     * allow for chaining (fluid interface)
-     *
-     * @param integer $offset
-     * @throws \InvalidArgumentException
-     * @return QueryInterface
-     * @api
-     */
-    public function setOffset($offset)
-    {
-        if (!is_int($offset) || $offset < 0) {
-            throw new \InvalidArgumentException('The offset must be a positive integer', 1245071872);
-        }
-        $this->offset = $offset;
-        return $this;
-    }
-
-    /**
-     * Returns the start offset of the result set.
-     *
-     * @return integer
-     * @api
-     */
-    public function getOffset()
-    {
-        return $this->offset;
-    }
-
-    /**
-     * The constraint used to limit the result set. Returns $this to allow
-     * for chaining (fluid interface)
-     *
-     * @param ConstraintInterface $constraint
-     * @return QueryInterface
-     * @api
-     */
-    public function matching($constraint)
-    {
-        $this->constraint = $constraint;
-        return $this;
-    }
-
-    /**
-     * Gets the constraint for this query.
-     *
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface the constraint, or null if none
-     * @api
-     */
-    public function getConstraint()
-    {
-        return $this->constraint;
-    }
-
-    /**
-     * Performs a logical conjunction of the given constraints. The method takes one or more contraints and concatenates them with a boolean AND.
-     * It also scepts a single array of constraints to be concatenated.
-     *
-     * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
-     * @throws InvalidNumberOfConstraintsException
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\AndInterface
-     * @api
-     */
-    public function logicalAnd($constraint1)
-    {
-        if (is_array($constraint1)) {
-            $resultingConstraint = array_shift($constraint1);
-            $constraints = $constraint1;
-        } else {
-            $constraints = func_get_args();
-            $resultingConstraint = array_shift($constraints);
-        }
-        if ($resultingConstraint === null) {
-            throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1401289500);
-        }
-        foreach ($constraints as $constraint) {
-            $resultingConstraint = $this->qomFactory->_and($resultingConstraint, $constraint);
-        }
-        return $resultingConstraint;
-    }
-
-    /**
-     * Performs a logical disjunction of the two given constraints
-     *
-     * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
-     * @throws InvalidNumberOfConstraintsException
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\OrInterface
-     * @api
-     */
-    public function logicalOr($constraint1)
-    {
-        if (is_array($constraint1)) {
-            $resultingConstraint = array_shift($constraint1);
-            $constraints = $constraint1;
-        } else {
-            $constraints = func_get_args();
-            $resultingConstraint = array_shift($constraints);
-        }
-        if ($resultingConstraint === null) {
-            throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1401289501);
-        }
-        foreach ($constraints as $constraint) {
-            $resultingConstraint = $this->qomFactory->_or($resultingConstraint, $constraint);
-        }
-        return $resultingConstraint;
-    }
-
-    /**
-     * Performs a logical negation of the given constraint
-     *
-     * @param ConstraintInterface $constraint Constraint to negate
-     * @throws \RuntimeException
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\NotInterface
-     * @api
-     */
-    public function logicalNot(ConstraintInterface $constraint)
-    {
-        return $this->qomFactory->not($constraint);
-    }
-
-    /**
-     * Returns an equals criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @param boolean $caseSensitive Whether the equality test should be done case-sensitive
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function equals($propertyName, $operand, $caseSensitive = true)
-    {
-        if (is_object($operand) || $caseSensitive) {
-            $comparison = $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_EQUAL_TO, $operand);
-        } else {
-            $comparison = $this->qomFactory->comparison($this->qomFactory->lowerCase($this->qomFactory->propertyValue($propertyName, $this->getSelectorName())), QueryInterface::OPERATOR_EQUAL_TO, \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Charset\CharsetConverter::class)->conv_case(\TYPO3\CMS\Extbase\Persistence\Generic\Query::CHARSET, $operand, 'toLower'));
-        }
-        return $comparison;
-    }
-
-    /**
-     * Returns a like criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @param boolean $caseSensitive Whether the matching should be done case-sensitive
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function like($propertyName, $operand, $caseSensitive = true)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LIKE, $operand);
-    }
-
-    /**
-     * Returns a "contains" criterion used for matching objects against a query.
-     * It matches if the multivalued property contains the given operand.
-     *
-     * @param string $propertyName The name of the (multivalued) property to compare against
-     * @param mixed $operand The value to compare with
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function contains($propertyName, $operand)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_CONTAINS, $operand);
-    }
-
-    /**
-     * Returns an "in" criterion used for matching objects against a query. It
-     * matches if the property's value is contained in the multivalued operand.
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with, multivalued
-     * @throws UnexpectedTypeException
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function in($propertyName, $operand)
-    {
-        if (!is_array($operand) && !$operand instanceof \ArrayAccess && !$operand instanceof \Traversable) {
-            throw new UnexpectedTypeException('The "in" operator must be given a mutlivalued operand (array, ArrayAccess, Traversable).', 1264678095);
-        }
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_IN, $operand);
-    }
-
-    /**
-     * Returns a less than criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function lessThan($propertyName, $operand)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LESS_THAN, $operand);
-    }
-
-    /**
-     * Returns a less or equal than criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function lessThanOrEqual($propertyName, $operand)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LESS_THAN_OR_EQUAL_TO, $operand);
-    }
-
-    /**
-     * Returns a greater than criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function greaterThan($propertyName, $operand)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_GREATER_THAN, $operand);
-    }
-
-    /**
-     * Returns a greater than or equal criterion used for matching objects against a query
-     *
-     * @param string $propertyName The name of the property to compare against
-     * @param mixed $operand The value to compare with
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
-     */
-    public function greaterThanOrEqual($propertyName, $operand)
-    {
-        return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_GREATER_THAN_OR_EQUAL_TO, $operand);
-    }
-
-    /**
-     * Returns the query result count.
-     *
-     * @return integer The query result count
-     * @api
-     */
-    public function count()
-    {
-        /** @var VidiDbBackend $backend */
-        $backend = $this->getObjectManager()->get(VidiDbBackend::class, $this);
-        return $backend->countResult();
-    }
-
-    /**
-     * Returns an "isEmpty" criterion used for matching objects against a query.
-     * It matches if the multivalued property contains no values or is null.
-     *
-     * @param string $propertyName The name of the multivalued property to compare against
-     * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
-     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException if used on a single-valued property
-     * @api
-     */
-    public function isEmpty($propertyName)
-    {
-        throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException(__METHOD__);
-    }
-
-    /**
-     * @return string
-     */
-    public function getDistinct()
-    {
-        return $this->distinct;
-    }
-
-    /**
-     * @param string $distinct
-     * @return $this
-     */
-    public function setDistinct($distinct)
-    {
-        $this->distinct = $distinct;
-        return $this;
-    }
-
-    /**
-     * Sets the statement of this query. If you use this, you will lose the abstraction from a concrete storage
-     * backend (database).
-     *
-     * @param string|\TYPO3\CMS\Core\Database\PreparedStatement $statement The statement
-     * @param array $parameters An array of parameters. These will be bound to placeholders '?' in the $statement.
-     * @return QueryInterface
-     */
-    public function statement($statement, array $parameters = array())
-    {
-        $this->statement = $this->qomFactory->statement($statement, $parameters);
-        return $this;
-    }
-
-    /**
-     * Returns the statement of this query.
-     *
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\Statement
-     */
-    public function getStatement()
-    {
-        return $this->statement;
-    }
-
-    /**
-     * Returns whether the current mode is Backend.
-     *
-     * @return bool
-     */
-    protected function isBackendMode()
-    {
-        return ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isBackend();
-    }
-
-    /**
-     * @return string
-     */
-    public function getSourceFieldName()
-    {
-        return $this->sourceFieldName;
-    }
-
-    /**
-     * @param string $sourceFieldName
-     * @return $this
-     */
-    public function setSourceFieldName($sourceFieldName)
-    {
-        $this->sourceFieldName = $sourceFieldName;
-        return $this;
-    }
-
-    /**
-     * @return object|\TYPO3\CMS\Extbase\Object\ObjectManager
-     */
-    protected function getObjectManager()
-    {
-        return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
-    }
+	/**
+	 * An inner join.
+	 */
+	const JCR_JOIN_TYPE_INNER = '{http://www.jcp.org/jcr/1.0}joinTypeInner';
+
+	/**
+	 * A left-outer join.
+	 */
+	const JCR_JOIN_TYPE_LEFT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeLeftOuter';
+
+	/**
+	 * A right-outer join.
+	 */
+	const JCR_JOIN_TYPE_RIGHT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeRightOuter';
+
+	/**
+	 * Charset of strings in QOM
+	 */
+	const CHARSET = 'utf-8';
+
+	/**
+	 * @var string
+	 */
+	protected $sourceFieldName;
+
+	/**
+	 * @var string
+	 */
+	protected $type;
+
+	/**
+	 * @var \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface
+	 */
+	protected $persistenceManager;
+
+	/**
+	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory
+	 */
+	protected $qomFactory;
+
+	/**
+	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface
+	 */
+	protected $source;
+
+	/**
+	 * @var ConstraintInterface
+	 */
+	protected $constraint;
+
+	/**
+	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\Qom\Statement
+	 */
+	protected $statement;
+
+	/**
+	 * @var array
+	 */
+	protected $orderings = [];
+
+	/**
+	 * @var int
+	 */
+	protected $limit;
+
+	/**
+	 * @var int
+	 */
+	protected $offset;
+
+	/**
+	 * Apply DISTINCT upon property.
+	 *
+	 * @var string
+	 */
+	protected $distinct;
+
+	/**
+	 * The query settings.
+	 *
+	 * @var \Fab\Vidi\Persistence\QuerySettings
+	 * @Inject
+	 */
+	public $querySettings;
+
+	/**
+	 * Constructs a query object working on the given class name
+	 *
+	 * @param string $type
+	 */
+	public function __construct($type)
+	{
+		$this->type = $type;
+	}
+
+	/**
+	 * Injects the persistence manager, used to fetch the CR session
+	 *
+	 * @param \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager
+	 * @return void
+	 */
+	public function injectPersistenceManager(\TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface $persistenceManager)
+	{
+		$this->persistenceManager = $persistenceManager;
+	}
+
+	/**
+	 * Injects the Query Object Model Factory
+	 *
+	 * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory $qomFactory
+	 * @return void
+	 */
+	public function injectQomFactory(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\QueryObjectModelFactory $qomFactory)
+	{
+		$this->qomFactory = $qomFactory;
+	}
+
+	/**
+	 * Sets the Query Settings. These Query settings must match the settings expected by
+	 * the specific Storage Backend.
+	 *
+	 * @param \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings The Query Settings
+	 * @return void
+	 * @api This method is not part of FLOW3 API
+	 */
+	public function setQuerySettings(\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings)
+	{
+		$this->querySettings = $querySettings;
+	}
+
+	/**
+	 * Returns the Query Settings.
+	 *
+	 * @throws \Exception
+	 * @return \Fab\Vidi\Persistence\QuerySettings $querySettings The Query Settings
+	 * @api This method is not part of FLOW3 API
+	 */
+	public function getQuerySettings()
+	{
+		if (!$this->querySettings instanceof \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface) {
+			throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception('Tried to get the query settings without setting them before.', 1248689115);
+		}
+
+		// Apply possible settings to the query.
+		if ($this->isBackendMode()) {
+			/** @var \TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager $backendConfigurationManager */
+			$backendConfigurationManager = $this->getObjectManager()->get('TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager');
+			$configuration = $backendConfigurationManager->getTypoScriptSetup();
+			$querySettings = array('respectSysLanguage');
+			foreach ($querySettings as $setting) {
+				if (isset($configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting])) {
+					$value = (bool)$configuration['config.']['tx_vidi.']['persistence.']['backend.'][$this->type . '.'][$setting];
+					ObjectAccess::setProperty($this->querySettings, $setting, $value);
+				}
+			}
+		}
+
+		return $this->querySettings;
+	}
+
+	/**
+	 * Returns the type this query cares for.
+	 *
+	 * @return string
+	 * @api
+	 */
+	public function getType()
+	{
+		return $this->type;
+	}
+
+	/**
+	 * Sets the source to fetch the result from
+	 *
+	 * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $source
+	 */
+	public function setSource(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface $source)
+	{
+		$this->source = $source;
+	}
+
+	/**
+	 * Returns the selectorn name or an empty string, if the source is not a selector
+	 * TODO This has to be checked at another place
+	 *
+	 * @return string The selector name
+	 */
+	protected function getSelectorName()
+	{
+		if ($this->getSource() instanceof \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SelectorInterface) {
+			return $this->source->getSelectorName();
+		} else {
+			return '';
+		}
+	}
+
+	/**
+	 * Gets the node-tuple source for this query.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface the node-tuple source; non-null
+	 */
+	public function getSource()
+	{
+		if ($this->source === null) {
+			$this->source = $this->qomFactory->selector($this->getType());
+		}
+		return $this->source;
+	}
+
+	/**
+	 * Executes the query against the database and returns the result
+	 *
+	 * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $this->getQuerySettings()->getReturnRawQueryResult() is true
+	 * @api
+	 */
+	public function execute($returnRawQueryResult = false)
+	{
+		/** @var VidiDbBackend $backend */
+		$backend = $this->getObjectManager()->get(VidiDbBackend::class, $this);
+		return $backend->fetchResult();
+	}
+
+	/**
+	 * Sets the property names to order the result by. Expected like this:
+	 * array(
+	 * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
+	 * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
+	 * )
+	 * where 'foo' and 'bar' are property names.
+	 *
+	 * @param array $orderings The property names to order by
+	 * @return QueryInterface
+	 * @api
+	 */
+	public function setOrderings(array $orderings)
+	{
+		$this->orderings = $orderings;
+		return $this;
+	}
+
+	/**
+	 * Returns the property names to order the result by. Like this:
+	 * array(
+	 * 'foo' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_ASCENDING,
+	 * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
+	 * )
+	 *
+	 * @return array
+	 */
+	public function getOrderings()
+	{
+		return $this->orderings;
+	}
+
+	/**
+	 * Sets the maximum size of the result set to limit. Returns $this to allow
+	 * for chaining (fluid interface)
+	 *
+	 * @param integer $limit
+	 * @throws \InvalidArgumentException
+	 * @return QueryInterface
+	 * @api
+	 */
+	public function setLimit($limit)
+	{
+		if (!is_int($limit) || $limit < 1) {
+			throw new \InvalidArgumentException('The limit must be an integer >= 1', 1245071870);
+		}
+		$this->limit = $limit;
+		return $this;
+	}
+
+	/**
+	 * Resets a previously set maximum size of the result set. Returns $this to allow
+	 * for chaining (fluid interface)
+	 *
+	 * @return QueryInterface
+	 * @api
+	 */
+	public function unsetLimit()
+	{
+		unset($this->limit);
+		return $this;
+	}
+
+	/**
+	 * Returns the maximum size of the result set to limit.
+	 *
+	 * @return integer
+	 * @api
+	 */
+	public function getLimit()
+	{
+		return $this->limit;
+	}
+
+	/**
+	 * Sets the start offset of the result set to offset. Returns $this to
+	 * allow for chaining (fluid interface)
+	 *
+	 * @param integer $offset
+	 * @throws \InvalidArgumentException
+	 * @return QueryInterface
+	 * @api
+	 */
+	public function setOffset($offset)
+	{
+		if (!is_int($offset) || $offset < 0) {
+			throw new \InvalidArgumentException('The offset must be a positive integer', 1245071872);
+		}
+		$this->offset = $offset;
+		return $this;
+	}
+
+	/**
+	 * Returns the start offset of the result set.
+	 *
+	 * @return integer
+	 * @api
+	 */
+	public function getOffset()
+	{
+		return $this->offset;
+	}
+
+	/**
+	 * The constraint used to limit the result set. Returns $this to allow
+	 * for chaining (fluid interface)
+	 *
+	 * @param ConstraintInterface $constraint
+	 * @return QueryInterface
+	 * @api
+	 */
+	public function matching($constraint)
+	{
+		$this->constraint = $constraint;
+		return $this;
+	}
+
+	/**
+	 * Gets the constraint for this query.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface the constraint, or null if none
+	 * @api
+	 */
+	public function getConstraint()
+	{
+		return $this->constraint;
+	}
+
+	/**
+	 * Performs a logical conjunction of the given constraints. The method takes one or more contraints and concatenates them with a boolean AND.
+	 * It also scepts a single array of constraints to be concatenated.
+	 *
+	 * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
+	 * @throws InvalidNumberOfConstraintsException
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\AndInterface
+	 * @api
+	 */
+	public function logicalAnd($constraint1)
+	{
+		if (is_array($constraint1)) {
+			$resultingConstraint = array_shift($constraint1);
+			$constraints = $constraint1;
+		} else {
+			$constraints = func_get_args();
+			$resultingConstraint = array_shift($constraints);
+		}
+		if ($resultingConstraint === null) {
+			throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1401289500);
+		}
+		foreach ($constraints as $constraint) {
+			$resultingConstraint = $this->qomFactory->_and($resultingConstraint, $constraint);
+		}
+		return $resultingConstraint;
+	}
+
+	/**
+	 * Performs a logical disjunction of the two given constraints
+	 *
+	 * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
+	 * @throws InvalidNumberOfConstraintsException
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\OrInterface
+	 * @api
+	 */
+	public function logicalOr($constraint1)
+	{
+		if (is_array($constraint1)) {
+			$resultingConstraint = array_shift($constraint1);
+			$constraints = $constraint1;
+		} else {
+			$constraints = func_get_args();
+			$resultingConstraint = array_shift($constraints);
+		}
+		if ($resultingConstraint === null) {
+			throw new InvalidNumberOfConstraintsException('There must be at least one constraint or a non-empty array of constraints given.', 1401289501);
+		}
+		foreach ($constraints as $constraint) {
+			$resultingConstraint = $this->qomFactory->_or($resultingConstraint, $constraint);
+		}
+		return $resultingConstraint;
+	}
+
+	/**
+	 * Performs a logical negation of the given constraint
+	 *
+	 * @param ConstraintInterface $constraint Constraint to negate
+	 * @throws \RuntimeException
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\NotInterface
+	 * @api
+	 */
+	public function logicalNot(ConstraintInterface $constraint)
+	{
+		return $this->qomFactory->not($constraint);
+	}
+
+	/**
+	 * Returns an equals criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @param boolean $caseSensitive Whether the equality test should be done case-sensitive
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function equals($propertyName, $operand, $caseSensitive = true)
+	{
+		if (is_object($operand) || $caseSensitive) {
+			$comparison = $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_EQUAL_TO, $operand);
+		} else {
+			$comparison = $this->qomFactory->comparison($this->qomFactory->lowerCase($this->qomFactory->propertyValue($propertyName, $this->getSelectorName())), QueryInterface::OPERATOR_EQUAL_TO, \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Charset\CharsetConverter::class)->conv_case(\TYPO3\CMS\Extbase\Persistence\Generic\Query::CHARSET, $operand, 'toLower'));
+		}
+		return $comparison;
+	}
+
+	/**
+	 * Returns a like criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @param boolean $caseSensitive Whether the matching should be done case-sensitive
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function like($propertyName, $operand, $caseSensitive = true)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LIKE, $operand);
+	}
+
+	/**
+	 * Returns a "contains" criterion used for matching objects against a query.
+	 * It matches if the multivalued property contains the given operand.
+	 *
+	 * @param string $propertyName The name of the (multivalued) property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function contains($propertyName, $operand)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_CONTAINS, $operand);
+	}
+
+	/**
+	 * Returns an "in" criterion used for matching objects against a query. It
+	 * matches if the property's value is contained in the multivalued operand.
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with, multivalued
+	 * @throws UnexpectedTypeException
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function in($propertyName, $operand)
+	{
+		if (!is_array($operand) && !$operand instanceof \ArrayAccess && !$operand instanceof \Traversable) {
+			throw new UnexpectedTypeException('The "in" operator must be given a mutlivalued operand (array, ArrayAccess, Traversable).', 1264678095);
+		}
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_IN, $operand);
+	}
+
+	/**
+	 * Returns a less than criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function lessThan($propertyName, $operand)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LESS_THAN, $operand);
+	}
+
+	/**
+	 * Returns a less or equal than criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function lessThanOrEqual($propertyName, $operand)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_LESS_THAN_OR_EQUAL_TO, $operand);
+	}
+
+	/**
+	 * Returns a greater than criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function greaterThan($propertyName, $operand)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_GREATER_THAN, $operand);
+	}
+
+	/**
+	 * Returns a greater than or equal criterion used for matching objects against a query
+	 *
+	 * @param string $propertyName The name of the property to compare against
+	 * @param mixed $operand The value to compare with
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
+	 * @api
+	 */
+	public function greaterThanOrEqual($propertyName, $operand)
+	{
+		return $this->qomFactory->comparison($this->qomFactory->propertyValue($propertyName, $this->getSelectorName()), QueryInterface::OPERATOR_GREATER_THAN_OR_EQUAL_TO, $operand);
+	}
+
+	/**
+	 * Returns the query result count.
+	 *
+	 * @return integer The query result count
+	 * @api
+	 */
+	public function count()
+	{
+		/** @var VidiDbBackend $backend */
+		$backend = $this->getObjectManager()->get(VidiDbBackend::class, $this);
+		return $backend->countResult();
+	}
+
+	/**
+	 * Returns an "isEmpty" criterion used for matching objects against a query.
+	 * It matches if the multivalued property contains no values or is null.
+	 *
+	 * @param string $propertyName The name of the multivalued property to compare against
+	 * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
+	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\InvalidQueryException if used on a single-valued property
+	 * @api
+	 */
+	public function isEmpty($propertyName)
+	{
+		throw new \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException(__METHOD__);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getDistinct()
+	{
+		return $this->distinct;
+	}
+
+	/**
+	 * @param string $distinct
+	 * @return $this
+	 */
+	public function setDistinct($distinct)
+	{
+		$this->distinct = $distinct;
+		return $this;
+	}
+
+	/**
+	 * Sets the statement of this query. If you use this, you will lose the abstraction from a concrete storage
+	 * backend (database).
+	 *
+	 * @param string|\TYPO3\CMS\Core\Database\PreparedStatement $statement The statement
+	 * @param array $parameters An array of parameters. These will be bound to placeholders '?' in the $statement.
+	 * @return QueryInterface
+	 */
+	public function statement($statement, array $parameters = array())
+	{
+		$this->statement = $this->qomFactory->statement($statement, $parameters);
+		return $this;
+	}
+
+	/**
+	 * Returns the statement of this query.
+	 *
+	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\Statement
+	 */
+	public function getStatement()
+	{
+		return $this->statement;
+	}
+
+	/**
+	 * Returns whether the current mode is Backend.
+	 *
+	 * @return bool
+	 */
+	protected function isBackendMode()
+	{
+		return ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isBackend();
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getSourceFieldName()
+	{
+		return $this->sourceFieldName;
+	}
+
+	/**
+	 * @param string $sourceFieldName
+	 * @return $this
+	 */
+	public function setSourceFieldName($sourceFieldName)
+	{
+		$this->sourceFieldName = $sourceFieldName;
+		return $this;
+	}
+
+	/**
+	 * @return object|\TYPO3\CMS\Extbase\Object\ObjectManager
+	 */
+	protected function getObjectManager()
+	{
+		return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
+	}
 
 }

Classes/Service/ClipboardService.php

Spacing +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
      */
     protected function getDataKey()
     {
-        return 'vidi_clipboard_' . $this->getModuleLoader()->getDataType();
+        return 'vidi_clipboard_'.$this->getModuleLoader()->getDataType();
     }
 
     /**

Indentation +71 added lines, -71 removed lines

@@ -18,83 +18,83 @@
 class ClipboardService implements SingletonInterface
 {
 
-    /**
-     * Get the Matcher object of the clipboard.
-     *
-     * @return Matcher
-     */
-    public function getMatcher()
-    {
-        $matcher = $this->getBackendUser()->getModuleData($this->getDataKey());
-        if (!$matcher) {
-            /** @var $matcher Matcher */
-            $matcher = GeneralUtility::makeInstance(\Fab\Vidi\Persistence\Matcher::class);
-        }
-        return $matcher;
-    }
+	/**
+	 * Get the Matcher object of the clipboard.
+	 *
+	 * @return Matcher
+	 */
+	public function getMatcher()
+	{
+		$matcher = $this->getBackendUser()->getModuleData($this->getDataKey());
+		if (!$matcher) {
+			/** @var $matcher Matcher */
+			$matcher = GeneralUtility::makeInstance(\Fab\Vidi\Persistence\Matcher::class);
+		}
+		return $matcher;
+	}
 
-    /**
-     * Tell whether the clipboard has items or not.
-     *
-     * @return bool
-     */
-    public function hasItems()
-    {
-        $matcher = $this->getMatcher();
+	/**
+	 * Tell whether the clipboard has items or not.
+	 *
+	 * @return bool
+	 */
+	public function hasItems()
+	{
+		$matcher = $this->getMatcher();
 
-        $inCriteria = $matcher->getIn();
-        $likeCriteria = $matcher->getLike();
-        $searchTerm = $matcher->getSearchTerm();
+		$inCriteria = $matcher->getIn();
+		$likeCriteria = $matcher->getLike();
+		$searchTerm = $matcher->getSearchTerm();
 
-        $hasItems = !empty($inCriteria) || !empty($likeCriteria) || !empty($searchTerm);
-        return $hasItems;
-    }
+		$hasItems = !empty($inCriteria) || !empty($likeCriteria) || !empty($searchTerm);
+		return $hasItems;
+	}
 
-    /**
-     * Save data into the clipboard.
-     *
-     * @param Matcher $matches
-     */
-    public function save(Matcher $matches)
-    {
-        $this->getBackendUser()->pushModuleData($this->getDataKey(), $matches);
-    }
+	/**
+	 * Save data into the clipboard.
+	 *
+	 * @param Matcher $matches
+	 */
+	public function save(Matcher $matches)
+	{
+		$this->getBackendUser()->pushModuleData($this->getDataKey(), $matches);
+	}
 
-    /**
-     * Completely empty the clipboard for a data type.
-     *
-     * @return void
-     */
-    public function flush()
-    {
-        $this->getBackendUser()->pushModuleData($this->getDataKey(), null);
-    }
+	/**
+	 * Completely empty the clipboard for a data type.
+	 *
+	 * @return void
+	 */
+	public function flush()
+	{
+		$this->getBackendUser()->pushModuleData($this->getDataKey(), null);
+	}
 
-    /**
-     * @return string
-     */
-    protected function getDataKey()
-    {
-        return 'vidi_clipboard_' . $this->getModuleLoader()->getDataType();
-    }
+	/**
+	 * @return string
+	 */
+	protected function getDataKey()
+	{
+		return 'vidi_clipboard_' . $this->getModuleLoader()->getDataType();
+	}
 
-    /**
-     * Get the Vidi Module Loader.
-     *
-     * @return \Fab\Vidi\Module\ModuleLoader|object
-     */
-    protected function getModuleLoader()
-    {
-        return GeneralUtility::makeInstance(\Fab\Vidi\Module\ModuleLoader::class);
-    }
+	/**
+	 * Get the Vidi Module Loader.
+	 *
+	 * @return \Fab\Vidi\Module\ModuleLoader|object
+	 */
+	protected function getModuleLoader()
+	{
+		return GeneralUtility::makeInstance(\Fab\Vidi\Module\ModuleLoader::class);
+	}
 
-    /**
-     * Returns an instance of the current Backend User.
-     *
-     * @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
-     */
-    protected function getBackendUser()
-    {
-        return $GLOBALS['BE_USER'];
-    }
+	/**
+	 * Returns an instance of the current Backend User.
+	 *
+	 * @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
+	 */
+	protected function getBackendUser()
+	{
+		return $GLOBALS['BE_USER'];
+	}
 }

Classes/View/Grid/Row.php

Spacing +3 added lines, -3 removed lines

@@ -126,7 +126,7 @@ 
             $output[$this->getFieldName()] = $value;
         }
 
-        $output['DT_RowId'] = 'row-' . $object->getUid();
+        $output['DT_RowId'] = 'row-'.$object->getUid();
         $output['DT_RowClass'] = sprintf('%s_%s', $object->getDataType(), $object->getUid());
 
         return $output;
@@ -327,7 +327,7 @@ 
         foreach ($localizedStructure as $index => $structure) {
 
             $localizedStructure[$index]['value'] = sprintf('<span>%s %s</span>',
-                empty($structure['languageFlag']) ? '' : $this->getIconFactory()->getIcon('flags-' . $structure['languageFlag'], Icon::SIZE_SMALL),
+                empty($structure['languageFlag']) ? '' : $this->getIconFactory()->getIcon('flags-'.$structure['languageFlag'], Icon::SIZE_SMALL),
                 $structure['value']
             );
         }
@@ -352,7 +352,7 @@ 
             $enablesMethods = array('Hidden', 'Deleted', 'StartTime', 'EndTime');
             foreach ($enablesMethods as $enableMethod) {
 
-                $methodName = 'get' . $enableMethod . 'Field';
+                $methodName = 'get'.$enableMethod.'Field';
 
                 // Fetch possible hidden filed.
                 $enableField = Tca::table($object)->$methodName();

Indentation +623 added lines, -623 removed lines

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

Tests/Functional/Domain/Model/ContentTest.php

Spacing +3 added lines, -3 removed lines

@@ -16,7 +16,7 @@ 
 
 use Fab\Vidi\Tests\Functional\AbstractFunctionalTestCase;
 
-require_once dirname(dirname(dirname(__FILE__))) . '/AbstractFunctionalTestCase.php';
+require_once dirname(dirname(dirname(__FILE__))).'/AbstractFunctionalTestCase.php';
 
 /**
  * Test case for class \Fab\Vidi\Domain\Model\Content.
@@ -113,8 +113,8 @@ 
 	 * @dataProvider propertyProvider
 	 */
 	public function testProperty($propertyName, $value) {
-		$setter = 'set' . ucfirst($propertyName);
-		$getter = 'get' . ucfirst($propertyName);
+		$setter = 'set'.ucfirst($propertyName);
+		$getter = 'get'.ucfirst($propertyName);
 		$this->markTestIncomplete(); # TCA must be faked
 		#call_user_func_array(array($this->fixture, $setter), array($value));
 		#$this->assertEquals($value, call_user_func(array($this->fixture, $getter)));

Tests/Functional/Module/ModuleLoaderTest.php

Spacing +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
 
 use Fab\Vidi\Tests\Functional\AbstractFunctionalTestCase;
 
-require_once dirname(dirname(__FILE__)) . '/AbstractFunctionalTestCase.php';
+require_once dirname(dirname(__FILE__)).'/AbstractFunctionalTestCase.php';
 
 /**
  * Test case for class \Fab\Vidi\Module\ModuleLoader.
@@ -54,7 +54,7 @@ 
 	 * @dataProvider attributeValueProvider
 	 */
 	public function attributeCanBeSet($attribute, $value) {
-		$setter = 'set' . ucfirst($attribute);
+		$setter = 'set'.ucfirst($attribute);
 		$this->fixture->$setter($value);
 		$this->assertAttributeEquals($value, $attribute, $this->fixture);
 	}

Tests/Functional/Grid/RelationRendererTest.php

Spacing +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 
 use Fab\Vidi\Tests\Functional\AbstractFunctionalTestCase;
 
-require_once dirname(dirname(__FILE__)) . '/AbstractFunctionalTestCase.php';
+require_once dirname(dirname(__FILE__)).'/AbstractFunctionalTestCase.php';
 
 /**
  * Test case for class \Fab\Vidi\Grid\CategoryRenderer.