MetadataManager::__sleep() - Code Metrics - Inspection of "WIP: Fix metadata manager serialisation" - Algo-Web/ODataMetadata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#100)

by Alex

created 2017-06-02 13:28 UTC

MetadataManager::__sleep() A

↳ Parent: MetadataManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

namespace AlgoWeb\ODataMetadata;

use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\AssociationSetAnonymousType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\AssociationSetAnonymousType\EndAnonymousType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\EntitySetAnonymousType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TAssociationEndType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TAssociationType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TConstraintType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TDocumentationType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityPropertyType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityTypeType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TNavigationPropertyType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TPropertyRefType;
use AlgoWeb\ODataMetadata\MetadataV3\edm\TReferentialConstraintRoleElementType;
use AlgoWeb\ODataMetadata\MetadataV3\edmx\Edmx;
use Illuminate\Support\Str;
use JMS\Serializer\SerializerBuilder;

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);
        }
        $this->initSerialiser();
        assert(null != $this->serializer, "Serializer must not be null at end of constructor");
    }

    public function getEdmx()
    {
        $msg = null;
        assert($this->V3Edmx->isOk($msg), $msg);
        return $this->V3Edmx;
    }

    public function getEdmxXML()
    {
        assert(null != $this->serializer, "Serializer must not be null when trying to get edmx xml");
        return $this->serializer->serialize($this->getEdmx(), "xml");
    }

    public function addEntityType($name, $accessType = "Public", $summary = null, $longDescription = null)
    {
        $NewEntity = new TEntityTypeType();
        $NewEntity->setName($name);
        if (null != $summary || null != $longDescription) {

            $documentation = new TDocumentationType();
            $documentation->setSummary($summary);
            $documentation->setLongDescription($longDescription);
            $NewEntity->setDocumentation($documentation);
        }

        $entitySet = new EntitySetAnonymousType();
        $entitySet->setName(Str::plural($NewEntity->getName(), 2));
        $namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
        if (0 == strlen(trim($namespace))) {

            $entityTypeName = $NewEntity->getName();
        } else {
            $entityTypeName = $namespace . "." . $NewEntity->getName();
        }
        $entitySet->setEntityType($entityTypeName);
        $entitySet->setGetterAccess($accessType);

        $this->V3Edmx->getDataServiceType()->getSchema()[0]->addToEntityType($NewEntity);
        $this->V3Edmx->getDataServiceType()->getSchema()[0]->getEntityContainer()[0]->addToEntitySet($entitySet);
        if (!$this->V3Edmx->isok($this->lastError)) {
            return false;
        }
        return $NewEntity;
    }

    public function getSerialiser()
    {
        return $this->serializer;
    }

    /**
     * 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';
        }
    }

    public function addPropertyToEntityType(
        $entityType,
        $name,
        $type,
        $defaultValue = null,
        $nullable = false,
        $isKey = false,
        $storeGeneratedPattern = null,
        $summary = null,
        $longDescription = null
    ) {
        $NewProperty = new TEntityPropertyType();
        $NewProperty->setName($name);
        $NewProperty->setType($type);
        $NewProperty->setStoreGeneratedPattern($storeGeneratedPattern);
        $NewProperty->setNullable($nullable);
        if (null != $summary || null != $longDescription) {

            $documentation = new TDocumentationType();
            $documentation->setSummary($summary);
            $documentation->setLongDescription($longDescription);
            $NewProperty->addToDocumentation($documentation);
        }
        if (null != $defaultValue) {
            $NewProperty->setDefaultValue($defaultValue);
        }
        $entityType->addToProperty($NewProperty);
        if ($isKey) {
            $Key = new TPropertyRefType();
            $Key->setName($name);
            $entityType->addToKey($Key);
        }
        if (!$this->V3Edmx->isok($this->lastError)) {
            return false;
        }
        return $NewProperty;
    }

    public function addNavigationPropertyToEntityType(
        TEntityTypeType $principalType,
        $principalMultiplicity,
        $principalProperty,
        TEntityTypeType $dependentType,
        $dependentMultiplicity,
        $dependentProperty = "",
        array $principalConstraintProperty = null,
        array $dependentConstraintProperty = null,
        $principalGetterAccess = "Public",
        $principalSetterAccess = "Public",
        $dependentGetterAccess = "Public",
        $dependentSetterAccess = "Public",
        $principalSummery = null,
        $principalLongDescription = null,
        $dependentSummery = null,
        $dependentLongDescription = null
    ) {
        $principalEntitySetName = Str::plural($principalType->getName(), 2);
        $dependentEntitySetName = Str::plural($dependentType->getName(), 2);
        $relationName = $principalType->getName() . "_" . $principalProperty . "_"
                        . $dependentType->getName() . "_" . $dependentProperty;
        $relationName = trim($relationName, "_");

        $namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
        if (0 == strlen(trim($namespace))) {
            $relationFQName = $relationName;
        } else {
            $relationFQName = $namespace . "." . $relationName;
        }

        $principalNavigationProperty = new TNavigationPropertyType();
        $principalNavigationProperty->setName($principalProperty);
        $principalNavigationProperty->setToRole(trim($dependentEntitySetName . "_" . $dependentProperty, "_"));
        $principalNavigationProperty->setFromRole($principalEntitySetName . "_" . $principalProperty);
        $principalNavigationProperty->setRelationship($relationFQName);
        $principalNavigationProperty->setGetterAccess($principalGetterAccess);
        $principalNavigationProperty->setSetterAccess($principalSetterAccess);
        if (null != $principalSummery || null != $principalLongDescription) {
            $principalDocumentation = new TDocumentationType();
            $principalDocumentation->setSummary($principalSummery);
            $principalDocumentation->setLongDescription($principalLongDescription);
            $principalNavigationProperty->setDocumentation($principalDocumentation);
        }
        $principalType->addToNavigationProperty($principalNavigationProperty);
        $dependentNavigationProperty = null;
        if (!empty($dependentProperty)) {
            $dependentNavigationProperty = new TNavigationPropertyType();
            $dependentNavigationProperty->setName($dependentProperty);
            $dependentNavigationProperty->setToRole($principalEntitySetName . "_" . $principalProperty);
            $dependentNavigationProperty->setFromRole($dependentEntitySetName . "_" . $dependentProperty);
            $dependentNavigationProperty->setRelationship($relationFQName);
            $dependentNavigationProperty->setGetterAccess($dependentGetterAccess);
            $dependentNavigationProperty->setSetterAccess($dependentSetterAccess);
            if (null != $dependentSummery || null != $dependentLongDescription) {
                $dependentDocumentation = new TDocumentationType();
                $dependentDocumentation->setSummary($dependentSummery);
                $dependentDocumentation->setLongDescription($dependentLongDescription);
                $dependentNavigationProperty->setDocumentation($dependentDocumentation);
            }
            $dependentType->addToNavigationProperty($dependentNavigationProperty);
        }

        $assocation = $this->createAssocationFromNavigationProperty(
            $principalType,
            $dependentType,
            $principalNavigationProperty,
            $dependentNavigationProperty,
            $principalMultiplicity,
            $dependentMultiplicity,
            $principalConstraintProperty,
            $dependentConstraintProperty
        );

        $this->V3Edmx->getDataServiceType()->getSchema()[0]->addToAssociation($assocation);

        $associationSet = $this->createAssocationSetForAssocation(
            $assocation,
            $principalEntitySetName,
            $dependentEntitySetName
        );

        $this->V3Edmx->getDataServiceType()->getSchema()[0]
            ->getEntityContainer()[0]->addToAssociationSet($associationSet);

        if (!$this->V3Edmx->isok($this->lastError)) {
            return false;
        }
        return [$principalNavigationProperty, $dependentNavigationProperty];
    }

    protected function createAssocationFromNavigationProperty(
        TEntityTypeType $principalType,
        TEntityTypeType $dependentType,
        TNavigationPropertyType $principalNavigationProperty,
        TNavigationPropertyType $dependentNavigationProperty = null,
        $principalMultiplicity,
        $dependentMultiplicity,
        array $principalConstraintProperty = null,
        array $dependentConstraintProperty = null
    ) {
        if (null != $dependentNavigationProperty) {
            if ($dependentNavigationProperty->getRelationship() != $principalNavigationProperty->getRelationship()) {
                $msg = "if you have both a dependent property and a principal property,"
                       ." they should both have the same relationship";
                throw new \Exception($msg);
            }
            if ($dependentNavigationProperty->getFromRole() != $principalNavigationProperty->getToRole() ||
                $dependentNavigationProperty->getToRole() != $principalNavigationProperty->getFromRole()
            ) {
                throw new \Exception("The from roles and two roles from matching properties should match");
            }
        }
        $namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();

        if (0 == strlen(trim($namespace))) {
            $principalTypeFQName = $principalType->getName();
            $dependentTypeFQName = $dependentType->getName();
        } else {
            $principalTypeFQName = $namespace . "." . $principalType->getName();
            $dependentTypeFQName = $namespace . "." . $dependentType->getName();
        }
        $association = new TAssociationType();
        $relationship = $principalNavigationProperty->getRelationship();
        if (strpos($relationship, '.') !== false) {
            $relationship = substr($relationship, strpos($relationship, '.') + 1);
        }

        $association->setName($relationship);
        $principalEnd = new TAssociationEndType();
        $principalEnd->setType($principalTypeFQName);
        $principalEnd->setRole($principalNavigationProperty->getFromRole());
        $principalEnd->setMultiplicity($principalMultiplicity);
        $association->addToEnd($principalEnd);
        $dependentEnd = new TAssociationEndType();
        $dependentEnd->setType($dependentTypeFQName);
        $dependentEnd->setMultiplicity($dependentMultiplicity);
        $association->addToEnd($dependentEnd);

        if (null != $dependentNavigationProperty) {
            $dependentEnd->setRole($dependentNavigationProperty->getFromRole());
        } else {
            $dependentEnd->setRole($principalNavigationProperty->getToRole());
        }

        $principalReferralConstraint = null;
        $dependentReferralConstraint = null;

        if (null != $principalConstraintProperty && 0 < count($principalConstraintProperty)) {

            $principalReferralConstraint = new TReferentialConstraintRoleElementType();
            $principalReferralConstraint->setRole($principalNavigationProperty->getFromRole());
            foreach ($principalConstraintProperty as $propertyRef) {
                $TpropertyRef = new TPropertyRefType();
                $TpropertyRef->setName($propertyRef);
                $principalReferralConstraint->addToPropertyRef($TpropertyRef);
            }
        }
        if (null != $dependentConstraintProperty && 0 < count($dependentConstraintProperty)) {

            $dependentReferralConstraint = new TReferentialConstraintRoleElementType();
            $dependentReferralConstraint->setRole($dependentNavigationProperty->getFromRole());
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
            foreach ($dependentConstraintProperty as $propertyRef) {
                $TpropertyRef = new TPropertyRefType();
                $TpropertyRef->setName($propertyRef);
                $dependentReferralConstraint->addToPropertyRef($TpropertyRef);
            }
        }

        if (null != $dependentReferralConstraint || null != $principalReferralConstraint) {
            $constraint = new TConstraintType();
            $constraint->setPrincipal($principalReferralConstraint);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $constraint->setDependent($dependentReferralConstraint);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $association->setReferentialConstraint($constraint);
        }
        return $association;
    }

    protected function createAssocationSetForAssocation(
        TAssociationType $association,
        $principalEntitySetName,
        $dependentEntitySetName
    ) {
        $as = new AssociationSetAnonymousType();
        $name = $association->getName();
        $as->setName($name);
        $namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
        if (0 == strlen(trim($namespace))) {

            $associationSetName = $association->getName();
        } else {
            $associationSetName = $namespace . "." . $association->getName();
        }
        $as->setAssociation($associationSetName);
        $end1 = new EndAnonymousType();
        $end1->setRole($association->getEnd()[0]->getRole());
        $end1->setEntitySet($principalEntitySetName);
        $end2 = new EndAnonymousType();
        $end2->setRole($association->getEnd()[1]->getRole());
        $end2->setEntitySet($dependentEntitySetName);
        $as->addToEnd($end1);
        $as->addToEnd($end2);
        return $as;
    }

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

    private function initSerialiser()
    {
        $ymlDir = __DIR__ . DIRECTORY_SEPARATOR . "MetadataV3" . DIRECTORY_SEPARATOR . "JMSmetadata";
        $this->serializer =
            SerializerBuilder::create()
                ->addMetadataDir($ymlDir)
                ->build();
    }

    public function __sleep()
    {
        $this->serializer = null;
        $result = array_keys(get_object_vars($this));
        return $result;
    }

    public function __wakeup()
    {
        $this->initSerialiser();
    }
}


1		<?php
2
3		namespace AlgoWeb\ODataMetadata;
4
5		use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\AssociationSetAnonymousType;
6		use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\AssociationSetAnonymousType\EndAnonymousType;
7		use AlgoWeb\ODataMetadata\MetadataV3\edm\EntityContainer\EntitySetAnonymousType;
8		use AlgoWeb\ODataMetadata\MetadataV3\edm\TAssociationEndType;
9		use AlgoWeb\ODataMetadata\MetadataV3\edm\TAssociationType;
10		use AlgoWeb\ODataMetadata\MetadataV3\edm\TConstraintType;
11		use AlgoWeb\ODataMetadata\MetadataV3\edm\TDocumentationType;
12		use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityPropertyType;
13		use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityTypeType;
14		use AlgoWeb\ODataMetadata\MetadataV3\edm\TNavigationPropertyType;
15		use AlgoWeb\ODataMetadata\MetadataV3\edm\TPropertyRefType;
16		use AlgoWeb\ODataMetadata\MetadataV3\edm\TReferentialConstraintRoleElementType;
17		use AlgoWeb\ODataMetadata\MetadataV3\edmx\Edmx;
18		use Illuminate\Support\Str;
19		use JMS\Serializer\SerializerBuilder;
20
21		class MetadataManager
22		{
23		private $V3Edmx = null;
24		private $oldEdmx = null;
		0 ignored issues – show Unused Code introduced 2017-05-23 03:44 UTC by Report Bug Copy Issue Report The property `$oldEdmx` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
25		private $lastError = null;
26		private $serializer = null;
27
28		public function __construct($namespaceName = "Data", $containerName = "DefaultContainer")
29		{
30		$this->V3Edmx = new Edmx($namespaceName, $containerName);
31		if (!$this->V3Edmx->isOK($msg)) {
32		throw new \Exception($msg);
33		}
34		$this->initSerialiser();
35		assert(null != $this->serializer, "Serializer must not be null at end of constructor");
36		}
37
38		public function getEdmx()
39		{
40		$msg = null;
41		assert($this->V3Edmx->isOk($msg), $msg);
42		return $this->V3Edmx;
43		}
44
45		public function getEdmxXML()
46		{
47		assert(null != $this->serializer, "Serializer must not be null when trying to get edmx xml");
48		return $this->serializer->serialize($this->getEdmx(), "xml");
49		}
50
51		public function addEntityType($name, $accessType = "Public", $summary = null, $longDescription = null)
52		{
53		$NewEntity = new TEntityTypeType();
54		$NewEntity->setName($name);
55	View Code Duplication	if (null != $summary \|\| null != $longDescription) {
		0 ignored issues – show Duplication introduced 2017-05-11 11:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
56		$documentation = new TDocumentationType();
57		$documentation->setSummary($summary);
58		$documentation->setLongDescription($longDescription);
59		$NewEntity->setDocumentation($documentation);
60		}
61
62		$entitySet = new EntitySetAnonymousType();
63		$entitySet->setName(Str::plural($NewEntity->getName(), 2));
64		$namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
65	View Code Duplication	if (0 == strlen(trim($namespace))) {
		0 ignored issues – show Duplication introduced 2017-05-11 14:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
66		$entityTypeName = $NewEntity->getName();
67		} else {
68		$entityTypeName = $namespace . "." . $NewEntity->getName();
69		}
70		$entitySet->setEntityType($entityTypeName);
71		$entitySet->setGetterAccess($accessType);
72
73		$this->V3Edmx->getDataServiceType()->getSchema()[0]->addToEntityType($NewEntity);
74		$this->V3Edmx->getDataServiceType()->getSchema()[0]->getEntityContainer()[0]->addToEntitySet($entitySet);
75		if (!$this->V3Edmx->isok($this->lastError)) {
76		return false;
77		}
78		return $NewEntity;
79		}
80
81		public function getSerialiser()
82		{
83		return $this->serializer;
84		}
85
86		/**
87		* Pluralizes a word if quantity is not one.
88		*
89		* @param int $quantity Number of items
90		* @param string $singular Singular form of word
91		* @param string $plural Plural form of word; function will attempt to deduce plural
92		* form from singular if not provided
93		* @return string Pluralized word if quantity is not one, otherwise singular
94		*/
95		public static function pluralize($quantity, $singular, $plural = null)
96		{
97		if ($quantity == 1 \|\| !strlen($singular)) {
98		return $singular;
99		}
100		if ($plural !== null) {
101		return $plural;
102		}
103
104		$last_letter = strtolower($singular[strlen($singular) - 1]);
105		switch ($last_letter) {
106		case 'y':
107		return substr($singular, 0, -1) . 'ies';
108		case 's':
109		return $singular . 'es';
110		default:
111		return $singular . 's';
112		}
113		}
114
115		public function addPropertyToEntityType(
116		$entityType,
117		$name,
118		$type,
119		$defaultValue = null,
120		$nullable = false,
121		$isKey = false,
122		$storeGeneratedPattern = null,
123		$summary = null,
124		$longDescription = null
125		) {
126		$NewProperty = new TEntityPropertyType();
127		$NewProperty->setName($name);
128		$NewProperty->setType($type);
129		$NewProperty->setStoreGeneratedPattern($storeGeneratedPattern);
130		$NewProperty->setNullable($nullable);
131	View Code Duplication	if (null != $summary \|\| null != $longDescription) {
		0 ignored issues – show Duplication introduced 2017-05-30 15:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
132		$documentation = new TDocumentationType();
133		$documentation->setSummary($summary);
134		$documentation->setLongDescription($longDescription);
135		$NewProperty->addToDocumentation($documentation);
136		}
137		if (null != $defaultValue) {
138		$NewProperty->setDefaultValue($defaultValue);
139		}
140		$entityType->addToProperty($NewProperty);
141		if ($isKey) {
142		$Key = new TPropertyRefType();
143		$Key->setName($name);
144		$entityType->addToKey($Key);
145		}
146		if (!$this->V3Edmx->isok($this->lastError)) {
147		return false;
148		}
149		return $NewProperty;
150		}
151
152		public function addNavigationPropertyToEntityType(
153		TEntityTypeType $principalType,
154		$principalMultiplicity,
155		$principalProperty,
156		TEntityTypeType $dependentType,
157		$dependentMultiplicity,
158		$dependentProperty = "",
159		array $principalConstraintProperty = null,
160		array $dependentConstraintProperty = null,
161		$principalGetterAccess = "Public",
162		$principalSetterAccess = "Public",
163		$dependentGetterAccess = "Public",
164		$dependentSetterAccess = "Public",
165		$principalSummery = null,
166		$principalLongDescription = null,
167		$dependentSummery = null,
168		$dependentLongDescription = null
169		) {
170		$principalEntitySetName = Str::plural($principalType->getName(), 2);
171		$dependentEntitySetName = Str::plural($dependentType->getName(), 2);
172		$relationName = $principalType->getName() . "_" . $principalProperty . "_"
173		. $dependentType->getName() . "_" . $dependentProperty;
174		$relationName = trim($relationName, "_");
175
176		$namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
177		if (0 == strlen(trim($namespace))) {
178		$relationFQName = $relationName;
179		} else {
180		$relationFQName = $namespace . "." . $relationName;
181		}
182
183		$principalNavigationProperty = new TNavigationPropertyType();
184		$principalNavigationProperty->setName($principalProperty);
185		$principalNavigationProperty->setToRole(trim($dependentEntitySetName . "_" . $dependentProperty, "_"));
186		$principalNavigationProperty->setFromRole($principalEntitySetName . "_" . $principalProperty);
187		$principalNavigationProperty->setRelationship($relationFQName);
188		$principalNavigationProperty->setGetterAccess($principalGetterAccess);
189		$principalNavigationProperty->setSetterAccess($principalSetterAccess);
190		if (null != $principalSummery \|\| null != $principalLongDescription) {
191		$principalDocumentation = new TDocumentationType();
192		$principalDocumentation->setSummary($principalSummery);
193		$principalDocumentation->setLongDescription($principalLongDescription);
194		$principalNavigationProperty->setDocumentation($principalDocumentation);
195		}
196		$principalType->addToNavigationProperty($principalNavigationProperty);
197		$dependentNavigationProperty = null;
198		if (!empty($dependentProperty)) {
199		$dependentNavigationProperty = new TNavigationPropertyType();
200		$dependentNavigationProperty->setName($dependentProperty);
201		$dependentNavigationProperty->setToRole($principalEntitySetName . "_" . $principalProperty);
202		$dependentNavigationProperty->setFromRole($dependentEntitySetName . "_" . $dependentProperty);
203		$dependentNavigationProperty->setRelationship($relationFQName);
204		$dependentNavigationProperty->setGetterAccess($dependentGetterAccess);
205		$dependentNavigationProperty->setSetterAccess($dependentSetterAccess);
206		if (null != $dependentSummery \|\| null != $dependentLongDescription) {
207		$dependentDocumentation = new TDocumentationType();
208		$dependentDocumentation->setSummary($dependentSummery);
209		$dependentDocumentation->setLongDescription($dependentLongDescription);
210		$dependentNavigationProperty->setDocumentation($dependentDocumentation);
211		}
212		$dependentType->addToNavigationProperty($dependentNavigationProperty);
213		}
214
215		$assocation = $this->createAssocationFromNavigationProperty(
216		$principalType,
217		$dependentType,
218		$principalNavigationProperty,
219		$dependentNavigationProperty,
220		$principalMultiplicity,
221		$dependentMultiplicity,
222		$principalConstraintProperty,
223		$dependentConstraintProperty
224		);
225
226		$this->V3Edmx->getDataServiceType()->getSchema()[0]->addToAssociation($assocation);
227
228		$associationSet = $this->createAssocationSetForAssocation(
229		$assocation,
230		$principalEntitySetName,
231		$dependentEntitySetName
232		);
233
234		$this->V3Edmx->getDataServiceType()->getSchema()[0]
235		->getEntityContainer()[0]->addToAssociationSet($associationSet);
236
237		if (!$this->V3Edmx->isok($this->lastError)) {
238		return false;
239		}
240		return [$principalNavigationProperty, $dependentNavigationProperty];
241		}
242
243		protected function createAssocationFromNavigationProperty(
244		TEntityTypeType $principalType,
245		TEntityTypeType $dependentType,
246		TNavigationPropertyType $principalNavigationProperty,
247		TNavigationPropertyType $dependentNavigationProperty = null,
248		$principalMultiplicity,
249		$dependentMultiplicity,
250		array $principalConstraintProperty = null,
251		array $dependentConstraintProperty = null
252		) {
253		if (null != $dependentNavigationProperty) {
254		if ($dependentNavigationProperty->getRelationship() != $principalNavigationProperty->getRelationship()) {
255		$msg = "if you have both a dependent property and a principal property,"
256		." they should both have the same relationship";
257		throw new \Exception($msg);
258		}
259		if ($dependentNavigationProperty->getFromRole() != $principalNavigationProperty->getToRole() \|\|
260		$dependentNavigationProperty->getToRole() != $principalNavigationProperty->getFromRole()
261		) {
262		throw new \Exception("The from roles and two roles from matching properties should match");
263		}
264		}
265		$namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
266
267		if (0 == strlen(trim($namespace))) {
268		$principalTypeFQName = $principalType->getName();
269		$dependentTypeFQName = $dependentType->getName();
270		} else {
271		$principalTypeFQName = $namespace . "." . $principalType->getName();
272		$dependentTypeFQName = $namespace . "." . $dependentType->getName();
273		}
274		$association = new TAssociationType();
275		$relationship = $principalNavigationProperty->getRelationship();
276		if (strpos($relationship, '.') !== false) {
277		$relationship = substr($relationship, strpos($relationship, '.') + 1);
278		}
279
280		$association->setName($relationship);
281		$principalEnd = new TAssociationEndType();
282		$principalEnd->setType($principalTypeFQName);
283		$principalEnd->setRole($principalNavigationProperty->getFromRole());
284		$principalEnd->setMultiplicity($principalMultiplicity);
285		$association->addToEnd($principalEnd);
286		$dependentEnd = new TAssociationEndType();
287		$dependentEnd->setType($dependentTypeFQName);
288		$dependentEnd->setMultiplicity($dependentMultiplicity);
289		$association->addToEnd($dependentEnd);
290
291		if (null != $dependentNavigationProperty) {
292		$dependentEnd->setRole($dependentNavigationProperty->getFromRole());
293		} else {
294		$dependentEnd->setRole($principalNavigationProperty->getToRole());
295		}
296
297		$principalReferralConstraint = null;
298		$dependentReferralConstraint = null;
299
300	View Code Duplication	if (null != $principalConstraintProperty && 0 < count($principalConstraintProperty)) {
		0 ignored issues – show Duplication introduced 2017-05-11 12:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
301		$principalReferralConstraint = new TReferentialConstraintRoleElementType();
302		$principalReferralConstraint->setRole($principalNavigationProperty->getFromRole());
303		foreach ($principalConstraintProperty as $propertyRef) {
304		$TpropertyRef = new TPropertyRefType();
305		$TpropertyRef->setName($propertyRef);
306		$principalReferralConstraint->addToPropertyRef($TpropertyRef);
307		}
308		}
309	View Code Duplication	if (null != $dependentConstraintProperty && 0 < count($dependentConstraintProperty)) {
		0 ignored issues – show Duplication introduced 2017-05-11 12:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
310		$dependentReferralConstraint = new TReferentialConstraintRoleElementType();
311		$dependentReferralConstraint->setRole($dependentNavigationProperty->getFromRole());
		0 ignored issues – show Bug introduced 2017-05-18 14:53 UTC by Report Bug Copy Issue Report It seems like `$dependentNavigationProperty` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
312		foreach ($dependentConstraintProperty as $propertyRef) {
313		$TpropertyRef = new TPropertyRefType();
314		$TpropertyRef->setName($propertyRef);
315		$dependentReferralConstraint->addToPropertyRef($TpropertyRef);
316		}
317		}
318
319		if (null != $dependentReferralConstraint \|\| null != $principalReferralConstraint) {
320		$constraint = new TConstraintType();
321		$constraint->setPrincipal($principalReferralConstraint);
		0 ignored issues – show Bug introduced 2017-05-11 12:36 UTC by Report Bug Copy Issue Report It seems like `$principalReferralConstraint` defined by `null` on line `297` can be `null`; however, `AlgoWeb\ODataMetadata\Me...intType::setPrincipal()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
322		$constraint->setDependent($dependentReferralConstraint);
		0 ignored issues – show Bug introduced 2017-05-11 12:36 UTC by Report Bug Copy Issue Report It seems like `$dependentReferralConstraint` defined by `null` on line `298` can be `null`; however, `AlgoWeb\ODataMetadata\Me...intType::setDependent()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
323		$association->setReferentialConstraint($constraint);
324		}
325		return $association;
326		}
327
328		protected function createAssocationSetForAssocation(
329		TAssociationType $association,
330		$principalEntitySetName,
331		$dependentEntitySetName
332		) {
333		$as = new AssociationSetAnonymousType();
334		$name = $association->getName();
335		$as->setName($name);
336		$namespace = $this->V3Edmx->getDataServiceType()->getSchema()[0]->getNamespace();
337	View Code Duplication	if (0 == strlen(trim($namespace))) {
		0 ignored issues – show Duplication introduced 2017-05-11 14:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
338		$associationSetName = $association->getName();
339		} else {
340		$associationSetName = $namespace . "." . $association->getName();
341		}
342		$as->setAssociation($associationSetName);
343		$end1 = new EndAnonymousType();
344		$end1->setRole($association->getEnd()[0]->getRole());
345		$end1->setEntitySet($principalEntitySetName);
346		$end2 = new EndAnonymousType();
347		$end2->setRole($association->getEnd()[1]->getRole());
348		$end2->setEntitySet($dependentEntitySetName);
349		$as->addToEnd($end1);
350		$as->addToEnd($end2);
351		return $as;
352		}
353
354		public function getLastError()
355		{
356		return $this->lastError;
357		}
358
359		private function initSerialiser()
360		{
361		$ymlDir = __DIR__ . DIRECTORY_SEPARATOR . "MetadataV3" . DIRECTORY_SEPARATOR . "JMSmetadata";
362		$this->serializer =
363		SerializerBuilder::create()
364		->addMetadataDir($ymlDir)
365		->build();
366		}
367
368		public function __sleep()
369		{
370		$this->serializer = null;
371		$result = array_keys(get_object_vars($this));
372		return $result;
373		}
374
375		public function __wakeup()
376		{
377		$this->initSerialiser();
378		}
379		}
380

Algo-Web / ODataMetadata

Pull Request — master (#100)

MetadataManager::__sleep() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like