MetadataManager - Code Metrics - Inspection of "Support adding properties to entity types" - Algo-Web/ODataMetadata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c85fb5...8c4d6d )

by Christopher

created 2017-05-11 11:22 UTC

MetadataManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	137
Duplicated Lines	10.95 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	24
c	2
b	0
f	1
lcom	1
cbo	10
dl	15
loc	137
rs	10

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	getEdmx()	0	4	1
A	getEdmxXML()	0	4	1
A	startEdmxTransaction()	0	4	1
B	pluralize()	15	15	6
B	addEntityType()	0	27	3
A	revertEdmxTransaction()	0	4	1
A	commitEdmxTransaction()	0	4	1
B	addPropertyToEntityType()	0	29	6
A	addComplexType()	0	4	1
A	getLastError()	0	4	1

How to fix Duplicated Code

<?php

namespace AlgoWeb\ODataMetadata;

use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityTypeType;
use AlgoWeb\ODataMetadata\MetadataV3\edmx\Edmx;

class MetadataManager
{
    private $V3Edmx = null;
    private $oldEdmx = null;
    private $lastError = null;
    private $serializer = null;

    public function __construct($namespaceName = "Data", $containerName = "DefaultContainer")
    {
        $this->V3Edmx = new Edmx($namespaceName, $containerName);
        if (!$this->V3Edmx->isOK($msg)) {
            throw new \Exception($msg);
        }
        $ymlDir = dirname(__DIR__) . DIRECTORY_SEPARATOR . "MetadataV3" . DIRECTORY_SEPARATOR . "JMSmetadata";
        $this->serializer =
            \JMS\Serializer\SerializerBuilder::create()
                ->addMetadataDir($ymlDir)
                ->build();
    }

    public function getEdmx()
    {
        return $this->V3Edmx;
    }

    public function getEdmxXML()
    {
        return $this->serializer->serialize($this->V3Edmx, "xml");
    }

    public function addEntityType($name, $accessType = "Public")
    {
        $this->startEdmxTransaction();
        $NewEntity = new TEntityTypeType();
        $NewEntity->setName($name);


        $entitySet = new \AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\EntitySetAnonymousType();
        $entitySet->setName($this->pluralize(2, $NewEntity->getName()));
        $namespace = $this->V3Edmx->getDataServices()[0]->getNamespace();
        if (0 == strlen(trim($namespace))) {
            $entityTypeName = $NewEntity->getName();
        } else {
            $entityTypeName = $namespace . "." . $NewEntity->getName();
        }
        $entitySet->setEntityType($entityTypeName);
        $entitySet->setGetterAccess($accessType);

        $this->V3Edmx->getDataServices()[0]->addToEntityType($NewEntity);
        $this->V3Edmx->getDataServices()[0]->getEntityContainer()[0]->addToEntitySet($entitySet);
        if (!$this->V3Edmx->isok($this->lastError)) {
            $this->revertEdmxTransaction();
            return false;
        }
        $this->commitEdmxTransaction();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        return $NewEntity;
    }

    private function startEdmxTransaction()
    {
        $this->oldEdmx = serialize($this->V3Edmx);
    }

    /**
     * Pluralizes a word if quantity is not one.
     *
     * @param int $quantity Number of items
     * @param string $singular Singular form of word
     * @param string $plural Plural form of word; function will attempt to deduce plural form from singular if not provided
     * @return string Pluralized word if quantity is not one, otherwise singular
     */
    public static function pluralize($quantity, $singular, $plural = null)

    {
        if ($quantity == 1 || !strlen($singular)) return $singular;
        if ($plural !== null) return $plural;

        $last_letter = strtolower($singular[strlen($singular) - 1]);
        switch ($last_letter) {
            case 'y':
                return substr($singular, 0, -1) . 'ies';
            case 's':
                return $singular . 'es';
            default:
                return $singular . 's';
        }
    }

    private function revertEdmxTransaction()
    {
        $this->V3Edmx = unserialize($this->oldEdmx);
    }

    private function commitEdmxTransaction()
    {
        $this->oldEdmx == null;
    }

    public function addPropertyToEntityType($entityType, $name, $type, $defaultValue = null, $isKey = false, $storeGeneratedPattern = false, $summary = null, $longDescription = null)
    {
        $this->startEdmxTransaction();
        $NewProperty = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityPropertyType();
        $NewProperty->setName($name);
        $NewProperty->setType($type);
        $NewProperty->setStoreGeneratedPattern($storeGeneratedPattern);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if (null != $summary || null != $longDescription) {
            $documentation = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TDocumentationType();
            $documentation->setSummary($summary);
            $documentation->setLongDescription($longDescription);
            $NewProperty->setDocumentation($documentation);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if (null != $defaultValue) {
            $NewProperty->setDefaultValue($defaultValue);
        }
        $entityType->addToProperty($NewProperty);
        if ($isKey) {
            $Key = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TPropertyRefType();
            $Key->setName($name);
            $entityType->addToKey($Key);
        }
        if (!$this->V3Edmx->isok($this->lastError)) {
            $this->revertEdmxTransaction();
            return false;
        }
        $this->commitEdmxTransaction();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        return $NewProperty;
    }

    public function addComplexType(\ReflectionClass $refClass, $name, $namespace = null, $baseResourceType = null)
    {
        return $this->createResourceType($refClass, $name, $namespace, ResourceTypeKind::COMPLEX, $baseResourceType);

    }

    public function getLastError()
    {
        return $this->lastError();

    }
}


1		<?php
2
3		namespace AlgoWeb\ODataMetadata;
4
5		use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityTypeType;
6		use AlgoWeb\ODataMetadata\MetadataV3\edmx\Edmx;
7
8		class MetadataManager
9		{
10		private $V3Edmx = null;
11		private $oldEdmx = null;
12		private $lastError = null;
13		private $serializer = null;
14
15		public function __construct($namespaceName = "Data", $containerName = "DefaultContainer")
16		{
17		$this->V3Edmx = new Edmx($namespaceName, $containerName);
18		if (!$this->V3Edmx->isOK($msg)) {
19		throw new \Exception($msg);
20		}
21		$ymlDir = dirname(__DIR__) . DIRECTORY_SEPARATOR . "MetadataV3" . DIRECTORY_SEPARATOR . "JMSmetadata";
22		$this->serializer =
23		\JMS\Serializer\SerializerBuilder::create()
24		->addMetadataDir($ymlDir)
25		->build();
26		}
27
28		public function getEdmx()
29		{
30		return $this->V3Edmx;
31		}
32
33		public function getEdmxXML()
34		{
35		return $this->serializer->serialize($this->V3Edmx, "xml");
36		}
37
38		public function addEntityType($name, $accessType = "Public")
39		{
40		$this->startEdmxTransaction();
41		$NewEntity = new TEntityTypeType();
42		$NewEntity->setName($name);
43
44
45		$entitySet = new \AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\EntitySetAnonymousType();
46		$entitySet->setName($this->pluralize(2, $NewEntity->getName()));
47		$namespace = $this->V3Edmx->getDataServices()[0]->getNamespace();
48		if (0 == strlen(trim($namespace))) {
49		$entityTypeName = $NewEntity->getName();
50		} else {
51		$entityTypeName = $namespace . "." . $NewEntity->getName();
52		}
53		$entitySet->setEntityType($entityTypeName);
54		$entitySet->setGetterAccess($accessType);
55
56		$this->V3Edmx->getDataServices()[0]->addToEntityType($NewEntity);
57		$this->V3Edmx->getDataServices()[0]->getEntityContainer()[0]->addToEntitySet($entitySet);
58		if (!$this->V3Edmx->isok($this->lastError)) {
59		$this->revertEdmxTransaction();
60		return false;
61		}
62		$this->commitEdmxTransaction();
		0 ignored issues – show Unused Code introduced 2017-05-11 11:00 UTC by Report Bug Copy Issue Report The call to the method `AlgoWeb\ODataMetadata\Me...commitEdmxTransaction()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
63		return $NewEntity;
64		}
65
66		private function startEdmxTransaction()
67		{
68		$this->oldEdmx = serialize($this->V3Edmx);
69		}
70
71		/**
72		* Pluralizes a word if quantity is not one.
73		*
74		* @param int $quantity Number of items
75		* @param string $singular Singular form of word
76		* @param string $plural Plural form of word; function will attempt to deduce plural form from singular if not provided
77		* @return string Pluralized word if quantity is not one, otherwise singular
78		*/
79	View Code Duplication	public static function pluralize($quantity, $singular, $plural = null)
		0 ignored issues – show Duplication introduced 2017-05-11 10:39 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...
80		{
81		if ($quantity == 1 \|\| !strlen($singular)) return $singular;
82		if ($plural !== null) return $plural;
83
84		$last_letter = strtolower($singular[strlen($singular) - 1]);
85		switch ($last_letter) {
86		case 'y':
87		return substr($singular, 0, -1) . 'ies';
88		case 's':
89		return $singular . 'es';
90		default:
91		return $singular . 's';
92		}
93		}
94
95		private function revertEdmxTransaction()
96		{
97		$this->V3Edmx = unserialize($this->oldEdmx);
98		}
99
100		private function commitEdmxTransaction()
101		{
102		$this->oldEdmx == null;
103		}
104
105		public function addPropertyToEntityType($entityType, $name, $type, $defaultValue = null, $isKey = false, $storeGeneratedPattern = false, $summary = null, $longDescription = null)
106		{
107		$this->startEdmxTransaction();
108		$NewProperty = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityPropertyType();
109		$NewProperty->setName($name);
110		$NewProperty->setType($type);
111		$NewProperty->setStoreGeneratedPattern($storeGeneratedPattern);
		0 ignored issues – show Documentation introduced 2017-05-11 11:39 UTC by Report Bug Copy Issue Report `$storeGeneratedPattern` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112		if (null != $summary \|\| null != $longDescription) {
113		$documentation = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TDocumentationType();
114		$documentation->setSummary($summary);
115		$documentation->setLongDescription($longDescription);
116		$NewProperty->setDocumentation($documentation);
		0 ignored issues – show Documentation introduced 2017-05-11 11:39 UTC by Report Bug Copy Issue Report `$documentation` is of type `object<AlgoWeb\ODataMeta...edm\TDocumentationType>`, but the function expects a `array<integer,object<Alg...dm\TDocumentationType>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
117		}
118		if (null != $defaultValue) {
119		$NewProperty->setDefaultValue($defaultValue);
120		}
121		$entityType->addToProperty($NewProperty);
122		if ($isKey) {
123		$Key = new \AlgoWeb\ODataMetadata\MetadataV3\edm\TPropertyRefType();
124		$Key->setName($name);
125		$entityType->addToKey($Key);
126		}
127		if (!$this->V3Edmx->isok($this->lastError)) {
128		$this->revertEdmxTransaction();
129		return false;
130		}
131		$this->commitEdmxTransaction();
		0 ignored issues – show Unused Code introduced 2017-05-11 11:30 UTC by Report Bug Copy Issue Report The call to the method `AlgoWeb\ODataMetadata\Me...commitEdmxTransaction()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
132		return $NewProperty;
133		}
134
135		public function addComplexType(\ReflectionClass $refClass, $name, $namespace = null, $baseResourceType = null)
136		{
137		return $this->createResourceType($refClass, $name, $namespace, ResourceTypeKind::COMPLEX, $baseResourceType);
		0 ignored issues – show Bug introduced 2017-05-10 02:49 UTC by Report Bug Copy Issue Report The method `createResourceType()` does not seem to exist on `object<AlgoWeb\ODataMetadata\MetadataManager>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
138		}
139
140		public function getLastError()
141		{
142		return $this->lastError();
		0 ignored issues – show Bug introduced 2017-05-11 11:00 UTC by Report Bug Copy Issue Report The method `lastError()` does not exist on `AlgoWeb\ODataMetadata\MetadataManager`. Did you maybe mean `getLastError()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
143		}
144		}
145

Algo-Web / ODataMetadata

Push — master ( c85fb5...8c4d6d )

MetadataManager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like