Add return types to repository behavior methods [WEB-2961]

art-institute-of-chicago · Dec 9, 2024 · 7be994b · 7be994b
1 parent a9c2a09
commit 7be994b
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 15 deletions.
diff --git a/app/Libraries/Api/Models/BaseApiModel.php b/app/Libraries/Api/Models/BaseApiModel.php
@@ -328,7 +328,7 @@ public function setAppends(array $appends)
      *
      * @return array
      */
-    public function getFillable()
+    public function getFillable(): array
     {
         return $this->fillable;
     }

diff --git a/app/Repositories/Behaviors/Handle3DModel.php b/app/Repositories/Behaviors/Handle3DModel.php
@@ -37,7 +37,7 @@ private function handle3DModel($object, $fields, $fieldName = 'aic_3d_model')
         }
     }
 
-    private function getFormFieldsFor3DModel($object, $fields, $fieldName = 'aic_3d_model')
+    private function getFormFieldsFor3DModel($object, $fields, $fieldName = 'aic_3d_model'): array
     {
         // Render the 3d model field in repeater block
         if (

diff --git a/app/Repositories/Behaviors/HandleApiBlocks.php b/app/Repositories/Behaviors/HandleApiBlocks.php
@@ -9,7 +9,7 @@
 
 trait HandleApiBlocks
 {
-    protected function getBlockBrowsers($block)
+    protected function getBlockBrowsers($block): array
     {
         return collect($block['content']['browsers'])->mapWithKeys(function ($ids, $relation) use ($block) {
             try {

diff --git a/app/Repositories/Behaviors/HandleApiBrowsers.php b/app/Repositories/Behaviors/HandleApiBrowsers.php
@@ -28,14 +28,14 @@ protected function getApiBrowsers()
         })->values();
     }
 
-    public function afterSaveHandleApiBrowsers($object, $fields)
+    public function afterSaveHandleApiBrowsers($object, $fields): void
     {
         foreach ($this->getApiBrowsers() as $browser) {
             $this->updateBrowserApiRelated($object, $fields, $browser['browserName']);
         }
     }
 
-    public function getFormFieldsHandleApiBrowsers($object, $fields)
+    public function getFormFieldsHandleApiBrowsers($object, $fields): array
     {
         foreach ($this->getApiBrowsers() as $browser) {
             $fields['browsers'][$browser['browserName']] = $this->getFormFieldsForBrowserApi($object, $browser['relation'], $browser['model'], $browser['routePrefix'], $browser['titleKey'], $browser['moduleName']);

diff --git a/app/Repositories/Behaviors/HandleApiRelations.php b/app/Repositories/Behaviors/HandleApiRelations.php
@@ -14,7 +14,7 @@ trait HandleApiRelations
      * and it creates new models per each new relation as we don't have both ends of the polymorphic relation
      * This is done this way so we can reuse the same functions and table for all API browsers.
      */
-    public function updateBrowserApiRelated($object, $fields, $relationship, $positionAttribute = 'position')
+    public function updateBrowserApiRelated($object, $fields, $relationship, $positionAttribute = 'position'): void
     {
         $relatedElementsWithPosition = [];
 
@@ -40,7 +40,7 @@ public function updateBrowserApiRelated($object, $fields, $relationship, $positi
         $object->{$relationship}()->attach($relatedElementsWithPosition);
     }
 
-    public function updateMultiBrowserApiRelated($object, $fields, $relationship, $typeUsesApi)
+    public function updateMultiBrowserApiRelated($object, $fields, $relationship, $typeUsesApi): void
     {
         // WEB-2272: check if we dont leave some stale data in database by not deleting apiElements
         // Remove all associations
@@ -87,7 +87,7 @@ public function updateMultiBrowserApiRelated($object, $fields, $relationship, $t
      * This way we don't have to redesign the browser.
      *
      */
-    public function getFormFieldsForBrowserApi($object, $relation, $apiModel, $routePrefix = null, $titleKey = 'title', $moduleName = null)
+    public function getFormFieldsForBrowserApi($object, $relation, $apiModel, $routePrefix = null, $titleKey = 'title', $moduleName = null): array
     {
         // Get all datahub_id's
         $ids = $object->{$relation}->pluck('datahub_id')->toArray();
@@ -127,7 +127,7 @@ public function getFormFieldsForBrowserApi($object, $relation, $apiModel, $route
         })->values()->toArray();
     }
 
-    public function getFormFieldsForMultiBrowserApi($object, $browser_name, $apiModelsDefinitions, $typeUsesApi)
+    public function getFormFieldsForMultiBrowserApi($object, $browser_name, $apiModelsDefinitions, $typeUsesApi): array
     {
         $results = collect();
 

diff --git a/app/Repositories/Behaviors/HandleAuthors.php b/app/Repositories/Behaviors/HandleAuthors.php
@@ -4,12 +4,12 @@
 
 trait HandleAuthors
 {
-    public function afterSaveHandleAuthors($object, $fields)
+    public function afterSaveHandleAuthors($object, $fields): void
     {
         $this->updateBrowser($object, $fields, 'authors');
     }
 
-    public function getFormFieldsHandleAuthors($object, $fields)
+    public function getFormFieldsHandleAuthors($object, $fields): array
     {
         $fields['browsers']['authors'] = $this->getFormFieldsForBrowser($object, 'authors', 'collection');
 

diff --git a/app/Repositories/Behaviors/HandleExperienceModule.php b/app/Repositories/Behaviors/HandleExperienceModule.php
@@ -9,7 +9,7 @@
 
 trait HandleExperienceModule
 {
-    public function updateExperienceModule($object, $fields, $relation, $model = null, $fieldName = null)
+    public function updateExperienceModule($object, $fields, $relation, $model = null, $fieldName = null): void
     {
         if ($model === 'ExperienceImage') {
             $morphKey = 'imagable';
@@ -76,7 +76,7 @@ public function updateExperienceModule($object, $fields, $relation, $model = nul
         }
     }
 
-    public function getExperienceModule($object, $fields, $relation, $model = null, $fieldName = null)
+    public function getExperienceModule($object, $fields, $relation, $model = null, $fieldName = null): array
     {
         $repeaters = [];
         $repeatersFields = [];

diff --git a/app/Repositories/Behaviors/HandleFeaturedRelated.php b/app/Repositories/Behaviors/HandleFeaturedRelated.php
@@ -7,7 +7,7 @@
  */
 trait HandleFeaturedRelated
 {
-    public function afterSaveHandleFeaturedRelated($object, $fields)
+    public function afterSaveHandleFeaturedRelated($object, $fields): void
     {
         $this->updateMultiBrowserApiRelated($object, $fields, 'sidebar_items', [
             'articles' => false,
@@ -21,7 +21,7 @@ public function afterSaveHandleFeaturedRelated($object, $fields)
         ]);
     }
 
-    public function getFormFieldsHandleFeaturedRelated($object, $fields)
+    public function getFormFieldsHandleFeaturedRelated($object, $fields): array
     {
         $fields['browsers']['sidebar_items'] = $this->getFormFieldsForMultiBrowserApi($object, 'sidebar_items', [
             'exhibitions' => [
-Original file line number
+Diff line change
@@ Expand Up @@
             }
         }
-        private function getFormFieldsFor3DModel($object, $fields, $fieldName = 'aic_3d_model')
+        private function getFormFieldsFor3DModel($object, $fields, $fieldName = 'aic_3d_model'): array
         {
             // Render the 3d model field in repeater block
             if (
@@ Expand Down @@