HDNET\Autoloader\Utility\IconUtility

Complexity

Total Complexity

12

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addTcaTypeIcon()	0	14	2
A	getByExtensionKey()	0	13	3
A	getByModelName()	0	19	2
A	getIconFileExtension()	0	16	3
A	returnRelativeIconPath()	0	9	2

<?php

/**
 * Icon helper.
 */
declare(strict_types = 1);

namespace HDNET\Autoloader\Utility;

use TYPO3\CMS\Core\Imaging\IconProvider\BitmapIconProvider;
use TYPO3\CMS\Core\Imaging\IconProvider\SvgIconProvider;
use TYPO3\CMS\Core\Imaging\IconRegistry;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\PathUtility;
use TYPO3\CMS\Core\Utility\StringUtility;

/**
 * Icon helper.
 */
class IconUtility
{
    /**
     * Add the given icon to the TCA table type.
     *
     * @param string $table
     * @param string $type
     * @param string $icon
     */
    public static function addTcaTypeIcon($table, $type, $icon): void
    {
        $fullIconPath = mb_substr(PathUtility::getAbsoluteWebPath($icon), 1);
        if (StringUtility::endsWith(mb_strtolower($fullIconPath), 'svg')) {
            $iconProviderClass = SvgIconProvider::class;
        } else {
            $iconProviderClass = BitmapIconProvider::class;
        }
        /** @var IconRegistry $iconRegistry */
        $iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);
        $iconIdentifier = 'tcarecords-' . $table . '-' . $type;
        $iconRegistry->registerIcon($iconIdentifier, $iconProviderClass, ['source' => $fullIconPath]);
        $GLOBALS['TCA']['tt_content']['ctrl']['typeicon_classes'][$type] = $iconIdentifier;
    }

    /**
     * Get the relative path of the extension icon.
     *
     * @param string $extensionKey
     * @param bool   $extSyntax    Get the EXT: Syntax instead of a rel Path
     *
     * @return string
     */
    public static function getByExtensionKey($extensionKey, $extSyntax = false)
    {
        $fileExtension = self::getIconFileExtension(ExtensionManagementUtility::extPath($extensionKey) . 'Resources/Public/Icons/Extension.');
        if ($fileExtension) {

The expression $fileExtension of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            return self::returnRelativeIconPath($extensionKey, 'Resources/Public/Icons/Extension.' . $fileExtension, $extSyntax);
        }
        $fileExtension = self::getIconFileExtension(ExtensionManagementUtility::extPath($extensionKey) . 'ext_icon.');
        if ($fileExtension) {

The expression $fileExtension of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            return self::returnRelativeIconPath($extensionKey, 'ext_icon.' . $fileExtension, $extSyntax);
        }

        return self::getByExtensionKey('autoloader');
    }

    /**
     * Get the absolute table icon for the given model name.
     *
     * @param string $modelClassName
     * @param bool   $extSyntax      Get the EXT: Syntax instead of a rel Path
     *
     * @return string
     */
    public static function getByModelName($modelClassName, $extSyntax = false)
    {
        $modelInformation = ClassNamingUtility::explodeObjectModelName($modelClassName);

        $extensionKey = GeneralUtility::camelCaseToLowerCaseUnderscored($modelInformation['extensionName']);
        $modelName = str_replace('\\', '/', $modelInformation['modelName']);

        $tableIconPath = ExtensionManagementUtility::extPath($extensionKey) . 'Resources/Public/Icons/' . $modelName . '.';
        $fileExtension = self::getIconFileExtension($tableIconPath);
        if ($fileExtension) {

The expression $fileExtension of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            return self::returnRelativeIconPath(
                $extensionKey,
                'Resources/Public/Icons/' . $modelName . '.' . $fileExtension,
                $extSyntax
            );
        }

        return self::getByExtensionKey($extensionKey, $extSyntax);
    }

    /**
     * Get the file extension (svg,png,gif) of the absolute path. The path is
     * without file extension but incl. the dot. e.g.:
     * "/test/icon.".
     *
     * @param string $absolutePathWithoutExtension
     *
     * @return string
     */
    public static function getIconFileExtension($absolutePathWithoutExtension)
    {
        $fileExtensions = [
            'svg',
            'png',
            'gif',
            'jpg',
        ];
        foreach ($fileExtensions as $fileExtension) {
            if (is_file($absolutePathWithoutExtension . $fileExtension)) {
                return $fileExtension;
            }
        }

        return false;
    }

    /**
     * Return the right relative path.
     *
     * @param string $extensionKey
     * @param string $path
     * @param bool   $extSyntax
     *
     * @return string
     */
    protected static function returnRelativeIconPath($extensionKey, $path, $extSyntax = false)
    {
        $extSyntaxPath = 'EXT:' . $extensionKey . '/' . $path;
        if ($extSyntax) {
            return $extSyntaxPath;
        }

        return PathUtility::getAbsoluteWebPath(GeneralUtility::getFileAbsFileName($extSyntaxPath));
    }
}