lochmueller / autoloader

Classes/Utility/FileUtility.php

<?php

/**
 * FileUtility.
 */
declare(strict_types=1);

namespace HDNET\Autoloader\Utility;

use HDNET\Autoloader\Exception;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\PathUtility;

/**
 * FileUtility.
 */
class FileUtility
{
    /**
     * Write a file and create the target folder, if the folder do not exists.
     *
     * @param string $absoluteFileName
     * @param string $content
     *
     * @throws Exception
     *
     * @return bool
     */
    public static function writeFileAndCreateFolder($absoluteFileName, $content)
    {
        $dir = PathUtility::dirname($absoluteFileName) . '/';
        if (!\is_dir($dir)) {
            GeneralUtility::mkdir_deep($dir);
        }
        if (\is_file($absoluteFileName) && !\is_writable($absoluteFileName)) {
            throw new Exception(
                'The autoloader try to add same content to ' . $absoluteFileName . ' but the file is not writable for the autoloader. Please fix it!',
                234627835
            );
        }

        return GeneralUtility::writeFile($absoluteFileName, $content);
    }

    /**
     * Get all base file names in the given directory with the given file extension
     * Check also if the directory exists.
     *
     * @param string $dirPath
     * @param string $fileExtension
     *
     * @return array
     */
    public static function getBaseFilesInDir($dirPath, $fileExtension)
    {
        return self::getFileInformationInDir($dirPath, $fileExtension, PATHINFO_FILENAME);
    }

    /**
     * Get all base file names in the given directory with the given file extension
     * Check also if the directory exists.
     *
     * @param string $dirPath
     * @param string $fileExtension
     *
     * @return array
     */
    public static function getBaseFilesWithExtensionInDir($dirPath, $fileExtension)
    {
        return self::getFileInformationInDir($dirPath, $fileExtension, PATHINFO_BASENAME);
    }

    /**
     * Get all base file names in the given directory with the given file extension
     * Check also if the directory exists. If you scan the dir recursively you get
     * also the folder name. The filename is also "basename" only.
     *
     * @param string $dirPath
     * @param string $fileExtensions
     * @param bool   $recursively
     *
     * @return array
     */
    public static function getBaseFilesRecursivelyInDir($dirPath, $fileExtensions, $recursively = true)
    {
        if (!\is_dir($dirPath)) {
            return [];
        }
        $recursively = $recursively ? 99 : 0;
        $files = GeneralUtility::getAllFilesAndFoldersInPath([], $dirPath, $fileExtensions, false, $recursively);
        foreach ($files as $key => $file) {
            $pathInfo = PathUtility::pathinfo($file);
            $files[$key] = $pathInfo['dirname'] . '/' . $pathInfo['filename'];
        }
        $files = GeneralUtility::removePrefixPathFromList($files, $dirPath);

        return \array_values($files);
    }

    /**
     * Get file information in the given folder.
     *
     * @param string $dirPath
     * @param string $fileExtension
     * @param int    $informationType
     *
     * @return array
     */
    protected static function getFileInformationInDir($dirPath, $fileExtension, $informationType)
    {
        if (!\is_dir($dirPath)) {
            return [];
        }
        $files = GeneralUtility::getFilesInDir($dirPath, $fileExtension);
        foreach ($files as $key => $file) {

The expression $files of type array|string is not guaranteed to be traversable. How about adding an additional type check?

            $files[$key] = PathUtility::pathinfo($file, $informationType);
        }

        return \array_values($files);
    }
}