fabarea / media

Configuration/TCA/Overrides/sys_file.php

Indentation +197 added lines, -197 removed lines

@@ -15,214 +15,214 @@
 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
 
 if (!defined('TYPO3')) {
-    die('Access denied.');
+	die('Access denied.');
 }
 
 $tca = [
-    'ctrl' => [
-        // Beware that "metadata.categories" is quite expansive performance wise.
-        'searchFields' => 'uid, extension, name, metadata.title, metadata.description, metadata.categories',
-    ],
-    'columns' => [
-        'extension' => [
-            'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.extension',
-            'config' => [
-                'type' => 'input',
-                'size' => 255,
-                'eval' => 'trim',
-            ],
-        ],
-        'number_of_references' => [
-            'config' => [
-                'type' => 'input',
-                'size' => 255,
-                'readOnly' => true,
-                'eval' => 'int',
-            ],
-        ],
-    ],
-    'vidi' => [
-        // For actions such as update, remove, copy, move, the DataHandler of the Core is configured to be used by default.
-        // It will work fine in most cases. However, there is the chance to set your own Data Handler if there are special needs (@see FileDataHandler in EXT:media)
-        // Another reasons, would be for speed. You will notice a performance cost when mass editing data using the Core DataHandler.
-        // Using your own DataHandler would make the mass processing much faster.
-        'data_handler' => [
-            // For all actions
-            '*' => 'Fab\Media\DataHandler\FileDataHandler'
-        ],
-    ],
-    'grid' => [
-        'excluded_fields' => 'number_of_references, missing',
-        'facets' => [
-            'metadata.title',
-            'metadata.categories',
-            'name',
-            StandardFacet::class => [
-                'name' => 'extension',
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.extension'
-            ],
-            'metadata.description',
-            'identifier',
-            NumberOfReferencesFacet::class => [],
-            TypeFacet::class => [],
-            ActionPermissionFacet::class => [],
-            'uid',
-        ],
-        'columns' => [
-            '__checkbox' => [
-                'renderer' => CheckBoxRenderer::class,
-            ],
-            'uid' => [
-                'visible' => false,
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:uid',
-                'width' => '5px',
-            ],
-            'identifier' => [
-                'visible' => false,
-            ],
-            'fileinfo' => [
-                'renderer' => PreviewRenderer::class,
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:preview',
-                'wrap' => '<div class="center preview">|</div>',
-                'width' => '150px',
-                'sortable' => false,
-            ],
-            'metadata.title' => [
-                'renderer' => MetadataRenderer::class,
-                'rendererConfiguration' => [
-                    'property' => 'title',
-                ],
-                'width' => '400px',
-                'editable' => true,
-                'sortable' => true,
-            ],
-            'metadata.description' => [
-                'renderer' => MetadataRenderer::class,
-                'rendererConfiguration' => [
-                    'property' => 'description',
-                ],
-                'visible' => false,
-                'sortable' => false,
-            ],
-            'tstamp' => [
-                'visible' => false,
-                'format' => 'Fab\Vidi\Formatter\Date',
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.tstamp',
-            ],
-            'metadata.categories' => [
-                'renderers' => [
-                    RelationEditRenderer::class,
-                    CategoryRenderer::class,
-                ],
-                'editable' => true,
-                'visible' => true,
-                'sortable' => false,
-            ],
-            'usage' => [
-                'renderer' => 'Fab\Media\Grid\UsageRenderer',
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:usage',
-                'visible' => true,
-                'sortable' => false,
-            ],
-            'metadata' => [
-                'label' => 'Metadata File Identifier',
-                'renderer' => MetadataRenderer::class,
-                'rendererConfiguration' => [
-                    'property' => 'uid',
-                ],
-                'visible' => false,
-                'sortable' => false,
-            ],
-            '__action_permission' => [
-                'renderer' => 'Fab\Media\Grid\ActionPermissionColumn',
-                'visible' => false,
-                'sortable' => false,
-                'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:permission',
-            ],
-        ]
-    ]
+	'ctrl' => [
+		// Beware that "metadata.categories" is quite expansive performance wise.
+		'searchFields' => 'uid, extension, name, metadata.title, metadata.description, metadata.categories',
+	],
+	'columns' => [
+		'extension' => [
+			'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.extension',
+			'config' => [
+				'type' => 'input',
+				'size' => 255,
+				'eval' => 'trim',
+			],
+		],
+		'number_of_references' => [
+			'config' => [
+				'type' => 'input',
+				'size' => 255,
+				'readOnly' => true,
+				'eval' => 'int',
+			],
+		],
+	],
+	'vidi' => [
+		// For actions such as update, remove, copy, move, the DataHandler of the Core is configured to be used by default.
+		// It will work fine in most cases. However, there is the chance to set your own Data Handler if there are special needs (@see FileDataHandler in EXT:media)
+		// Another reasons, would be for speed. You will notice a performance cost when mass editing data using the Core DataHandler.
+		// Using your own DataHandler would make the mass processing much faster.
+		'data_handler' => [
+			// For all actions
+			'*' => 'Fab\Media\DataHandler\FileDataHandler'
+		],
+	],
+	'grid' => [
+		'excluded_fields' => 'number_of_references, missing',
+		'facets' => [
+			'metadata.title',
+			'metadata.categories',
+			'name',
+			StandardFacet::class => [
+				'name' => 'extension',
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.extension'
+			],
+			'metadata.description',
+			'identifier',
+			NumberOfReferencesFacet::class => [],
+			TypeFacet::class => [],
+			ActionPermissionFacet::class => [],
+			'uid',
+		],
+		'columns' => [
+			'__checkbox' => [
+				'renderer' => CheckBoxRenderer::class,
+			],
+			'uid' => [
+				'visible' => false,
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:uid',
+				'width' => '5px',
+			],
+			'identifier' => [
+				'visible' => false,
+			],
+			'fileinfo' => [
+				'renderer' => PreviewRenderer::class,
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:preview',
+				'wrap' => '<div class="center preview">|</div>',
+				'width' => '150px',
+				'sortable' => false,
+			],
+			'metadata.title' => [
+				'renderer' => MetadataRenderer::class,
+				'rendererConfiguration' => [
+					'property' => 'title',
+				],
+				'width' => '400px',
+				'editable' => true,
+				'sortable' => true,
+			],
+			'metadata.description' => [
+				'renderer' => MetadataRenderer::class,
+				'rendererConfiguration' => [
+					'property' => 'description',
+				],
+				'visible' => false,
+				'sortable' => false,
+			],
+			'tstamp' => [
+				'visible' => false,
+				'format' => 'Fab\Vidi\Formatter\Date',
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:sys_file.tstamp',
+			],
+			'metadata.categories' => [
+				'renderers' => [
+					RelationEditRenderer::class,
+					CategoryRenderer::class,
+				],
+				'editable' => true,
+				'visible' => true,
+				'sortable' => false,
+			],
+			'usage' => [
+				'renderer' => 'Fab\Media\Grid\UsageRenderer',
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:usage',
+				'visible' => true,
+				'sortable' => false,
+			],
+			'metadata' => [
+				'label' => 'Metadata File Identifier',
+				'renderer' => MetadataRenderer::class,
+				'rendererConfiguration' => [
+					'property' => 'uid',
+				],
+				'visible' => false,
+				'sortable' => false,
+			],
+			'__action_permission' => [
+				'renderer' => 'Fab\Media\Grid\ActionPermissionColumn',
+				'visible' => false,
+				'sortable' => false,
+				'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:permission',
+			],
+		]
+	]
 ];
 
 // Add more info to the Grid if EXT:filemetadata is loaded. Notice that the extension is not required but suggested.
 if (ExtensionManagementUtility::isLoaded('filemetadata')) {
-    $additionalTca = [
-        'ctrl' => [
-            'searchFields' => $tca['ctrl']['searchFields'] . ', metadata.keywords',
-        ],
-        'grid' => [
-            'columns' => [
-                'metadata.keywords' => [
-                    'renderer' => MetadataRenderer::class,
-                    'configuration' => [
-                        'property' => 'keywords',
-                    ],
-                    'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.keywords',
-                    'visible' => false,
-                    'sortable' => false,
-                ],
-                'metadata.fe_groups' => [
-                    'renderers' => [
-                        RelationEditRenderer::class,
-                        FrontendPermissionRenderer::class,
-                    ],
-                    'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:permissions_fe_groups',
-                    'visible' => false,
-                    'sortable' => false,
-                ],
-                'metadata.status' => [
-                    'renderer' => MetadataRenderer::class,
-                    'rendererConfiguration' => [
-                        'property' => 'status',
-                    ],
-                    'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.status',
-                    'visible' => false,
-                    'width' => '5%',
-                    'sortable' => false,
-                ],
-                # un-comment me to see the "visible" flag in the grid.
-                #'visible' => array(
-                #	'renderer' => 'Fab\Media\Grid\VisibilityRenderer', @todo will not work out of the box after 6.2 migration
-                #	'label' => 'LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:visibility_abbreviation',
-                #	'width' => '3%',
-                #),
-                'metadata.creator_tool' => [
-                    'renderer' => MetadataRenderer::class,
-                    'rendererConfiguration' => [
-                        'property' => 'creator_tool',
-                    ],
-                    'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.creator_tool',
-                    'visible' => false,
-                    'sortable' => false,
-                ],
-                'metadata.content_creation_date' => [
-                    'renderer' => MetadataRenderer::class,
-                    'rendererConfiguration' => [
-                        'property' => 'content_creation_date',
-                    ],
-                    'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.content_creation_date',
-                    'visible' => false,
-                    'format' => 'datetime',
-                    'sortable' => false,
-                ],
-                'metadata.content_modification_date' => [
-                    'renderer' => MetadataRenderer::class,
-                    'rendererConfiguration' => [
-                        'property' => 'content_modification_date',
-                    ],
-                    'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.content_modification_date',
-                    'visible' => false,
-                    'format' => 'datetime',
-                    'sortable' => false,
-                ],
-            ]
-        ]
-    ];
-    ArrayUtility::mergeRecursiveWithOverrule($tca, $additionalTca);
+	$additionalTca = [
+		'ctrl' => [
+			'searchFields' => $tca['ctrl']['searchFields'] . ', metadata.keywords',
+		],
+		'grid' => [
+			'columns' => [
+				'metadata.keywords' => [
+					'renderer' => MetadataRenderer::class,
+					'configuration' => [
+						'property' => 'keywords',
+					],
+					'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.keywords',
+					'visible' => false,
+					'sortable' => false,
+				],
+				'metadata.fe_groups' => [
+					'renderers' => [
+						RelationEditRenderer::class,
+						FrontendPermissionRenderer::class,
+					],
+					'label' => 'LLL:EXT:media/Resources/Private/Language/locallang.xlf:permissions_fe_groups',
+					'visible' => false,
+					'sortable' => false,
+				],
+				'metadata.status' => [
+					'renderer' => MetadataRenderer::class,
+					'rendererConfiguration' => [
+						'property' => 'status',
+					],
+					'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.status',
+					'visible' => false,
+					'width' => '5%',
+					'sortable' => false,
+				],
+				# un-comment me to see the "visible" flag in the grid.
+				#'visible' => array(
+				#	'renderer' => 'Fab\Media\Grid\VisibilityRenderer', @todo will not work out of the box after 6.2 migration
+				#	'label' => 'LLL:EXT:vidi/Resources/Private/Language/locallang.xlf:visibility_abbreviation',
+				#	'width' => '3%',
+				#),
+				'metadata.creator_tool' => [
+					'renderer' => MetadataRenderer::class,
+					'rendererConfiguration' => [
+						'property' => 'creator_tool',
+					],
+					'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.creator_tool',
+					'visible' => false,
+					'sortable' => false,
+				],
+				'metadata.content_creation_date' => [
+					'renderer' => MetadataRenderer::class,
+					'rendererConfiguration' => [
+						'property' => 'content_creation_date',
+					],
+					'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.content_creation_date',
+					'visible' => false,
+					'format' => 'datetime',
+					'sortable' => false,
+				],
+				'metadata.content_modification_date' => [
+					'renderer' => MetadataRenderer::class,
+					'rendererConfiguration' => [
+						'property' => 'content_modification_date',
+					],
+					'label' => 'LLL:EXT:filemetadata/Resources/Private/Language/locallang_tca.xlf:sys_file_metadata.content_modification_date',
+					'visible' => false,
+					'format' => 'datetime',
+					'sortable' => false,
+				],
+			]
+		]
+	];
+	ArrayUtility::mergeRecursiveWithOverrule($tca, $additionalTca);
 }
 
 // Control buttons such as edit, delete, etc... must be set at the end in any case.
 $tca['grid']['columns']['__buttons'] = [
-    'renderer' => ButtonGroupRenderer::class,
+	'renderer' => ButtonGroupRenderer::class,
 ];
 
 ArrayUtility::mergeRecursiveWithOverrule($GLOBALS['TCA']['sys_file'], $tca);

Classes/Grid/UsageRenderer.php

Indentation +182 added lines, -182 removed lines

@@ -23,186 +23,186 @@
  */
 class UsageRenderer extends ColumnRendererAbstract
 {
-    /**
-     * Render usage of an asset in the grid.
-     *
-     * @return string
-     */
-    public function render(): string
-    {
-        $file = $this->getFileConverter()->convert($this->object);
-
-        $result = '';
-
-        // Add number of references on the top!
-        if ($this->object['number_of_references'] > 1) {
-            $result .= sprintf(
-                '<div><strong>%s (%s)</strong></div>',
-                $this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:references'),
-                $this->object['number_of_references']
-            );
-        }
-
-        // Render File usage
-        $fileReferences = $this->getFileReferenceService()->findFileReferences($file);
-        if (!empty($fileReferences)) {
-            // Finalize file references assembling.
-            $result .= sprintf(
-                $this->getWrappingTemplate(),
-                $this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:file_reference'),
-                $this->assembleOutput($fileReferences, array('referenceIdentifier' => 'uid_foreign', 'tableName' => 'tablenames'))
-            );
-        }
-
-        // Render link usage in RTE
-        $linkSoftReferences = $this->getFileReferenceService()->findSoftLinkReferences($file);
-        if (!empty($linkSoftReferences)) {
-            // Finalize link references assembling.
-            $result .= sprintf(
-                $this->getWrappingTemplate(),
-                $this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:link_references_in_rte'),
-                $this->assembleOutput($linkSoftReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
-            );
-        }
-
-        // Render image usage in RTE
-        $imageSoftReferences = $this->getFileReferenceService()->findSoftImageReferences($file);
-        if (!empty($imageSoftReferences)) {
-            // Finalize image references assembling.
-            $result .= sprintf(
-                $this->getWrappingTemplate(),
-                $this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:image_references_in_rte'),
-                $this->assembleOutput($imageSoftReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
-            );
-        }
-
-        // Render related index references
-        $contentIndexReferences = $this->getFileReferenceService()->findContentIndexReferences($file);
-        if (!empty($contentIndexReferences)) {
-            // Finalize image references assembling.
-            $result .= sprintf(
-                $this->getWrappingTemplate(),
-                $this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:content_reference'),
-                $this->assembleOutput($contentIndexReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
-            );
-        }
-
-        return $result;
-    }
-
-    /**
-     * Assemble output reference.
-     */
-    protected function assembleOutput(array $references, array $mapping): string
-    {
-        $result = '';
-        foreach ($references as $reference) {
-            $button = $this->makeLinkButton()
-                ->setHref($this->getEditUri($reference, $mapping))
-                ->setClasses('btn-edit-reference')
-                ->setIcon($this->getIconFactory()->getIcon('actions-document-open', Icon::SIZE_SMALL))
-                ->render();
-
-            $tableName = $reference[$mapping['tableName']];
-            $identifier = (int)$reference[$mapping['referenceIdentifier']];
-
-            $result .= sprintf(
-                '<li title="">%s %s</li>',
-                $button,
-                $this->computeTitle($tableName, $identifier)
-            );
-        }
-
-        return $result;
-    }
-
-    /**
-     * @param int $identifier
-     */
-    protected function computeTitle(string $tableName, $identifier): string
-    {
-        $title = '';
-        if (!empty($GLOBALS['TCA'][$tableName])) {
-            $title = $this->getRecordTitle($tableName, $identifier);
-            if (!$title) {
-                $title = Tca::table($tableName)->getTitle();
-            }
-        }
-        return $title;
-    }
-
-    protected function makeLinkButton(): LinkButton
-    {
-        return GeneralUtility::makeInstance(LinkButton::class);
-    }
-
-    protected function getEditUri(array $reference, array $mapping): string
-    {
-        $parameterName = sprintf('edit[%s][%s]', $reference[$mapping['tableName']], $reference[$mapping['referenceIdentifier']]);
-        $uri = BackendUtility::getModuleUrl(
-            'record_edit',
-            array(
-                $parameterName => 'edit',
-                'returnUrl' => $this->getModuleUrl()
-            )
-        );
-        return $uri;
-    }
-
-    protected function getModuleUrl(): string
-    {
-        $additionalParameters = [];
-        if (GeneralUtility::_GP('id')) {
-            $additionalParameters = array(
-                'id' => urldecode(GeneralUtility::_GP('id')),
-            );
-        }
-        return BackendUtility::getModuleUrl(GeneralUtility::_GP('route'), $additionalParameters);
-    }
-
-    /**
-     * Return the title given a table name and an identifier.
-     *
-     * @param string $identifier
-     */
-    protected function getRecordTitle(string $tableName, $identifier): string
-    {
-        $result = '';
-        if ($tableName && (int)$identifier > 0) {
-            $labelField = Tca::table($tableName)->getLabelField();
-
-            // Get the title of the record.
-            $record = $this->getDataService()
-                ->getRecord($tableName, ['uid' => $identifier,]);
-
-            if (!empty($record[$labelField])) {
-                $result = $record[$labelField];
-            }
-        }
-
-        return $result;
-    }
-
-    protected function getDataService(): DataService
-    {
-        return GeneralUtility::makeInstance(DataService::class);
-    }
-
-    /**
-     * Return the wrapping HTML template.
-     */
-    protected function getWrappingTemplate(): string
-    {
-        return '<div style="text-decoration: underline; margin-top: 10px; margin-bottom: 10px">%s</div><ul class="usage-list">%s</ul>';
-    }
-
-    protected function getFileReferenceService(): FileReferenceService
-    {
-        return GeneralUtility::makeInstance(FileReferenceService::class);
-    }
-
-    protected function getFileConverter(): ContentToFileConverter
-    {
-        return GeneralUtility::makeInstance(ContentToFileConverter::class);
-    }
+	/**
+	 * Render usage of an asset in the grid.
+	 *
+	 * @return string
+	 */
+	public function render(): string
+	{
+		$file = $this->getFileConverter()->convert($this->object);
+
+		$result = '';
+
+		// Add number of references on the top!
+		if ($this->object['number_of_references'] > 1) {
+			$result .= sprintf(
+				'<div><strong>%s (%s)</strong></div>',
+				$this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:references'),
+				$this->object['number_of_references']
+			);
+		}
+
+		// Render File usage
+		$fileReferences = $this->getFileReferenceService()->findFileReferences($file);
+		if (!empty($fileReferences)) {
+			// Finalize file references assembling.
+			$result .= sprintf(
+				$this->getWrappingTemplate(),
+				$this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:file_reference'),
+				$this->assembleOutput($fileReferences, array('referenceIdentifier' => 'uid_foreign', 'tableName' => 'tablenames'))
+			);
+		}
+
+		// Render link usage in RTE
+		$linkSoftReferences = $this->getFileReferenceService()->findSoftLinkReferences($file);
+		if (!empty($linkSoftReferences)) {
+			// Finalize link references assembling.
+			$result .= sprintf(
+				$this->getWrappingTemplate(),
+				$this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:link_references_in_rte'),
+				$this->assembleOutput($linkSoftReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
+			);
+		}
+
+		// Render image usage in RTE
+		$imageSoftReferences = $this->getFileReferenceService()->findSoftImageReferences($file);
+		if (!empty($imageSoftReferences)) {
+			// Finalize image references assembling.
+			$result .= sprintf(
+				$this->getWrappingTemplate(),
+				$this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:image_references_in_rte'),
+				$this->assembleOutput($imageSoftReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
+			);
+		}
+
+		// Render related index references
+		$contentIndexReferences = $this->getFileReferenceService()->findContentIndexReferences($file);
+		if (!empty($contentIndexReferences)) {
+			// Finalize image references assembling.
+			$result .= sprintf(
+				$this->getWrappingTemplate(),
+				$this->getLanguageService()->sL('LLL:EXT:media/Resources/Private/Language/locallang.xlf:content_reference'),
+				$this->assembleOutput($contentIndexReferences, array('referenceIdentifier' => 'recuid', 'tableName' => 'tablename'))
+			);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * Assemble output reference.
+	 */
+	protected function assembleOutput(array $references, array $mapping): string
+	{
+		$result = '';
+		foreach ($references as $reference) {
+			$button = $this->makeLinkButton()
+				->setHref($this->getEditUri($reference, $mapping))
+				->setClasses('btn-edit-reference')
+				->setIcon($this->getIconFactory()->getIcon('actions-document-open', Icon::SIZE_SMALL))
+				->render();
+
+			$tableName = $reference[$mapping['tableName']];
+			$identifier = (int)$reference[$mapping['referenceIdentifier']];
+
+			$result .= sprintf(
+				'<li title="">%s %s</li>',
+				$button,
+				$this->computeTitle($tableName, $identifier)
+			);
+		}
+
+		return $result;
+	}
+
+	/**
+	 * @param int $identifier
+	 */
+	protected function computeTitle(string $tableName, $identifier): string
+	{
+		$title = '';
+		if (!empty($GLOBALS['TCA'][$tableName])) {
+			$title = $this->getRecordTitle($tableName, $identifier);
+			if (!$title) {
+				$title = Tca::table($tableName)->getTitle();
+			}
+		}
+		return $title;
+	}
+
+	protected function makeLinkButton(): LinkButton
+	{
+		return GeneralUtility::makeInstance(LinkButton::class);
+	}
+
+	protected function getEditUri(array $reference, array $mapping): string
+	{
+		$parameterName = sprintf('edit[%s][%s]', $reference[$mapping['tableName']], $reference[$mapping['referenceIdentifier']]);
+		$uri = BackendUtility::getModuleUrl(
+			'record_edit',
+			array(
+				$parameterName => 'edit',
+				'returnUrl' => $this->getModuleUrl()
+			)
+		);
+		return $uri;
+	}
+
+	protected function getModuleUrl(): string
+	{
+		$additionalParameters = [];
+		if (GeneralUtility::_GP('id')) {
+			$additionalParameters = array(
+				'id' => urldecode(GeneralUtility::_GP('id')),
+			);
+		}
+		return BackendUtility::getModuleUrl(GeneralUtility::_GP('route'), $additionalParameters);
+	}
+
+	/**
+	 * Return the title given a table name and an identifier.
+	 *
+	 * @param string $identifier
+	 */
+	protected function getRecordTitle(string $tableName, $identifier): string
+	{
+		$result = '';
+		if ($tableName && (int)$identifier > 0) {
+			$labelField = Tca::table($tableName)->getLabelField();
+
+			// Get the title of the record.
+			$record = $this->getDataService()
+				->getRecord($tableName, ['uid' => $identifier,]);
+
+			if (!empty($record[$labelField])) {
+				$result = $record[$labelField];
+			}
+		}
+
+		return $result;
+	}
+
+	protected function getDataService(): DataService
+	{
+		return GeneralUtility::makeInstance(DataService::class);
+	}
+
+	/**
+	 * Return the wrapping HTML template.
+	 */
+	protected function getWrappingTemplate(): string
+	{
+		return '<div style="text-decoration: underline; margin-top: 10px; margin-bottom: 10px">%s</div><ul class="usage-list">%s</ul>';
+	}
+
+	protected function getFileReferenceService(): FileReferenceService
+	{
+		return GeneralUtility::makeInstance(FileReferenceService::class);
+	}
+
+	protected function getFileConverter(): ContentToFileConverter
+	{
+		return GeneralUtility::makeInstance(ContentToFileConverter::class);
+	}
 }

Classes/Resource/FileReferenceService.php

Indentation +215 added lines, -215 removed lines

@@ -21,219 +21,219 @@
  */
 class FileReferenceService
 {
-    /**
-     * Return all references found in sys_file_reference.
-     *
-     * @param File|int $file
-     */
-    public function findFileReferences($file): array
-    {
-        $fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
-
-        // Get the file references of the file.
-        return $this->getDataService()->getRecords(
-            'sys_file_reference',
-            [
-                'uid_local' => $fileIdentifier,
-            ]
-        );
-    }
-
-    /**
-     * Return soft image references.
-     *
-     * @param File|int $file
-     */
-    public function findSoftImageReferences($file): array
-    {
-        $fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
-
-        // Get the file references of the file in the RTE.
-        $softReferences = $this->getDataService()->getRecords(
-            'sys_refindex',
-            [
-                'softref_key' => 'rtehtmlarea_images',
-                'ref_table' => 'sys_file',
-                'ref_uid' => $fileIdentifier,
-            ]
-        );
-        return $softReferences;
-    }
-
-    protected function findFileIndexReferences(File $file): array
-    {
-        $queryBuilder = $this->getQueryBuilder('sys_refindex');
-        return $queryBuilder
-            ->select('*')
-            ->from('sys_refindex')
-            ->where(
-                $queryBuilder->expr()->eq(
-                    'ref_table',
-                    $queryBuilder->createNamedParameter('sys_file')
-                ),
-                $queryBuilder->expr()->eq(
-                    'ref_uid',
-                    $queryBuilder->createNamedParameter($file->getUid(), Connection::PARAM_INT)
-                ),
-                $queryBuilder->expr()->neq(
-                    'tablename',
-                    $queryBuilder->createNamedParameter('sys_file_metadata')
-                )
-            )
-            ->executeQuery()
-            ->fetchAllAssociative();
-    }
-
-    public function findContentIndexReferences(File $file): array
-    {
-        $queryBuilder = $this->getQueryBuilder('sys_refindex');
-        $relatedIndexReferences = [];
-        foreach ($this->findFileIndexReferences($file) as $fileIndexReference) {
-            $relatedIndexReference = $queryBuilder
-                ->select('*')
-                ->from('sys_refindex')
-                ->where(
-                    $queryBuilder->expr()->eq(
-                        'ref_table',
-                        $queryBuilder->createNamedParameter('sys_file_reference')
-                    ),
-                    $queryBuilder->expr()->eq(
-                        'ref_uid',
-                        $queryBuilder->createNamedParameter($fileIndexReference['recuid'], Connection::PARAM_INT)
-                    ),
-                    $queryBuilder->expr()->neq(
-                        'tablename',
-                        $queryBuilder->createNamedParameter('sys_file_metadata')
-                    )
-                )
-                ->executeQuery()
-                ->fetchAssociative();
-
-            if ($relatedIndexReference) {
-                $relatedIndexReferences[] = $relatedIndexReference;
-            }
-        }
-        return $relatedIndexReferences;
-    }
-
-    /**
-     * Return link image references.
-     *
-     * @param File|int $file
-     */
-    public function findSoftLinkReferences($file)
-    {
-        $fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
-
-        // Get the link references of the file.
-        $softReferences = $this->getDataService()->getRecords(
-            'sys_refindex',
-            [
-                'softref_key' => 'typolink_tag',
-                'ref_table' => 'sys_file',
-                'ref_uid' => $fileIdentifier,
-            ]
-        );
-        return $softReferences;
-    }
-
-    /**
-     * @param File|int $file
-     */
-    public function countTotalReferences($file): int
-    {
-
-        $fileUid = $file instanceof File
-            ? $file->getUid()
-            : $file;
-
-        $numberOfReferences = $this->countFileReferences($fileUid);
-        $numberOfReferences += $this->countSoftImageReferences($fileUid);
-        $numberOfReferences += $this->countSoftLinkReferences($fileUid);
-        $numberOfReferences += $this->countFileIndexReferences($fileUid);
-
-        return $numberOfReferences;
-    }
-
-    /**
-     * Count all references found in sys_file_reference.
-     */
-    protected function countFileReferences(int $fileUid): int
-    {
-        return $this->getDataService()
-            ->count(
-                'sys_file_reference',
-                [
-                    'uid_local' => $fileUid
-                ]
-            );
-    }
-
-    /**
-     * Count soft image references.
-     */
-    protected function countSoftImageReferences(int $fileUid): int
-    {
-        return $this->getDataService()
-            ->count(
-                'sys_refindex',
-                [
-                    'softref_key' => 'rtehtmlarea_images',
-                    'ref_table' => 'sys_file',
-                    'ref_uid' => $fileUid
-                ]
-            );
-    }
-
-    /**
-     * Count link image references.
-     */
-    protected function countSoftLinkReferences(int $fileUid): int
-    {
-        return $this->getDataService()
-            ->count(
-                'sys_refindex',
-                [
-                    'softref_key' => 'typolink_tag',
-                    'ref_table' => 'sys_file',
-                    'ref_uid' => $fileUid
-                ]
-            );
-    }
-
-    protected function countFileIndexReferences(int $fileUid): int
-    {
-        $queryBuilder = $this->getQueryBuilder('sys_refindex');
-        return (int)$queryBuilder
-            ->count('*')
-            ->from('sys_refindex')
-            ->where(
-                $queryBuilder->expr()->eq(
-                    'ref_table',
-                    $queryBuilder->createNamedParameter('sys_file')
-                ),
-                $queryBuilder->expr()->eq(
-                    'ref_uid',
-                    $queryBuilder->createNamedParameter($fileUid, Connection::PARAM_INT)
-                ),
-                $queryBuilder->expr()->neq(
-                    'tablename',
-                    $queryBuilder->createNamedParameter('sys_file_metadata')
-                )
-            )
-            ->executeQuery()
-            ->fetchOne();
-    }
-
-    protected function getQueryBuilder(string $tableName): QueryBuilder
-    {
-        /** @var ConnectionPool $connectionPool */
-        $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
-        return $connectionPool->getQueryBuilderForTable($tableName);
-    }
-
-    protected function getDataService(): DataService
-    {
-        return GeneralUtility::makeInstance(DataService::class);
-    }
+	/**
+	 * Return all references found in sys_file_reference.
+	 *
+	 * @param File|int $file
+	 */
+	public function findFileReferences($file): array
+	{
+		$fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
+
+		// Get the file references of the file.
+		return $this->getDataService()->getRecords(
+			'sys_file_reference',
+			[
+				'uid_local' => $fileIdentifier,
+			]
+		);
+	}
+
+	/**
+	 * Return soft image references.
+	 *
+	 * @param File|int $file
+	 */
+	public function findSoftImageReferences($file): array
+	{
+		$fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
+
+		// Get the file references of the file in the RTE.
+		$softReferences = $this->getDataService()->getRecords(
+			'sys_refindex',
+			[
+				'softref_key' => 'rtehtmlarea_images',
+				'ref_table' => 'sys_file',
+				'ref_uid' => $fileIdentifier,
+			]
+		);
+		return $softReferences;
+	}
+
+	protected function findFileIndexReferences(File $file): array
+	{
+		$queryBuilder = $this->getQueryBuilder('sys_refindex');
+		return $queryBuilder
+			->select('*')
+			->from('sys_refindex')
+			->where(
+				$queryBuilder->expr()->eq(
+					'ref_table',
+					$queryBuilder->createNamedParameter('sys_file')
+				),
+				$queryBuilder->expr()->eq(
+					'ref_uid',
+					$queryBuilder->createNamedParameter($file->getUid(), Connection::PARAM_INT)
+				),
+				$queryBuilder->expr()->neq(
+					'tablename',
+					$queryBuilder->createNamedParameter('sys_file_metadata')
+				)
+			)
+			->executeQuery()
+			->fetchAllAssociative();
+	}
+
+	public function findContentIndexReferences(File $file): array
+	{
+		$queryBuilder = $this->getQueryBuilder('sys_refindex');
+		$relatedIndexReferences = [];
+		foreach ($this->findFileIndexReferences($file) as $fileIndexReference) {
+			$relatedIndexReference = $queryBuilder
+				->select('*')
+				->from('sys_refindex')
+				->where(
+					$queryBuilder->expr()->eq(
+						'ref_table',
+						$queryBuilder->createNamedParameter('sys_file_reference')
+					),
+					$queryBuilder->expr()->eq(
+						'ref_uid',
+						$queryBuilder->createNamedParameter($fileIndexReference['recuid'], Connection::PARAM_INT)
+					),
+					$queryBuilder->expr()->neq(
+						'tablename',
+						$queryBuilder->createNamedParameter('sys_file_metadata')
+					)
+				)
+				->executeQuery()
+				->fetchAssociative();
+
+			if ($relatedIndexReference) {
+				$relatedIndexReferences[] = $relatedIndexReference;
+			}
+		}
+		return $relatedIndexReferences;
+	}
+
+	/**
+	 * Return link image references.
+	 *
+	 * @param File|int $file
+	 */
+	public function findSoftLinkReferences($file)
+	{
+		$fileIdentifier = $file instanceof File ? $file->getUid() : (int)$file;
+
+		// Get the link references of the file.
+		$softReferences = $this->getDataService()->getRecords(
+			'sys_refindex',
+			[
+				'softref_key' => 'typolink_tag',
+				'ref_table' => 'sys_file',
+				'ref_uid' => $fileIdentifier,
+			]
+		);
+		return $softReferences;
+	}
+
+	/**
+	 * @param File|int $file
+	 */
+	public function countTotalReferences($file): int
+	{
+
+		$fileUid = $file instanceof File
+			? $file->getUid()
+			: $file;
+
+		$numberOfReferences = $this->countFileReferences($fileUid);
+		$numberOfReferences += $this->countSoftImageReferences($fileUid);
+		$numberOfReferences += $this->countSoftLinkReferences($fileUid);
+		$numberOfReferences += $this->countFileIndexReferences($fileUid);
+
+		return $numberOfReferences;
+	}
+
+	/**
+	 * Count all references found in sys_file_reference.
+	 */
+	protected function countFileReferences(int $fileUid): int
+	{
+		return $this->getDataService()
+			->count(
+				'sys_file_reference',
+				[
+					'uid_local' => $fileUid
+				]
+			);
+	}
+
+	/**
+	 * Count soft image references.
+	 */
+	protected function countSoftImageReferences(int $fileUid): int
+	{
+		return $this->getDataService()
+			->count(
+				'sys_refindex',
+				[
+					'softref_key' => 'rtehtmlarea_images',
+					'ref_table' => 'sys_file',
+					'ref_uid' => $fileUid
+				]
+			);
+	}
+
+	/**
+	 * Count link image references.
+	 */
+	protected function countSoftLinkReferences(int $fileUid): int
+	{
+		return $this->getDataService()
+			->count(
+				'sys_refindex',
+				[
+					'softref_key' => 'typolink_tag',
+					'ref_table' => 'sys_file',
+					'ref_uid' => $fileUid
+				]
+			);
+	}
+
+	protected function countFileIndexReferences(int $fileUid): int
+	{
+		$queryBuilder = $this->getQueryBuilder('sys_refindex');
+		return (int)$queryBuilder
+			->count('*')
+			->from('sys_refindex')
+			->where(
+				$queryBuilder->expr()->eq(
+					'ref_table',
+					$queryBuilder->createNamedParameter('sys_file')
+				),
+				$queryBuilder->expr()->eq(
+					'ref_uid',
+					$queryBuilder->createNamedParameter($fileUid, Connection::PARAM_INT)
+				),
+				$queryBuilder->expr()->neq(
+					'tablename',
+					$queryBuilder->createNamedParameter('sys_file_metadata')
+				)
+			)
+			->executeQuery()
+			->fetchOne();
+	}
+
+	protected function getQueryBuilder(string $tableName): QueryBuilder
+	{
+		/** @var ConnectionPool $connectionPool */
+		$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
+		return $connectionPool->getQueryBuilderForTable($tableName);
+	}
+
+	protected function getDataService(): DataService
+	{
+		return GeneralUtility::makeInstance(DataService::class);
+	}
 }