Filesystem::getBaseName() - Code Metrics - Inspection of "Move markup engines to a DI setup in the container" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Vladimir

created 2018-05-09 15:50 UTC

Filesystem::getBaseName() A

↳ Parent: Filesystem

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\System;

use allejo\stakx\Exception\FileAccessDeniedException;
use allejo\stakx\Filesystem\File;
use allejo\stakx\Filesystem\FilesystemPath;
use allejo\stakx\Service;
use Symfony\Component\Filesystem\Exception\FileNotFoundException;
use Symfony\Component\Filesystem\Exception\IOException;

/**
 * Class Filesystem.
 *
 * This class extends Symfony's Filesystem to provide convenience functions
 */
class Filesystem extends \Symfony\Component\Filesystem\Filesystem
{
    /**
     * Build an absolute file or directory path separated by the OS specific directory separator.
     *
     * @param string ...$pathFragments
     *
     * @return string
     */
    public function absolutePath($pathFragments)
    {
        if ($pathFragments instanceof FilesystemPath)
        {
            $pathFragments = (string)$pathFragments;

        }

        if ($this->isAbsolutePath($pathFragments))
        {
            return $pathFragments;
        }

        $args = func_get_args();
        array_unshift($args, Service::getWorkingDirectory());

        return implode(DIRECTORY_SEPARATOR, $args);
    }

    /**
     * Build a file or directory path separated by the OS specific directory separator.
     *
     * @param string ...$pathFragments
     *
     * @return string
     */
    public function appendPath($pathFragments)

    {
        return implode(DIRECTORY_SEPARATOR, func_get_args());
    }

    /**
     * Copy a file or folder recursively.
     *
     * @param string $originFile          The original filename
     * @param string $targetFile          The target filename
     * @param bool   $overwriteNewerFiles If true, target files newer than origin files are overwritten
     *
     * @throws FileNotFoundException When originFile doesn't exist
     * @throws IOException           When copy fails
     */
    public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
    {
        if ($this->isDir($originFile))
        {
            if (!$this->isDir($targetFile))
            {
                mkdir($targetFile, 0755, true);
            }

            $dir = dir($originFile);

            while (false !== $entry = $dir->read())
            {
                // Skip pointers
                if ($entry == '.' || $entry == '..')
                {
                    continue;
                }

                $this->copy("$originFile/$entry", "$targetFile/$entry", true);
            }

            $dir->close();
        }
        else
        {
            parent::copy($originFile, $targetFile, $overwriteNewerFiles);
        }
    }

    /**
     * Create an instance of stakx's File object with relative path information.
     *
     * @param string $filePath
     *
     * @return File
     */
    public function createFileObject($filePath)
    {
        return new File($this->absolutePath($filePath));
    }

    /**
     * Strip the current working directory from an absolute path.
     *
     * @param string $path An absolute path
     *
     * @return string
     */
    public function getRelativePath($path)
    {
        return str_replace(Service::getWorkingDirectory() . DIRECTORY_SEPARATOR, '', $path);
    }

    /**
     * Get the name of a given file without the extension.
     *
     * @param string $filePath A file path
     *
     * @return string
     */
    public function getBaseName($filePath)
    {
        return pathinfo($filePath, PATHINFO_FILENAME);
    }

    /**
     * Get the name of a given file.
     *
     * @param string $filePath A file path
     *
     * @return string
     */
    public function getFileName($filePath)
    {
        return pathinfo($filePath, PATHINFO_BASENAME);
    }

    /**
     * Get the parent directory of a given file.
     *
     * @param string $filePath A file path
     *
     * @return string
     */
    public function getFolderPath($filePath)
    {
        return pathinfo($filePath, PATHINFO_DIRNAME);
    }

    /**
     * Get the extension of a given file.
     *
     * @param string $filename A file path
     *
     * @return string The extension of the file
     */
    public function getExtension($filename)
    {
        return pathinfo($filename, PATHINFO_EXTENSION);
    }

    /**
     * Check whether or not if a given path is a directory.
     *
     * @param string $folderPath
     *
     * @return bool
     */
    public function isDir($folderPath)
    {
        return is_dir($folderPath);
    }

    /**
     * Check whether or not a given path is a file.
     *
     * @param string $filePath
     *
     * @return bool
     */
    public function isFile($filePath)
    {
        return is_file($filePath);
    }

    /**
     * Check whether a given file path is a symlink
     *
     * @param  string $filePath
     *
     * @return bool
     */
    public function isSymlink($filePath)
    {
        return is_link($filePath);
    }

    /**
     * Only read a file's contents if it's within the current working directory
     *
     * @param  string $filePath
     *
     * @return bool|string
     */
    public function safeReadFile($filePath)
    {
        $absPath = File::realpath($this->absolutePath($filePath));

        if (!$this->exists($absPath))
        {
            throw new FileNotFoundException(sprintf(
                "The '%s' file could not be found or is outside the website working directory",
                $filePath
            ));
        }

        if (strpos($absPath, Service::getWorkingDirectory()) !== 0)
        {
            throw new FileAccessDeniedException(sprintf(
                "The '%s' file is outside the website working directory",
                $filePath
            ));
        }

        return file_get_contents($absPath);
    }

    /**
     * Get the full path to the file without the extension.
     *
     * @param string $filename A file path
     *
     * @return string
     */
    public function removeExtension($filename)
    {
        return $this->appendPath(
            $this->getFolderPath($filename),
            $this->getBaseName($filename)
        );
    }

    public function path($path)
    {
        return (new FilesystemPath($path));
    }
}


1		<?php
2
3		/**
4		* @copyright 2017 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\System;
9
10		use allejo\stakx\Exception\FileAccessDeniedException;
11		use allejo\stakx\Filesystem\File;
12		use allejo\stakx\Filesystem\FilesystemPath;
13		use allejo\stakx\Service;
14		use Symfony\Component\Filesystem\Exception\FileNotFoundException;
15		use Symfony\Component\Filesystem\Exception\IOException;
16
17		/**
18		* Class Filesystem.
19		*
20		* This class extends Symfony's Filesystem to provide convenience functions
21		*/
22		class Filesystem extends \Symfony\Component\Filesystem\Filesystem
23		{
24		/**
25		* Build an absolute file or directory path separated by the OS specific directory separator.
26		*
27		* @param string ...$pathFragments
28		*
29		* @return string
30		*/
31	53	public function absolutePath($pathFragments)
32		{
33	53	if ($pathFragments instanceof FilesystemPath)
34		{
35	26	$pathFragments = (string)$pathFragments;
		0 ignored issues – show Coding Style introduced 2018-04-03 21:19 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$pathFragments`. This often makes code more readable. Loading history...
36		}
37
38	43	if ($this->isAbsolutePath($pathFragments))
39	43	{
40		return $pathFragments;
41	43	}
42
43		$args = func_get_args();
44		array_unshift($args, Service::getWorkingDirectory());
45
46		return implode(DIRECTORY_SEPARATOR, $args);
47		}
48
49		/**
50		* Build a file or directory path separated by the OS specific directory separator.
51	46	*
52		* @param string ...$pathFragments
53	46	*
54		* @return string
55		*/
56		public function appendPath($pathFragments)
		0 ignored issues – show Unused Code introduced 2017-10-01 22:57 UTC by Report Bug Copy Issue Report The parameter `$pathFragments` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
57		{
58		return implode(DIRECTORY_SEPARATOR, func_get_args());
59		}
60
61		/**
62		* Copy a file or folder recursively.
63		*
64		* @param string $originFile The original filename
65		* @param string $targetFile The target filename
66		* @param bool $overwriteNewerFiles If true, target files newer than origin files are overwritten
67		*
68		* @throws FileNotFoundException When originFile doesn't exist
69		* @throws IOException When copy fails
70		*/
71		public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
72		{
73		if ($this->isDir($originFile))
74		{
75		if (!$this->isDir($targetFile))
76		{
77		mkdir($targetFile, 0755, true);
78		}
79
80		$dir = dir($originFile);
81
82		while (false !== $entry = $dir->read())
83		{
84		// Skip pointers
85		if ($entry == '.' \|\| $entry == '..')
86		{
87		continue;
88		}
89
90		$this->copy("$originFile/$entry", "$targetFile/$entry", true);
91		}
92
93		$dir->close();
94		}
95		else
96		{
97		parent::copy($originFile, $targetFile, $overwriteNewerFiles);
98		}
99		}
100
101		/**
102		* Create an instance of stakx's File object with relative path information.
103		*
104		* @param string $filePath
105		*
106		* @return File
107		*/
108		public function createFileObject($filePath)
109		{
110		return new File($this->absolutePath($filePath));
111		}
112
113		/**
114		* Strip the current working directory from an absolute path.
115	84	*
116		* @param string $path An absolute path
117	84	*
118		* @return string
119		*/
120		public function getRelativePath($path)
121		{
122		return str_replace(Service::getWorkingDirectory() . DIRECTORY_SEPARATOR, '', $path);
123		}
124
125		/**
126		* Get the name of a given file without the extension.
127	3	*
128		* @param string $filePath A file path
129	3	*
130		* @return string
131		*/
132		public function getBaseName($filePath)
133		{
134		return pathinfo($filePath, PATHINFO_FILENAME);
135		}
136
137		/**
138		* Get the name of a given file.
139		*
140		* @param string $filePath A file path
141		*
142		* @return string
143		*/
144		public function getFileName($filePath)
145		{
146		return pathinfo($filePath, PATHINFO_BASENAME);
147		}
148
149		/**
150		* Get the parent directory of a given file.
151	15	*
152		* @param string $filePath A file path
153	15	*
154		* @return string
155		*/
156		public function getFolderPath($filePath)
157		{
158		return pathinfo($filePath, PATHINFO_DIRNAME);
159		}
160
161		/**
162		* Get the extension of a given file.
163	36	*
164		* @param string $filename A file path
165	36	*
166		* @return string The extension of the file
167		*/
168		public function getExtension($filename)
169		{
170		return pathinfo($filename, PATHINFO_EXTENSION);
171		}
172
173		/**
174		* Check whether or not if a given path is a directory.
175		*
176		* @param string $folderPath
177		*
178		* @return bool
179		*/
180		public function isDir($folderPath)
181		{
182		return is_dir($folderPath);
183		}
184
185		/**
186		* Check whether or not a given path is a file.
187		*
188		* @param string $filePath
189		*
190		* @return bool
191		*/
192		public function isFile($filePath)
193		{
194		return is_file($filePath);
195		}
196
197		/**
198		* Check whether a given file path is a symlink
199		*
200		* @param string $filePath
201		*
202		* @return bool
203		*/
204		public function isSymlink($filePath)
205		{
206		return is_link($filePath);
207		}
208
209		/**
210		* Only read a file's contents if it's within the current working directory
211		*
212		* @param string $filePath
213		*
214		* @return bool\|string
215		*/
216		public function safeReadFile($filePath)
217		{
218		$absPath = File::realpath($this->absolutePath($filePath));
219
220		if (!$this->exists($absPath))
221		{
222		throw new FileNotFoundException(sprintf(
223		"The '%s' file could not be found or is outside the website working directory",
224		$filePath
225		));
226		}
227
228		if (strpos($absPath, Service::getWorkingDirectory()) !== 0)
229		{
230		throw new FileAccessDeniedException(sprintf(
231		"The '%s' file is outside the website working directory",
232		$filePath
233		));
234		}
235
236		return file_get_contents($absPath);
237		}
238
239		/**
240		* Get the full path to the file without the extension.
241	3	*
242		* @param string $filename A file path
243	3	*
244	3	* @return string
245	3	*/
246		public function removeExtension($filename)
247		{
248		return $this->appendPath(
249	6	$this->getFolderPath($filename),
250		$this->getBaseName($filename)
251	6	);
252		}
253
254		public function path($path)
255		{
256		return (new FilesystemPath($path));
257		}
258		}
259

stakx-io / stakx

Pull Request — master (#61)

Filesystem::getBaseName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like