FileUploadTrait::getImagesFileDir() - Code Metrics - Inspection of "Merge pull request #128 from wagnert/master" - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 313f20...c23fe9 )

by Tim

created 2018-03-03 08:41 UTC

FileUploadTrait::getImagesFileDir() A

↳ Parent: FileUploadTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * TechDivision\Import\Subjects\FileUploadTrait
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Subjects;

/**
 * The trait implementation for the file upload functionality.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */
trait FileUploadTrait
{

    /**
     * The directory with the Magento media files => target directory for images (relative to the root directory).
     *
     * @var string
     */
    protected $mediaDir;

    /**
     * The directory with the images that have to be imported (relative to the root directory).
     *
     * @var string
     */
    protected $imagesFileDir;

    /**
     * The flag whether to copy the images or not.
     *
     * @var boolean
     */
    protected $copyImages = false;

    /**
     * Set's the flag to copy the images or not.
     *
     * @param boolean $copyImages The flag
     *
     * @return void
     */
    public function setCopyImages($copyImages)
    {
        $this->copyImages = $copyImages;
    }

    /**
     * Return's the flag to copy images or not.
     *
     * @return boolean The flag
     */
    public function hasCopyImages()
    {
        return $this->copyImages;
    }

    /**
     * Set's directory with the Magento media files => target directory for images.
     *
     * @param string $mediaDir The directory with the Magento media files => target directory for images
     *
     * @return void
     */
    public function setMediaDir($mediaDir)
    {
        $this->mediaDir = $mediaDir;
    }

    /**
     * Return's the directory with the Magento media files => target directory for images.
     *
     * @return string The directory with the Magento media files => target directory for images
     */
    public function getMediaDir()
    {
        return $this->mediaDir;
    }

    /**
     * Set's directory with the images that have to be imported.
     *
     * @param string $imagesFileDir The directory with the images that have to be imported
     *
     * @return void
     */
    public function setImagesFileDir($imagesFileDir)
    {
        $this->imagesFileDir = $imagesFileDir;
    }

    /**
     * Return's the directory with the images that have to be imported.
     *
     * @return string The directory with the images that have to be imported
     */
    public function getImagesFileDir()
    {
        return $this->imagesFileDir;
    }

    /**
     * Get new file name if the same is already exists.
     *
     * @param string $targetFilename The name of the exisising files
     *
     * @return string The new filename
     */
    public function getNewFileName($targetFilename)
    {

        // load the file information
        $fileInfo = pathinfo($targetFilename);

        // query whether or not, the file exists
        if ($this->getFilesystemAdapter()->isFile($targetFilename)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            // initialize the incex and the basename
            $index = 1;
            $baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];

            // prepare the new filename by raising the index
            while ($this->getFilesystemAdapter()->isFile($fileInfo['dirname'] . '/' . $baseName)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
                $index++;
            }

            // set the new filename
            $targetFilename = $baseName;


        } else {
            // if not, simply return the filename
            return $fileInfo['basename'];
        }

        // return the new filename
        return $targetFilename;
    }

    /**
     * Upload's the file with the passed name to the Magento
     * media directory. If the file already exists, the will
     * be given a new name that will be returned.
     *
     * @param string $filename The name of the file to be uploaded
     *
     * @return string The name of the uploaded file
     * @throws \Exception Is thrown, if the file with the passed name is not available
     */
    public function uploadFile($filename)
    {

        // trim the leading /, if available
        $trimmedFilename = ltrim($filename, '/');
        $mediaDir = ltrim($this->getMediaDir(), '/');
        $imagesFileDir = ltrim($this->getImagesFileDir(), '/');

        // prepare source/target filename
        $sourceFilename = sprintf('%s/%s', $imagesFileDir, $trimmedFilename);
        $targetFilename = sprintf('%s/%s', $mediaDir, $trimmedFilename);

        // query whether or not the image file to be imported is available
        if (!$this->getFilesystemAdapter()->isFile($sourceFilename)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            throw new \Exception(sprintf('Media file %s not available', $sourceFilename));
        }

        // prepare the target filename, if necessary
        $newTargetFilename = $this->getNewFileName($targetFilename);
        $targetFilename = str_replace(basename($targetFilename), $newTargetFilename, $targetFilename);

        // make sure, the target directory exists
        if (!$this->getFilesystemAdapter()->isDir($targetDirectory = dirname($targetFilename))) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->getFilesystemAdapter()->mkdir($targetDirectory, 0755);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        // copy the image to the target directory
        $this->getFilesystemAdapter()->copy($sourceFilename, $targetFilename);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // return the new target filename
        return str_replace($mediaDir, '', $targetFilename);
    }

    /**
     * Delete the file with the passed name.
     *
     * @param string $filename The name of the file to be deleted
     *
     * @return boolean TRUE on success, else FALSE
     */
    public function deleteFile($filename)
    {

        // trim the leading /, if available
        $trimmedFilename = ltrim($filename, '/');
        $mediaDir = ltrim($this->getMediaDir(), '/');

        // prepare source/target filename
        $targetFilename = sprintf('%s/%s', $mediaDir, $trimmedFilename);

        // query whether or not the image file to be deleted is available
        if (!$this->getFilesystemAdapter()->isFile($targetFilename)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            throw new \Exception(sprintf('Media file %s not available', $targetFilename));
        }

        // delte the image from the target directory
        $this->getFilesystemAdapter()->delete($targetFilename);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1		<?php
2
3		/**
4		* TechDivision\Import\Subjects\FileUploadTrait
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2016 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link https://github.com/techdivision/import
18		* @link http://www.techdivision.com
19		*/
20
21		namespace TechDivision\Import\Subjects;
22
23		/**
24		* The trait implementation for the file upload functionality.
25		*
26		* @author Tim Wagner <[email protected]>
27		* @copyright 2016 TechDivision GmbH <[email protected]>
28		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29		* @link https://github.com/techdivision/import
30		* @link http://www.techdivision.com
31		*/
32		trait FileUploadTrait
33		{
34
35		/**
36		* The directory with the Magento media files => target directory for images (relative to the root directory).
37		*
38		* @var string
39		*/
40		protected $mediaDir;
41
42		/**
43		* The directory with the images that have to be imported (relative to the root directory).
44		*
45		* @var string
46		*/
47		protected $imagesFileDir;
48
49		/**
50		* The flag whether to copy the images or not.
51		*
52		* @var boolean
53		*/
54		protected $copyImages = false;
55
56		/**
57		* Set's the flag to copy the images or not.
58		*
59		* @param boolean $copyImages The flag
60		*
61		* @return void
62		*/
63	1	public function setCopyImages($copyImages)
64		{
65	1	$this->copyImages = $copyImages;
66	1	}
67
68		/**
69		* Return's the flag to copy images or not.
70		*
71		* @return boolean The flag
72		*/
73	1	public function hasCopyImages()
74		{
75	1	return $this->copyImages;
76		}
77
78		/**
79		* Set's directory with the Magento media files => target directory for images.
80		*
81		* @param string $mediaDir The directory with the Magento media files => target directory for images
82		*
83		* @return void
84		*/
85	3	public function setMediaDir($mediaDir)
86		{
87	3	$this->mediaDir = $mediaDir;
88	3	}
89
90		/**
91		* Return's the directory with the Magento media files => target directory for images.
92		*
93		* @return string The directory with the Magento media files => target directory for images
94		*/
95	3	public function getMediaDir()
96		{
97	3	return $this->mediaDir;
98		}
99
100		/**
101		* Set's directory with the images that have to be imported.
102		*
103		* @param string $imagesFileDir The directory with the images that have to be imported
104		*
105		* @return void
106		*/
107	3	public function setImagesFileDir($imagesFileDir)
108		{
109	3	$this->imagesFileDir = $imagesFileDir;
110	3	}
111
112		/**
113		* Return's the directory with the images that have to be imported.
114		*
115		* @return string The directory with the images that have to be imported
116		*/
117	3	public function getImagesFileDir()
118		{
119	3	return $this->imagesFileDir;
120		}
121
122		/**
123		* Get new file name if the same is already exists.
124		*
125		* @param string $targetFilename The name of the exisising files
126		*
127		* @return string The new filename
128		*/
129	3	public function getNewFileName($targetFilename)
130		{
131
132		// load the file information
133	3	$fileInfo = pathinfo($targetFilename);
134
135		// query whether or not, the file exists
136	3	if ($this->getFilesystemAdapter()->isFile($targetFilename)) {
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
137		// initialize the incex and the basename
138	1	$index = 1;
139	1	$baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];
140
141		// prepare the new filename by raising the index
142	1	while ($this->getFilesystemAdapter()->isFile($fileInfo['dirname'] . '/' . $baseName)) {
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
143	1	$baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
144	1	$index++;
145		}
146
147		// set the new filename
148	1	$targetFilename = $baseName;
149
		0 ignored issues – show Coding Style introduced 2017-02-27 15:33 UTC by Report Bug Copy Issue Report Blank line found at end of control structure Loading history...
150		} else {
151		// if not, simply return the filename
152	2	return $fileInfo['basename'];
153		}
154
155		// return the new filename
156	1	return $targetFilename;
157		}
158
159		/**
160		* Upload's the file with the passed name to the Magento
161		* media directory. If the file already exists, the will
162		* be given a new name that will be returned.
163		*
164		* @param string $filename The name of the file to be uploaded
165		*
166		* @return string The name of the uploaded file
167		* @throws \Exception Is thrown, if the file with the passed name is not available
168		*/
169	2	public function uploadFile($filename)
170		{
171
172		// trim the leading /, if available
173	2	$trimmedFilename = ltrim($filename, '/');
174	2	$mediaDir = ltrim($this->getMediaDir(), '/');
175	2	$imagesFileDir = ltrim($this->getImagesFileDir(), '/');
176
177		// prepare source/target filename
178	2	$sourceFilename = sprintf('%s/%s', $imagesFileDir, $trimmedFilename);
179	2	$targetFilename = sprintf('%s/%s', $mediaDir, $trimmedFilename);
180
181		// query whether or not the image file to be imported is available
182	2	if (!$this->getFilesystemAdapter()->isFile($sourceFilename)) {
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
183	1	throw new \Exception(sprintf('Media file %s not available', $sourceFilename));
184		}
185
186		// prepare the target filename, if necessary
187	1	$newTargetFilename = $this->getNewFileName($targetFilename);
188	1	$targetFilename = str_replace(basename($targetFilename), $newTargetFilename, $targetFilename);
189
190		// make sure, the target directory exists
191	1	if (!$this->getFilesystemAdapter()->isDir($targetDirectory = dirname($targetFilename))) {
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
192	1	$this->getFilesystemAdapter()->mkdir($targetDirectory, 0755);
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
193		}
194
195		// copy the image to the target directory
196	1	$this->getFilesystemAdapter()->copy($sourceFilename, $targetFilename);
		0 ignored issues – show Bug introduced 2017-08-01 16:40 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
197
198		// return the new target filename
199	1	return str_replace($mediaDir, '', $targetFilename);
200		}
201
202		/**
203		* Delete the file with the passed name.
204		*
205		* @param string $filename The name of the file to be deleted
206		*
207		* @return boolean TRUE on success, else FALSE
208		*/
209		public function deleteFile($filename)
210		{
211
212		// trim the leading /, if available
213		$trimmedFilename = ltrim($filename, '/');
214		$mediaDir = ltrim($this->getMediaDir(), '/');
215
216		// prepare source/target filename
217		$targetFilename = sprintf('%s/%s', $mediaDir, $trimmedFilename);
218
219		// query whether or not the image file to be deleted is available
220		if (!$this->getFilesystemAdapter()->isFile($targetFilename)) {
		0 ignored issues – show Bug introduced 2017-09-02 10:06 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
221		throw new \Exception(sprintf('Media file %s not available', $targetFilename));
222		}
223
224		// delte the image from the target directory
225		$this->getFilesystemAdapter()->delete($targetFilename);
		0 ignored issues – show Bug introduced 2017-09-02 10:06 UTC by Report Bug Copy Issue Report It seems like `getFilesystemAdapter()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
226		}
227		}
228

techdivision / import

Push — master ( 313f20...c23fe9 )

FileUploadTrait::getImagesFileDir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like