Merge pull request #6 from mbrueggemann/fix-return-type-in-docblock

fixed missing backslash
JeffreyHyer · Dec 11, 2019 · 0409c39 · 0409c39
2 parents bdf8bea + ebeada0
commit 0409c39
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 49 deletions.
diff --git a/src/Api/Benefits.php b/src/Api/Benefits.php
@@ -15,7 +15,7 @@ class Benefits extends AbstractApi
      *
      * @param string $benefitCoverageId [Optional]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitCoverages($benefitCoverageId = null)
     {
@@ -29,7 +29,7 @@ public function getBenefitCoverages($benefitCoverageId = null)
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getEmployeeDependents($employeeId = null)
     {
@@ -44,7 +44,7 @@ public function getEmployeeDependents($employeeId = null)
      * @param string $dependentId
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function updateEmployeeDependent($dependentId, $data = array())
     {
@@ -56,7 +56,7 @@ public function updateEmployeeDependent($dependentId, $data = array())
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addEmployeeDependent($data)
     {
@@ -68,7 +68,7 @@ public function addEmployeeDependent($data)
      *
      * @param string $planId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitPlans($planId = null)
     {
@@ -83,7 +83,7 @@ public function getBenefitPlans($planId = null)
      * @param string $planId
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function updateBenefitPlan($planId, $data)
     {
@@ -95,7 +95,7 @@ public function updateBenefitPlan($planId, $data)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addBenefitPlan($data)
     {
@@ -107,7 +107,7 @@ public function addBenefitPlan($data)
      *
      * @param string $id [Optional]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitPlanCoverages($id)
     {
@@ -122,7 +122,7 @@ public function getBenefitPlanCoverages($id)
      * @param string $id
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function updateBenefitPlanCoverage($id, $data)
     {
@@ -145,7 +145,7 @@ public function addBenefitPlanCoverage($data)
      *
      * @param string $id
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitGroup($id = null)
     {
@@ -160,7 +160,7 @@ public function getBenefitGroup($id = null)
      * @param string $id
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function updateBenefitGroup($id, $data)
     {
@@ -172,7 +172,7 @@ public function updateBenefitGroup($id, $data)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addBenefitGroup($data)
     {
@@ -184,7 +184,7 @@ public function addBenefitGroup($data)
      *
      * @param string $id [Optional]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitGroupEmployees($id = null)
     {
@@ -198,7 +198,7 @@ public function getBenefitGroupEmployees($id = null)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addBenefitGroupEmployee($data)
     {
@@ -210,7 +210,7 @@ public function addBenefitGroupEmployee($data)
      *
      * @param string $id [Optional]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitGroupPlans($id)
     {
@@ -224,7 +224,7 @@ public function getBenefitGroupPlans($id)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addBenefitGroupPlan($data)
     {
@@ -236,7 +236,7 @@ public function addBenefitGroupPlan($data)
      *
      * @param string $id
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitGroupPlanCosts($id = null)
     {
@@ -250,7 +250,7 @@ public function getBenefitGroupPlanCosts($id = null)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addBenefitGroupPlanCost($data)
     {
@@ -263,7 +263,7 @@ public function addBenefitGroupPlanCost($data)
      * @param string $planId
      * @param string $employeeId [Optional]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getEmployeeDeductionsByBenefitPlan($planId, $employeeId = null)
     {
@@ -275,7 +275,7 @@ public function getEmployeeDeductionsByBenefitPlan($planId, $employeeId = null)
      *
      * @param string $id Employee ID
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getPlanDeductionsByEmployee($id)
     {
@@ -287,7 +287,7 @@ public function getPlanDeductionsByEmployee($id)
      *
      * @param string $id
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getBenefitDeductionsForEmployee($id)
     {

diff --git a/src/Api/Company.php b/src/Api/Company.php
@@ -8,7 +8,7 @@ class Company extends AbstractApi
     /**
      * Get a list of files and categories associated with the company
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function files()
     {
@@ -20,7 +20,7 @@ public function files()
      *
      * @param string $category
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addFileCategory($category)
     {
@@ -35,7 +35,7 @@ public function addFileCategory($category)
      * @param string $fileId
      * @param array $data ['name' => string, 'categoryId' => integer, 'shareWithEmployee' => 'yes|no']
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function updateFile($fileId, array $data)
     {
@@ -63,7 +63,7 @@ public function updateFile($fileId, array $data)
      *
      * @param string $fileId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function deleteFile($fileId)
     {
@@ -75,7 +75,7 @@ public function deleteFile($fileId)
      *
      * @param string $fileId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function downloadFile($fileId)
     {
@@ -87,7 +87,7 @@ public function downloadFile($fileId)
      *
      * @param array $data
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function uploadFile(array $data)
     {

diff --git a/src/Api/Employees.php b/src/Api/Employees.php
@@ -275,7 +275,7 @@ public function uploadFile($id, array $data)
      *
      * @param array $data [[_employee_], ...]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function import(array $data)
     {

diff --git a/src/Api/Metadata.php b/src/Api/Metadata.php
@@ -13,7 +13,7 @@ class Metadata extends AbstractApi
     /**
      * Get a list of fields
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function fields()
     {
@@ -23,7 +23,7 @@ public function fields()
     /**
      * Get a list of tabular fields
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function tables()
     {
@@ -33,7 +33,7 @@ public function tables()
     /**
      * Get the details for "list" fields
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function lists()
     {
@@ -46,7 +46,7 @@ public function lists()
      * @param string $listId
      * @param array $options [['id' => string (optional), 'archived' => 'yes|no' (optional), 'value' => string (required)], ...]
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addEditList($listId, array $options)
     {
@@ -74,7 +74,7 @@ public function addEditList($listId, array $options)
     /**
      * Get a list of time off types
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function timeOffTypes()
     {
@@ -84,7 +84,7 @@ public function timeOffTypes()
     /**
      * Get a list of time off policies
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function timeOffPolicies()
     {
@@ -94,7 +94,7 @@ public function timeOffPolicies()
     /**
      * Get a list of users
      *
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function users()
     {

diff --git a/src/Api/Payroll.php b/src/Api/Payroll.php
@@ -68,7 +68,7 @@ public function addDirectDeposit($employeeId, $ddInfo = array())
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getDirectDeposit($employeeId)
     {
@@ -80,7 +80,7 @@ public function getDirectDeposit($employeeId)
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function clearDirectDeposit($employeeId)
     {
@@ -93,7 +93,7 @@ public function clearDirectDeposit($employeeId)
      * @param string $employeeId
      * @param array $stubs
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addUnpaidPayStubs($employeeId, $stubs = array())
     {
@@ -105,7 +105,7 @@ public function addUnpaidPayStubs($employeeId, $stubs = array())
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getUnpaidPayStubs($employeeId)
     {
@@ -117,7 +117,7 @@ public function getUnpaidPayStubs($employeeId)
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function clearUnpaidPayStubs($employeeId)
     {
@@ -130,7 +130,7 @@ public function clearUnpaidPayStubs($employeeId)
      * @param string $employeeId
      * @param array $stub
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function addPayStub($employeeId, $stub = array())
     {
@@ -142,7 +142,7 @@ public function addPayStub($employeeId, $stub = array())
      *
      * @param string $recordId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getPayStub($recordId)
     {
@@ -154,7 +154,7 @@ public function getPayStub($recordId)
      *
      * @param string $recordId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function deletePayStub($recordId)
     {
@@ -166,7 +166,7 @@ public function deletePayStub($recordId)
      *
      * @param string $employeeId
      * 
-     * @return BambooHR\Api\Response
+     * @return \BambooHR\Api\Response
      */
     public function getPayrollDeductions($employeeId)
     {