Fab\Media\Grid\UsageRenderer

Complexity

Total Complexity

22

Size/Duplication

Total Lines	213
Duplicated Lines	12.68 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	assembleOutput()	0	23	2
A	computeTitle()	0	11	3
A	makeLinkButton()	0	4	1
A	getEditUri()	0	13	1
A	getModuleUrl()	0	11	2
B	render()	27	53	5
A	getRecordTitle()	0	19	4
A	getDataService()	0	4	1
A	getWrappingTemplate()	0	4	1
A	getFileReferenceService()	0	4	1
A	getFileConverter()	0	4	1

<?php
namespace Fab\Media\Grid;

/*
 * This file is part of the Fab/Media project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use Fab\Vidi\Grid\ColumnRendererAbstract;
use Fab\Vidi\Service\DataService;
use TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton;
use Fab\Vidi\Utility\BackendUtility;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use Fab\Vidi\Tca\Tca;

/**
 * Class rendering usage of an asset in the grid.
 */
class UsageRenderer extends ColumnRendererAbstract
{

    /**
     * Render usage of an asset in the grid.
     *
     * @return string
     */
    public function render()
    {
        $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)) {

This code seems to be duplicated across your project.

            // 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)) {

This code seems to be duplicated across your project.

            // 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)) {

This code seems to be duplicated across your project.

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

        return $result;
    }

    /**
     * Assemble output reference.
     *
     * @param array $references
     * @param array $mapping
     * @return string
     */
    protected function assembleOutput(array $references, array $mapping)
    {

        $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 string $tableName
     * @param int $identifier
     * @return string
     */
    protected function computeTitle($tableName, $identifier)
    {
        $title = '';
        if (!empty($GLOBALS['TCA'][$tableName])) {
            $title = $this->getRecordTitle($tableName, $identifier);
            if (!$title) {
                $title = Tca::table($tableName)->getTitle();
            }
        }
        return $title;
    }

    /**
     * @return object|LinkButton
     */
    protected function makeLinkButton()
    {
        return GeneralUtility::makeInstance(LinkButton::class);
    }

    /**
     * @param array $reference
     * @param array $mapping
     * @return string
     */
    protected function getEditUri(array $reference, array $mapping)
    {

        $parameterName = sprintf('edit[%s][%s]', $reference[$mapping['tableName']], $reference[$mapping['referenceIdentifier']]);
        $uri = BackendUtility::getModuleUrl(
            'record_edit',
            array(
                $parameterName => 'edit',
                'returnUrl' => $this->getModuleUrl()
            )
        );
        return $uri;
    }

    /**
     * @return string
     */
    protected function getModuleUrl()
    {

        $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 $tableName
     * @param string $identifier
     * @return string
     */
    protected function getRecordTitle($tableName, $identifier)
    {

        $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;
    }

    /**
     * @return object|DataService
     */
    protected function getDataService(): DataService
    {
        return GeneralUtility::makeInstance(DataService::class);
    }

    /**
     * Return the wrapping HTML template.
     *
     * @return string
     */
    protected function getWrappingTemplate()
    {
        return '<div style="text-decoration: underline; margin-top: 10px; margin-bottom: 10px">%s</div><ul class="usage-list">%s</ul>';
    }

    /**
     * @return \Fab\Media\Resource\FileReferenceService|object
     */
    protected function getFileReferenceService()
    {
        return GeneralUtility::makeInstance(\Fab\Media\Resource\FileReferenceService::class);
    }

    /**
     * @return \Fab\Media\TypeConverter\ContentToFileConverter|object
     */
    protected function getFileConverter()
    {
        return GeneralUtility::makeInstance(\Fab\Media\TypeConverter\ContentToFileConverter::class);
    }
}