EmbeddedPropMetadata::setEmbedType() - Code Metrics - Inspection of "Add core support for Embedded models" - as3io/modlr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#79)

by Jacob

created 2016-04-19 04:35 UTC

EmbeddedPropMetadata::setEmbedType() A

↳ Parent: EmbeddedPropMetadata

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

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

<?php

namespace As3\Modlr\Metadata;

use As3\Modlr\Exception\MetadataException;

/**
 * Defines metadata for an embedded field.
 * Should be loaded using the MetadataFactory, not instantiated directly.
 *
 * @author Jacob Bare <[email protected]>
 */
class EmbeddedPropMetadata extends FieldMetadata
{
    /**
     * The embedded metadata for this embedded property.
     *
     * @var string
     */
    public $embedMeta;

    /**
     * The embed type: one or many
     *
     * @var string
     */
    public $embedType;

    /**
     * Constructor.
     *
     * @param   string          $key
     * @param   string          $embedType
     * @param   EmbedMetadata   $embedMeta
     * @param   bool            $mixin
     */
    public function __construct($key, $embedType, EmbedMetadata $embedMeta, $mixin = false)
    {
        $this->embedMeta = $embedMeta;

        $this->setEmbedType($embedType);
        parent::__construct($key, $mixin);
    }

    /**
     * Determines if this is a one (single) embed.
     *
     * @return  bool
     */
    public function isOne()
    {
        return 'one' === $this->embedType;
    }

    /**
     * Determines if this is a many embed.
     *
     * @return bool
     */
    public function isMany()
    {
        return 'many' === $this->embedType;
    }

    /**
     * Sets the embed type: one or many.
     *
     * @param   string  $relType
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return  self
     */
    public function setEmbedType($embedType)
    {
        $embedType = strtolower($embedType);
        $this->validateType($embedType);
        $this->embedType = $embedType;
        return $this;
    }

    /**
     * Validates the embed type.
     *
     * @param   string  $type
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return  bool
     * @throws  MetadataException
     */
    protected function validateType($embedType)

    {
        $valid = ['one', 'many'];
        if (!in_array($embedType, $valid)) {
            throw MetadataException::invalidRelType($embedType, $valid);
        }
        return true;
    }
}


1		<?php
2
3		namespace As3\Modlr\Metadata;
4
5		use As3\Modlr\Exception\MetadataException;
6
7		/**
8		* Defines metadata for an embedded field.
9		* Should be loaded using the MetadataFactory, not instantiated directly.
10		*
11		* @author Jacob Bare <[email protected]>
12		*/
13		class EmbeddedPropMetadata extends FieldMetadata
14		{
15		/**
16		* The embedded metadata for this embedded property.
17		*
18		* @var string
19		*/
20		public $embedMeta;
21
22		/**
23		* The embed type: one or many
24		*
25		* @var string
26		*/
27		public $embedType;
28
29		/**
30		* Constructor.
31		*
32		* @param string $key
33		* @param string $embedType
34		* @param EmbedMetadata $embedMeta
35		* @param bool $mixin
36		*/
37		public function __construct($key, $embedType, EmbedMetadata $embedMeta, $mixin = false)
38		{
39		$this->embedMeta = $embedMeta;
		0 ignored issues – show Documentation Bug introduced 2016-04-19 04:25 UTC by Report Bug Copy Issue Report It seems like `$embedMeta` of type `object<As3\Modlr\Metadata\EmbedMetadata>` is incompatible with the declared type `string` of property `$embedMeta`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
40		$this->setEmbedType($embedType);
41		parent::__construct($key, $mixin);
42		}
43
44		/**
45		* Determines if this is a one (single) embed.
46		*
47		* @return bool
48		*/
49		public function isOne()
50		{
51		return 'one' === $this->embedType;
52		}
53
54		/**
55		* Determines if this is a many embed.
56		*
57		* @return bool
58		*/
59		public function isMany()
60		{
61		return 'many' === $this->embedType;
62		}
63
64		/**
65		* Sets the embed type: one or many.
66		*
67		* @param string $relType
		0 ignored issues – show Bug introduced 2016-04-19 04:25 UTC by Report Bug Copy Issue Report There is no parameter named `$relType`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
68		* @return self
69		*/
70		public function setEmbedType($embedType)
71		{
72		$embedType = strtolower($embedType);
73		$this->validateType($embedType);
74		$this->embedType = $embedType;
75		return $this;
76		}
77
78		/**
79		* Validates the embed type.
80		*
81		* @param string $type
		0 ignored issues – show Bug introduced 2016-04-19 04:25 UTC by Report Bug Copy Issue Report There is no parameter named `$type`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
82		* @return bool
83		* @throws MetadataException
84		*/
85	View Code Duplication	protected function validateType($embedType)
		0 ignored issues – show Duplication introduced 2016-04-19 04:25 UTC by Report Bug Copy Issue Report This method 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...
86		{
87		$valid = ['one', 'many'];
88		if (!in_array($embedType, $valid)) {
89		throw MetadataException::invalidRelType($embedType, $valid);
90		}
91		return true;
92		}
93		}
94

as3io / modlr

Pull Request — master (#79)

EmbeddedPropMetadata::setEmbedType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like