Base::getRelativeFilePath() - Code Metrics - Inspection of "API core changes" - gplcart/file_manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0f4f62...400760 )

by Iurii

created 2017-12-14 06:31 UTC

Base::getRelativeFilePath() A

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * @package File manager
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2017, Iurii Makukh <[email protected]>
 * @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
 */

namespace gplcart\modules\file_manager\handlers\commands;

use DirectoryIterator;
use gplcart\core\Handler,
    gplcart\core\Container;

/**
 * Base handler class
 */
class Base extends Handler
{

    /**
     * Config class instance
     * @var \gplcart\core\Config $config
     */
    protected $config;

    /**
     * Translation UI model class instance
     * @var \gplcart\core\models\Translation $translation
     */
    protected $translation;

    /**
     * Command model class instance
     * @var \gplcart\modules\file_manager\models\Command $command
     */
    protected $command;

    /**
     * Scanner model class instance
     * @var \gplcart\modules\file_manager\models\Scanner $scanner
     */
    protected $scanner;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->config = Container::get('gplcart\\core\\Config');
        $this->translation = Container::get('gplcart\\core\\models\\Translation');
        $this->command = Container::get('gplcart\\modules\\file_manager\\models\\Command');
        $this->scanner = Container::get('gplcart\\modules\\file_manager\\models\\Scanner');
    }

    /**
     * Sets a property
     * @param string $name
     * @param mixed $value
     */
    public function setProperty($name, $value)
    {
        $this->{$name} = $value;
    }

    /**
     * Returns a total number of scanned files
     * @param string $directory
     * @param array $options
     * @return integer
     */
    protected function getTotal($directory, array $options = array())
    {
        $options['count'] = true;
        return (int) $this->scanner->scan($directory, $options);
    }

    /**
     * Returns an array of scanned files
     * @param string $directory
     * @param array $options
     * @return array
     */
    protected function getFiles($directory, array $options = array())
    {
        return (array) $this->scanner->scan($directory, $options);
    }

    /**
     * Returns a normalized relative path for the file
     * @param string $file
     * @return string
     */
    protected function getRelativeFilePath($file)
    {
        return gplcart_path_normalize(gplcart_file_relative($file));
    }

    /**
     * Returns a relative file path or initial directory
     * @param null|string $path
     * @return string
     */
    protected function getRelativePath($path = null)
    {
        if (!isset($path)) {
            $path = $this->scanner->getInitialPath(true);
        }

        return gplcart_path_normalize(gplcart_path_relative($path));
    }

    /**
     * Returns a relative directory path for the file
     * @param string $file
     * @return string
     */
    protected function getRelativeDirectory($file)
    {
        return trim(dirname($this->getRelativeFilePath($file)), '.');
    }

    /**
     * Moves a file to a new destination
     * @param string $src
     * @param string $dest
     * @param int $errors
     * @param int $success
     * @return bool
     */
    protected function move($src, $dest, &$errors = 0, &$success = 0)
    {
        $this->copy($src, $dest, $errors, $success);

        if (empty($errors)) {
            gplcart_file_delete_recursive($src, $errors);
        }

        return empty($errors);
    }

    /**
     * Copy a file / directory
     * @param string $src
     * @param string $dest
     * @param int $errors
     * @param int $success
     * @return boolean
     */
    protected function copy($src, $dest, &$errors = 0, &$success = 0)
    {
        if (is_file($src)) {
            if (copy($src, $dest)) {
                $success++;
                return true;
            }
            $errors++;
            return false;
        }

        if (!is_dir($dest) && !mkdir($dest)) {
            $errors++;
            return false;
        }

        foreach (new DirectoryIterator($src) as $file) {

            $result = null;
            $copyto = "$dest/" . $file->getBasename();
            if ($file->isFile() || (!$file->isDot() && $file->isDir())) {
                $result = $this->copy($file->getRealPath(), $copyto, $errors, $success);
            }

            if (!isset($result)) {
                continue;
            }

            if ($result) {
                $success++;
            } else {
                $errors++;
            }
        }

        $success++;
        return true;
    }

    /**
     * Whether the current file is the initial file manager path
     * @param \SplFileInfo $file
     * @return bool
     */
    protected function isInitialPath($file)
    {
        $current_path = gplcart_path_normalize($file->getRealPath());
        $initial_path = gplcart_path_normalize($this->scanner->getInitialPath(true));
        return $current_path === $initial_path;
    }

}


1			<?php
2
3			/**
4			* @package File manager
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2017, Iurii Makukh <[email protected]>
7			* @license https://www.gnu.org/licenses/gpl-3.0.en.html GPL-3.0+
8			*/
9
10			namespace gplcart\modules\file_manager\handlers\commands;
11
12			use DirectoryIterator;
13			use gplcart\core\Handler,
14			gplcart\core\Container;
15
16			/**
17			* Base handler class
18			*/
19			class Base extends Handler
20			{
21
22			/**
23			* Config class instance
24			* @var \gplcart\core\Config $config
25			*/
26			protected $config;
27
28			/**
29			* Translation UI model class instance
30			* @var \gplcart\core\models\Translation $translation
31			*/
32			protected $translation;
33
34			/**
35			* Command model class instance
36			* @var \gplcart\modules\file_manager\models\Command $command
37			*/
38			protected $command;
39
40			/**
41			* Scanner model class instance
42			* @var \gplcart\modules\file_manager\models\Scanner $scanner
43			*/
44			protected $scanner;
45
46			/**
47			* Constructor
48			*/
49			public function __construct()
50			{
51			$this->config = Container::get('gplcart\\core\\Config');
52			$this->translation = Container::get('gplcart\\core\\models\\Translation');
53			$this->command = Container::get('gplcart\\modules\\file_manager\\models\\Command');
54			$this->scanner = Container::get('gplcart\\modules\\file_manager\\models\\Scanner');
55			}
56
57			/**
58			* Sets a property
59			* @param string $name
60			* @param mixed $value
61			*/
62			public function setProperty($name, $value)
63			{
64			$this->{$name} = $value;
65			}
66
67			/**
68			* Returns a total number of scanned files
69			* @param string $directory
70			* @param array $options
71			* @return integer
72			*/
73			protected function getTotal($directory, array $options = array())
74			{
75			$options['count'] = true;
76			return (int) $this->scanner->scan($directory, $options);
77			}
78
79			/**
80			* Returns an array of scanned files
81			* @param string $directory
82			* @param array $options
83			* @return array
84			*/
85			protected function getFiles($directory, array $options = array())
86			{
87			return (array) $this->scanner->scan($directory, $options);
88			}
89
90			/**
91			* Returns a normalized relative path for the file
92			* @param string $file
93			* @return string
94			*/
95			protected function getRelativeFilePath($file)
96			{
97			return gplcart_path_normalize(gplcart_file_relative($file));
98			}
99
100			/**
101			* Returns a relative file path or initial directory
102			* @param null\|string $path
103			* @return string
104			*/
105			protected function getRelativePath($path = null)
106			{
107			if (!isset($path)) {
108			$path = $this->scanner->getInitialPath(true);
109			}
110
111			return gplcart_path_normalize(gplcart_path_relative($path));
112			}
113
114			/**
115			* Returns a relative directory path for the file
116			* @param string $file
117			* @return string
118			*/
119			protected function getRelativeDirectory($file)
120			{
121			return trim(dirname($this->getRelativeFilePath($file)), '.');
122			}
123
124			/**
125			* Moves a file to a new destination
126			* @param string $src
127			* @param string $dest
128			* @param int $errors
129			* @param int $success
130			* @return bool
131			*/
132			protected function move($src, $dest, &$errors = 0, &$success = 0)
133			{
134			$this->copy($src, $dest, $errors, $success);
135
136			if (empty($errors)) {
137			gplcart_file_delete_recursive($src, $errors);
138			}
139
140			return empty($errors);
141			}
142
143			/**
144			* Copy a file / directory
145			* @param string $src
146			* @param string $dest
147			* @param int $errors
148			* @param int $success
149			* @return boolean
150			*/
151			protected function copy($src, $dest, &$errors = 0, &$success = 0)
152			{
153			if (is_file($src)) {
154			if (copy($src, $dest)) {
155			$success++;
156			return true;
157			}
158			$errors++;
159			return false;
160			}
161
162			if (!is_dir($dest) && !mkdir($dest)) {
163			$errors++;
164			return false;
165			}
166
167			foreach (new DirectoryIterator($src) as $file) {
168
169			$result = null;
170			$copyto = "$dest/" . $file->getBasename();
171			if ($file->isFile() \|\| (!$file->isDot() && $file->isDir())) {
172			$result = $this->copy($file->getRealPath(), $copyto, $errors, $success);
173			}
174
175			if (!isset($result)) {
176			continue;
177			}
178
179			if ($result) {
180			$success++;
181			} else {
182			$errors++;
183			}
184			}
185
186			$success++;
187			return true;
188			}
189
190			/**
191			* Whether the current file is the initial file manager path
192			* @param \SplFileInfo $file
193			* @return bool
194			*/
195			protected function isInitialPath($file)
196			{
197			$current_path = gplcart_path_normalize($file->getRealPath());
198			$initial_path = gplcart_path_normalize($this->scanner->getInitialPath(true));
199			return $current_path === $initial_path;
200			}
201
202			}
203

gplcart / file_manager

Push — master ( 0f4f62...400760 )

Base::getRelativeFilePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like