FilesManagement::createFolder() - Code Metrics - mambax7/planet - Measure and Improve Code Quality continuously with Scrutinizer

FilesManagement::createFolder() A
last analyzed 2019-01-19 04:01 UTC

↳ Parent: FilesManagement

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	6
nop	1
dl	0
loc	14
rs	9.2222
c	0
b	0
f	0

<?php namespace XoopsModules\Planet\Common;

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * @copyright   XOOPS Project (https://xoops.org)
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
 * @author      mamba <[email protected]>
 */
trait FilesManagement
{
    /**
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
     *
     * @param string $folder The full path of the directory to check
     *
     * @return void
     */
    public static function createFolder($folder)
    {
        try {
            if (!file_exists($folder)) {
                if (!is_dir($folder) && !mkdir($folder) && !is_dir($folder)) {
                    throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
                }

                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
            }
        } catch (\Exception $e) {
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
        }
    }

    /**
     * @param $file
     * @param $folder
     * @return bool
     */
    public static function copyFile($file, $folder)
    {
        return copy($file, $folder);
    }

    /**
     * @param $src
     * @param $dst
     */
    public static function recurseCopy($src, $dst)
    {
        $dir = opendir($src);
        //        @mkdir($dst);
        if (!mkdir($dst) && !is_dir($dst)) {
            while (false !== ($file = readdir($dir))) {
                if (('.' !== $file) && ('..' !== $file)) {
                    if (is_dir($src . '/' . $file)) {
                        self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
                    } else {
                        copy($src . '/' . $file, $dst . '/' . $file);
                    }
                }
            }
        }
        closedir($dir);
    }

    /**
     *
     * Remove files and (sub)directories
     *
     * @param string $src source directory to delete
     *
     * @uses \Xmf\Module\Helper::getHelper()
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @return bool true on success
     */
    public static function deleteDirectory($src)
    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        $success = true;
        // remove old files
        $dirInfo = new \SplFileInfo($src);
        // validate is a directory
        if ($dirInfo->isDir()) {
            $fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
            foreach ($fileList as $k => $v) {
                $fileInfo = new \SplFileInfo("{$src}/{$v}");
                if ($fileInfo->isDir()) {
                    // recursively handle subdirectories
                    if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
                        break;
                    }
                } else {
                    // delete the file
                    if (!($success = unlink($fileInfo->getRealPath()))) {
                        break;
                    }
                }
            }
            // now delete this (sub)directory if all the files are gone
            if ($success) {
                $success = rmdir($dirInfo->getRealPath());
            }
        } else {
            // input is not a valid directory
            $success = false;
        }
        return $success;
    }

    /**
     *
     * Recursively remove directory
     *
     * @todo currently won't remove directories with hidden files, should it?
     *
     * @param string $src directory to remove (delete)
     *
     * @return bool true on success
     */
    public static function rrmdir($src)
    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        $success = true;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                $filename = $fObj->getPathname();
                $fObj     = null; // clear this iterator object to close the file
                if (!unlink($filename)) {
                    return false; // couldn't delete the file
                }
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                // Try recursively on directory
                self::rrmdir($fObj->getPathname());
            }
        }
        $iterator = null;   // clear iterator Obj to close file/directory
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return rmdir($src); // remove the directory & return results
    }

    /**
     * Recursively move files from one directory to another
     *
     * @param string $src  - Source of files being moved
     * @param string $dest - Destination of files being moved
     *
     * @return bool true on success
     */
    public static function rmove($src, $dest)

    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        // If the destination directory does not exist and could not be created stop processing
        if (!is_dir($dest) && !mkdir($dest) && !is_dir($dest)) {
            return false;
        }

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                // Try recursively on directory
                self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
                //                rmdir($fObj->getPath()); // now delete the directory
            }
        }
        $iterator = null;   // clear iterator Obj to close file/directory
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        return rmdir($src); // remove the directory & return results
    }

    /**
     * Recursively copy directories and files from one directory to another
     *
     * @param string $src  - Source of files being moved
     * @param string $dest - Destination of files being moved
     *
     * @uses \Xmf\Module\Helper::getHelper()
     * @uses \Xmf\Module\Helper::isUserAdmin()
     *
     * @return bool true on success
     */
    public static function rcopy($src, $dest)

    {
        // Only continue if user is a 'global' Admin
        if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return false;
        }

        // If source is not a directory stop processing
        if (!is_dir($src)) {
            return false;
        }

        // If the destination directory does not exist and could not be created stop processing
        if (!is_dir($dest) && !mkdir($dest) && !is_dir($dest)) {
            return false;
        }

        // Open the source directory to read in files
        $iterator = new \DirectoryIterator($src);
        foreach ($iterator as $fObj) {
            if ($fObj->isFile()) {
                copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            } elseif (!$fObj->isDot() && $fObj->isDir()) {
                self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
            }
        }
        return true;
    }
}


FilesManagement::createFolder() A
last analyzed 2019-01-19 04:01 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php namespace XoopsModules\Planet\Common;
2
3		/*
4		You may not change or alter any portion of this comment or credits
5		of supporting developers from this source code or any supporting source code
6		which is considered copyrighted (c) material of the original comment or credit authors.
7
8		This program is distributed in the hope that it will be useful,
9		but WITHOUT ANY WARRANTY; without even the implied warranty of
10		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11		*/
12
13		/**
14		* @copyright XOOPS Project (https://xoops.org)
15		* @license http://www.fsf.org/copyleft/gpl.html GNU public license
16		* @author mamba <[email protected]>
17		*/
18		trait FilesManagement
19		{
20		/**
21		* Function responsible for checking if a directory exists, we can also write in and create an index.html file
22		*
23		* @param string $folder The full path of the directory to check
24		*
25		* @return void
26		*/
27		public static function createFolder($folder)
28		{
29		try {
30		if (!file_exists($folder)) {
31		if (!is_dir($folder) && !mkdir($folder) && !is_dir($folder)) {
32		throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
33		}
34
35		file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
36		}
37		} catch (\Exception $e) {
38		echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
39		}
40		}
41
42		/**
43		* @param $file
44		* @param $folder
45		* @return bool
46		*/
47		public static function copyFile($file, $folder)
48		{
49		return copy($file, $folder);
50		}
51
52		/**
53		* @param $src
54		* @param $dst
55		*/
56		public static function recurseCopy($src, $dst)
57		{
58		$dir = opendir($src);
59		// @mkdir($dst);
60		if (!mkdir($dst) && !is_dir($dst)) {
61		while (false !== ($file = readdir($dir))) {
62		if (('.' !== $file) && ('..' !== $file)) {
63		if (is_dir($src . '/' . $file)) {
64		self::recurseCopy($src . '/' . $file, $dst . '/' . $file);
65		} else {
66		copy($src . '/' . $file, $dst . '/' . $file);
67		}
68		}
69		}
70		}
71		closedir($dir);
72		}
73
74		/**
75		*
76		* Remove files and (sub)directories
77		*
78		* @param string $src source directory to delete
79		*
80		* @uses \Xmf\Module\Helper::getHelper()
81		* @uses \Xmf\Module\Helper::isUserAdmin()
82		*
83		* @return bool true on success
84		*/
85		public static function deleteDirectory($src)
86		{
87		// Only continue if user is a 'global' Admin
88		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
89		return false;
90		}
91
92		$success = true;
93		// remove old files
94		$dirInfo = new \SplFileInfo($src);
95		// validate is a directory
96		if ($dirInfo->isDir()) {
97		$fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']);
98		foreach ($fileList as $k => $v) {
99		$fileInfo = new \SplFileInfo("{$src}/{$v}");
100		if ($fileInfo->isDir()) {
101		// recursively handle subdirectories
102		if (!$success = self::deleteDirectory($fileInfo->getRealPath())) {
103		break;
104		}
105		} else {
106		// delete the file
107		if (!($success = unlink($fileInfo->getRealPath()))) {
108		break;
109		}
110		}
111		}
112		// now delete this (sub)directory if all the files are gone
113		if ($success) {
114		$success = rmdir($dirInfo->getRealPath());
115		}
116		} else {
117		// input is not a valid directory
118		$success = false;
119		}
120		return $success;
121		}
122
123		/**
124		*
125		* Recursively remove directory
126		*
127		* @todo currently won't remove directories with hidden files, should it?
128		*
129		* @param string $src directory to remove (delete)
130		*
131		* @return bool true on success
132		*/
133		public static function rrmdir($src)
134		{
135		// Only continue if user is a 'global' Admin
136		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
137		return false;
138		}
139
140		// If source is not a directory stop processing
141		if (!is_dir($src)) {
142		return false;
143		}
144
145		$success = true;
		0 ignored issues – show Unused Code introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report `$success` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
146
147		// Open the source directory to read in files
148		$iterator = new \DirectoryIterator($src);
149		foreach ($iterator as $fObj) {
150		if ($fObj->isFile()) {
151		$filename = $fObj->getPathname();
152		$fObj = null; // clear this iterator object to close the file
153		if (!unlink($filename)) {
154		return false; // couldn't delete the file
155		}
156		} elseif (!$fObj->isDot() && $fObj->isDir()) {
157		// Try recursively on directory
158		self::rrmdir($fObj->getPathname());
159		}
160		}
161		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report `$iterator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
162		return rmdir($src); // remove the directory & return results
163		}
164
165		/**
166		* Recursively move files from one directory to another
167		*
168		* @param string $src - Source of files being moved
169		* @param string $dest - Destination of files being moved
170		*
171		* @return bool true on success
172		*/
173	View Code Duplication	public static function rmove($src, $dest)
		0 ignored issues – show Duplication introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report 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...
174		{
175		// Only continue if user is a 'global' Admin
176		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
177		return false;
178		}
179
180		// If source is not a directory stop processing
181		if (!is_dir($src)) {
182		return false;
183		}
184
185		// If the destination directory does not exist and could not be created stop processing
186		if (!is_dir($dest) && !mkdir($dest) && !is_dir($dest)) {
187		return false;
188		}
189
190		// Open the source directory to read in files
191		$iterator = new \DirectoryIterator($src);
192		foreach ($iterator as $fObj) {
193		if ($fObj->isFile()) {
194		rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
195		} elseif (!$fObj->isDot() && $fObj->isDir()) {
196		// Try recursively on directory
197		self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
198		// rmdir($fObj->getPath()); // now delete the directory
199		}
200		}
201		$iterator = null; // clear iterator Obj to close file/directory
		0 ignored issues – show Unused Code introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report `$iterator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
202		return rmdir($src); // remove the directory & return results
203		}
204
205		/**
206		* Recursively copy directories and files from one directory to another
207		*
208		* @param string $src - Source of files being moved
209		* @param string $dest - Destination of files being moved
210		*
211		* @uses \Xmf\Module\Helper::getHelper()
212		* @uses \Xmf\Module\Helper::isUserAdmin()
213		*
214		* @return bool true on success
215		*/
216	View Code Duplication	public static function rcopy($src, $dest)
		0 ignored issues – show Duplication introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report 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...
217		{
218		// Only continue if user is a 'global' Admin
219		if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) \|\| !$GLOBALS['xoopsUser']->isAdmin()) {
		0 ignored issues – show Bug introduced 2018-04-01 09:45 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
220		return false;
221		}
222
223		// If source is not a directory stop processing
224		if (!is_dir($src)) {
225		return false;
226		}
227
228		// If the destination directory does not exist and could not be created stop processing
229		if (!is_dir($dest) && !mkdir($dest) && !is_dir($dest)) {
230		return false;
231		}
232
233		// Open the source directory to read in files
234		$iterator = new \DirectoryIterator($src);
235		foreach ($iterator as $fObj) {
236		if ($fObj->isFile()) {
237		copy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
238		} elseif (!$fObj->isDot() && $fObj->isDir()) {
239		self::rcopy($fObj->getPathname(), "{$dest}/" . $fObj->getFilename());
240		}
241		}
242		return true;
243		}
244		}
245

mambax7 / planet

FilesManagement::createFolder() A last analyzed 2019-01-19 04:01 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

FilesManagement::createFolder() A
last analyzed 2019-01-19 04:01 UTC