Completed
Push — master ( 985b3f...9db75f )
by Jimmy K. Oak
05:52 queued 28s
created

FileUtils   A

Complexity

Total Complexity 20

Size/Duplication

Total Lines 125
Duplicated Lines 16 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 4
Bugs 0 Features 1
Metric Value
wmc 20
c 4
b 0
f 1
lcom 1
cbo 1
dl 20
loc 125
rs 10

7 Methods

Rating   Name   Duplication   Size   Complexity  
C scanDir() 0 32 8
A makePath() 0 6 1
A sanitizePathTokens() 0 12 4
A getExtension() 10 10 2
A getNameWithoutExtension() 10 10 2
A extensionIs() 0 6 1
A stripPathLastDirectorySeparator() 0 8 2

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace JimmyOak\Utility;
4
5
class FileUtils extends UtilsBase
6
{
7
    const FILES = 1;
8
    const DIRS = 2;
9
    const ALL = 3;
10
11
    /**
12
     * @param string $path
13
     * @param int $fileOrDirs
14
     * @param bool $recursive
15
     *
16
     * @return array
17
     */
18
    public function scanDir($path, $fileOrDirs = self::ALL, $recursive = true)
19
    {
20
        $files = scandir($path);
21
22
        $path = $this->stripPathLastDirectorySeparator($path);
23
24
        $allFiles = [];
25
        foreach ($files as $file) {
26
            if ($file !== '.' && $file !== '..') {
27
                $pathToScan = $path . DIRECTORY_SEPARATOR . $file;
28
                if (is_dir($pathToScan)) {
29
                    if ($recursive) {
30
                        $moreFiles = $this->scanDir($pathToScan, $fileOrDirs, true);
31
                        $appendParents = function ($path) use ($file) {
32
                            return $file . DIRECTORY_SEPARATOR . $path;
33
                        };
34
                        $moreFiles = array_map($appendParents, $moreFiles);
35
                        $allFiles = array_merge($allFiles, $moreFiles);
36
                    }
37
                    if ($fileOrDirs & self::DIRS) {
38
                        $allFiles[] = (string) $file;
39
                    }
40
                } else {
41
                    if ($fileOrDirs & self::FILES) {
42
                        $allFiles[] = (string) $file;
43
                    }
44
                }
45
            }
46
        }
47
48
        return $allFiles;
49
    }
50
51
    /**
52
     * @var string $tokens ...
53
     *
54
     * @return string
55
     */
56
    public function makePath()
57
    {
58
        $tokens = $this->sanitizePathTokens(func_get_args());
59
60
        return implode(DIRECTORY_SEPARATOR, $tokens);
61
    }
62
63
    private function sanitizePathTokens($tokens)
64
    {
65
        $sanitized = [];
66
67
        foreach ($tokens as $token) {
68
            if (!in_array($token, ['', DIRECTORY_SEPARATOR], true) && is_string($token)) {
69
                $sanitized[] = $this->stripPathLastDirectorySeparator($token);
70
            }
71
        }
72
73
        return $sanitized;
74
    }
75
76
    /**
77
     * @param $fileName
78
     *
79
     * @return string
80
     */
81 View Code Duplication
    public function getExtension($fileName)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
82
    {
83
        $lastDot = strrpos($fileName, '.');
84
85
        if (!$lastDot) {
86
            return '';
87
        }
88
89
        return substr($fileName, $lastDot + 1);
90
    }
91
92
    /**
93
     * @param $fileName
94
     *
95
     * @return string
96
     */
97 View Code Duplication
    public function getNameWithoutExtension($fileName)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
98
    {
99
        $lastDot = strrpos($fileName, '.');
100
101
        if (!$lastDot) {
102
            return $fileName;
103
        }
104
105
        return substr($fileName, 0, $lastDot);
106
    }
107
108
    /**
109
     * @param string $fileName
110
     * @param string $extension
111
     *
112
     * @return bool
113
     */
114
    public function extensionIs($fileName, $extension)
115
    {
116
        $extensionPregQuoted = preg_quote($extension);
117
118
        return preg_match('/\.' . $extensionPregQuoted . '$/i', $fileName) > 0;
119
    }
120
121
    private function stripPathLastDirectorySeparator($path)
122
    {
123
        $pathLength = strlen($path);
124
        $pathLastChar = $path[$pathLength - 1];
125
        $path = $pathLastChar === DIRECTORY_SEPARATOR ? substr($path, 0, -1) : $path;
126
127
        return $path;
128
    }
129
}
130