File::createDirIfNotExists() - Code Metrics - Werkspot/BingAdsApiBundle - Measure and Improve Code Quality continuously with Scrutinizer

File::createDirIfNotExists() A
last analyzed 2016-04-19 07:37 UTC

↳ Parent: File

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	0
cts	0
cp	0
rs	9.4285
cc	2
eloc	3
nc	2
nop	1
crap	6

<?php
namespace Werkspot\BingAdsApiBundle\Api\Helper;

use Exception;
use GuzzleHttp\ClientInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Werkspot\BingAdsApiBundle\Api\Exceptions\FileNotCopiedException;
use Werkspot\BingAdsApiBundle\Api\Exceptions\NoFileDestinationException;
use Werkspot\BingAdsApiBundle\Guzzle\Exceptions\CurlException;
use Werkspot\BingAdsApiBundle\Guzzle\Exceptions\HttpStatusCodeException;
use ZipArchive;

class File
{
    /**
     * @var ClientInterface
     */
    private $guzzleClient;

    /**
     * @var Filesystem
     */
    private $filesystem;

    /**
     * @var Finder
     */
    private $finder;

    /**
     * @var ZipArchive
     */
    private $zipArchive;

    public function __construct(ClientInterface $guzzleClient, Filesystem $fileSystem, Finder $finder)
    {
        $this->guzzleClient = $guzzleClient;
        $this->filesystem = $fileSystem;
        $this->finder = $finder;
        $this->zipArchive = new ZipArchive();
    }

    /**
     * @param $source
     * @param null|string $destination
     *
     * @throws NoFileDestinationException|FileNotCopiedException
     *
     * @return string
     */
    public function copyFile($source, $destination = null)
    {
        if (preg_match('/^http(s?):\/\//', $source)) {
            if ($destination === null) {
                throw new NoFileDestinationException();
            }
            $destination = $this->download($source, $destination);
        } else {
            if ($destination !== null) {
                $this->filesystem->copy($source, $destination);
            } else {
                $destination = $source;
            }
        }

        if (!$this->filesystem->exists($destination)) {
            throw new FileNotCopiedException();
        }

        return $destination;
    }

    /**
     * @param string $file
     *
     * @return bool
     */
    public function isHealthyZipFile($file)
    {
        $zipStatus = $this->zipArchive->open($file, ZipArchive::CHECKCONS);
        if ($zipStatus === ZipArchive::ER_OK || $zipStatus === true) {
            $this->zipArchive->close();
            $status = true;
        } else {
            $status = false;
        }

        return $status;
    }

    /**
     * @param string $url
     * @param string $destination
     *
     * @throws CurlException
     * @throws HttpStatusCodeException
     * @throws \Exception
     *
     * @return string
     */
    public function download($url, $destination)
    {
        $this->guzzleClient->request('GET', $url, ['sink' => $destination]);

        return $destination;
    }

    /**
     * @param string $file zipFile we want to open
     * @param null|string $extractTo
     * @param true|bool $delete
     *
     * @throws Exception
     *
     * @return array
     */
    public function unZip($file, $extractTo = null, $delete = true)
    {
        $zipDir = ($extractTo) ? $extractTo : dirname($file);

        if ($this->zipArchive->open($file) !== true) {
            throw new Exception("Could not open file {$file}");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        }
        $files = [];
        for ($i = 0; $i < $this->zipArchive->numFiles; ++$i) {
            $stat = $this->zipArchive->statIndex($i);
            $files[] = "{$zipDir}/{$stat['name']}";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        }
        $this->zipArchive->extractTo($zipDir);
        $this->zipArchive->close();
        if ($delete) {
            $this->filesystem->remove($file);
        }

        return $files;
    }

    /**
     * @param string $file
     * @return string[]
     */
    public function readFileLinesIntoArray($file)
    {
        return file($file);
    }

    /**
     * @param string[] $lines
     * @param string $file
     */
    public function writeLinesToFile($lines, $file)
    {
        $fp = fopen($file, 'w');
        fwrite($fp, implode('', $lines));
        fclose($fp);
    }

    /**
     * @param string|string[] $cache
     */
    public function clearCache($cache)
    {
        if (is_array($cache)) {
            foreach ($cache as $file) {
                $this->removeFile($file);
            }
        } elseif (is_dir($cache)) {
            foreach ($this->finder->files()->in($cache) as $file) {
                $this->removeFile($file);
            }
        } else {
            $this->removeFile($cache);
        }
    }

    /**
     * @param string $file
     */
    private function removeFile($file)
    {
        $this->filesystem->remove($file);
    }

    /**
     * @param string[] $files
     * @param string $target
     */
    public function moveFirstFile(array $files, $target)
    {
        $this->filesystem->rename($files[0], $target);
    }

    public function createDirIfNotExists($path)
    {
        if (!$this->filesystem->exists($path)) {
            $this->filesystem->mkdir($path, 0700);
        }
    }
}


1		<?php
2		namespace Werkspot\BingAdsApiBundle\Api\Helper;
3
4		use Exception;
5		use GuzzleHttp\ClientInterface;
6		use Symfony\Component\Filesystem\Filesystem;
7		use Symfony\Component\Finder\Finder;
8		use Werkspot\BingAdsApiBundle\Api\Exceptions\FileNotCopiedException;
9		use Werkspot\BingAdsApiBundle\Api\Exceptions\NoFileDestinationException;
10		use Werkspot\BingAdsApiBundle\Guzzle\Exceptions\CurlException;
11		use Werkspot\BingAdsApiBundle\Guzzle\Exceptions\HttpStatusCodeException;
12		use ZipArchive;
13
14		class File
15		{
16		/**
17		* @var ClientInterface
18		*/
19		private $guzzleClient;
20
21		/**
22		* @var Filesystem
23	27	*/
24		private $filesystem;
25	27
26	27	/**
27	27	* @var Finder
28		*/
29		private $finder;
30
31		/**
32		* @var ZipArchive
33		*/
34		private $zipArchive;
35
36		public function __construct(ClientInterface $guzzleClient, Filesystem $fileSystem, Finder $finder)
37	2	{
38		$this->guzzleClient = $guzzleClient;
39	2	$this->filesystem = $fileSystem;
40	2	$this->finder = $finder;
41	1	$this->zipArchive = new ZipArchive();
42		}
43	1
44	1	/**
45	1	* @param $source
46	1	* @param null\|string $destination
47	1	*
48	1	* @throws NoFileDestinationException\|FileNotCopiedException
49		*
50		* @return string
51		*/
52	1	public function copyFile($source, $destination = null)
53	1	{
54		if (preg_match('/^http(s?):\/\//', $source)) {
55		if ($destination === null) {
56	1	throw new NoFileDestinationException();
57		}
58		$destination = $this->download($source, $destination);
59		} else {
60		if ($destination !== null) {
61		$this->filesystem->copy($source, $destination);
62		} else {
63		$destination = $source;
64		}
65		}
66
67		if (!$this->filesystem->exists($destination)) {
68		throw new FileNotCopiedException();
69	2	}
70
71	2	return $destination;
72		}
73	2
74		/**
75		* @param string $file
76		*
77		* @return bool
78		*/
79		public function isHealthyZipFile($file)
80		{
81		$zipStatus = $this->zipArchive->open($file, ZipArchive::CHECKCONS);
82		if ($zipStatus === ZipArchive::ER_OK \|\| $zipStatus === true) {
83		$this->zipArchive->close();
84		$status = true;
85	2	} else {
86		$status = false;
87	2	}
88	2
89	2	return $status;
90	1	}
91
92	1	/**
93	1	* @param string $url
94	1	* @param string $destination
95	1	*
96	1	* @throws CurlException
97	1	* @throws HttpStatusCodeException
98	1	* @throws \Exception
99	1	*
100	1	* @return string
101	1	*/
102		public function download($url, $destination)
103	1	{
104		$this->guzzleClient->request('GET', $url, ['sink' => $destination]);
105
106		return $destination;
107		}
108
109		/**
110		* @param string $file zipFile we want to open
111		* @param null\|string $extractTo
112		* @param true\|bool $delete
113		*
114		* @throws Exception
115		*
116		* @return array
117		*/
118		public function unZip($file, $extractTo = null, $delete = true)
119		{
120		$zipDir = ($extractTo) ? $extractTo : dirname($file);
121
122		if ($this->zipArchive->open($file) !== true) {
123		throw new Exception("Could not open file {$file}");
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-07 09:51 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$file` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
124		}
125		$files = [];
126		for ($i = 0; $i < $this->zipArchive->numFiles; ++$i) {
127		$stat = $this->zipArchive->statIndex($i);
128		$files[] = "{$zipDir}/{$stat['name']}";
		0 ignored issues – show Coding Style Best Practice introduced 2016-03-07 09:51 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$zipDir` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history... Coding Style Best Practice introduced 2016-03-07 09:51 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$stat` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
129		}
130		$this->zipArchive->extractTo($zipDir);
131		$this->zipArchive->close();
132		if ($delete) {
133		$this->filesystem->remove($file);
134		}
135
136		return $files;
137		}
138
139		/**
140		* @param string $file
141		* @return string[]
142		*/
143		public function readFileLinesIntoArray($file)
144		{
145		return file($file);
146		}
147
148		/**
149		* @param string[] $lines
150		* @param string $file
151		*/
152		public function writeLinesToFile($lines, $file)
153		{
154		$fp = fopen($file, 'w');
155		fwrite($fp, implode('', $lines));
156		fclose($fp);
157		}
158
159		/**
160		* @param string\|string[] $cache
161		*/
162		public function clearCache($cache)
163		{
164		if (is_array($cache)) {
165		foreach ($cache as $file) {
166		$this->removeFile($file);
167		}
168		} elseif (is_dir($cache)) {
169		foreach ($this->finder->files()->in($cache) as $file) {
170		$this->removeFile($file);
171		}
172		} else {
173		$this->removeFile($cache);
174		}
175		}
176
177		/**
178		* @param string $file
179		*/
180		private function removeFile($file)
181		{
182		$this->filesystem->remove($file);
183		}
184
185		/**
186		* @param string[] $files
187		* @param string $target
188		*/
189		public function moveFirstFile(array $files, $target)
190		{
191		$this->filesystem->rename($files[0], $target);
192		}
193
194		public function createDirIfNotExists($path)
195		{
196		if (!$this->filesystem->exists($path)) {
197		$this->filesystem->mkdir($path, 0700);
198		}
199		}
200		}
201

Werkspot / BingAdsApiBundle

File::createDirIfNotExists() A last analyzed 2016-04-19 07:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

File::createDirIfNotExists() A
last analyzed 2016-04-19 07:37 UTC