AbstractFileResolver::getPatternElements() - Code Metrics - Inspection of "Merge branch '16.x' of github.com:techdivision/imp..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.x ( 0056bb...bd3602 )

by Tim

created 2020-04-03 16:21 UTC

AbstractFileResolver::getPatternElements() A

↳ Parent: AbstractFileResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

/**
 * TechDivision\Import\Subjects\FileResolver\AbstractFileResolver
 *
 * 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\FileResolver;

use TechDivision\Import\Utils\RegistryKeys;
use TechDivision\Import\Loaders\FilteredLoaderInterface;
use TechDivision\Import\Adapter\FilesystemAdapterInterface;
use TechDivision\Import\Services\RegistryProcessorInterface;
use TechDivision\Import\Configuration\SubjectConfigurationInterface;
use TechDivision\Import\Configuration\Subject\FileResolverConfigurationInterface;

/**
 * Abstract file resolver implementation.
 *
 * @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
 */
abstract class AbstractFileResolver implements FileResolverInterface

{

    /**
     * The registry processor instance.
     *
     * @var \TechDivision\Import\Services\RegistryProcessorInterface
     */
    private $registryProcessor;

    /**
     * The actual source directory to load the files from.
     *
     * @var string
     */
    private $sourceDir;

    /**
     * The subject configuraiton instance.
     *
     * @var \TechDivision\Import\Configuration\SubjectConfigurationInterface
     */
    private $subjectConfiguration;

    /**
     * The filesystem adapter instance.
     *
     * @var \TechDivision\Import\Adapter\PhpFilesystemAdapterInterface
     */
    private $filesystemAdapter;

    /**
     * The filesystem loader instance.
     *
     * @var \TechDivision\Import\Loaders\LoaderInterface
     */
    private $filesystemLoader;

    /**
     * Initializes the file resolver with the application and the registry instance.
     *
     * @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry instance
     * @param \TechDivision\Import\Loaders\FilteredLoaderInterface     $filesystemLoader  The filesystem loader instance
     */
    public function __construct(RegistryProcessorInterface $registryProcessor, FilteredLoaderInterface $filesystemLoader)
    {
        $this->registryProcessor = $registryProcessor;
        $this->filesystemLoader = $filesystemLoader;
    }

    /**
     * Return's the registry processor instance.
     *
     * @return \TechDivision\Import\Services\RegistryProcessorInterface The processor instance
     */
    protected function getRegistryProcessor() : RegistryProcessorInterface
    {
        return $this->registryProcessor;
    }

    /**
     * Return's the filesystem loader instance.
     *
     * @return \TechDivision\Import\Loaders\FilteredLoaderInterface The loader instance
     */
    protected function getFilesystemLoader() : FilteredLoaderInterface
    {
        return $this->filesystemLoader;
    }

    /**
     * Sets the actual source directory to load the files from.
     *
     * @param string $sourceDir The actual source directory
     *
     * @return void
     */
    protected function setSourceDir(string $sourceDir) : void
    {
        $this->sourceDir = $sourceDir;
    }

    /**
     * Returns the actual source directory to load the files from.
     *
     * @return string The actual source directory
     */
    protected function getSourceDir() : string
    {
        return $this->sourceDir;
    }

    /**
     * Returns the file resolver configuration instance.
     *
     * @return \TechDivision\Import\Configuration\Subject\FileResolverConfigurationInterface The configuration instance
     */
    protected function getFileResolverConfiguration() : FileResolverConfigurationInterface
    {
        return $this->getSubjectConfiguration()->getFileResolver();
    }

    /**
     * Returns the suffix for the import files.
     *
     * @return string The suffix
     */
    protected function getSuffix() : string
    {
        return $this->getFileResolverConfiguration()->getSuffix();
    }

    /**
     * Initializes the file resolver for the import process with the passed serial.
     *
     * @param string $serial The unique identifier of the actual import process
     *
     * @return void
     * @throws \Exception Is thrown if the configured source directory is not available
     */
    protected function initialize(string $serial) : void

    {

        // load the actual status
        $status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);

        // query whether or not the configured source directory is available
        if ($this->getFilesystemAdapter()->isDir($sourceDir = $status[RegistryKeys::SOURCE_DIRECTORY])) {
            // set the source directory, if it is accessible
            $this->setSourceDir($sourceDir);
            // return immediately
            return;
        }

        // throw an exception otherwise
        throw new \Exception(sprintf('Configured source directory "%s" is not available!', $sourceDir));
    }

    /**
     * Sets the subject configuration instance.
     *
     * @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $subjectConfiguration The subject configuration
     *
     * @return void
     */
    public function setSubjectConfiguration(SubjectConfigurationInterface $subjectConfiguration) : void
    {
        $this->subjectConfiguration = $subjectConfiguration;
    }

    /**
     * Returns the subject configuration instance.
     *
     * @return \TechDivision\Import\Configuration\SubjectConfigurationInterface The subject configuration
     */
    public function getSubjectConfiguration() : SubjectConfigurationInterface
    {
        return $this->subjectConfiguration;
    }

    /**
     * Set's the filesystem adapter instance.
     *
     * @param \TechDivision\Import\Adapter\FilesystemAdapterInterface $filesystemAdapter
     *
     * @return void
     */
    public function setFilesystemAdapter(FilesystemAdapterInterface $filesystemAdapter) : void
    {
        $this->filesystemAdapter = $filesystemAdapter;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * Return's the filesystem adapter instance.
     *
     * @return \TechDivision\Import\Adapter\FilesystemAdapterInterface The filesystem adapter instance
     */
    public function getFilesystemAdapter() : FilesystemAdapterInterface
    {
        return $this->filesystemAdapter;
    }

    /**
     * Loads the files from the source directory and return's them sorted.
     *
     * @param string $serial The unique identifier of the actual import process
     *
     * @return array The array with the files matching the subjects suffix
     * @throws \Exception Is thrown, when the source directory is NOT available
     */
    public function loadFiles(string $serial) : array
    {

        // initialize the resolver
        // @TODO Check if the method can not be moved to object initialization
        $this->initialize($serial);

        // initialize the array with the files matching the suffix found in the source directory
        return $this->getFilesystemLoader()->load(sprintf('%s/*.%s', $this->getSourceDir(), $this->getSuffix()));

    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Subjects\FileResolver\AbstractFileResolver
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\FileResolver;
22
23			use TechDivision\Import\Utils\RegistryKeys;
24			use TechDivision\Import\Loaders\FilteredLoaderInterface;
25			use TechDivision\Import\Adapter\FilesystemAdapterInterface;
26			use TechDivision\Import\Services\RegistryProcessorInterface;
27			use TechDivision\Import\Configuration\SubjectConfigurationInterface;
28			use TechDivision\Import\Configuration\Subject\FileResolverConfigurationInterface;
29
30			/**
31			* Abstract file resolver implementation.
32			*
33			* @author Tim Wagner <[email protected]>
34			* @copyright 2016 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link https://github.com/techdivision/import
37			* @link http://www.techdivision.com
38			*/
39		View Code Duplication	abstract class AbstractFileResolver implements FileResolverInterface
			0 ignored issues – show Duplication introduced 2020-04-03 16:23 UTC by Report Bug Copy Issue Report This class 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...
40			{
41
42			/**
43			* The registry processor instance.
44			*
45			* @var \TechDivision\Import\Services\RegistryProcessorInterface
46			*/
47			private $registryProcessor;
48
49			/**
50			* The actual source directory to load the files from.
51			*
52			* @var string
53			*/
54			private $sourceDir;
55
56			/**
57			* The subject configuraiton instance.
58			*
59			* @var \TechDivision\Import\Configuration\SubjectConfigurationInterface
60			*/
61			private $subjectConfiguration;
62
63			/**
64			* The filesystem adapter instance.
65			*
66			* @var \TechDivision\Import\Adapter\PhpFilesystemAdapterInterface
67			*/
68			private $filesystemAdapter;
69
70			/**
71			* The filesystem loader instance.
72			*
73			* @var \TechDivision\Import\Loaders\LoaderInterface
74			*/
75			private $filesystemLoader;
76
77			/**
78			* Initializes the file resolver with the application and the registry instance.
79			*
80			* @param \TechDivision\Import\Services\RegistryProcessorInterface $registryProcessor The registry instance
81	3		* @param \TechDivision\Import\Loaders\FilteredLoaderInterface $filesystemLoader The filesystem loader instance
82			*/
83	3		public function __construct(RegistryProcessorInterface $registryProcessor, FilteredLoaderInterface $filesystemLoader)
84	3		{
85	3		$this->registryProcessor = $registryProcessor;
86			$this->filesystemLoader = $filesystemLoader;
87			}
88
89			/**
90			* Return's the registry processor instance.
91			*
92			* @return \TechDivision\Import\Services\RegistryProcessorInterface The processor instance
93			*/
94			protected function getRegistryProcessor() : RegistryProcessorInterface
95			{
96			return $this->registryProcessor;
97			}
98
99			/**
100			* Return's the filesystem loader instance.
101			*
102			* @return \TechDivision\Import\Loaders\FilteredLoaderInterface The loader instance
103			*/
104			protected function getFilesystemLoader() : FilteredLoaderInterface
105			{
106			return $this->filesystemLoader;
107			}
108
109			/**
110			* Sets the actual source directory to load the files from.
111			*
112			* @param string $sourceDir The actual source directory
113			*
114			* @return void
115			*/
116			protected function setSourceDir(string $sourceDir) : void
117			{
118			$this->sourceDir = $sourceDir;
119			}
120
121			/**
122			* Returns the actual source directory to load the files from.
123			*
124			* @return string The actual source directory
125			*/
126			protected function getSourceDir() : string
127			{
128			return $this->sourceDir;
129			}
130
131			/**
132			* Returns the file resolver configuration instance.
133			*
134	3		* @return \TechDivision\Import\Configuration\Subject\FileResolverConfigurationInterface The configuration instance
135			*/
136	3		protected function getFileResolverConfiguration() : FileResolverConfigurationInterface
137			{
138			return $this->getSubjectConfiguration()->getFileResolver();
139			}
140
141			/**
142			* Returns the suffix for the import files.
143			*
144	3		* @return string The suffix
145			*/
146	3		protected function getSuffix() : string
147			{
148			return $this->getFileResolverConfiguration()->getSuffix();
149			}
150
151			/**
152			* Initializes the file resolver for the import process with the passed serial.
153			*
154	3		* @param string $serial The unique identifier of the actual import process
155			*
156	3		* @return void
157			* @throws \Exception Is thrown if the configured source directory is not available
158			*/
159			protected function initialize(string $serial) : void
			0 ignored issues – show Unused Code introduced 2020-04-03 16:23 UTC by Report Bug Copy Issue Report The parameter `$serial` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
160			{
161
162			// load the actual status
163			$status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
164	3
165			// query whether or not the configured source directory is available
166	3		if ($this->getFilesystemAdapter()->isDir($sourceDir = $status[RegistryKeys::SOURCE_DIRECTORY])) {
167			// set the source directory, if it is accessible
168			$this->setSourceDir($sourceDir);
169			// return immediately
170			return;
171			}
172
173			// throw an exception otherwise
174	1		throw new \Exception(sprintf('Configured source directory "%s" is not available!', $sourceDir));
175			}
176	1
177			/**
178			* Sets the subject configuration instance.
179			*
180			* @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $subjectConfiguration The subject configuration
181			*
182			* @return void
183			*/
184			public function setSubjectConfiguration(SubjectConfigurationInterface $subjectConfiguration) : void
185			{
186			$this->subjectConfiguration = $subjectConfiguration;
187			}
188
189			/**
190			* Returns the subject configuration instance.
191			*
192			* @return \TechDivision\Import\Configuration\SubjectConfigurationInterface The subject configuration
193			*/
194			public function getSubjectConfiguration() : SubjectConfigurationInterface
195			{
196			return $this->subjectConfiguration;
197			}
198
199			/**
200			* Set's the filesystem adapter instance.
201			*
202			* @param \TechDivision\Import\Adapter\FilesystemAdapterInterface $filesystemAdapter
203			*
204			* @return void
205			*/
206			public function setFilesystemAdapter(FilesystemAdapterInterface $filesystemAdapter) : void
207			{
208			$this->filesystemAdapter = $filesystemAdapter;
			0 ignored issues – show Documentation Bug introduced 2020-04-03 16:23 UTC by Report Bug Copy Issue Report `$filesystemAdapter` is of type `object<TechDivision\Impo...systemAdapterInterface>`, but the property `$filesystemAdapter` was declared to be of type `object<TechDivision\Impo...systemAdapterInterface>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
209	3		}
210
211	3		/**
212	3		* Return's the filesystem adapter instance.
213			*
214			* @return \TechDivision\Import\Adapter\FilesystemAdapterInterface The filesystem adapter instance
215			*/
216			public function getFilesystemAdapter() : FilesystemAdapterInterface
217			{
218			return $this->filesystemAdapter;
219	3		}
220
221	3		/**
222			* Loads the files from the source directory and return's them sorted.
223			*
224			* @param string $serial The unique identifier of the actual import process
225			*
226			* @return array The array with the files matching the subjects suffix
227			* @throws \Exception Is thrown, when the source directory is NOT available
228			*/
229			public function loadFiles(string $serial) : array
230			{
231
232			// initialize the resolver
233			// @TODO Check if the method can not be moved to object initialization
234			$this->initialize($serial);
235
236			// initialize the array with the files matching the suffix found in the source directory
237			return $this->getFilesystemLoader()->load(sprintf('%s/*.%s', $this->getSourceDir(), $this->getSuffix()));
			0 ignored issues – show Unused Code introduced 2020-04-03 16:23 UTC by Report Bug Copy Issue Report The call to `FilteredLoaderInterface::load()` has too many arguments starting with `sprintf('%s/*.%s', $this...(), $this->getSuffix())`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
238			}
239			}
240

techdivision / import

Push — 16.x ( 0056bb...bd3602 )

AbstractFileResolver::getPatternElements() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like