FileUtility::getBaseFilesRecursivelyInDir() - Code Metrics - Inspection of "PHP CS fixer" - lochmueller/autoloader - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dfd5cb...5cac00 )

by Tim

created 2019-01-23 19:44 UTC

FileUtility::getBaseFilesRecursivelyInDir() A

↳ Parent: FileUtility

Complexity

Conditions	4
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	15
ccs	0
cts	5
cp	0
rs	9.7666
cc	4
nc	5
nop	3
crap	20

<?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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $files[$key] = PathUtility::pathinfo($file, $informationType);
        }

        return \array_values($files);
    }
}


1			<?php
2
3			/**
4			* FileUtility.
5			*/
6			declare(strict_types=1);
7
8			namespace HDNET\Autoloader\Utility;
9
10			use HDNET\Autoloader\Exception;
11			use TYPO3\CMS\Core\Utility\GeneralUtility;
12			use TYPO3\CMS\Core\Utility\PathUtility;
13
14			/**
15			* FileUtility.
16			*/
17			class FileUtility
18			{
19			/**
20			* Write a file and create the target folder, if the folder do not exists.
21			*
22			* @param string $absoluteFileName
23			* @param string $content
24			*
25			* @throws Exception
26			*
27			* @return bool
28			*/
29			public static function writeFileAndCreateFolder($absoluteFileName, $content)
30			{
31			$dir = PathUtility::dirname($absoluteFileName) . '/';
32			if (!\is_dir($dir)) {
33			GeneralUtility::mkdir_deep($dir);
34			}
35			if (\is_file($absoluteFileName) && !\is_writable($absoluteFileName)) {
36			throw new Exception(
37			'The autoloader try to add same content to ' . $absoluteFileName . ' but the file is not writable for the autoloader. Please fix it!',
38			234627835
39			);
40			}
41
42			return GeneralUtility::writeFile($absoluteFileName, $content);
43			}
44
45			/**
46			* Get all base file names in the given directory with the given file extension
47			* Check also if the directory exists.
48			*
49			* @param string $dirPath
50			* @param string $fileExtension
51			*
52			* @return array
53			*/
54			public static function getBaseFilesInDir($dirPath, $fileExtension)
55			{
56			return self::getFileInformationInDir($dirPath, $fileExtension, PATHINFO_FILENAME);
57			}
58
59			/**
60			* Get all base file names in the given directory with the given file extension
61			* Check also if the directory exists.
62			*
63			* @param string $dirPath
64			* @param string $fileExtension
65			*
66			* @return array
67			*/
68			public static function getBaseFilesWithExtensionInDir($dirPath, $fileExtension)
69			{
70			return self::getFileInformationInDir($dirPath, $fileExtension, PATHINFO_BASENAME);
71			}
72
73			/**
74			* Get all base file names in the given directory with the given file extension
75			* Check also if the directory exists. If you scan the dir recursively you get
76			* also the folder name. The filename is also "basename" only.
77			*
78			* @param string $dirPath
79			* @param string $fileExtensions
80			* @param bool $recursively
81			*
82			* @return array
83			*/
84			public static function getBaseFilesRecursivelyInDir($dirPath, $fileExtensions, $recursively = true)
85			{
86			if (!\is_dir($dirPath)) {
87			return [];
88			}
89			$recursively = $recursively ? 99 : 0;
90			$files = GeneralUtility::getAllFilesAndFoldersInPath([], $dirPath, $fileExtensions, false, $recursively);
91			foreach ($files as $key => $file) {
92			$pathInfo = PathUtility::pathinfo($file);
93			$files[$key] = $pathInfo['dirname'] . '/' . $pathInfo['filename'];
94			}
95			$files = GeneralUtility::removePrefixPathFromList($files, $dirPath);
96
97			return \array_values($files);
98			}
99
100			/**
101			* Get file information in the given folder.
102			*
103			* @param string $dirPath
104			* @param string $fileExtension
105			* @param int $informationType
106			*
107			* @return array
108			*/
109			protected static function getFileInformationInDir($dirPath, $fileExtension, $informationType)
110			{
111			if (!\is_dir($dirPath)) {
112			return [];
113			}
114			$files = GeneralUtility::getFilesInDir($dirPath, $fileExtension);
115			foreach ($files as $key => $file) {
			0 ignored issues – show Bug introduced 2016-06-15 14:13 UTC by Report Bug Copy Issue Report The expression `$files` of type `array\|string` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
116			$files[$key] = PathUtility::pathinfo($file, $informationType);
117			}
118
119			return \array_values($files);
120			}
121			}
122

lochmueller / autoloader

Push — master ( dfd5cb...5cac00 )

FileUtility::getBaseFilesRecursivelyInDir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like