Algo-Web / ODataMetadata

src/MetadataManager.php

Doc Comments +22 added lines

@@ -53,6 +53,11 @@ 
         return $this->getSerialiser()->serialize($this->getEdmx(), "xml");
     }
 
+    /**
+     * @param string $name
+     * @param TTextType $summary
+     * @param TTextType $longDescription
+     */
     public function addEntityType($name, $accessType = "Public", $summary = null, $longDescription = null)
     {
         $NewEntity = new TEntityTypeType();
@@ -126,6 +131,14 @@ 
         return $NewProperty;
     }
 
+    /**
+     * @param string $name
+     * @param string $type
+     * @param string $defaultValue
+     * @param string $storeGeneratedPattern
+     * @param TTextType $summary
+     * @param TTextType $longDescription
+     */
     public function addPropertyToEntityType(
         TEntityTypeType $entityType,
         $name,
@@ -158,6 +171,11 @@ 
         return $NewProperty;
     }
 
+    /**
+     * @param string $principalMultiplicity
+     * @param string $principalProperty
+     * @param string $dependentMultiplicity
+     */
     public function addNavigationPropertyToEntityType(
         TEntityTypeType $principalType,
         $principalMultiplicity,
@@ -320,6 +338,10 @@ 
         return $association;
     }
 
+    /**
+     * @param string $principalEntitySetName
+     * @param string $dependentEntitySetName
+     */
     protected function createAssocationSetForAssocation(
         TAssociationType $association,
         $principalEntitySetName,

Spacing +14 added lines, -14 removed lines

@@ -65,7 +65,7 @@ 
         $entitySet = new EntitySetAnonymousType();
         $entitySet->setName(Str::plural($NewEntity->getName()));
         $namespace = $this->getNamespace();
-        $entityTypeName = $namespace . $NewEntity->getName();
+        $entityTypeName = $namespace.$NewEntity->getName();
         $entitySet->setEntityType($entityTypeName);
         $entitySet->setGetterAccess($accessType);
 
@@ -178,17 +178,17 @@ 
     ) {
         $principalEntitySetName = Str::plural($principalType->getName());
         $dependentEntitySetName = Str::plural($dependentType->getName());
-        $relationName = $principalType->getName() . "_" . $principalProperty . "_"
-                        . $dependentType->getName() . "_" . $dependentProperty;
+        $relationName = $principalType->getName()."_".$principalProperty."_"
+                        . $dependentType->getName()."_".$dependentProperty;
         $relationName = trim($relationName, "_");
 
         $namespace = $this->getNamespace();
-        $relationFQName = $namespace . $relationName;
+        $relationFQName = $namespace.$relationName;
 
         $principalNavigationProperty = new TNavigationPropertyType();
         $principalNavigationProperty->setName($principalProperty);
-        $principalNavigationProperty->setToRole(trim($dependentEntitySetName . "_" . $dependentProperty, "_"));
-        $principalNavigationProperty->setFromRole($principalEntitySetName . "_" . $principalProperty);
+        $principalNavigationProperty->setToRole(trim($dependentEntitySetName."_".$dependentProperty, "_"));
+        $principalNavigationProperty->setFromRole($principalEntitySetName."_".$principalProperty);
         $principalNavigationProperty->setRelationship($relationFQName);
         $principalNavigationProperty->setGetterAccess($principalGetterAccess);
         $principalNavigationProperty->setSetterAccess($principalSetterAccess);
@@ -201,8 +201,8 @@ 
         if (!empty($dependentProperty)) {
             $dependentNavigationProperty = new TNavigationPropertyType();
             $dependentNavigationProperty->setName($dependentProperty);
-            $dependentNavigationProperty->setToRole($principalEntitySetName . "_" . $principalProperty);
-            $dependentNavigationProperty->setFromRole($dependentEntitySetName . "_" . $dependentProperty);
+            $dependentNavigationProperty->setToRole($principalEntitySetName."_".$principalProperty);
+            $dependentNavigationProperty->setFromRole($dependentEntitySetName."_".$dependentProperty);
             $dependentNavigationProperty->setRelationship($relationFQName);
             $dependentNavigationProperty->setGetterAccess($dependentGetterAccess);
             $dependentNavigationProperty->setSetterAccess($dependentSetterAccess);
@@ -249,7 +249,7 @@ 
         array $principalConstraintProperty = null,
         array $dependentConstraintProperty = null
     ) {
-        $multCombo = [ '*' => ['*', '1'], '0..1' => ['1'], '1' => ['*', '0..1']];
+        $multCombo = ['*' => ['*', '1'], '0..1' => ['1'], '1' => ['*', '0..1']];
         $multKeys = array_keys($multCombo);
         if (null != $dependentNavigationProperty) {
             if ($dependentNavigationProperty->getRelationship() != $principalNavigationProperty->getRelationship()) {
@@ -270,13 +270,13 @@ 
         }
         if (!in_array($dependentMultiplicity, $multCombo[$principalMultiplicity])) {
             throw new \InvalidArgumentException(
-                "Invalid multiplicity combination - ". $principalMultiplicity . ' ' . $dependentMultiplicity
+                "Invalid multiplicity combination - ".$principalMultiplicity.' '.$dependentMultiplicity
             );
         }
 
         $namespace = $this->getNamespace();
-        $principalTypeFQName = $namespace . $principalType->getName();
-        $dependentTypeFQName = $namespace . $dependentType->getName();
+        $principalTypeFQName = $namespace.$principalType->getName();
+        $dependentTypeFQName = $namespace.$dependentType->getName();
         $association = new TAssociationType();
         $relationship = $principalNavigationProperty->getRelationship();
         if (false !== strpos($relationship, '.')) {
@@ -329,7 +329,7 @@ 
         $name = $association->getName();
         $as->setName($name);
         $namespace = $this->getNamespace();
-        $associationSetName = $namespace . $association->getName();
+        $associationSetName = $namespace.$association->getName();
         $as->setAssociation($associationSetName);
         $end1 = new EndAnonymousType();
         $end1->setRole($association->getEnd()[0]->getRole());
@@ -392,7 +392,7 @@ 
 
     private function initSerialiser()
     {
-        $ymlDir = __DIR__ . DIRECTORY_SEPARATOR . "MetadataV3" . DIRECTORY_SEPARATOR . "JMSmetadata";
+        $ymlDir = __DIR__.DIRECTORY_SEPARATOR."MetadataV3".DIRECTORY_SEPARATOR."JMSmetadata";
         $this->serializer =
             SerializerBuilder::create()
                 ->addMetadataDir($ymlDir)

tests/MetadataManagerTest.php

Unused Use Statements -2 removed lines

@@ -11,8 +11,6 @@
 use AlgoWeb\ODataMetadata\MetadataV3\edm\TComplexTypeType;
 use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityPropertyType;
 use AlgoWeb\ODataMetadata\MetadataV3\edm\TEntityTypeType;
-use AlgoWeb\ODataMetadata\MetadataV3\edm\TFunctionReturnTypeType;
-use AlgoWeb\ODataMetadata\MetadataV3\edm\TFunctionType;
 use AlgoWeb\ODataMetadata\MetadataV3\edm\TNavigationPropertyType;
 use AlgoWeb\ODataMetadata\MetadataV3\edm\TTextType;
 use AlgoWeb\ODataMetadata\MetadataV3\edmx\Edmx;

Spacing +20 added lines, -20 removed lines

@@ -37,7 +37,7 @@ 
     {
         $ds = DIRECTORY_SEPARATOR;
 
-        $goodxsd = dirname(__DIR__) . $ds . "xsd" . $ds . "Microsoft.Data.Entity.Design.Edmx_3.Fixed.xsd";
+        $goodxsd = dirname(__DIR__).$ds."xsd".$ds."Microsoft.Data.Entity.Design.Edmx_3.Fixed.xsd";
         if (!file_exists($goodxsd)) {
             return true;
         }
@@ -52,7 +52,7 @@ 
         $result = null;
 
         list($eType, $result) = $metadataManager->addEntityType("Category");
-        $this->assertNotFalse($eType, "Etype is false not type " . $metadataManager->getLastError());
+        $this->assertNotFalse($eType, "Etype is false not type ".$metadataManager->getLastError());
         $metadataManager->addPropertyToEntityType($eType, "CategoryID", "Int32", null, false, true, "Identity");
         $metadataManager->addPropertyToEntityType($eType, "CategoryName", "String");
         $metadataManager->addPropertyToEntityType($eType, "Description", "String");
@@ -79,7 +79,7 @@ 
         $result = null;
 
         list($CategoryType, $result) = $metadataManager->addEntityType("Category");
-        $this->assertNotFalse($CategoryType, "Etype is false not type " . $metadataManager->getLastError());
+        $this->assertNotFalse($CategoryType, "Etype is false not type ".$metadataManager->getLastError());
         $metadataManager->addPropertyToEntityType($CategoryType, "CategoryID", "Int32", null, false, true, "Identity");
         $metadataManager->addPropertyToEntityType($CategoryType, "CategoryName", "String");
         $metadataManager->addPropertyToEntityType($CategoryType, "Description", "String");
@@ -165,7 +165,7 @@ 
         $this->assertTrue($metadataManager->getEdmx()->isOK($msg), $msg);
 
         $expectedRelation = "Data.Category_Products_Product_Category";
-        list($principalNav, ) = $metadataManager->addNavigationPropertyToEntityType(
+        list($principalNav,) = $metadataManager->addNavigationPropertyToEntityType(
             $CategoryType, "*", "Products", $ProductType, "1", "Category", ["CategoryID"], ["CategoryID"]
         );
         $this->assertEquals($expectedRelation, $principalNav->getRelationship());
@@ -610,7 +610,7 @@ 
     {
         list(, $metadataManager, $CategoryType, $CustomerType) = $this->setUpMetadataForNavTests();
 
-        $expected =  "Invalid multiplicity combination - 1 1";
+        $expected = "Invalid multiplicity combination - 1 1";
         $actual = null;
 
         try {
@@ -632,7 +632,7 @@ 
     {
         list(, $metadataManager, $CategoryType, $CustomerType) = $this->setUpMetadataForNavTests();
 
-        $expected =  "Invalid multiplicity combination - * 0..1";
+        $expected = "Invalid multiplicity combination - * 0..1";
         $actual = null;
 
         try {
@@ -652,7 +652,7 @@ 
 
     public function testAddComplexType()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
 
         $name = "Name";
         $accessType = "Public";
@@ -664,7 +664,7 @@ 
         $result = $metadataManager->addComplexType($name, $accessType, $summary, $longDescription);
 
         $newCount = count($metadataManager->getEdmx()->getDataServiceType()->getSchema()[0]->getComplexType());
-        $this->assertEquals($oldCount+1, $newCount);
+        $this->assertEquals($oldCount + 1, $newCount);
         $this->assertNotNull($result);
         $this->assertTrue($result instanceof TComplexTypeType, get_class($result));
         $this->assertNotNull($result->getDocumentation());
@@ -672,7 +672,7 @@ 
 
     public function testAddComplexTypeWithOnlySummary()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
 
         $name = "Name";
         $accessType = "Public";
@@ -684,7 +684,7 @@ 
         $result = $metadataManager->addComplexType($name, $accessType, $summary, $longDescription);
 
         $newCount = count($metadataManager->getEdmx()->getDataServiceType()->getSchema()[0]->getComplexType());
-        $this->assertEquals($oldCount+1, $newCount);
+        $this->assertEquals($oldCount + 1, $newCount);
         $this->assertNotNull($result);
         $this->assertTrue($result instanceof TComplexTypeType, get_class($result));
         $this->assertNull($result->getDocumentation());
@@ -692,7 +692,7 @@ 
 
     public function testAddComplexTypeWithOnlyDescription()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
 
         $name = "Name";
         $accessType = "Public";
@@ -704,7 +704,7 @@ 
         $result = $metadataManager->addComplexType($name, $accessType, $summary, $longDescription);
 
         $newCount = count($metadataManager->getEdmx()->getDataServiceType()->getSchema()[0]->getComplexType());
-        $this->assertEquals($oldCount+1, $newCount);
+        $this->assertEquals($oldCount + 1, $newCount);
         $this->assertNotNull($result);
         $this->assertTrue($result instanceof TComplexTypeType, get_class($result));
         $this->assertNull($result->getDocumentation());
@@ -715,7 +715,7 @@ 
         $expected = "Default value cannot be object or array";
         $actual = null;
 
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
         $complex = m::mock(TComplexTypeType::class);
         $name = "name";
         $type = "type";
@@ -734,7 +734,7 @@ 
         $expected = "Default value cannot be object or array";
         $actual = null;
 
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
         $complex = m::mock(TComplexTypeType::class);
         $name = "name";
         $type = "type";
@@ -750,7 +750,7 @@ 
 
     public function testAddPropertyToComplexTypeDefaultValueBoolean()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
         $complex = m::mock(TComplexTypeType::class);
         $complex->shouldReceive('addToProperty')
             ->with(m::type(TComplexTypePropertyType::class))->andReturnNull()->once();
@@ -776,7 +776,7 @@ 
 
     public function testAddPropertyToComplexTypeDefaultValueBooleanOnlySummary()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
         $complex = m::mock(TComplexTypeType::class);
         $complex->shouldReceive('addToProperty')
             ->with(m::type(TComplexTypePropertyType::class))->andReturnNull()->once();
@@ -803,7 +803,7 @@ 
 
     public function testAddPropertyToComplexTypeDefaultValueBooleanOnlyDescription()
     {
-        list(, $metadataManager, , ) = $this->setUpMetadataForNavTests();
+        list(, $metadataManager,,) = $this->setUpMetadataForNavTests();
         $complex = m::mock(TComplexTypeType::class);
         $complex->shouldReceive('addToProperty')
             ->with(m::type(TComplexTypePropertyType::class))->andReturnNull()->once();
@@ -922,7 +922,7 @@ 
         $longDescription = new TTextType();
 
         $metadataManager = new MetadataManager();
-        list($result, ) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
+        list($result,) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
         $this->assertNotNull($result->getDocumentation());
     }
 
@@ -934,7 +934,7 @@ 
         $longDescription = null;
 
         $metadataManager = new MetadataManager();
-        list($result, ) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
+        list($result,) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
         $this->assertNull($result->getDocumentation());
     }
 
@@ -946,7 +946,7 @@ 
         $longDescription = new TTextType();
 
         $metadataManager = new MetadataManager();
-        list($result, ) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
+        list($result,) = $metadataManager->addEntityType($name, $accessType, $summary, $longDescription);
         $this->assertNull($result->getDocumentation());
     }