Compress::close() - Code Metrics - jaeger-app/compress - Measure and Improve Code Quality continuously with Scrutinizer

Compress::close() A
last analyzed 2016-07-05 01:46 UTC

↳ Parent: Compress

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php
/**
 * Jaeger
 *
 * @copyright	Copyright (c) 2015-2016, mithra62
 * @link		http://jaeger-app.com
 * @version		1.0
 * @filesource 	./Compress.php
 */
namespace JaegerApp;

use JaegerApp\Exceptions\CompressException;

/**
 * Jaeger - Compress Object
 *
 * Handles compressing and decompressing files into various formats
 *
 * @package Compression
 * @author Eric Lamb <[email protected]> 
 */
class Compress
{

    /**
     * Returns an instance of the archive object
     * 
     * @var \ZipArchive
     */
    protected $archiver = null;

    /**
     * Flag to determine whether the orignial file should be kept
     * 
     * @var bool
     */
    protected $keep_original = true;

    /**
     * The name of the completed archive file
     * 
     * @var string
     */
    protected $archive_name = 'archive.zip';

    /**
     * Returns an instance of the Archiver
     * 
     * @return ZipArchive
     */
    public function getArchiver()
    {
        if (is_null($this->archiver)) {
            $this->archiver = new \ZipArchive();
        }
        
        return $this->archiver;
    }

    /**
     * Extracts a compressed file to the destination
     * 
     * @param string $file
     *            The full path to the file to extract
     * @param string $destination
     *            The destination to extract to
     * @return bool
     */
    public function extract($file, $destination = false)
    {
        $archive = $this->getArchiver()->open($file);
        if ($archive) {
            $this->getArchiver()->extractTo($destination);
            return $this->getArchiver()->close();
        }
    }

    /**
     * Sets the archive file name
     * 
     * @param string $name            
     * @return \mithra62\Compress
     */
    public function setArchiveName($name)
    {
        $this->archive_name = $name . '.zip';
        return $this;
    }

    /**
     * Returns the archive file name
     * 
     * @return string
     */
    public function getArchiveName()
    {
        return $this->archive_name;
    }

    /**
     * Starts the process of creating an archive
     * 
     * @param string $name            
     * @return \mithra62\Compress
     */
    public function create($name)
    {
        $this->setArchiveName($name);
        $this->getArchiver()->open($this->getArchiveName(), \ZipArchive::CREATE | \ZipArchive::OVERWRITE);
        return $this;
    }

    /**
     * Adds a file to the archive
     * 
     * @param string $path            
     * @param string $relative            
     * @return \mithra62\Compress
     */
    public function add($path, $relative)
    {
        $this->getArchiver()->addFile($path, $relative);
        return $this;
    }

    /**
     * Closes the zip archive object
     * 
     * @return string The path to the archive
     */
    public function close()
    {
        $this->getArchiver()->close();
        return $this->getArchiveName();
    }

    /**
     * Compresses a single file
     * 
     * @param string $file
     *            the full path to the file to compress
     * @param string $desination
     *            optional the full path to the destination. If none is given then $file is used with the extension appended
     */
    public function archiveSingle($file, $desination = false)
    {
        if ($file == '') {
            throw new CompressException('__exception_compress_file_value_empty');
        }
        
        if (! file_exists($file)) {
            throw new CompressException('__exception_compress_file_not_exist');
        }
        
        if (! is_readable($file)) {
            throw new CompressException('__exception_compress_file_not_readable');
        }
        
        // work out path stuff
        $old_cwd = getcwd();
        $path = dirname($file);
        chdir($path);
        
        $name = $this->getArchiveName();
        $zip = $this->getArchiver();
        $zip->open($name, \ZipArchive::CREATE);
        if (file_exists($file)) {
            $zip->addFile(basename($file));
        }
        
        if ($zip->status != '0') {
            throw new CompressException('__exception_compression');
        }
        
        $zip->close();
        
        if (! $this->getKeepOriginal() && file_exists($file)) {
            unlink($file);
        }
        
        if ($desination) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $desination = realpath($desination) . DIRECTORY_SEPARATOR . $name;
            copy($name, $desination);
            unlink($name);
            
            $name = $desination;
        } else {
            $name = $path . DIRECTORY_SEPARATOR . $name;
        }
        
        // reset path
        chdir($old_cwd);
        
        return $name;
    }

    /**
     * Sets whether the original file should be removed once compressed
     * 
     * @param bool $flag            
     * @return \mithra62\Compress
     */
    public function setKeepOriginal($flag = true)
    {
        $this->keep_original = $flag;
        return $this;
    }

    /**
     * Returns whether the original file should be kept once compressed
     * 
     * @return \mithra62\bool
     */
    public function getKeepOriginal()
    {
        return $this->keep_original;
    }
}

1			<?php
2			/**
3			* Jaeger
4			*
5			* @copyright Copyright (c) 2015-2016, mithra62
6			* @link http://jaeger-app.com
7			* @version 1.0
8			* @filesource ./Compress.php
9			*/
10			namespace JaegerApp;
11
12			use JaegerApp\Exceptions\CompressException;
13
14			/**
15			* Jaeger - Compress Object
16			*
17			* Handles compressing and decompressing files into various formats
18			*
19			* @package Compression
20			* @author Eric Lamb <[email protected]>
21			*/
22			class Compress
23			{
24
25			/**
26			* Returns an instance of the archive object
27			*
28			* @var \ZipArchive
29			*/
30			protected $archiver = null;
31
32			/**
33			* Flag to determine whether the orignial file should be kept
34			*
35			* @var bool
36			*/
37			protected $keep_original = true;
38
39			/**
40			* The name of the completed archive file
41			*
42			* @var string
43			*/
44			protected $archive_name = 'archive.zip';
45
46			/**
47			* Returns an instance of the Archiver
48			*
49			* @return ZipArchive
50			*/
51			public function getArchiver()
52			{
53			if (is_null($this->archiver)) {
54			$this->archiver = new \ZipArchive();
55			}
56
57			return $this->archiver;
58			}
59
60			/**
61			* Extracts a compressed file to the destination
62			*
63			* @param string $file
64			* The full path to the file to extract
65			* @param string $destination
66			* The destination to extract to
67			* @return bool
68			*/
69			public function extract($file, $destination = false)
70			{
71			$archive = $this->getArchiver()->open($file);
72			if ($archive) {
73			$this->getArchiver()->extractTo($destination);
74			return $this->getArchiver()->close();
75			}
76			}
77
78			/**
79			* Sets the archive file name
80			*
81			* @param string $name
82			* @return \mithra62\Compress
83			*/
84			public function setArchiveName($name)
85			{
86			$this->archive_name = $name . '.zip';
87			return $this;
88			}
89
90			/**
91			* Returns the archive file name
92			*
93			* @return string
94			*/
95			public function getArchiveName()
96			{
97			return $this->archive_name;
98			}
99
100			/**
101			* Starts the process of creating an archive
102			*
103			* @param string $name
104			* @return \mithra62\Compress
105			*/
106			public function create($name)
107			{
108			$this->setArchiveName($name);
109			$this->getArchiver()->open($this->getArchiveName(), \ZipArchive::CREATE \| \ZipArchive::OVERWRITE);
110			return $this;
111			}
112
113			/**
114			* Adds a file to the archive
115			*
116			* @param string $path
117			* @param string $relative
118			* @return \mithra62\Compress
119			*/
120			public function add($path, $relative)
121			{
122			$this->getArchiver()->addFile($path, $relative);
123			return $this;
124			}
125
126			/**
127			* Closes the zip archive object
128			*
129			* @return string The path to the archive
130			*/
131			public function close()
132			{
133			$this->getArchiver()->close();
134			return $this->getArchiveName();
135			}
136
137			/**
138			* Compresses a single file
139			*
140			* @param string $file
141			* the full path to the file to compress
142			* @param string $desination
143			* optional the full path to the destination. If none is given then $file is used with the extension appended
144			*/
145			public function archiveSingle($file, $desination = false)
146			{
147			if ($file == '') {
148			throw new CompressException('__exception_compress_file_value_empty');
149			}
150
151			if (! file_exists($file)) {
152			throw new CompressException('__exception_compress_file_not_exist');
153			}
154
155			if (! is_readable($file)) {
156			throw new CompressException('__exception_compress_file_not_readable');
157			}
158
159			// work out path stuff
160			$old_cwd = getcwd();
161			$path = dirname($file);
162			chdir($path);
163
164			$name = $this->getArchiveName();
165			$zip = $this->getArchiver();
166			$zip->open($name, \ZipArchive::CREATE);
167			if (file_exists($file)) {
168			$zip->addFile(basename($file));
169			}
170
171			if ($zip->status != '0') {
172			throw new CompressException('__exception_compression');
173			}
174
175			$zip->close();
176
177			if (! $this->getKeepOriginal() && file_exists($file)) {
178			unlink($file);
179			}
180
181			if ($desination) {
			0 ignored issues – show Bug Best Practice introduced 2016-04-19 01:03 UTC by Report Bug Copy Issue Report The expression `$desination` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
182			$desination = realpath($desination) . DIRECTORY_SEPARATOR . $name;
183			copy($name, $desination);
184			unlink($name);
185
186			$name = $desination;
187			} else {
188			$name = $path . DIRECTORY_SEPARATOR . $name;
189			}
190
191			// reset path
192			chdir($old_cwd);
193
194			return $name;
195			}
196
197			/**
198			* Sets whether the original file should be removed once compressed
199			*
200			* @param bool $flag
201			* @return \mithra62\Compress
202			*/
203			public function setKeepOriginal($flag = true)
204			{
205			$this->keep_original = $flag;
206			return $this;
207			}
208
209			/**
210			* Returns whether the original file should be kept once compressed
211			*
212			* @return \mithra62\bool
213			*/
214			public function getKeepOriginal()
215			{
216			return $this->keep_original;
217			}
218			}

jaeger-app / compress

Compress::close() A last analyzed 2016-07-05 01:46 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Compress::close() A
last analyzed 2016-07-05 01:46 UTC