OHRM5X-1959: Develop ClaimRequest getAll API #1656
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
March 28, 2023 06:03
ManulMax
suggested changes
Mar 31, 2023
src/plugins/orangehrmClaimPlugin/Api/EmployeeClaimRequestAPI.php
Outdated
Show resolved
Hide resolved
src/plugins/orangehrmClaimPlugin/Api/EmployeeClaimRequestAPI.php
Outdated
Show resolved
Hide resolved
src/plugins/orangehrmClaimPlugin/Api/Model/MyClaimRequestModel.php
Outdated
Show resolved
Hide resolved
src/plugins/orangehrmClaimPlugin/Api/Model/EmployeeClaimRequestModel.php
Show resolved
Hide resolved
src/plugins/orangehrmClaimPlugin/Api/Model/MyClaimRequestModel.php
Outdated
Show resolved
Hide resolved
RajithaKumara
approved these changes
Apr 10, 2023
Comment on lines
66
to
79
| public const PARAMETER_CLAIM_EVENT_ID = 'claimEventId'; | ||
| public const PARAMETER_CURRENCY_ID = 'currencyId'; | ||
| public const PARAMETER_REMARKS = 'remarks'; | ||
| public const REMARKS_MAX_LENGTH = 1000; | ||
| public const PARAMETER_ALLOWED_ACTIONS = 'allowedActions'; | ||
| public const PARAMETER_EMPLOYEE_NUMBER = 'empNumber'; | ||
| public const PARAMETER_REFERENCE_ID = 'referenceId'; | ||
| public const PARAMETER_EVENT_ID = 'eventId'; | ||
| public const PARAMETER_STATUS = 'status'; | ||
| public const PARAMETER_FROM_DATE = 'fromDate'; | ||
| public const PARAMETER_TO_DATE = 'toDate'; | ||
| public const ACTIONABLE_STATES_MAP = [ | ||
| WorkflowStateMachine::CLAIM_ACTION_SUBMIT => 'SUBMIT', | ||
| WorkflowStateMachine::CLAIM_ACTION_APPROVE => 'APPROVE', |
There was a problem hiding this comment.
public const PARAMETER_CLAIM_EVENT_ID = 'claimEventId';
public const PARAMETER_CURRENCY_ID = 'currencyId';
public const PARAMETER_REMARKS = 'remarks';
public const PARAMETER_ALLOWED_ACTIONS = 'allowedActions';
public const PARAMETER_EMPLOYEE_NUMBER = 'empNumber';
public const PARAMETER_REFERENCE_ID = 'referenceId';
public const PARAMETER_EVENT_ID = 'eventId';
public const PARAMETER_STATUS = 'status';
public const PARAMETER_FROM_DATE = 'fromDate';
public const PARAMETER_TO_DATE = 'toDate';
public const REMARKS_MAX_LENGTH = 1000;
public const ACTIONABLE_STATES_MAP = [
WorkflowStateMachine::CLAIM_ACTION_SUBMIT => 'SUBMIT',
WorkflowStateMachine::CLAIM_ACTION_APPROVE => 'APPROVE',
WorkflowStateMachine::CLAIM_ACTION_PAY => 'PAY',
WorkflowStateMachine::CLAIM_ACTION_CANCEL => 'CANCEL',
WorkflowStateMachine::CLAIM_ACTION_REJECT => 'REJECT'
];prefer if you can organize
| @@ -56,13 +61,19 @@ class EmployeeClaimRequestAPI extends Endpoint implements CrudEndpoint | |||
| use AuthUserTrait; | |||
| use NormalizerServiceTrait; | |||
| use UserRoleManagerTrait; | |||
| use EmployeeServiceTrait; | |||
|
|
|||
| public const PARAMETER_CLAIM_EVENT_ID = 'claimEventId'; | |||
| public const PARAMETER_CURRENCY_ID = 'currencyId'; | |||
| public const PARAMETER_REMARKS = 'remarks'; | |||
| public const REMARKS_MAX_LENGTH = 1000; | |||
| public const PARAMETER_ALLOWED_ACTIONS = 'allowedActions'; | |||
| public const PARAMETER_EMPLOYEE_NUMBER = 'empNumber'; | |||
There was a problem hiding this comment.
can use from common params
| } | ||
|
|
||
| /** | ||
| * @param array $claimRequests |
There was a problem hiding this comment.
Suggested change
| * @param array $claimRequests | |
| * @param ClaimRequest[] $claimRequests |
🤔
Comment on lines
+354
to
+356
| if (!$this->isSelfByEmpNumber($empNumber)) { | ||
| throw $this->getForbiddenException(); | ||
| } |
Comment on lines
+390
to
+401
| $claimRequestSearchFilterParams->setFromDate( | ||
| $this->getRequestParams()->getDateTimeOrNull( | ||
| RequestParams::PARAM_TYPE_QUERY, | ||
| self::PARAMETER_FROM_DATE | ||
| ) | ||
| ); | ||
| $claimRequestSearchFilterParams->setToDate( | ||
| $this->getRequestParams()->getDateTimeOrNull( | ||
| RequestParams::PARAM_TYPE_QUERY, | ||
| self::PARAMETER_TO_DATE | ||
| ) | ||
| ); |
There was a problem hiding this comment.
any idea to validate toDate > fromDate
| } | ||
|
|
||
| /** | ||
| * @param array|null $empNumbers |
There was a problem hiding this comment.
Suggested change
| * @param array|null $empNumbers | |
| * @param int[]|null $empNumbers |
| @@ -118,11 +113,11 @@ class ClaimRequest | |||
| private DateTime $createdDate; | |||
|
|
|||
| /** | |||
| * @var DateTime | |||
| * @var DateTime|null | |||
| * | |||
| * @ORM\Column(name="submitted_date", type="datetime") | |||
There was a problem hiding this comment.
Suggested change
| * @ORM\Column(name="submitted_date", type="datetime") | |
| * @ORM\Column(name="submitted_date", type="datetime", nullable=true) |
| $claimExpenseSearchFilterParams = new ClaimExpenseSearchFilterParams(); | ||
| $claimExpenseSearchFilterParams->setRequestId($requestId); | ||
| $totalExpense = $this->getClaimService()->getClaimDao()->getClaimExpenseTotal($claimExpenseSearchFilterParams); | ||
| if (is_null($totalExpense)) { |
There was a problem hiding this comment.
is this covered by unit tests?
| /** | ||
| * @return float | ||
| */ | ||
| public function getTotalExpense(): float |
There was a problem hiding this comment.
is there any other way to improve this. since if you have 50 items in API response then, this will call 50 times
| "referenceId": "202301170000009", | ||
| "claimEvent": { | ||
| "id": 3, | ||
| "name": "Travel Expenses" |
There was a problem hiding this comment.
need to check whether we need claim event status also in the response
RajithaKumara
pushed a commit
to RajithaKumara/orangehrm
that referenced
this pull request
May 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.