|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * OrangeHRM is a comprehensive Human Resource Management (HRM) System that captures |
| 4 | + * all the essential functionalities required for any enterprise. |
| 5 | + * Copyright (C) 2006 OrangeHRM Inc., http://www.orangehrm.com |
| 6 | + * |
| 7 | + * OrangeHRM is free software; you can redistribute it and/or modify it under the terms of |
| 8 | + * the GNU General Public License as published by the Free Software Foundation; either |
| 9 | + * version 2 of the License, or (at your option) any later version. |
| 10 | + * |
| 11 | + * OrangeHRM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| 12 | + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| 13 | + * See the GNU General Public License for more details. |
| 14 | + * |
| 15 | + * You should have received a copy of the GNU General Public License along with this program; |
| 16 | + * if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 17 | + * Boston, MA 02110-1301, USA |
| 18 | + */ |
| 19 | + |
| 20 | +namespace OrangeHRM\Leave\Api; |
| 21 | + |
| 22 | +use OrangeHRM\Core\Api\CommonParams; |
| 23 | +use OrangeHRM\Core\Api\V2\CollectionEndpoint; |
| 24 | +use OrangeHRM\Core\Api\V2\Endpoint; |
| 25 | +use OrangeHRM\Core\Api\V2\EndpointCollectionResult; |
| 26 | +use OrangeHRM\Core\Api\V2\EndpointResult; |
| 27 | +use OrangeHRM\Core\Api\V2\Model\ArrayModel; |
| 28 | +use OrangeHRM\Core\Api\V2\ParameterBag; |
| 29 | +use OrangeHRM\Core\Api\V2\RequestParams; |
| 30 | +use OrangeHRM\Core\Api\V2\Validator\ParamRule; |
| 31 | +use OrangeHRM\Core\Api\V2\Validator\ParamRuleCollection; |
| 32 | +use OrangeHRM\Core\Api\V2\Validator\Rule; |
| 33 | +use OrangeHRM\Core\Api\V2\Validator\Rules; |
| 34 | +use OrangeHRM\Core\Traits\Auth\AuthUserTrait; |
| 35 | +use OrangeHRM\Leave\Dto\LeaveTypeSearchFilterParams; |
| 36 | +use OrangeHRM\Leave\Entitlement\LeaveBalance; |
| 37 | +use OrangeHRM\Leave\Traits\Service\LeaveEntitlementServiceTrait; |
| 38 | +use OrangeHRM\Leave\Traits\Service\LeavePeriodServiceTrait; |
| 39 | +use OrangeHRM\Leave\Traits\Service\LeaveRequestServiceTrait; |
| 40 | +use OrangeHRM\Leave\Traits\Service\LeaveTypeServiceTrait; |
| 41 | + |
| 42 | +class EmployeeLeaveBalanceAPI extends Endpoint implements CollectionEndpoint |
| 43 | +{ |
| 44 | + use LeaveEntitlementServiceTrait; |
| 45 | + use LeaveRequestServiceTrait; |
| 46 | + use LeavePeriodServiceTrait; |
| 47 | + use LeaveTypeServiceTrait; |
| 48 | + use AuthUserTrait; |
| 49 | + |
| 50 | + /** |
| 51 | + * @inheritDoc |
| 52 | + */ |
| 53 | + public function getAll(): EndpointResult |
| 54 | + { |
| 55 | + $empNumber = $this->getRequestParams()->getInt( |
| 56 | + RequestParams::PARAM_TYPE_QUERY, |
| 57 | + CommonParams::PARAMETER_EMP_NUMBER, |
| 58 | + $this->getAuthUser()->getEmpNumber() |
| 59 | + ); |
| 60 | + |
| 61 | + if (!$this->getRequestParams()->has(RequestParams::PARAM_TYPE_QUERY, LeaveCommonParams::PARAMETER_FROM_DATE) || |
| 62 | + !$this->getRequestParams()->has(RequestParams::PARAM_TYPE_QUERY, LeaveCommonParams::PARAMETER_TO_DATE)) { |
| 63 | + $currentLeavePeriod = $this->getLeavePeriodService()->getCurrentLeavePeriod(); |
| 64 | + $fromDate = $this->getRequestParams()->getDateTime( |
| 65 | + RequestParams::PARAM_TYPE_QUERY, |
| 66 | + LeaveCommonParams::PARAMETER_FROM_DATE, |
| 67 | + null, |
| 68 | + $currentLeavePeriod->getStartDate() |
| 69 | + ); |
| 70 | + $toDate = $this->getRequestParams()->getDateTime( |
| 71 | + RequestParams::PARAM_TYPE_QUERY, |
| 72 | + LeaveCommonParams::PARAMETER_TO_DATE, |
| 73 | + null, |
| 74 | + $currentLeavePeriod->getEndDate() |
| 75 | + ); |
| 76 | + } else { |
| 77 | + $fromDate = $this->getRequestParams()->getDateTime( |
| 78 | + RequestParams::PARAM_TYPE_QUERY, |
| 79 | + LeaveCommonParams::PARAMETER_FROM_DATE, |
| 80 | + ); |
| 81 | + $toDate = $this->getRequestParams()->getDateTime( |
| 82 | + RequestParams::PARAM_TYPE_QUERY, |
| 83 | + LeaveCommonParams::PARAMETER_TO_DATE, |
| 84 | + ); |
| 85 | + } |
| 86 | + |
| 87 | + $leaveTypeSearchFilterParams = new LeaveTypeSearchFilterParams(); |
| 88 | + $this->setSortingAndPaginationParams($leaveTypeSearchFilterParams); |
| 89 | + |
| 90 | + $leaveTypes = $this->getLeaveTypeService() |
| 91 | + ->getLeaveTypeDao() |
| 92 | + ->searchLeaveType($leaveTypeSearchFilterParams); |
| 93 | + $leaveTypeCount = $this->getLeaveTypeService()->getLeaveTypeDao() |
| 94 | + ->getSearchLeaveTypesCount($leaveTypeSearchFilterParams); |
| 95 | + |
| 96 | + $leaveTypeIds = array_unique( |
| 97 | + array_merge( |
| 98 | + $this->getLeaveRequestService() |
| 99 | + ->getLeaveRequestDao() |
| 100 | + ->getUsedLeaveTypeIdsByEmployee($empNumber), |
| 101 | + $this->getLeaveEntitlementService() |
| 102 | + ->getLeaveEntitlementDao() |
| 103 | + ->getLeaveTypeIdsForEntitlementsByEmployee($empNumber) |
| 104 | + ) |
| 105 | + ); |
| 106 | + |
| 107 | + $leaveTypesResult = []; |
| 108 | + foreach ($leaveTypes as $leaveType) { |
| 109 | + $balanceArray = null; |
| 110 | + $balance = null; |
| 111 | + if (in_array($leaveType->getId(), $leaveTypeIds)) { |
| 112 | + $balance = $this->getLeaveEntitlementService() |
| 113 | + ->getLeaveBalance($empNumber, $leaveType->getId(), $fromDate, $toDate); |
| 114 | + $balanceArray = [ |
| 115 | + 'entitled' => $balance->getEntitled(), |
| 116 | + 'used' => $balance->getUsed(), |
| 117 | + 'scheduled' => $balance->getScheduled(), |
| 118 | + 'pending' => $balance->getPending(), |
| 119 | + 'taken' => $balance->getTaken(), |
| 120 | + 'balance' => $balance->getBalance(), |
| 121 | + ]; |
| 122 | + } |
| 123 | + |
| 124 | + $leaveTypeResult = [ |
| 125 | + 'leaveType' => [ |
| 126 | + 'id' => $leaveType->getId(), |
| 127 | + 'name' => $leaveType->getName(), |
| 128 | + 'deleted' => $leaveType->isDeleted(), |
| 129 | + ], |
| 130 | + 'usageBreakdown' => $balanceArray, |
| 131 | + 'fromDate' => $balance instanceof LeaveBalance ? $balance->getYmdAsAtDate() : null, |
| 132 | + 'toDate' => $balance instanceof LeaveBalance ? $balance->getYmdEndDate() : null, |
| 133 | + ]; |
| 134 | + $leaveTypesResult[] = $leaveTypeResult; |
| 135 | + } |
| 136 | + return new EndpointCollectionResult( |
| 137 | + ArrayModel::class, |
| 138 | + $leaveTypesResult, |
| 139 | + new ParameterBag([CommonParams::PARAMETER_TOTAL => $leaveTypeCount]) |
| 140 | + ); |
| 141 | + } |
| 142 | + |
| 143 | + /** |
| 144 | + * @inheritDoc |
| 145 | + */ |
| 146 | + public function getValidationRuleForGetAll(): ParamRuleCollection |
| 147 | + { |
| 148 | + return new ParamRuleCollection( |
| 149 | + $this->getValidationDecorator()->notRequiredParamRule( |
| 150 | + new ParamRule( |
| 151 | + CommonParams::PARAMETER_EMP_NUMBER, |
| 152 | + new Rule(Rules::POSITIVE), |
| 153 | + new Rule(Rules::IN_ACCESSIBLE_EMP_NUMBERS) |
| 154 | + ) |
| 155 | + ), |
| 156 | + ...$this->getSortingAndPaginationParamsRules(LeaveTypeSearchFilterParams::ALLOWED_SORT_FIELDS), |
| 157 | + ); |
| 158 | + } |
| 159 | + |
| 160 | + /** |
| 161 | + * @inheritDoc |
| 162 | + */ |
| 163 | + public function create(): EndpointResult |
| 164 | + { |
| 165 | + throw $this->getNotImplementedException(); |
| 166 | + } |
| 167 | + |
| 168 | + /** |
| 169 | + * @inheritDoc |
| 170 | + */ |
| 171 | + public function getValidationRuleForCreate(): ParamRuleCollection |
| 172 | + { |
| 173 | + throw $this->getNotImplementedException(); |
| 174 | + } |
| 175 | + |
| 176 | + /** |
| 177 | + * @inheritDoc |
| 178 | + */ |
| 179 | + public function delete(): EndpointResult |
| 180 | + { |
| 181 | + throw $this->getNotImplementedException(); |
| 182 | + } |
| 183 | + |
| 184 | + /** |
| 185 | + * @inheritDoc |
| 186 | + */ |
| 187 | + public function getValidationRuleForDelete(): ParamRuleCollection |
| 188 | + { |
| 189 | + throw $this->getNotImplementedException(); |
| 190 | + } |
| 191 | +} |
0 commit comments