IconUtility.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Utility;

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Versioning\VersionState;

class IconUtility {

    static public $fileSpriteIconNames = array(
        'htm' => 'mimetypes-text-html',
        'html' => 'mimetypes-text-html',
        'css' => 'mimetypes-text-css',
        'js' => 'mimetypes-text-js',
        'csv' => 'mimetypes-text-csv',
        'php' => 'mimetypes-text-php',
        'php6' => 'mimetypes-text-php',
        'php5' => 'mimetypes-text-php',
        'php4' => 'mimetypes-text-php',
        'php3' => 'mimetypes-text-php',
        'inc' => 'mimetypes-text-php',
        'ts' => 'mimetypes-text-ts',
        'txt' => 'mimetypes-text-text',
        'class' => 'mimetypes-text-text',
        'tmpl' => 'mimetypes-text-text',
        'jpg' => 'mimetypes-media-image',
        'jpeg' => 'mimetypes-media-image',
        'gif' => 'mimetypes-media-image',
        'png' => 'mimetypes-media-image',
        'bmp' => 'mimetypes-media-image',
        'tif' => 'mimetypes-media-image',
        'tga' => 'mimetypes-media-image',
        'psd' => 'mimetypes-media-image',
        'eps' => 'mimetypes-media-image',
        'avi' => 'mimetypes-media-video',
        'mpg' => 'mimetypes-media-video',
        'mpeg' => 'mimetypes-media-video',
        'mov' => 'mimetypes-media-video',
        'wav' => 'mimetypes-media-audio',
        'mp3' => 'mimetypes-media-audio',
        'mid' => 'mimetypes-media-audio',
        'swf' => 'mimetypes-media-flash',
        'swa' => 'mimetypes-media-flash',
        'exe' => 'mimetypes-executable-executable',
        'com' => 'mimetypes-executable-executable',
        't3x' => 'mimetypes-compressed',
        't3d' => 'mimetypes-compressed',
        'zip' => 'mimetypes-compressed',
        'tgz' => 'mimetypes-compressed',
        'gz' => 'mimetypes-compressed',
        'pdf' => 'mimetypes-pdf',
        'doc' => 'mimetypes-word',
        'dot' => 'mimetypes-word',
        'docm' => 'mimetypes-word',
        'docx' => 'mimetypes-word',
        'dotm' => 'mimetypes-word',
        'dotx' => 'mimetypes-word',
        'sxw' => 'mimetypes-word',
        'rtf' => 'mimetypes-word',
        'xls' => 'mimetypes-excel',
        'xlsm' => 'mimetypes-excel',
        'xlsx' => 'mimetypes-excel',
        'xltm' => 'mimetypes-excel',
        'xltx' => 'mimetypes-excel',
        'sxc' => 'mimetypes-excel',
        'pps' => 'mimetypes-powerpoint',
        'ppsx' => 'mimetypes-powerpoint',
        'ppt' => 'mimetypes-powerpoint',
        'pptm' => 'mimetypes-powerpoint',
        'pptx' => 'mimetypes-powerpoint',
        'potm' => 'mimetypes-powerpoint',
        'potx' => 'mimetypes-powerpoint',
        'mount' => 'apps-filetree-mount',
        'folder' => 'apps-filetree-folder-default',
        'default' => 'mimetypes-other-other'
    );

    static protected $spriteIconCache = array();

    static public function getIconImage($table, $row = array(), $backPath, $params = '', $shaded = FALSE) {
        GeneralUtility::logDeprecatedFunction();

        $str = '<img' . self::skinImg($backPath, self::getIcon($table, $row, $shaded), 'width="18" height="16"') . (trim($params) ? ' ' . trim($params) : '');
        if (!stristr($str, 'alt="')) {
            $str .= ' alt=""';
        }
        $str .= ' />';
        return $str;
    }

    static public function getIcon($table, $row = array(), $shaded = FALSE) {
        // Flags
        // If set, then the usergroup number will NOT be printed unto the icon. NOTICE.
        // The icon is generated only if a default icon for groups is not found... So effectively this is ineffective.
        $doNotRenderUserGroupNumber = TRUE;
        // Shadow
        if (!empty($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) && !empty($row['t3ver_state'])) {
            switch (VersionState::cast($row['t3ver_state'])) {
                case new VersionState(VersionState::NEW_PLACEHOLDER):
                    return 'gfx/i/shadow_hide.png';
                    break;
                case new VersionState(VersionState::DELETE_PLACEHOLDER):
                    return 'gfx/i/shadow_delete.png';
                    break;
                case new VersionState(VersionState::MOVE_PLACEHOLDER):
                    return 'gfx/i/shadow_moveto_plh.png';
                    break;
                case new VersionState(VersionState::MOVE_POINTER):
                    return 'gfx/i/shadow_moveto_pointer.png';
                    break;
            }
        }
        // First, find the icon file name. This can depend on configuration in TCA, field values and more:
        if ($table == 'pages') {
            $iconfile = $GLOBALS['PAGES_TYPES'][$row['doktype']]['icon'];
            if (!$iconfile) {
                $iconfile = $GLOBALS['PAGES_TYPES']['default']['icon'];
            }
        } else {
            if (!($iconfile = $GLOBALS['TCA'][$table]['ctrl']['typeicons'][$row[$GLOBALS['TCA'][$table]['ctrl']['typeicon_column']]])) {
                $iconfile = $GLOBALS['TCA'][$table]['ctrl']['iconfile'] ?: $table . '.gif';
            }
        }
        // Setting path of iconfile if not already set. Default is "gfx/i/"
        if (!strstr($iconfile, '/')) {
            $iconfile = 'gfx/i/' . $iconfile;
        }
        // Setting the absolute path where the icon should be found as a file:
        if (substr($iconfile, 0, 3) == '../') {
            $absfile = PATH_site . substr($iconfile, 3);
        } else {
            $absfile = PATH_typo3 . $iconfile;
        }
        // Initializing variables, all booleans except otherwise stated:
        $hidden = FALSE;
        $timing = FALSE;
        $futuretiming = FALSE;
        // In fact an integer value
        $user = FALSE;
        $deleted = FALSE;
        // Set, if a page-record (only pages!) has the extend-to-subpages flag set.
        $protectSection = FALSE;
        $noIconFound = $row['_NO_ICON_FOUND'] ? TRUE : FALSE;
        // + $shaded which is also boolean!
        // Icon state based on "enableFields":
        if (is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns'])) {
            $enCols = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
            // If "hidden" is enabled:
            if ($enCols['disabled']) {
                if ($row[$enCols['disabled']]) {
                    $hidden = TRUE;
                }
            }
            // If a "starttime" is set and higher than current time:
            if ($enCols['starttime']) {
                if ($GLOBALS['EXEC_TIME'] < (int)$row[$enCols['starttime']]) {
                    $timing = TRUE;
                    // And if "endtime" is NOT set:
                    if ((int)$row[$enCols['endtime']] === 0) {
                        $futuretiming = TRUE;
                    }
                }
            }
            // If an "endtime" is set:
            if ($enCols['endtime']) {
                if ((int)$row[$enCols['endtime']] > 0) {
                    if ((int)$row[$enCols['endtime']] < $GLOBALS['EXEC_TIME']) {
                        // End-timing applies at this point.
                        $timing = TRUE;
                    } else {
                        // End-timing WILL apply in the future for this element.
                        $futuretiming = TRUE;
                    }
                }
            }
            // If a user-group field is set:
            if ($enCols['fe_group']) {
                $user = $row[$enCols['fe_group']];
                if ($user && $doNotRenderUserGroupNumber) {
                    $user = 100;
                }
            }
        }
        // If "deleted" flag is set (only when listing records which are also deleted!)
        if ($col = $row[$GLOBALS['TCA'][$table]['ctrl']['delete']]) {
            $deleted = TRUE;
        }
        // Detecting extendToSubpages (for pages only)
        if ($table == 'pages' && $row['extendToSubpages'] && ($hidden || $timing || $futuretiming || $user)) {
            $protectSection = TRUE;
        }
        // If ANY of the booleans are set it means we have to alter the icon:
        if ($hidden || $timing || $futuretiming || $user || $deleted || $shaded || $noIconFound) {
            $flags = '';
            $string = '';
            if ($deleted) {
                $string = 'deleted';
                $flags = 'd';
            } elseif ($noIconFound) {
                // This is ONLY for creating icons with "?" on easily...
                $string = 'no_icon_found';
                $flags = 'x';
            } else {
                if ($hidden) {
                    $string .= 'hidden';
                }
                if ($timing) {
                    $string .= 'timing';
                }
                if (!$string && $futuretiming) {
                    $string = 'futuretiming';
                }
                $flags .= ($hidden ? 'h' : '') . ($timing ? 't' : '') . ($futuretiming ? 'f' : '') . ($user ? 'u' : '') . ($protectSection ? 'p' : '') . ($shaded ? 's' : '');
            }
            // Create tagged icon file name:
            $iconFileName_stateTagged = preg_replace('/.([[:alnum:]]+)$/', '__' . $flags . '.\\1', basename($iconfile));
            // Check if tagged icon file name exists (a tagged icon means the icon base name with the flags added between body and extension of the filename, prefixed with underscore)
            if (@is_file((dirname($absfile) . '/' . $iconFileName_stateTagged)) || @is_file(($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . '/' . dirname($iconfile) . '/' . $iconFileName_stateTagged))) {
                // Look for [iconname]_xxxx.[ext]
                return dirname($iconfile) . '/' . $iconFileName_stateTagged;
            } else {
                // Otherwise, create the icon:
                $theRes = self::makeIcon($GLOBALS['BACK_PATH'] . $iconfile, $string, $user, $protectSection, $absfile, $iconFileName_stateTagged);
                return $theRes;
            }
        } else {
            return $iconfile;
        }
    }

    static public function skinImg($backPath, $src, $wHattribs = '', $outputMode = 0) {
        static $cachedSkinImages = array();
        $imageId = md5($backPath . $src . $wHattribs . $outputMode);
        if (isset($cachedSkinImages[$imageId])) {
            return $cachedSkinImages[$imageId];
        }
        // Setting source key. If the icon is refered to inside an extension, we homogenize the prefix to "ext/":
        $srcKey = preg_replace('/^(\\.\\.\\/typo3conf\\/ext|sysext|ext)\\//', 'ext/', $src);
        // LOOKING for alternative icons:
        if ($GLOBALS['TBE_STYLES']['skinImg'][$srcKey]) {
            // Slower or faster with is_array()? Could be used.
            list($src, $wHattribs) = $GLOBALS['TBE_STYLES']['skinImg'][$srcKey];
        } elseif ($GLOBALS['TBE_STYLES']['skinImgAutoCfg']) {
            // Otherwise, test if auto-detection is enabled:
            // Search for alternative icon automatically:
            $fExt = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['forceFileExtension'];
            $scaleFactor = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['scaleFactor'] ?: 1;
            // Scaling factor
            $lookUpName = $fExt ? preg_replace('/\\.[[:alnum:]]+$/', '', $srcKey) . '.' . $fExt : $srcKey;
            // Set filename to look for
            if ($fExt && !@is_file(($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . $lookUpName))) {
                // Fallback to original filename if icon with forced extension doesn't exists
                $lookUpName = $srcKey;
            }
            // If file is found:
            if (@is_file(($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . $lookUpName))) {
                // If there is a file...
                $iInfo = @getimagesize(($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . $lookUpName));
                // Get width/height:
                // Set $src and $wHattribs:
                $src = $GLOBALS['TBE_STYLES']['skinImgAutoCfg']['relDir'] . $lookUpName;
                $wHattribs = 'width="' . round($iInfo[0] * $scaleFactor) . '" height="' . round($iInfo[1] * $scaleFactor) . '"';
            }
            // In any case, set currect src / wHattrib - this way we make sure that an entry IS found next time we hit the function,
            // regardless of whether it points to a alternative icon or just the current.
            $GLOBALS['TBE_STYLES']['skinImg'][$srcKey] = array($src, $wHattribs);
        }
        // Rendering disabled (greyed) icons using _i (inactive) as name suffix ("_d" is already used)
        $matches = array();
        $srcBasename = basename($src);
        if (preg_match('/(.*)_i(\\....)$/', $srcBasename, $matches)) {
            $temp_path = dirname(PATH_thisScript) . '/';
            if (!@is_file(($temp_path . $backPath . $src))) {
                $srcOrg = preg_replace('/_i' . preg_quote($matches[2], '/') . '$/', $matches[2], $src);
                $src = self::makeIcon($backPath . $srcOrg, 'disabled', 0, FALSE, $temp_path . $backPath . $srcOrg, $srcBasename);
            }
        }
        // Return icon source/wHattributes:
        $output = '';
        switch ($outputMode) {
            case 0:
                $output = ' src="' . $backPath . $src . '" ' . $wHattribs;
                break;
            case 1:
                $output = $backPath . $src;
                break;
            case 2:
                $output = $wHattribs;
                break;
        }
        $cachedSkinImages[$imageId] = $output;
        return $output;
    }

    /***********************************
     *
     * Other functions
     *
     ***********************************/
    static public function makeIcon($iconfile, $mode, $user, $protectSection, $absFile, $iconFileName_stateTagged) {
        $iconFileName = 'icon_' . GeneralUtility::shortMD5(($iconfile . '|' . $mode . '|-' . $user . '|' . $protectSection)) . '_' . $iconFileName_stateTagged . '.' . ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png'] ? 'png' : 'gif');
        $mainpath = '../typo3temp/' . $iconFileName;
        $path = PATH_site . 'typo3temp/' . $iconFileName;
        if (file_exists(PATH_typo3 . 'icons/' . $iconFileName)) {
            // Returns if found in typo3/icons/
            return 'icons/' . $iconFileName;
        } elseif (file_exists($path)) {
            // Returns if found in ../typo3temp/icons/
            return $mainpath;
        } else {
            // Makes icon:
            if (file_exists($absFile)) {
                if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib']) {
                    // Create image pointer, if possible
                    $im = self::imagecreatefrom($absFile);
                    if ($im < 0) {
                        return $iconfile;
                    }
                    // Converting to gray scale, dimming the icon:
                    if ($mode == 'disabled' or $mode != 'futuretiming' && $mode != 'no_icon_found' && !(!$mode && $user)) {
                        $totalImageColors = ImageColorsTotal($im);
                        for ($c = 0; $c < $totalImageColors; $c++) {
                            $cols = ImageColorsForIndex($im, $c);
                            $newcol = round(($cols['red'] + $cols['green'] + $cols['blue']) / 3);
                            $lighten = $mode == 'disabled' ? 2.5 : 2;
                            $newcol = round(255 - (255 - $newcol) / $lighten);
                            ImageColorSet($im, $c, $newcol, $newcol, $newcol);
                        }
                    }
                    // Applying user icon, if there are access control on the item:
                    if ($user) {
                        if ($user < 100) {
                            // Apply user number only if lower than 100
                            $black = ImageColorAllocate($im, 0, 0, 0);
                            imagefilledrectangle($im, 0, 0, $user > 10 ? 9 : 5, 8, $black);
                            $white = ImageColorAllocate($im, 255, 255, 255);
                            imagestring($im, 1, 1, 1, $user, $white);
                        }
                        $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_group.gif');
                        if ($ol_im < 0) {
                            return $iconfile;
                        }
                        self::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
                    }
                    // Applying overlay based on mode:
                    if ($mode) {
                        unset($ol_im);
                        switch ($mode) {
                            case 'deleted':
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_deleted.gif');
                                break;
                            case 'futuretiming':
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_timing.gif');
                                break;
                            case 'timing':
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_timing.gif');
                                break;
                            case 'hiddentiming':
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_hidden_timing.gif');
                                break;
                            case 'no_icon_found':
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_no_icon_found.gif');
                                break;
                            case 'disabled':
                                // is already greyed - nothing more
                                $ol_im = 0;
                                break;
                            case 'hidden':

                            default:
                                $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_hidden.gif');
                        }
                        if ($ol_im < 0) {
                            return $iconfile;
                        }
                        if ($ol_im) {
                            self::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
                        }
                    }
                    // Protect-section icon:
                    if ($protectSection) {
                        $ol_im = self::imagecreatefrom($GLOBALS['BACK_PATH'] . 'gfx/overlay_sub5.gif');
                        if ($ol_im < 0) {
                            return $iconfile;
                        }
                        self::imagecopyresized($im, $ol_im, 0, 0, 0, 0, imagesx($ol_im), imagesy($ol_im), imagesx($ol_im), imagesy($ol_im));
                    }
                    // Create the image as file, destroy GD image and return:
                    @self::imagemake($im, $path);
                    GeneralUtility::gif_compress($path, 'IM');
                    ImageDestroy($im);
                    return $mainpath;
                } else {
                    return $iconfile;
                }
            } else {
                return $GLOBALS['BACK_PATH'] . 'gfx/fileicons/default.gif';
            }
        }
    }

    static public function imagecopyresized(&$destinationImage, $sourceImage, $destinationX, $destinationY, $sourceX, $sourceY, $destinationWidth, $destinationHeight, $sourceWidth, $sourceHeight) {
        imagecopyresized($destinationImage, $sourceImage, $destinationX, $destinationY, $sourceX, $sourceY, $destinationWidth, $destinationHeight, $sourceWidth, $sourceHeight);
    }

    static public function imagecreatefrom($file) {
        $file = GeneralUtility::read_png_gif($file, $GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']);
        if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
            return $file ? imagecreatefrompng($file) : -1;
        } else {
            return $file ? imagecreatefromgif($file) : -1;
        }
    }

    static public function imagemake($im, $path) {
        if ($GLOBALS['TYPO3_CONF_VARS']['GFX']['gdlib_png']) {
            @ImagePng($im, $path);
        } else {
            @ImageGif($im, $path);
        }
        if (@is_file($path)) {
            GeneralUtility::fixPermissions($path);
        }
    }

    /**********************************************
     *       SPRITE ICON API
     *
     * The Sprite Icon API helps you to quickly get the HTML for any icon you want
     * this is typically wrapped in a <span> tag with corresponding CSS classes that
     * will be responsible for the
     *
     * There are four ways to use this API:
     *
     * 1) for any given TCA record
     *  $spriteIconHtml = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForRecord('pages', $row);
     *
     * 2) for any given File of Folder object
     *  $spriteIconHtml = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForResource($fileOrFolderObject);
     *
     * 3) for any given file
     *  $spriteIconHtml = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForFile('myimage.png');
     *
     * 4) for any other icon you know the name
     *  $spriteIconHtml = \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon('actions-document-open');
     *
     **********************************************/
    static public function getSpriteIcon($iconName, array $options = array(), array $overlays = array()) {
        // Check if icon can be cached and return cached version if present
        if (empty($options) && empty($overlays)) {
            if (isset(static::$spriteIconCache[$iconName])) {
                return static::$spriteIconCache[$iconName];
            }
            $iconIsCacheable = TRUE;
        } else {
            $iconIsCacheable = FALSE;
        }

        $innerHtml = isset($options['html']) ? $options['html'] : NULL;
        $tagName = isset($options['tagName']) ? $options['tagName'] : NULL;

        // Deal with the overlays
        foreach ($overlays as $overlayIconName => $overlayOptions) {
            $overlayOptions['html'] = $innerHtml;
            $overlayOptions['class'] = (isset($overlayOptions['class']) ? $overlayOptions['class'] . ' ' : '') . 't3-icon-overlay';
            $innerHtml = self::getSpriteIcon($overlayIconName, $overlayOptions);
        }

        $availableIcons = isset($GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable'])
            ? (array) $GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable']
            : array();
        if ($iconName !== 'empty-empty' && !in_array($iconName, $availableIcons, TRUE)) {
            $iconName = 'status-status-icon-missing';
        }

        // Create the CSS class
        $options['class'] = self::getSpriteIconClasses($iconName) . (isset($options['class']) ? ' ' . $options['class'] : '');
        unset($options['html'], $options['tagName']);
        $spriteHtml = self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);

        // Store result in cache if possible
        if ($iconIsCacheable) {
            static::$spriteIconCache[$iconName] = $spriteHtml;
        }
        return $spriteHtml;
    }

    static public function getSpriteIconForFile($fileExtension, array $options = array()) {
        $innerHtml = isset($options['html']) ? $options['html'] : NULL;
        $tagName = isset($options['tagName']) ? $options['tagName'] : NULL;
        // Create the CSS class
        $options['class'] = self::mapFileExtensionToSpriteIconClass($fileExtension) . (isset($options['class']) ? ' ' . $options['class'] : '');
        unset($options['html']);
        unset($options['tagName']);
        return self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);
    }

    static public function mapFileExtensionToSpriteIconClass($fileExtension) {
        return self::getSpriteIconClasses(self::mapFileExtensionToSpriteIconName($fileExtension));
    }

    static public function mapFileExtensionToSpriteIconName($fileExtension) {
        // If the file is a whole file with name etc (mainly, if it has a "." or a "/"),
        // then it is checked whether it is a valid directory
        if (strpos($fileExtension, '.') !== FALSE || strpos($fileExtension, '/') !== FALSE) {
            // Check if it is a directory
            $filePath = dirname(GeneralUtility::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $fileExtension;
            $path = GeneralUtility::resolveBackPath($filePath);
            if (is_dir($path) || substr($fileExtension, -1) === '/' || substr($fileExtension, -1) === '\\') {
                $fileExtension = 'folder';
            } else {
                if (($pos = strrpos($fileExtension, '.')) !== FALSE) {
                    $fileExtension = strtolower(substr($fileExtension, $pos + 1));
                } else {
                    $fileExtension = 'default';
                }
            }
        }
        // If the file extension is not valid
        // then use the default one
        if (!isset(self::$fileSpriteIconNames[$fileExtension])) {
            $fileExtension = 'default';
        }
        $iconName = self::$fileSpriteIconNames[$fileExtension];
        return $iconName;
    }

    static public function getSpriteIconForRecord($table, array $row, array $options = array()) {
        $innerHtml = isset($options['html']) ? $options['html'] : NULL;
        $tagName = isset($options['tagName']) ? $options['tagName'] : NULL;
        // Overlay this record icon with the status of the row
        $overlaySpriteIconName = self::mapRecordOverlayToSpriteIconName($table, $row);
        if ($overlaySpriteIconName) {
            $overlayOptions = array(
                'html' => $innerHtml,
                'class' => 't3-icon-overlay'
            );
            $innerHtml = self::getSpriteIcon($overlaySpriteIconName, $overlayOptions);
        }
        // Fetch the name for the CSS class, based on the $row
        $options['class'] = self::mapRecordTypeToSpriteIconClass($table, $row) . (isset($options['class']) ? ' ' . $options['class'] : '');
        unset($options['html']);
        unset($options['tagName']);
        return self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);
    }

    static public function getSpriteIconForResource(\TYPO3\CMS\Core\Resource\ResourceInterface $resource, array $options = array(), array $overlays = array()) {
        // Folder
        if ($resource instanceof \TYPO3\CMS\Core\Resource\FolderInterface) {
            $iconName = NULL;
            $role = $resource->getRole();
            // non browsable storage
            if ($resource->getStorage()->isBrowsable() === FALSE && !empty($options['mount-root'])) {
                $iconName = 'apps-filetree-folder-locked';
            } else {
                // storage root
                if ($resource->getStorage()->getRootLevelFolder()->getIdentifier() === $resource->getIdentifier()) {
                    $iconName = 'apps-filetree-root';
                }


                // user/group mount root
                if (!empty($options['mount-root'])) {
                    $iconName = 'apps-filetree-mount';
                    if ($role === \TYPO3\CMS\Core\Resource\FolderInterface::ROLE_READONLY_MOUNT) {
                        $overlays['status-overlay-locked'] = array();
                    } elseif ($role === \TYPO3\CMS\Core\Resource\FolderInterface::ROLE_USER_MOUNT) {
                        $overlays['status-overlay-access-restricted'] = array();
                    }
                }

                if ($iconName === NULL) {
                    // in folder tree view $options['folder-open'] can define a open folder icon
                    if (!empty($options['folder-open'])) {
                        $iconName = 'apps-filetree-folder-opened';
                    } else {
                        $iconName = 'apps-filetree-folder-default';
                    }

                    if ($role === \TYPO3\CMS\Core\Resource\FolderInterface::ROLE_TEMPORARY) {
                        $iconName = 'apps-filetree-folder-temp';
                    } elseif ($role === \TYPO3\CMS\Core\Resource\FolderInterface::ROLE_RECYCLER) {
                        $iconName = 'apps-filetree-folder-recycler';
                    }
                }

                // if locked add overlay
                if ($resource instanceof \TYPO3\CMS\Core\Resource\InaccessibleFolder ||
                    !$resource->getStorage()->isBrowsable() ||
                    !$resource->getStorage()->checkFolderActionPermission('add', $resource)
                ) {
                    $overlays['status-overlay-locked'] = array();
                }
            }



            // File
        } else {
            $iconName = self::mapFileExtensionToSpriteIconName($resource->getExtension());

            if ($resource instanceof \TYPO3\CMS\Core\Resource\File && $resource->isMissing()) {
                $overlays['status-overlay-missing'] = array();
            }
        }

        // Hook: allow some other process to influence the choice of icon and overlays
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideResourceIcon'])) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideResourceIcon'] as $classRef) {
                $hookObject = GeneralUtility::getUserObj($classRef);
                if (!$hookObject instanceof IconUtilityOverrideResourceIconHookInterface) {
                    throw new \UnexpectedValueException('$hookObject must implement interface TYPO3\\CMS\\Backend\\Utility\\IconUtilityOverrideResourceIconHookInterface', 1393574895);
                }
                $hookObject->overrideResourceIcon($resource, $iconName, $options, $overlays);
            }
        }

        unset($options['mount-root']);
        unset($options['folder-open']);
        return self::getSpriteIcon($iconName, $options, $overlays);
    }

    static public function mapRecordTypeToSpriteIconClass($table, array $row) {
        return self::getSpriteIconClasses(self::mapRecordTypeToSpriteIconName($table, $row));
    }

    static public function mapRecordTypeToSpriteIconName($table, array $row) {
        $recordType = array();
        $ref = NULL;
        if (isset($GLOBALS['TCA'][$table]['ctrl']['typeicon_column'])) {
            $column = $GLOBALS['TCA'][$table]['ctrl']['typeicon_column'];
            if (isset($row[$column])) {
                $recordType[1] = $row[$column];
            } else {
                $recordType[1] = 'default';
            }
            // Workaround to give nav_hide pages a complete different icon
            // Although it's not a separate doctype
            // and to give root-pages an own icon
            if ($table === 'pages') {
                if ($row['nav_hide']) {
                    $recordType[2] = $recordType[1] . '-hideinmenu';
                }
                if ($row['is_siteroot']) {
                    $recordType[3] = $recordType[1] . '-root';
                }
                if ($row['module']) {
                    $recordType[4] = 'contains-' . $row['module'];
                }
            }
            if (is_array($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes'])) {
                foreach ($recordType as $key => $type) {
                    if (isset($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes'][$type])) {
                        $recordType[$key] = $GLOBALS['TCA'][$table]['ctrl']['typeicon_classes'][$type];
                    } else {
                        unset($recordType[$key]);
                    }
                }
                $recordType[0] = $GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['default'];
                if (isset($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['mask'])) {
                    $recordType[5] = str_replace('###TYPE###', $row[$column], $GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['mask']);
                }
                if (isset($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['userFunc'])) {
                    $parameters = array('row' => $row);
                    $recordType[6] = GeneralUtility::callUserFunction($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['userFunc'], $parameters, $ref);
                }
            } else {
                foreach ($recordType as &$type) {
                    $type = 'tcarecords-' . $table . '-' . $type;
                }
                unset($type);
                $recordType[0] = 'tcarecords-' . $table . '-default';
            }
        } else {
            if (is_array($GLOBALS['TCA'][$table]['ctrl']['typeicon_classes'])) {
                $recordType[0] = $GLOBALS['TCA'][$table]['ctrl']['typeicon_classes']['default'];
            } else {
                $recordType[0] = 'tcarecords-' . $table . '-default';
            }
        }
        krsort($recordType);
        if (is_array($GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable'])) {
            foreach ($recordType as $iconName) {
                if (in_array($iconName, $GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable'])) {
                    return $iconName;
                }
            }
        }
        return 'status-status-icon-missing';
    }

    static public function mapRecordOverlayToSpriteIconName($table, array $row) {
        $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
        // Calculate for a given record the actual visibility at the moment
        $status = array(
            'hidden' => FALSE,
            'starttime' => FALSE,
            'endtime' => FALSE,
            'futureendtime' => FALSE,
            'fe_group' => FALSE,
            'deleted' => FALSE,
            'protectedSection' => FALSE,
            'nav_hide' => $row['nav_hide'] ? TRUE : FALSE,
            'noIconFound' => $row['_NO_ICON_FOUND'] ? TRUE : FALSE
        );
        // Icon state based on "enableFields":
        if (is_array($tcaCtrl['enablecolumns'])) {
            $enCols = $tcaCtrl['enablecolumns'];
            // If "hidden" is enabled:
            if ($tcaCtrl['enablecolumns']['disabled'] && $row[$tcaCtrl['enablecolumns']['disabled']]) {
                $status['hidden'] = TRUE;
            }
            // If a "starttime" is set and higher than current time:
            if ($tcaCtrl['enablecolumns']['starttime'] && $GLOBALS['EXEC_TIME'] < (int)$row[$tcaCtrl['enablecolumns']['starttime']]) {
                $status['starttime'] = TRUE;
            }
            // If an "endtime" is set
            if ($tcaCtrl['enablecolumns']['endtime']) {
                if ((int)$row[$tcaCtrl['enablecolumns']['endtime']] > 0) {
                    if ((int)$row[$tcaCtrl['enablecolumns']['endtime']] < $GLOBALS['EXEC_TIME']) {
                        // End-timing applies at this point.
                        $status['endtime'] = TRUE;
                    } else {
                        // End-timing WILL apply in the future for this element.
                        $status['futureendtime'] = TRUE;
                    }
                }
            }
            // If a user-group field is set
            if ($tcaCtrl['enablecolumns']['fe_group'] && $row[$tcaCtrl['enablecolumns']['fe_group']]) {
                $status['fe_group'] = TRUE;
            }
        }
        // If "deleted" flag is set (only when listing records which are also deleted!)
        if ($row[$tcaCtrl['delete']]) {
            $status['deleted'] = TRUE;
        }
        // Detecting extendToSubpages (for pages only)
        if ($table == 'pages' && $row['extendToSubpages']) {
            $status['protectedSection'] = TRUE;
        }
        // Hook: allow some other process to influence the choice of icon overlay
        // The method called receives the table name, the current row and the current status array as parameters
        // The status array should be passed as a reference and in order to be modified within the hook
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideIconOverlay'])) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideIconOverlay'] as $classRef) {
                $hookObject = GeneralUtility::getUserObj($classRef);
                if (method_exists($hookObject, 'overrideIconOverlay')) {
                    $hookObject->overrideIconOverlay($table, $row, $status);
                }
            }
        }
        // Now only show the status with the highest priority
        $priorities = $GLOBALS['TBE_STYLES']['spriteIconApi']['spriteIconRecordOverlayPriorities'];
        $iconName = '';
        if (is_array($priorities)) {
            foreach ($priorities as $priority) {
                if ($status[$priority]) {
                    $iconName = $GLOBALS['TBE_STYLES']['spriteIconApi']['spriteIconRecordOverlayNames'][$priority];
                    break;
                }
            }
        }
        return $iconName;
    }

    static public function getSpriteIconClasses($iconName) {
        $cssClasses = ($baseCssClass = 't3-icon');
        $parts = explode('-', $iconName);
        if (count($parts) > 1) {
            // Will be something like "t3-icon-actions"
            $cssClasses .= ' ' . ($baseCssClass . '-' . $parts[0]);
            // Will be something like "t3-icon-actions-document"
            $cssClasses .= ' ' . ($baseCssClass . '-' . $parts[0] . '-' . $parts[1]);
            // Will be something like "t3-icon-document-new"
            $cssClasses .= ' ' . ($baseCssClass . '-' . substr($iconName, (strlen($parts[0]) + 1)));
        }
        return $cssClasses;
    }

    static protected function buildSpriteHtmlIconTag(array $tagAttributes, $innerHtml = NULL, $tagName = NULL) {
        $innerHtml = $innerHtml === NULL ? '&nbsp;' : $innerHtml;
        $tagName = $tagName === NULL ? 'span' : $tagName;
        $attributes = '';
        foreach ($tagAttributes as $attribute => $value) {
            $attributes .= ' ' . htmlspecialchars($attribute) . '="' . htmlspecialchars($value) . '"';
        }
        return '<' . $tagName . $attributes . '>' . $innerHtml . '</' . $tagName . '>';
    }

}