/**
* the singleton pattern
*
* @return HumanResources_Controller_FreeDay
*/
public static function getInstance()
{
if (self::$_instance === NULL) {
self::$_instance = new HumanResources_Controller_FreeDay();
}
return self::$_instance;
}
/**
* update to 8.3 normalize contracts to have fields from update_1 set
*/
public function update_2()
{
$c = HumanResources_Controller_FreeTime::getInstance();
$d = HumanResources_Controller_FreeDay::getInstance();
$allC = $c->getAll();
$allD = $d->getAll();
if ($allC->count() > 0) {
try {
$this->promptForUsername();
foreach ($allC as $ct) {
$ct->freedays = $allD->filter('freetime_id', $ct->id)->toArray();
$c->update($ct);
}
} catch (Exception $e) {
// do nothing, update not important
}
}
$this->setApplicationVersion('HumanResources', '8.3');
}
/**
* returns all dates the employee have to work on by contract. the feast days are removed already
* if the period exceeds the contracts' period, the contracts' period will be used.
* freetimes are not respected here, if $respectTakenVacationDays is not set to TRUE
*
* @param HumanResources_Model_Contract|Tinebase_Record_RecordSet $contracts
* @param Tinebase_DateTime $firstDate
* @param Tinebase_DateTime $lastDate
* @param boolean $respectTakenVacationDays
*
* @return array
*/
public function getDatesToWorkOn($contracts, Tinebase_DateTime $firstDate, Tinebase_DateTime $lastDate, $respectTakenVacationDays = FALSE)
{
$contracts = $this->_convertToRecordSet($contracts);
// find out feast days
$feastDays = $this->getFeastDays($contracts, $firstDate, $lastDate);
$freeDayStrings = array();
foreach ($feastDays as $feastDay) {
$freeDayStrings[] = $feastDay->format('Y-m-d');
}
if ($respectTakenVacationDays) {
$vacationTimes = new Tinebase_Record_RecordSet('HumanResources_Model_FreeTime');
foreach ($contracts as $contract) {
$vacationTimes = $vacationTimes->merge($this->getFreeTimes($contract));
}
$filter = new HumanResources_Model_FreeDayFilter(array());
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $vacationTimes->id)));
$vacationDays = HumanResources_Controller_FreeDay::getInstance()->search($filter);
foreach ($vacationDays as $vDay) {
$freeDayStrings[] = $vDay->date->format('Y-m-d');
}
}
$hoursToWorkOn = 0;
$results = array();
$sumHours = 0;
foreach ($contracts as $contract) {
$firstDate = $this->_getFirstDate($contract, $firstDate);
$lastDate = $this->_getLastDate($contract, $lastDate);
$date = clone $firstDate;
$json = $contract->getWorkingTimeJson();
$weekdays = $json->days;
// datetime format w uses day 0 as sunday
$monday = array_pop($weekdays);
array_unshift($weekdays, $monday);
while ($date->isEarlier($lastDate)) {
// if calculated working day is not a feast day, add to days to work on
$ds = $date->format('Y-m-d');
$weekday = $date->format('w');
$hrs = $weekdays[$weekday];
if (!in_array($ds, $freeDayStrings) && $hrs > 0) {
$results[] = clone $date;
$sumHours += $hrs;
}
$date->addDay(1);
}
}
return array('hours' => $sumHours, 'results' => $results);
}
/**
* returns feast days and freedays of an employee for the freetime edit dialog
*
* @param string $_employeeId
* @param integer $_year
* @param string $_freeTimeId
* @param string $_accountId
*/
public function getFeastAndFreeDays($_employeeId, $_year = NULL, $_freeTimeId = NULL, $_accountId = NULL)
{
$cController = HumanResources_Controller_Contract::getInstance();
$eController = HumanResources_Controller_Employee::getInstance();
$aController = HumanResources_Controller_Account::getInstance();
$ftController = HumanResources_Controller_FreeTime::getInstance();
$fdController = HumanResources_Controller_FreeDay::getInstance();
if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) {
Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ . ' $_employeeId ' . $_employeeId . ' $_year ' . $_year . ' $_freeTimeId ' . $_freeTimeId . ' $_accountId ' . $_accountId);
}
// validate employeeId
$employee = $eController->get($_employeeId);
$_freeTimeId = strlen($_freeTimeId) == 40 ? $_freeTimeId : NULL;
// set period to search for
$minDate = Tinebase_DateTime::now()->setTimezone(Tinebase_Core::getUserTimezone())->setTime(0, 0, 0);
if ($_year && !$_freeTimeId) {
$minDate->setDate($_year, 1, 1);
} elseif ($_freeTimeId) {
// if a freetime id is given, take the year of the freetime
$myFreeTime = $ftController->get($_freeTimeId);
$minDate->setDate($myFreeTime->firstday_date->format('Y'), 1, 1);
} else {
$minDate->setDate($minDate->format('Y'), 1, 1);
}
if (!$_accountId) {
// find account
$filter = new HumanResources_Model_AccountFilter(array(array('field' => 'year', 'operator' => 'equals', 'value' => intval($_year))));
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'employee_id', 'operator' => 'equals', 'value' => $_employeeId)));
$account = $aController->search($filter)->getFirstRecord();
} else {
try {
$account = $aController->get($_accountId);
} catch (Exception $e) {
// throws a few lines later: HumanResources_Exception_NoAccount
}
}
if (!$account) {
throw new HumanResources_Exception_NoAccount();
}
$accountYear = $account->year;
$minAccountDate = Tinebase_DateTime::now()->setTimezone(Tinebase_Core::getUserTimezone())->setTime(0, 0, 0);
$minAccountDate->setDate($accountYear, 1, 1);
$maxAccountDate = clone $minAccountDate;
$maxAccountDate->addYear(1)->subSecond(1);
$maxDate = clone $minDate;
$maxDate->addYear(1)->subSecond(1);
// find contracts of the account year
$contracts = $cController->getValidContracts($minAccountDate, $maxAccountDate, $_employeeId);
$contracts->sort('start_date', 'ASC');
if ($contracts->count() < 1) {
throw new HumanResources_Exception_NoContract();
}
$remainingVacation = 0;
$contracts->setTimezone(Tinebase_Core::getUserTimezone());
// find out total amount of vacation days for the different contracts
foreach ($contracts as $contract) {
$remainingVacation += $cController->calculateVacationDays($contract, $minDate, $maxDate);
}
$remainingVacation = round($remainingVacation, 0);
$allVacation = $remainingVacation;
// find contracts of the year in which the vacation days will be taken
$contracts = $cController->getValidContracts($minDate, $maxDate, $_employeeId);
$contracts->sort('start_date', 'ASC');
$excludeDates = array();
if ($contracts->count() < 1) {
throw new HumanResources_Exception_NoContract();
}
$first = TRUE;
$feastDays = array();
$contracts->setTimezone(Tinebase_Core::getUserTimezone());
// find out disabled days for the different contracts
foreach ($contracts as $contract) {
$json = $contract->getWorkingTimeJson();
$startDay = $contract->start_date == NULL ? $minDate : $contract->start_date < $minDate ? $minDate : $contract->start_date;
$stopDay = $contract->end_date == NULL ? $maxDate : $contract->end_date > $maxDate ? $maxDate : $contract->end_date;
if ($first) {
$firstDay = clone $startDay;
$first = FALSE;
}
// find out weekdays to disable
if (is_object($json)) {
foreach ($json->days as $index => $hours) {
$hours = intval($hours);
if ($hours === 0) {
$day = clone $startDay;
$day->setWeekDay($index + 1);
while ($day->compare($stopDay) == -1) {
$exdate = clone $day;
$exdate->setTimezone(Tinebase_Core::getUserTimezone());
$excludeDates[] = $exdate;
$day->addWeek(1);
}
}
}
}
// search feast days
$feastDays = array_merge($cController->getFeastDays($contract, $startDay, $stopDay), $feastDays);
}
// set time to 0
foreach ($feastDays as &$feastDay) {
$feastDay->setTimezone(Tinebase_Core::getUserTimezone())->setTime(0, 0, 0);
}
// search free times for the account and the interval
// prepare free time filter, add employee_id
$freeTimeFilter = new HumanResources_Model_FreeTimeFilter(array(), 'AND');
$freeTimeFilter->addFilter(new Tinebase_Model_Filter_Id(array('field' => 'employee_id', 'operator' => 'equals', 'value' => $_employeeId)));
// don't search for freetimes belonging to the freetime handled itself
if ($_freeTimeId) {
$freeTimeFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'id', 'operator' => 'not', 'value' => $_freeTimeId)));
}
// prepare vacation times filter
$vacationTimesFilter = clone $freeTimeFilter;
$vacationTimesFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'type', 'operator' => 'equals', 'value' => 'vacation')));
// search all vacation times belonging to the account, regardless which interval we want
$accountFreeTimesFilter = clone $vacationTimesFilter;
$accountFreeTimesFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'account_id', 'operator' => 'equals', 'value' => $account->getId())));
$accountVacationTimeIds = $ftController->search($accountFreeTimesFilter)->id;
// search all vacation times for the interval
$fddMin = clone $minDate;
$fddMin->subDay(1);
$fddMax = clone $maxDate;
$fddMax->addDay(1);
$vacationTimesFilter->addFilter(new Tinebase_Model_Filter_Date(array('field' => 'firstday_date', 'operator' => 'after', 'value' => $fddMin)));
$vacationTimesFilter->addFilter(new Tinebase_Model_Filter_Date(array('field' => 'firstday_date', 'operator' => 'before', 'value' => $fddMax)));
$vacationTimes = $ftController->search($vacationTimesFilter);
$acceptedVacationTimes = $vacationTimes->filter('status', 'ACCEPTED');
// search all sickness times for the interval
$sicknessTimesFilter = clone $freeTimeFilter;
$sicknessTimesFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'type', 'operator' => 'equals', 'value' => 'sickness')));
$sicknessTimesFilter->addFilter(new Tinebase_Model_Filter_Date(array('field' => 'firstday_date', 'operator' => 'after', 'value' => $fddMin)));
$sicknessTimesFilter->addFilter(new Tinebase_Model_Filter_Date(array('field' => 'firstday_date', 'operator' => 'before', 'value' => $fddMax)));
$sicknessTimes = $ftController->search($sicknessTimesFilter);
// search free days belonging the found free times
// prepare free day filter
$freeDayFilter = new HumanResources_Model_FreeDayFilter(array(), 'AND');
$freeDayFilter->addFilter(new Tinebase_Model_Filter_Int(array('field' => 'duration', 'operator' => 'equals', 'value' => 1)));
// find vacation days belonging to the account (date doesn't matter, may be from another year, just count the days)
if (count($accountVacationTimeIds)) {
$accountFreeDayFilter = clone $freeDayFilter;
$accountFreeDayFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $accountVacationTimeIds)));
$remainingVacation = $remainingVacation - $fdController->search($accountFreeDayFilter)->count();
}
// find all vacation days of the period
$vacationDayFilter = clone $freeDayFilter;
$vacationDayFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $vacationTimes->id)));
$vacationDays = $fdController->search($vacationDayFilter);
// find out accepted vacation days. Vacation days will be substracted from remainingVacation only if they are accepted,
// but they will be shown in the freetime edit dialog
// TODO: discuss this
$acceptedVacationDayFilter = clone $freeDayFilter;
$acceptedVacationDayFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $acceptedVacationTimes->id)));
$acceptedVacationDays = $fdController->search($acceptedVacationDayFilter);
// calculate extra vacation days
if ($account) {
$filter = new HumanResources_Model_ExtraFreeTimeFilter(array());
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'account_id', 'operator' => 'equals', 'value' => $account->getId())));
$account->extra_free_times = HumanResources_Controller_ExtraFreeTime::getInstance()->search($filter);
$extraFreeTimes = $aController->calculateExtraFreeTimes($account, $acceptedVacationDays);
$allVacation = $allVacation + $extraFreeTimes['remaining'];
$remainingVacation = $remainingVacation + $extraFreeTimes['remaining'];
} else {
$extraFreeTimes = NULL;
}
// find all sickness days of the period
$sicknessDayFilter = clone $freeDayFilter;
$sicknessDayFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $sicknessTimes->id)));
$sicknessDays = $fdController->search($sicknessDayFilter);
$ownFreeDays = NULL;
if ($_freeTimeId) {
$ownFreeDaysFilter = clone $freeDayFilter;
$ownFreeDaysFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => array($_freeTimeId))));
$ownFreeDays = $fdController->search($ownFreeDaysFilter);
$remainingVacation = $remainingVacation - $ownFreeDays->count();
$ownFreeDays = $ownFreeDays->toArray();
}
// TODO: remove results property, just return results array itself
return array('results' => array('remainingVacation' => floor($remainingVacation), 'extraFreeTimes' => $extraFreeTimes, 'vacationDays' => $vacationDays->toArray(), 'sicknessDays' => $sicknessDays->toArray(), 'excludeDates' => $excludeDates, 'ownFreeDays' => $ownFreeDays, 'allVacation' => $allVacation, 'feastDays' => $feastDays, 'contracts' => $contracts->toArray(), 'employee' => $employee->toArray(), 'firstDay' => $firstDay, 'lastDay' => $stopDay));
}
/**
* book remaining vacation days for the next year
*
* @param array $accountIds
* @return booleam
*/
public function bookRemainingVacation($accountIds)
{
$filter = new HumanResources_Model_AccountFilter(array(array('field' => 'id', 'operator' => 'in', 'value' => $accountIds)));
$accounts = $this->search($filter);
$freeTimeController = HumanResources_Controller_FreeTime::getInstance();
$freeDayController = HumanResources_Controller_FreeDay::getInstance();
$configInstance = HumanResources_Config::getInstance();
$extraFreeTimeController = HumanResources_Controller_ExtraFreeTime::getInstance();
$db = method_exists($this->_backend, 'getAdapter') ? $this->_backend->getAdapter() : Tinebase_Core::getDb();
$thisYear = (int) Tinebase_DateTime::now()->format('Y');
try {
foreach ($accounts as $account) {
$transactionId = Tinebase_TransactionManager::getInstance()->startTransaction($db);
if ($account->year >= $thisYear) {
throw new HumanResources_Exception_RemainingNotBookable();
}
$data = $this->resolveVirtualFields($account);
// do nothing if there are no remaining vacation days
if ($data['remaining_vacation_days'] <= 0) {
continue;
}
$year = intval($account->year) + 1;
// get account of next year
$filter = new HumanResources_Model_AccountFilter(array(array('field' => 'year', 'operator' => 'equals', 'value' => $year)));
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'employee_id', 'operator' => 'equals', 'value' => $account->employee_id)));
$result = $this->search($filter);
if ($result->count() == 0) {
$ca = $this->createMissingAccounts($year, $account->employee_id);
$newAccount = $ca->getFirstRecord();
} elseif ($result->count() > 1) {
throw new Tinebase_Exception_Record_NotAllowed('There is more than one account for the year ' . $year . '!');
} else {
$newAccount = $result->getFirstRecord();
}
// create new extraFreetime for the new year
$extraFreeTime = new HumanResources_Model_ExtraFreeTime(array('days' => $data['remaining_vacation_days'], 'account_id' => $newAccount->getId(), 'type' => 'PAYED', 'description' => 'Booked from last year', 'expires' => $configInstance->getVacationExpirationDate()));
$extraFreeTimeController->create($extraFreeTime);
// create freetimes for old year
$freetime = $freeTimeController->create(new HumanResources_Model_FreeTime(array('type' => 'vacation', 'description' => 'Booked as extra freetime for next year.', 'status' => 'ACCEPTED', 'firstday_date' => NULL, 'employee_id' => $account->employee_id, 'account_id' => $account->getId())));
$i = 0;
while ($i < $data['remaining_vacation_days']) {
$freeDay = $freeDayController->create(new HumanResources_Model_FreeDay(array('freetime_id' => $freetime->getId(), 'duration' => 1, 'date' => null)));
$i++;
}
}
Tinebase_TransactionManager::getInstance()->commitTransaction($transactionId);
return true;
} catch (Exception $e) {
Tinebase_TransactionManager::getInstance()->rollBack();
throw $e;
}
}
/**
* finds overwritten by sickness days overwritten vacation days.
* deletes the overwritten vacation day and the vacation itself if days_count = 0
*
* @param Tinebase_Record_Interface $_record
*/
protected function _handleOverwrittenVacation($_record)
{
$fdController = HumanResources_Controller_FreeDay::getInstance();
$changedFreeTimes = array();
foreach ($_record->freedays as $freeday) {
$vacationTimeFilter = new HumanResources_Model_FreeTimeFilter(array(array('field' => 'type', 'operator' => 'equals', 'value' => 'vacation')));
$vacationTimeFilter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'employee_id', 'operator' => 'equals', 'value' => $_record->employee_id)));
$vacationTimes = $this->search($vacationTimeFilter);
$filter = new HumanResources_Model_FreeDayFilter(array(array('field' => 'date', 'operator' => 'equals', 'value' => $freeday['date'])));
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'not', 'value' => $_record->getId())));
$filter->addFilter(new Tinebase_Model_Filter_Text(array('field' => 'freetime_id', 'operator' => 'in', 'value' => $vacationTimes->id)));
$vacationDay = $fdController->search($filter)->getFirstRecord();
if ($vacationDay) {
$fdController->delete($vacationDay->getId());
$freeTime = $this->get($vacationDay->freetime_id);
if (!isset($changedFreeTimes[$vacationDay->freetime_id])) {
$changedFreeTimes[$vacationDay->freetime_id] = $freeTime;
}
$count = (int) $changedFreeTimes[$vacationDay->freetime_id]->days_count - 1;
$changedFreeTimes[$vacationDay->freetime_id]->days_count = $count;
}
}
foreach ($changedFreeTimes as $freeTimeId => $freetime) {
if ($freetime->days_count == 0) {
$this->delete($freetime->getId());
} else {
$freeTime->days_count = $count;
$this->update($freetime);
}
}
}
