Configuration::setGeneratedClassAutoloader() - Code Metrics - Inspection of "Dropped minimum-stability from composer.json" - Ocramius/GeneratedHydrator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#49)

by Markus

created 2016-04-28 16:18 UTC

Configuration::setGeneratedClassAutoloader() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license.
 */

declare(strict_types=1);

namespace GeneratedHydrator;

use GeneratedHydrator\ClassGenerator\HydratorGenerator;
use GeneratedHydrator\ClassGenerator\HydratorGeneratorInterface;
use GeneratedHydrator\Factory\HydratorFactory;
use GeneratedHydrator\ClassGenerator\HydratorGeneratorFactory;
use GeneratedHydrator\ClassGenerator\HydratorGeneratorFactoryInterface;
use CodeGenerationUtils\Autoloader\AutoloaderInterface;
use CodeGenerationUtils\Autoloader\Autoloader;
use CodeGenerationUtils\FileLocator\FileLocator;
use CodeGenerationUtils\GeneratorStrategy\FileWriterGeneratorStrategy;
use CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface;
use CodeGenerationUtils\Inflector\ClassNameInflectorInterface;
use CodeGenerationUtils\Inflector\ClassNameInflector;

/**
 * Base configuration class for the generated hydrator - serves as micro disposable DIC/facade
 *
 * @author Marco Pivetta <[email protected]>
 * @license MIT
 */
class Configuration
{
    const DEFAULT_GENERATED_CLASS_NAMESPACE = 'GeneratedHydratorGeneratedClass';

    /**
     * @var string
     */
    protected $hydratedClassName;

    /**
     * @var bool
     */
    protected $autoGenerateProxies = true;

    /**
     * @var string|null
     */
    protected $generatedClassesTargetDir;

    /**
     * @var string
     */
    protected $generatedClassesNamespace = self::DEFAULT_GENERATED_CLASS_NAMESPACE;

    /**
     * @var \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface|null
     */
    protected $generatorStrategy;

    /**
     * @var callable|null
     */
    protected $generatedClassesAutoloader;

    /**
     * @var \CodeGenerationUtils\Inflector\ClassNameInflectorInterface|null
     */
    protected $classNameInflector;

    /**
     * @var \GeneratedHydrator\ClassGenerator\HydratorGeneratorInterface|null
     */
    protected $hydratorGenerator;

    /**
     * @param string $hydratedClassName
     */
    public function __construct(string $hydratedClassName)
    {
        $this->setHydratedClassName($hydratedClassName);
    }

    /**
     * @return \GeneratedHydrator\Factory\HydratorFactory
     */
    public function createFactory() : HydratorFactory
    {
        return new HydratorFactory($this);
    }

    /**
     * @param string $hydratedClassName
     */
    public function setHydratedClassName(string $hydratedClassName)
    {
        $this->hydratedClassName = $hydratedClassName;
    }

    /**
     * @return string
     */
    public function getHydratedClassName() : string
    {
        return $this->hydratedClassName;
    }

    /**
     * @param bool $autoGenerateProxies
     */
    public function setAutoGenerateProxies(bool $autoGenerateProxies)
    {
        $this->autoGenerateProxies = $autoGenerateProxies;
    }

    /**
     * @return bool
     */
    public function doesAutoGenerateProxies() : bool
    {
        return $this->autoGenerateProxies;
    }

    /**
     * @param \CodeGenerationUtils\Autoloader\AutoloaderInterface $generatedClassesAutoloader
     */
    public function setGeneratedClassAutoloader(AutoloaderInterface $generatedClassesAutoloader)
    {
        $this->generatedClassesAutoloader = $generatedClassesAutoloader;
    }

    /**
     * @return \CodeGenerationUtils\Autoloader\AutoloaderInterface
     *
     * @throws \CodeGenerationUtils\Exception\InvalidGeneratedClassesDirectoryException
     */
    public function getGeneratedClassAutoloader() : AutoloaderInterface
    {
        if (null === $this->generatedClassesAutoloader) {
            $this->generatedClassesAutoloader = new Autoloader(
                new FileLocator($this->getGeneratedClassesTargetDir()),
                $this->getClassNameInflector()
            );
        }

        return $this->generatedClassesAutoloader;
    }

    /**
     * @param string $generatedClassesNamespace
     */
    public function setGeneratedClassesNamespace(string $generatedClassesNamespace)
    {
        $this->generatedClassesNamespace = $generatedClassesNamespace;
    }

    /**
     * @return string
     */
    public function getGeneratedClassesNamespace() : string
    {
        return $this->generatedClassesNamespace;
    }

    /**
     * @param string $generatedClassesTargetDir
     */
    public function setGeneratedClassesTargetDir(string $generatedClassesTargetDir)
    {
        $this->generatedClassesTargetDir = $generatedClassesTargetDir;
    }

    /**
     * @return null|string
     */
    public function getGeneratedClassesTargetDir()
    {
        if (null === $this->generatedClassesTargetDir) {
            $this->generatedClassesTargetDir = sys_get_temp_dir();
        }

        return $this->generatedClassesTargetDir;
    }

    /**
     * @param \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface $generatorStrategy
     */
    public function setGeneratorStrategy(GeneratorStrategyInterface $generatorStrategy)
    {
        $this->generatorStrategy = $generatorStrategy;
    }

    /**
     * @return \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface
     *
     * @throws \CodeGenerationUtils\Exception\InvalidGeneratedClassesDirectoryException
     */
    public function getGeneratorStrategy() : GeneratorStrategyInterface
    {
        if (null === $this->generatorStrategy) {
            $this->generatorStrategy = new FileWriterGeneratorStrategy(
                new FileLocator($this->getGeneratedClassesTargetDir())
            );
        }

        return $this->generatorStrategy;
    }

    /**
     * @param \CodeGenerationUtils\Inflector\ClassNameInflectorInterface $classNameInflector
     */
    public function setClassNameInflector(ClassNameInflectorInterface $classNameInflector)
    {
        $this->classNameInflector = $classNameInflector;
    }

    /**
     * @return \CodeGenerationUtils\Inflector\ClassNameInflectorInterface
     */
    public function getClassNameInflector() : ClassNameInflectorInterface
    {
        if (null === $this->classNameInflector) {
            $this->classNameInflector = new ClassNameInflector($this->getGeneratedClassesNamespace());
        }

        return $this->classNameInflector;
    }

    /**
     * @param HydratorGeneratorInterface $hydratorGenerator
     */
    public function setHydratorGenerator(HydratorGeneratorInterface $hydratorGenerator)
    {
        $this->hydratorGenerator = $hydratorGenerator;
    }

    /**
     * @return HydratorGeneratorInterface
     */
    public function getHydratorGenerator()
    {
        if (null === $this->hydratorGenerator) {
            $this->hydratorGenerator = new HydratorGenerator();
        }

        return $this->hydratorGenerator;
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license.
17		*/
18
19		declare(strict_types=1);
20
21		namespace GeneratedHydrator;
22
23		use GeneratedHydrator\ClassGenerator\HydratorGenerator;
24		use GeneratedHydrator\ClassGenerator\HydratorGeneratorInterface;
25		use GeneratedHydrator\Factory\HydratorFactory;
26		use GeneratedHydrator\ClassGenerator\HydratorGeneratorFactory;
27		use GeneratedHydrator\ClassGenerator\HydratorGeneratorFactoryInterface;
28		use CodeGenerationUtils\Autoloader\AutoloaderInterface;
29		use CodeGenerationUtils\Autoloader\Autoloader;
30		use CodeGenerationUtils\FileLocator\FileLocator;
31		use CodeGenerationUtils\GeneratorStrategy\FileWriterGeneratorStrategy;
32		use CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface;
33		use CodeGenerationUtils\Inflector\ClassNameInflectorInterface;
34		use CodeGenerationUtils\Inflector\ClassNameInflector;
35
36		/**
37		* Base configuration class for the generated hydrator - serves as micro disposable DIC/facade
38		*
39		* @author Marco Pivetta <[email protected]>
40		* @license MIT
41		*/
42		class Configuration
43		{
44		const DEFAULT_GENERATED_CLASS_NAMESPACE = 'GeneratedHydratorGeneratedClass';
45
46		/**
47		* @var string
48		*/
49		protected $hydratedClassName;
50
51		/**
52		* @var bool
53		*/
54		protected $autoGenerateProxies = true;
55
56		/**
57		* @var string\|null
58		*/
59		protected $generatedClassesTargetDir;
60
61		/**
62		* @var string
63		*/
64		protected $generatedClassesNamespace = self::DEFAULT_GENERATED_CLASS_NAMESPACE;
65
66		/**
67		* @var \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface\|null
68		*/
69		protected $generatorStrategy;
70
71		/**
72		* @var callable\|null
73		*/
74		protected $generatedClassesAutoloader;
75
76		/**
77		* @var \CodeGenerationUtils\Inflector\ClassNameInflectorInterface\|null
78		*/
79		protected $classNameInflector;
80
81		/**
82		* @var \GeneratedHydrator\ClassGenerator\HydratorGeneratorInterface\|null
83		*/
84		protected $hydratorGenerator;
85
86		/**
87		* @param string $hydratedClassName
88		*/
89		public function __construct(string $hydratedClassName)
90		{
91		$this->setHydratedClassName($hydratedClassName);
92		}
93
94		/**
95		* @return \GeneratedHydrator\Factory\HydratorFactory
96		*/
97	1	public function createFactory() : HydratorFactory
98		{
99	1	return new HydratorFactory($this);
100		}
101
102		/**
103		* @param string $hydratedClassName
104		*/
105	1	public function setHydratedClassName(string $hydratedClassName)
106		{
107	1	$this->hydratedClassName = $hydratedClassName;
108	1	}
109
110		/**
111		* @return string
112		*/
113	1	public function getHydratedClassName() : string
114		{
115	1	return $this->hydratedClassName;
116		}
117
118		/**
119		* @param bool $autoGenerateProxies
120		*/
121	1	public function setAutoGenerateProxies(bool $autoGenerateProxies)
122		{
123	1	$this->autoGenerateProxies = $autoGenerateProxies;
124	1	}
125
126		/**
127		* @return bool
128		*/
129	1	public function doesAutoGenerateProxies() : bool
130		{
131	1	return $this->autoGenerateProxies;
132		}
133
134		/**
135		* @param \CodeGenerationUtils\Autoloader\AutoloaderInterface $generatedClassesAutoloader
136		*/
137	1	public function setGeneratedClassAutoloader(AutoloaderInterface $generatedClassesAutoloader)
138		{
139	1	$this->generatedClassesAutoloader = $generatedClassesAutoloader;
140	1	}
141
142		/**
143		* @return \CodeGenerationUtils\Autoloader\AutoloaderInterface
144		*
145		* @throws \CodeGenerationUtils\Exception\InvalidGeneratedClassesDirectoryException
146		*/
147	1	public function getGeneratedClassAutoloader() : AutoloaderInterface
148		{
149	1	if (null === $this->generatedClassesAutoloader) {
150	1	$this->generatedClassesAutoloader = new Autoloader(
151	1	new FileLocator($this->getGeneratedClassesTargetDir()),
152	1	$this->getClassNameInflector()
153		);
154		}
155
156	1	return $this->generatedClassesAutoloader;
157		}
158
159		/**
160		* @param string $generatedClassesNamespace
161		*/
162	1	public function setGeneratedClassesNamespace(string $generatedClassesNamespace)
163		{
164	1	$this->generatedClassesNamespace = $generatedClassesNamespace;
165	1	}
166
167		/**
168		* @return string
169		*/
170	1	public function getGeneratedClassesNamespace() : string
171		{
172	1	return $this->generatedClassesNamespace;
173		}
174
175		/**
176		* @param string $generatedClassesTargetDir
177		*/
178	1	public function setGeneratedClassesTargetDir(string $generatedClassesTargetDir)
179		{
180	1	$this->generatedClassesTargetDir = $generatedClassesTargetDir;
181	1	}
182
183		/**
184		* @return null\|string
185		*/
186	1	public function getGeneratedClassesTargetDir()
187		{
188	1	if (null === $this->generatedClassesTargetDir) {
189	1	$this->generatedClassesTargetDir = sys_get_temp_dir();
190		}
191
192	1	return $this->generatedClassesTargetDir;
193		}
194
195		/**
196		* @param \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface $generatorStrategy
197		*/
198	1	public function setGeneratorStrategy(GeneratorStrategyInterface $generatorStrategy)
199		{
200	1	$this->generatorStrategy = $generatorStrategy;
201	1	}
202
203		/**
204		* @return \CodeGenerationUtils\GeneratorStrategy\GeneratorStrategyInterface
205		*
206		* @throws \CodeGenerationUtils\Exception\InvalidGeneratedClassesDirectoryException
207		*/
208	1	public function getGeneratorStrategy() : GeneratorStrategyInterface
209		{
210	1	if (null === $this->generatorStrategy) {
211	1	$this->generatorStrategy = new FileWriterGeneratorStrategy(
212	1	new FileLocator($this->getGeneratedClassesTargetDir())
213		);
214		}
215
216	1	return $this->generatorStrategy;
217		}
218
219		/**
220		* @param \CodeGenerationUtils\Inflector\ClassNameInflectorInterface $classNameInflector
221		*/
222	1	public function setClassNameInflector(ClassNameInflectorInterface $classNameInflector)
223		{
224	1	$this->classNameInflector = $classNameInflector;
225	1	}
226
227		/**
228		* @return \CodeGenerationUtils\Inflector\ClassNameInflectorInterface
229		*/
230	1	public function getClassNameInflector() : ClassNameInflectorInterface
231		{
232	1	if (null === $this->classNameInflector) {
233	1	$this->classNameInflector = new ClassNameInflector($this->getGeneratedClassesNamespace());
234		}
235
236	1	return $this->classNameInflector;
237		}
238
239		/**
240		* @param HydratorGeneratorInterface $hydratorGenerator
241		*/
242	1	public function setHydratorGenerator(HydratorGeneratorInterface $hydratorGenerator)
243		{
244	1	$this->hydratorGenerator = $hydratorGenerator;
245	1	}
246
247		/**
248		* @return HydratorGeneratorInterface
249		*/
250	1	public function getHydratorGenerator()
251		{
252	1	if (null === $this->hydratorGenerator) {
253	1	$this->hydratorGenerator = new HydratorGenerator();
254		}
255
256	1	return $this->hydratorGenerator;
257		}
258		}
259

Ocramius / GeneratedHydrator

Pull Request — master (#49)

Configuration::setGeneratedClassAutoloader() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like