From 9e6e2de71eaed34dcfb5be0deb974412706aba48 Mon Sep 17 00:00:00 2001
From: Marcus Moore <contact@marcusmoore.io>
Date: Mon, 5 Feb 2024 12:49:29 -0800
Subject: [PATCH] Add docblock

---
 app/Models/Company.php | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/app/Models/Company.php b/app/Models/Company.php
index c3a2fdae7..60a8022ed 100644
--- a/app/Models/Company.php
+++ b/app/Models/Company.php
@@ -113,6 +113,14 @@ final class Company extends SnipeModel
         }
     }
 
+    /**
+     * Get the company id for the current user taking into
+     * account the full multiple company support setting
+     * and if the current user is a super user.
+     *
+     * @param $unescaped_input
+     * @return int|mixed|string|null
+     */
     public static function getIdForCurrentUser($unescaped_input)
     {
         if (! static::isFullMultipleCompanySupportEnabled()) {