Deprecated omitWhenNotIncluded

CHANGELOG.md

@@ -12,6 +12,11 @@ FIXED:
 
 ## 3.1.1 - 2019-04-05
 
+DEPRECATED:
+
+- `ToOneRelationship::omitWhenNotIncluded()`: Use `ToOneRelationship::omitDataWhenNotIncluded()`
+- `ToManyRelationship::omitWhenNotIncluded()`: Use `ToManyRelationship::omitDataWhenNotIncluded()`
+
 FIXED:
 
 - [#82](https://github.com/woohoolabs/yin/pull/82): Fix output for ToOneRelationship when the relationship doesn't contain any keys

README.md

@@ -837,14 +837,14 @@ public function getRelationships($user): array
             return
                 ToManyRelationship::create()
                     ->setData($user["contacts"], $this->contactTransformer)
-                    ->omitWhenNotIncluded()
+                    ->omitDataWhenNotIncluded()
                 ;
         }
     ];
 }
 ```
 
-With usage of the `omitWhenNotIncluded()` method, the relationship data will be omitted when the relationship is not
+By using the `omitDataWhenNotIncluded()` method, the relationship data will be omitted when the relationship is not
 included. However, sometimes this optimization is not enough on its own. Even though we can save bandwidth with the prior
 technique, the relationship still has to be loaded from the data source (probably from a database), because we pass it
 to the relationship object with the `setData()` method.
@@ -866,7 +866,7 @@ public function getRelationships($user): array
                         },
                         $this->contactTransformer
                     )
-                    ->omitWhenNotIncluded()
+                    ->omitDataWhenNotIncluded()
                 ;
         }
     ];

examples/Book/JsonApi/Resource/BookResourceTransformer.php

@@ -170,7 +170,7 @@ public function getRelationships($book): array
                             )
                         )
                         ->setData($book["publisher"], $this->publisherTransformer)
-                        ->omitWhenNotIncluded()
+                        ->omitDataWhenNotIncluded()
                     ;
             }
         ];

examples/User/JsonApi/Resource/UserResourceTransformer.php

@@ -127,7 +127,7 @@ public function getRelationships($user): array
                         ->setDataAsCallable(function () use ($user) {
                             return $user["contacts"];
                         }, $this->contactTransformer)
-                        ->omitWhenNotIncluded()
+                        ->omitDataWhenNotIncluded()
                     ;
             }
         ];

src/JsonApi/Schema/Relationship/AbstractRelationship.php

@@ -117,6 +117,15 @@ public function setDataAsCallable(callable $data, ResourceInterface $resourceTra
     /**
      * @return $this
      */
+    public function omitDataWhenNotIncluded()
+    {
+        return $this->omitWhenNotIncluded();
+    }
+
+    /**
+     * @deprecated since 3.1.1, will be removed in 4.0.0. Use omitDataWhenNotIncluded() instead.
+     * @return $this
+     */
     public function omitWhenNotIncluded()
     {
         $this->omitDataWhenNotIncluded = true;

tests/JsonApi/Double/FakeRelationship.php

@@ -24,7 +24,7 @@ public function getRetrieveData()
         return $this->retrieveData();
     }
 
-    public function isOmitWhenNotIncluded(): bool
+    public function isOmitDataWhenNotIncluded(): bool
     {
         return $this->omitDataWhenNotIncluded;
     }

tests/JsonApi/Schema/Relationship/AbstractRelationshipTest.php

@@ -53,7 +53,7 @@ public function dataNotOmittedWhenNotIncludedByDefault()
     {
         $relationship = $this->createRelationship();
 
-        $this->assertFalse($relationship->isOmitWhenNotIncluded());
+        $this->assertFalse($relationship->isOmitDataWhenNotIncluded());
     }
 
     /**
@@ -63,8 +63,8 @@ public function omitDataWhenNotIncluded()
     {
         $relationship = $this->createRelationship();
 
-        $relationship->omitWhenNotIncluded();
-        $this->assertTrue($relationship->isOmitWhenNotIncluded());
+        $relationship->omitDataWhenNotIncluded();
+        $this->assertTrue($relationship->isOmitDataWhenNotIncluded());
     }
 
     /**