Merge pull request #1090 from grantholle/default-property-value

Add a default value to getExtraProperty
spatie · Sep 22, 2022 · f9487d7 · f9487d7
2 parents c8e4aa6 + 86fd1d2
commit f9487d7
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 8 deletions.
diff --git a/src/Contracts/Activity.php b/src/Contracts/Activity.php
@@ -13,7 +13,7 @@ public function subject(): MorphTo;
 
     public function causer(): MorphTo;
 
-    public function getExtraProperty(string $propertyName): mixed;
+    public function getExtraProperty(string $propertyName, mixed $defaultValue): mixed;
 
     public function changes(): Collection;
 

diff --git a/src/Models/Activity.php b/src/Models/Activity.php
@@ -71,9 +71,9 @@ public function causer(): MorphTo
         return $this->morphTo();
     }
 
-    public function getExtraProperty(string $propertyName): mixed
+    public function getExtraProperty(string $propertyName, mixed $defaultValue = null): mixed
     {
-        return Arr::get($this->properties->toArray(), $propertyName);
+        return Arr::get($this->properties->toArray(), $propertyName, $defaultValue);
     }
 
     public function changes(): Collection

diff --git a/tests/ActivityLoggerTest.php b/tests/ActivityLoggerTest.php
@@ -157,6 +157,7 @@
 
     expect($firstActivity->properties)->toBeInstanceOf(Collection::class);
     expect($firstActivity->getExtraProperty('key'))->toEqual('value');
+    expect($firstActivity->getExtraProperty('non_existant', 'default value'))->toEqual('default value');
 });
 
 it('can translate a given causer id to an object', function () {

diff --git a/tests/Models/Activity.php b/tests/Models/Activity.php
@@ -40,9 +40,9 @@ public function causer(): MorphTo
         return $this->morphTo();
     }
 
-    public function getExtraProperty(string $propertyName): mixed
+    public function getExtraProperty(string $propertyName, mixed $defaultValue = null): mixed
     {
-        return Arr::get($this->properties->toArray(), $propertyName);
+        return Arr::get($this->properties->toArray(), $propertyName, $defaultValue);
     }
 
     public function changes(): Collection

diff --git a/tests/Models/AnotherInvalidActivity.php b/tests/Models/AnotherInvalidActivity.php
@@ -42,12 +42,12 @@ public function causer(): MorphTo
      * Get the extra properties with the given name.
      *
      * @param string $propertyName
-     *
+     * @param mixed $defaultValue
      * @return mixed
      */
-    public function getExtraProperty(string $propertyName): mixed
+    public function getExtraProperty(string $propertyName, mixed $defaultValue = null): mixed
     {
-        return Arr::get($this->properties->toArray(), $propertyName);
+        return Arr::get($this->properties->toArray(), $propertyName, $defaultValue);
     }
 
     public function changes(): Collection