FieldBuilder::__construct() - Code Metrics - Inspection of "Readonly column property for generated/virtual col..." - doctrine/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5728)

by Sebastiaan de

created 2016-03-21 09:55 UTC

FieldBuilder::__construct() A

↳ Parent: FieldBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Metric	Value
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	3
nc	1
nop	2
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. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\ORM\Mapping\Builder;

/**
 * Field Builder
 *
 * @license     http://www.opensource.org/licenses/mit-license.php MIT
 * @link        www.doctrine-project.com
 * @since       2.2
 * @author      Benjamin Eberlei <[email protected]>
 */
class FieldBuilder
{
    /**
     * @var ClassMetadataBuilder
     */
    private $builder;

    /**
     * @var array
     */
    private $mapping;

    /**
     * @var bool
     */
    private $version;

    /**
     * @var string
     */
    private $generatedValue;

    /**
     * @var array
     */
    private $sequenceDef;

    /**
     * @var string|null
     */
    private $customIdGenerator;

    /**
     * @param ClassMetadataBuilder $builder
     * @param array                $mapping
     */
    public function __construct(ClassMetadataBuilder $builder, array $mapping)
    {
        $this->builder = $builder;
        $this->mapping = $mapping;
    }

    /**
     * Sets length.
     *
     * @param int $length
     *
     * @return FieldBuilder
     */
    public function length($length)
    {
        $this->mapping['length'] = $length;

        return $this;
    }

    /**
     * Sets nullable.
     *
     * @param bool $flag
     *
     * @return FieldBuilder
     */
    public function nullable($flag = true)
    {
        $this->mapping['nullable'] = (bool) $flag;

        return $this;
    }

    /**
     * Sets Unique.
     *
     * @param bool $flag
     *
     * @return FieldBuilder
     */
    public function unique($flag = true)
    {
        $this->mapping['unique'] = (bool) $flag;

        return $this;
    }

    /**
     * Sets column name.
     *
     * @param string $name
     *
     * @return FieldBuilder
     */
    public function columnName($name)
    {
        $this->mapping['columnName'] = $name;

        return $this;
    }

    /**
     * Sets Precision.
     *
     * @param int $p
     *
     * @return FieldBuilder
     */
    public function precision($p)
    {
        $this->mapping['precision'] = $p;

        return $this;
    }

    /**
     * Sets scale.
     *
     * @param int $s
     *
     * @return FieldBuilder
     */
    public function scale($s)
    {
        $this->mapping['scale'] = $s;

        return $this;
    }

    /**
     * Sets readOnly.
     *
     * @param bool $flag
     *
     * @return FieldBuilder
     */
    public function readOnly($flag = true)
    {
        $this->mapping['readOnly'] = (bool) $flag;

        return $this;
    }

    /**
     * Sets field as primary key.
     *
     * @deprecated Use makePrimaryKey() instead
     * @return FieldBuilder
     */
    public function isPrimaryKey()
    {
        return $this->makePrimaryKey();
    }

    /**
     * Sets field as primary key.
     *
     * @return FieldBuilder
     */
    public function makePrimaryKey()
    {
        $this->mapping['id'] = true;

        return $this;
    }

    /**
     * Sets an option.
     *
     * @param string $name
     * @param mixed  $value
     *
     * @return FieldBuilder
     */
    public function option($name, $value)
    {
        $this->mapping['options'][$name] = $value;

        return $this;
    }

    /**
     * @param string $strategy
     *
     * @return FieldBuilder
     */
    public function generatedValue($strategy = 'AUTO')
    {
        $this->generatedValue = $strategy;

        return $this;
    }

    /**
     * Sets field versioned.
     *
     * @return FieldBuilder
     */
    public function isVersionField()
    {
        $this->version = true;

        return $this;
    }

    /**
     * Sets Sequence Generator.
     *
     * @param string $sequenceName
     * @param int    $allocationSize
     * @param int    $initialValue
     *
     * @return FieldBuilder
     */
    public function setSequenceGenerator($sequenceName, $allocationSize = 1, $initialValue = 1)
    {
        $this->sequenceDef = array(
            'sequenceName' => $sequenceName,
            'allocationSize' => $allocationSize,
            'initialValue' => $initialValue,
        );

        return $this;
    }

    /**
     * Sets column definition.
     *
     * @param string $def
     *
     * @return FieldBuilder
     */
    public function columnDefinition($def)
    {
        $this->mapping['columnDefinition'] = $def;

        return $this;
    }

    /**
     * Set the FQCN of the custom ID generator.
     * This class must extend \Doctrine\ORM\Id\AbstractIdGenerator.
     *
     * @param string $customIdGenerator
     *
     * @return $this
     */
    public function setCustomIdGenerator($customIdGenerator)
    {
        $this->customIdGenerator = (string) $customIdGenerator;

        return $this;
    }

    /**
     * Finalizes this field and attach it to the ClassMetadata.
     *
     * Without this call a FieldBuilder has no effect on the ClassMetadata.
     *
     * @return ClassMetadataBuilder
     */
    public function build()
    {
        $cm = $this->builder->getClassMetadata();
        if ($this->generatedValue) {
            $cm->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_' . $this->generatedValue));
        }

        if ($this->version) {
            $cm->setVersionMapping($this->mapping);
        }

        $cm->mapField($this->mapping);
        if ($this->sequenceDef) {

            $cm->setSequenceGeneratorDefinition($this->sequenceDef);
        }

        if ($this->customIdGenerator) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $cm->setCustomGeneratorDefinition(['class' => $this->customIdGenerator]);
        }

        return $this->builder;
    }
}


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. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace Doctrine\ORM\Mapping\Builder;
21
22		/**
23		* Field Builder
24		*
25		* @license http://www.opensource.org/licenses/mit-license.php MIT
26		* @link www.doctrine-project.com
27		* @since 2.2
28		* @author Benjamin Eberlei <[email protected]>
29		*/
30		class FieldBuilder
31		{
32		/**
33		* @var ClassMetadataBuilder
34		*/
35		private $builder;
36
37		/**
38		* @var array
39		*/
40		private $mapping;
41
42		/**
43		* @var bool
44		*/
45		private $version;
46
47		/**
48		* @var string
49		*/
50		private $generatedValue;
51
52		/**
53		* @var array
54		*/
55		private $sequenceDef;
56
57		/**
58		* @var string\|null
59		*/
60		private $customIdGenerator;
61
62		/**
63		* @param ClassMetadataBuilder $builder
64		* @param array $mapping
65		*/
66	5	public function __construct(ClassMetadataBuilder $builder, array $mapping)
67		{
68	5	$this->builder = $builder;
69	5	$this->mapping = $mapping;
70	5	}
71
72		/**
73		* Sets length.
74		*
75		* @param int $length
76		*
77		* @return FieldBuilder
78		*/
79	1	public function length($length)
80		{
81	1	$this->mapping['length'] = $length;
82
83	1	return $this;
84		}
85
86		/**
87		* Sets nullable.
88		*
89		* @param bool $flag
90		*
91		* @return FieldBuilder
92		*/
93	1	public function nullable($flag = true)
94		{
95	1	$this->mapping['nullable'] = (bool) $flag;
96
97	1	return $this;
98		}
99
100		/**
101		* Sets Unique.
102		*
103		* @param bool $flag
104		*
105		* @return FieldBuilder
106		*/
107	1	public function unique($flag = true)
108		{
109	1	$this->mapping['unique'] = (bool) $flag;
110
111	1	return $this;
112		}
113
114		/**
115		* Sets column name.
116		*
117		* @param string $name
118		*
119		* @return FieldBuilder
120		*/
121	1	public function columnName($name)
122		{
123	1	$this->mapping['columnName'] = $name;
124
125	1	return $this;
126		}
127
128		/**
129		* Sets Precision.
130		*
131		* @param int $p
132		*
133		* @return FieldBuilder
134		*/
135		public function precision($p)
136		{
137		$this->mapping['precision'] = $p;
138
139		return $this;
140		}
141
142		/**
143		* Sets scale.
144		*
145		* @param int $s
146		*
147		* @return FieldBuilder
148		*/
149		public function scale($s)
150		{
151		$this->mapping['scale'] = $s;
152
153		return $this;
154		}
155
156		/**
157		* Sets readOnly.
158		*
159		* @param bool $flag
160		*
161		* @return FieldBuilder
162		*/
163		public function readOnly($flag = true)
164		{
165		$this->mapping['readOnly'] = (bool) $flag;
166
167		return $this;
168		}
169
170		/**
171		* Sets field as primary key.
172		*
173		* @deprecated Use makePrimaryKey() instead
174		* @return FieldBuilder
175		*/
176		public function isPrimaryKey()
177		{
178		return $this->makePrimaryKey();
179		}
180
181		/**
182		* Sets field as primary key.
183		*
184		* @return FieldBuilder
185		*/
186	1	public function makePrimaryKey()
187		{
188	1	$this->mapping['id'] = true;
189
190	1	return $this;
191		}
192
193		/**
194		* Sets an option.
195		*
196		* @param string $name
197		* @param mixed $value
198		*
199		* @return FieldBuilder
200		*/
201	1	public function option($name, $value)
202		{
203	1	$this->mapping['options'][$name] = $value;
204
205	1	return $this;
206		}
207
208		/**
209		* @param string $strategy
210		*
211		* @return FieldBuilder
212		*/
213	2	public function generatedValue($strategy = 'AUTO')
214		{
215	2	$this->generatedValue = $strategy;
216
217	2	return $this;
218		}
219
220		/**
221		* Sets field versioned.
222		*
223		* @return FieldBuilder
224		*/
225	1	public function isVersionField()
226		{
227	1	$this->version = true;
228
229	1	return $this;
230		}
231
232		/**
233		* Sets Sequence Generator.
234		*
235		* @param string $sequenceName
236		* @param int $allocationSize
237		* @param int $initialValue
238		*
239		* @return FieldBuilder
240		*/
241		public function setSequenceGenerator($sequenceName, $allocationSize = 1, $initialValue = 1)
242		{
243		$this->sequenceDef = array(
244		'sequenceName' => $sequenceName,
245		'allocationSize' => $allocationSize,
246		'initialValue' => $initialValue,
247		);
248
249		return $this;
250		}
251
252		/**
253		* Sets column definition.
254		*
255		* @param string $def
256		*
257		* @return FieldBuilder
258		*/
259	1	public function columnDefinition($def)
260		{
261	1	$this->mapping['columnDefinition'] = $def;
262
263	1	return $this;
264		}
265
266		/**
267		* Set the FQCN of the custom ID generator.
268		* This class must extend \Doctrine\ORM\Id\AbstractIdGenerator.
269		*
270		* @param string $customIdGenerator
271		*
272		* @return $this
273		*/
274	1	public function setCustomIdGenerator($customIdGenerator)
275		{
276	1	$this->customIdGenerator = (string) $customIdGenerator;
277
278	1	return $this;
279		}
280
281		/**
282		* Finalizes this field and attach it to the ClassMetadata.
283		*
284		* Without this call a FieldBuilder has no effect on the ClassMetadata.
285		*
286		* @return ClassMetadataBuilder
287		*/
288	5	public function build()
289		{
290	5	$cm = $this->builder->getClassMetadata();
291	5	if ($this->generatedValue) {
292	2	$cm->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_' . $this->generatedValue));
293		}
294
295	5	if ($this->version) {
296	1	$cm->setVersionMapping($this->mapping);
297		}
298
299	5	$cm->mapField($this->mapping);
300	5	if ($this->sequenceDef) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-29 16:33 UTC by Report Bug Copy Issue Report The expression `$this->sequenceDef` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
301		$cm->setSequenceGeneratorDefinition($this->sequenceDef);
302		}
303
304	5	if ($this->customIdGenerator) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-29 16:33 UTC by Report Bug Copy Issue Report The expression `$this->customIdGenerator` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` 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...
305	1	$cm->setCustomGeneratorDefinition(['class' => $this->customIdGenerator]);
306		}
307
308	5	return $this->builder;
309		}
310		}
311

doctrine / orm

Pull Request — master (#5728)

FieldBuilder::__construct() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like