Filesystem::removeExtension() - Code Metrics - Inspection of "Set the "working dir" relative to the config's pat..." - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3c4d84...92e7ec )

by Vladimir

created 2018-03-20 22:17 UTC

Filesystem::removeExtension() A

↳ Parent: Filesystem

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?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 ($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 = 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	77	public function absolutePath($pathFragments)
32		{
33	77	if ($this->isAbsolutePath($pathFragments))
34		{
35	50	return $pathFragments;
36		}
37
38	31	$args = func_get_args();
39	31	array_unshift($args, Service::getWorkingDirectory());
40
41	31	return implode(DIRECTORY_SEPARATOR, $args);
42		}
43
44		/**
45		* Build a file or directory path separated by the OS specific directory separator.
46		*
47		* @param string ...$pathFragments
48		*
49		* @return string
50		*/
51	13	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...
52		{
53	13	return implode(DIRECTORY_SEPARATOR, func_get_args());
54		}
55
56		/**
57		* Copy a file or folder recursively.
58		*
59		* @param string $originFile The original filename
60		* @param string $targetFile The target filename
61		* @param bool $overwriteNewerFiles If true, target files newer than origin files are overwritten
62		*
63		* @throws FileNotFoundException When originFile doesn't exist
64		* @throws IOException When copy fails
65		*/
66		public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
67		{
68		if ($this->isDir($originFile))
69		{
70		if (!$this->isDir($targetFile))
71		{
72		mkdir($targetFile, 0755, true);
73		}
74
75		$dir = dir($originFile);
76
77		while (false !== $entry = $dir->read())
78		{
79		// Skip pointers
80		if ($entry == '.' \|\| $entry == '..')
81		{
82		continue;
83		}
84
85		$this->copy("$originFile/$entry", "$targetFile/$entry", true);
86		}
87
88		$dir->close();
89		}
90		else
91		{
92		parent::copy($originFile, $targetFile, $overwriteNewerFiles);
93		}
94		}
95
96		/**
97		* Create an instance of stakx's File object with relative path information.
98		*
99		* @param string $filePath
100		*
101		* @return File
102		*/
103		public function createFileObject($filePath)
104		{
105		return new File($this->absolutePath($filePath));
106		}
107
108		/**
109		* Strip the current working directory from an absolute path.
110		*
111		* @param string $path An absolute path
112		*
113		* @return string
114		*/
115	64	public function getRelativePath($path)
116		{
117	64	return str_replace(Service::getWorkingDirectory() . DIRECTORY_SEPARATOR, '', $path);
118		}
119
120		/**
121		* Get the name of a given file without the extension.
122		*
123		* @param string $filePath A file path
124		*
125		* @return string
126		*/
127	4	public function getBaseName($filePath)
128		{
129	4	return pathinfo($filePath, PATHINFO_FILENAME);
130		}
131
132		/**
133		* Get the name of a given file.
134		*
135		* @param string $filePath A file path
136		*
137		* @return string
138		*/
139		public function getFileName($filePath)
140		{
141		return pathinfo($filePath, PATHINFO_BASENAME);
142		}
143
144		/**
145		* Get the parent directory of a given file.
146		*
147		* @param string $filePath A file path
148		*
149		* @return string
150		*/
151	4	public function getFolderPath($filePath)
152		{
153	4	return pathinfo($filePath, PATHINFO_DIRNAME);
154		}
155
156		/**
157		* Get the extension of a given file.
158		*
159		* @param string $filename A file path
160		*
161		* @return string The extension of the file
162		*/
163	25	public function getExtension($filename)
164		{
165	25	return pathinfo($filename, PATHINFO_EXTENSION);
166		}
167
168		/**
169		* Check whether or not if a given path is a directory.
170		*
171		* @param string $folderPath
172		*
173		* @return bool
174		*/
175		public function isDir($folderPath)
176		{
177		return is_dir($folderPath);
178		}
179
180		/**
181		* Check whether or not a given path is a file.
182		*
183		* @param string $filePath
184		*
185		* @return bool
186		*/
187		public function isFile($filePath)
188		{
189		return is_file($filePath);
190		}
191
192		/**
193		* Check whether a given file path is a symlink
194		*
195		* @param string $filePath
196		*
197		* @return bool
198		*/
199		public function isSymlink($filePath)
200		{
201		return is_link($filePath);
202		}
203
204		/**
205		* Only read a file's contents if it's within the current working directory
206		*
207		* @param string $filePath
208		*
209		* @return bool\|string
210		*/
211	36	public function safeReadFile($filePath)
212		{
213	36	$absPath = realpath($this->absolutePath($filePath));
214
215	36	if (!$this->exists($absPath))
216		{
217		throw new FileNotFoundException(sprintf(
218		"The '%s' file could not be found or is outside the website working directory",
219		$filePath
220		));
221		}
222
223	36	if (strpos($absPath, Service::getWorkingDirectory()) !== 0)
224		{
225	36	throw new FileAccessDeniedException(sprintf(
226	36	"The '%s' file is outside the website working directory",
227	36	$filePath
228		));
229		}
230
231		return file_get_contents($absPath);
232		}
233
234		/**
235		* Get the full path to the file without the extension.
236		*
237		* @param string $filename A file path
238		*
239		* @return string
240		*/
241	4	public function removeExtension($filename)
242		{
243	4	return $this->appendPath(
244	4	$this->getFolderPath($filename),
245	4	$this->getBaseName($filename)
246		);
247		}
248
249	6	public function path($path)
250		{
251	6	return (new FilesystemPath($path));
252		}
253		}
254

stakx-io / stakx

Push — master ( 3c4d84...92e7ec )

Filesystem::removeExtension() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like