TimeTrex/classes/modules/holiday/RecurringHolidayFactory.class.php

725 lines
21 KiB
PHP
Raw Permalink Normal View History

2022-12-13 07:10:06 +01:00
<?php
/*********************************************************************************
*
* TimeTrex is a Workforce Management program developed by
* TimeTrex Software Inc. Copyright (C) 2003 - 2021 TimeTrex Software Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by
* the Free Software Foundation with the addition of the following permission
* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
* WORK IN WHICH THE COPYRIGHT IS OWNED BY TIMETREX, TIMETREX DISCLAIMS THE
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
*
* You should have received a copy of the GNU Affero General Public License along
* with this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
*
* You can contact TimeTrex headquarters at Unit 22 - 2475 Dobbin Rd. Suite
* #292 West Kelowna, BC V4T 2E9, Canada or at email address info@timetrex.com.
*
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
*
* In accordance with Section 7(b) of the GNU Affero General Public License
* version 3, these Appropriate Legal Notices must retain the display of the
* "Powered by TimeTrex" logo. If the display of the logo is not reasonably
* feasible for technical reasons, the Appropriate Legal Notices must display
* the words "Powered by TimeTrex".
*
********************************************************************************/
/**
* @package Modules\Holiday
*/
class RecurringHolidayFactory extends Factory {
protected $table = 'recurring_holiday';
protected $pk_sequence_name = 'recurring_holiday_id_seq'; //PK Sequence name
protected $company_obj = null;
/**
* @param $name
* @param null $parent
* @return array|null
*/
function _getFactoryOptions( $name, $parent = null ) {
$retval = null;
switch ( $name ) {
case 'special_day':
$retval = [
0 => TTi18n::gettext( 'N/A' ),
1 => TTi18n::gettext( 'Good Friday' ),
5 => TTi18n::gettext( 'Easter Sunday' ),
6 => TTi18n::gettext( 'Easter Monday' ),
];
break;
case 'type':
$retval = [
10 => TTi18n::gettext( 'Static' ),
20 => TTi18n::gettext( 'Dynamic: Week Interval' ),
30 => TTi18n::gettext( 'Dynamic: Pivot Day' ),
];
break;
case 'week_interval':
$retval = [
1 => TTi18n::gettext( '1st' ),
2 => TTi18n::gettext( '2nd' ),
3 => TTi18n::gettext( '3rd' ),
4 => TTi18n::gettext( '4th' ),
5 => TTi18n::gettext( '5th' ),
];
break;
case 'pivot_day_direction':
$retval = [
10 => TTi18n::gettext( 'Before' ),
20 => TTi18n::gettext( 'After' ),
30 => TTi18n::gettext( 'On or Before' ),
40 => TTi18n::gettext( 'On or After' ),
];
break;
case 'always_week_day':
$retval = [
//Adjust holiday to next weekday
0 => TTi18n::gettext( 'No' ),
1 => TTi18n::gettext( 'Yes - Previous Week Day' ),
2 => TTi18n::gettext( 'Yes - Next Week Day' ),
3 => TTi18n::gettext( 'Yes - Closest Week Day' ),
10 => TTi18n::gettext( 'Split - Sat=Sat, Sun=Mon' ),
20 => TTi18n::gettext( 'Split - Sat=Fri, Sun=Sun' ),
];
break;
case 'columns':
$retval = [
'-1010-name' => TTi18n::gettext( 'Name' ),
'-1010-type' => TTi18n::gettext( 'Type' ),
'-1020-next_date' => TTi18n::gettext( 'Next Date' ),
'-2000-created_by' => TTi18n::gettext( 'Created By' ),
'-2010-created_date' => TTi18n::gettext( 'Created Date' ),
'-2020-updated_by' => TTi18n::gettext( 'Updated By' ),
'-2030-updated_date' => TTi18n::gettext( 'Updated Date' ),
];
break;
case 'list_columns':
$retval = Misc::arrayIntersectByKey( $this->getOptions( 'default_display_columns' ), Misc::trimSortPrefix( $this->getOptions( 'columns' ) ) );
break;
case 'default_display_columns': //Columns that are displayed by default.
$retval = [
'name',
'next_date',
'updated_date',
'updated_by',
];
break;
case 'unique_columns': //Columns that are unique, and disabled for mass editing.
$retval = [
'name',
];
break;
}
return $retval;
}
/**
* @param $data
* @return array
*/
function _getVariableToFunctionMap( $data ) {
$variable_function_map = [
'id' => 'ID',
'company_id' => 'Company',
'special_day' => 'SpecialDay',
'type_id' => 'Type',
'type' => false,
'pivot_day_direction_id' => 'PivotDayDirection',
'name' => 'Name',
'week_interval' => 'WeekInterval',
'day_of_week' => 'DayOfWeek',
'day_of_month' => 'DayOfMonth',
'month_int' => 'Month',
'always_week_day_id' => 'AlwaysOnWeekDay',
'next_date' => 'NextDate',
'deleted' => 'Deleted',
];
return $variable_function_map;
}
/**
* @return null
*/
function getCompanyObject() {
if ( is_object( $this->company_obj ) ) {
return $this->company_obj;
} else {
$clf = TTnew( 'CompanyListFactory' ); /** @var CompanyListFactory $clf */
$this->company_obj = $clf->getById( $this->getCompany() )->getCurrent();
return $this->company_obj;
}
}
/**
* @return bool|mixed
*/
function getCompany() {
return $this->getGenericDataValue( 'company_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setCompany( $value ) {
$value = TTUUID::castUUID( $value );
Debug::Text( 'Company ID: ' . $value, __FILE__, __LINE__, __METHOD__, 10 );
return $this->setGenericDataValue( 'company_id', $value );
}
/**
* @return bool|mixed
*/
function getSpecialDay() {
return $this->getGenericDataValue( 'special_day' );
}
/**
* @param $value
* @return bool
*/
function setSpecialDay( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'special_day', $value );
}
/**
* @return bool|int
*/
function getType() {
return $this->getGenericDataValue( 'type_id' );
}
/**
* @param $value
* @return bool
*/
function setType( $value ) {
$value = (int)trim( $value );
return $this->setGenericDataValue( 'type_id', $value );
}
/**
* @return bool|int
*/
function getPivotDayDirection() {
return $this->getGenericDataValue( 'pivot_day_direction_id' );
}
/**
* @param $value
* @return bool
*/
function setPivotDayDirection( $value ) {
$value = (int)trim( $value );
return $this->setGenericDataValue( 'pivot_day_direction_id', $value );
}
/**
* @param $name
* @return bool
*/
function isUniqueName( $name ) {
$name = trim( $name );
if ( $name == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $this->getCompany() ),
'name' => TTi18n::strtolower( $name ),
];
$query = 'select id from ' . $this->getTable() . ' where company_id = ? AND lower(name) = ? AND deleted=0';
$name_id = $this->db->GetOne( $query, $ph );
Debug::Arr( $name_id, 'Unique Name: ' . $name, __FILE__, __LINE__, __METHOD__, 10 );
if ( $name_id === false ) {
return true;
} else {
if ( $name_id == $this->getId() ) {
return true;
}
}
return false;
}
/**
* @return bool|mixed
*/
function getName() {
return $this->getGenericDataValue( 'name' );
}
/**
* @param $value
* @return bool
*/
function setName( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'name', $value );
}
/**
* @return bool|int
*/
function getWeekInterval() {
return (int)$this->getGenericDataValue( 'week_interval' );
}
/**
* @param $value
* @return bool
*/
function setWeekInterval( $value ) {
$value = trim( $value );
if ( empty( $value ) ) {
$value = 0;
}
return $this->setGenericDataValue( 'week_interval', $value );
}
/**
* @return bool|int
*/
function getDayOfWeek() {
return (int)$this->getGenericDataValue( 'day_of_week' );
}
/**
* @param $value
* @return bool
*/
function setDayOfWeek( $value ) {
$value = trim( $value );
if ( $value == '' ) {
$value = 0;
}
return $this->setGenericDataValue( 'day_of_week', $value );
}
/**
* @return bool|int
*/
function getDayOfMonth() {
return (int)$this->getGenericDataValue( 'day_of_month' );
}
/**
* @param $value
* @return bool
*/
function setDayOfMonth( $value ) {
$value = trim( $value );
if ( empty( $value ) ) {
$value = 0;
}
return $this->setGenericDataValue( 'day_of_month', $value );
}
/**
* @return bool|int
*/
function getMonth() {
return (int)$this->getGenericDataValue( 'month_int' );
}
/**
* @param $value
* @return bool
*/
function setMonth( $value ) {
$value = trim( $value );
if ( empty( $value ) ) {
$value = 0;
}
return $this->setGenericDataValue( 'month_int', $value );
}
/**
* @return bool|int
*/
function getAlwaysOnWeekDay() {
return (int)$this->getGenericDataValue( 'always_week_day_id' );
}
/**
* @param $value
* @return bool
*/
function setAlwaysOnWeekDay( $value ) {
$value = (int)$value;
return $this->setGenericDataValue( 'always_week_day_id', $value );
}
/**
* @param bool $epoch
* @return bool|false|int
*/
function getNextDate( $epoch = false, $exclude_dates = [] ) {
if ( $epoch == '' ) {
$epoch = TTDate::getTime();
}
if ( $this->getSpecialDay() == 1 || $this->getSpecialDay() == 5 || $this->getSpecialDay() == 6 ) {
Debug::text( 'Easter Sunday Date...', __FILE__, __LINE__, __METHOD__, 10 );
//Use easter_days() instead, as easter_date returns incorrect values for some timezones/years (2010 and US/Eastern on Windows)
//$easter_epoch = easter_date(date('Y', $epoch));
//$easter_epoch = mktime( 12, 0, 0, 3, ( 21 + easter_days( date('Y', $epoch) ) ), date('Y', $epoch) );
$easter_epoch = mktime( 12, 0, 0, 3, ( 21 + TTDate::getEasterDays( date( 'Y', $epoch ) ) ), date( 'Y', $epoch ) );
//Fix "cross-year" bug.
if ( $easter_epoch < $epoch ) {
//$easter_epoch = easter_date(date('Y', $epoch)+1);
//$easter_epoch = mktime( 12, 0, 0, 3, ( 21 + easter_days( (date('Y', $epoch) + 1) ) ), ( date('Y', $epoch) + 1 ) );
$easter_epoch = mktime( 12, 0, 0, 3, ( 21 + TTDate::getEasterDays( ( date( 'Y', $epoch ) + 1 ) ) ), ( date( 'Y', $epoch ) + 1 ) );
}
if ( $this->getSpecialDay() == 1 ) {
Debug::text( 'Good Friday Date...', __FILE__, __LINE__, __METHOD__, 10 );
//$holiday_epoch = mktime(12, 0, 0, date('n', $easter_epoch), date('j', $easter_epoch) - 2, date('Y', $easter_epoch));
$holiday_epoch = ( $easter_epoch - ( 2 * 86400 ) );
} else if ( $this->getSpecialDay() == 6 ) {
Debug::text( 'Easter Monday Date...', __FILE__, __LINE__, __METHOD__, 10 );
$holiday_epoch = ( $easter_epoch + 86400 );
} else {
$holiday_epoch = $easter_epoch;
}
} else {
if ( $this->getType() == 10 ) { //Static
Debug::text( 'Static Date...', __FILE__, __LINE__, __METHOD__, 10 );
//Static date
$holiday_epoch = mktime( 12, 0, 0, $this->getMonth(), $this->getDayOfMonth(), date( 'Y', $epoch ) );
if ( $holiday_epoch < $epoch ) {
$holiday_epoch = mktime( 12, 0, 0, $this->getMonth(), $this->getDayOfMonth(), ( date( 'Y', $epoch ) + 1 ) );
}
} else if ( $this->getType() == 20 ) { //Dynamic - Week Interval
Debug::text( 'Dynamic - Week Interval... Current Month: ' . TTDate::getMonth( $epoch ) . ' Holiday Month: ' . $this->getMonth(), __FILE__, __LINE__, __METHOD__, 10 );
//Dynamic
$start_month_epoch = TTDate::getBeginMonthEpoch( $epoch );
$end_month_epoch = mktime( 12, 0, 0, ( $this->getMonth() + 1 ), 1, ( date( 'Y', $epoch ) + 1 ) );
$tmp_holiday_epoch = false;
Debug::text( 'Start Epoch: ' . TTDate::getDate( 'DATE+TIME', $start_month_epoch ) . ' End Epoch: ' . TTDate::getDate( 'DATE+TIME', $end_month_epoch ) . ' Current Epoch: ' . TTDate::getDate( 'DATE+TIME', $epoch ), __FILE__, __LINE__, __METHOD__, 10 );
//Get all day of weeks in the month. Determine which is less or greater then day.
$day_of_week_dates = [];
$week_interval = 0;
//for ($i = $start_month_epoch; $i <= $end_month_epoch; $i += 86400) {
foreach ( TTDate::getDatePeriod( $start_month_epoch, $end_month_epoch, 'P1D' ) as $i ) {
if ( TTDate::getMonth( $i ) == $this->getMonth() ) {
$day_of_week = TTDate::getDayOfWeek( $i );
//Debug::text('I: '. $i .'('.TTDate::getDate('DATE+TIME', $i).') Current Day Of Week: '. $day_of_week .' Looking for Day Of Week: '. $this->getDayOfWeek(), __FILE__, __LINE__, __METHOD__, 10);
if ( $day_of_week == abs( $this->getDayOfWeek() ) ) {
$day_of_week_dates[] = date( 'j', $i );
Debug::text( 'I: ' . $i . ' Day Of Month: ' . date( 'j', $i ) . ' Week Interval: ' . $week_interval, __FILE__, __LINE__, __METHOD__, 10 );
$week_interval++;
}
if ( $week_interval >= $this->getWeekInterval() ) {
$tmp_holiday_epoch = mktime( 12, 0, 0, $this->getMonth(), $day_of_week_dates[( $this->getWeekInterval() - 1 )], date( 'Y', $i ) );
//Make sure we keep processing until the holiday comes AFTER todays date.
if ( $tmp_holiday_epoch > $epoch ) {
break;
}
}
} else {
//Outside the month we need to be in, so reset all other settings.
$week_interval = 0;
$day_of_week_dates = [];
}
}
$holiday_epoch = $tmp_holiday_epoch;
} else if ( $this->getType() == 30 ) { //Dynamic - Pivot Day
Debug::text( 'Dynamic - Pivot Date...', __FILE__, __LINE__, __METHOD__, 10 );
//Dynamic
if ( TTDate::getMonth( $epoch ) > $this->getMonth() ) {
$year_modifier = 1;
} else {
$year_modifier = 0;
}
$start_epoch = mktime( 12, 0, 0, $this->getMonth(), $this->getDayOfMonth(), ( date( 'Y', $epoch ) + $year_modifier ) );
$holiday_epoch = $start_epoch;
$x = 0;
$x_max = 100;
if ( $this->getPivotDayDirection() == 10 || $this->getPivotDayDirection() == 30 ) {
$direction_multiplier = -1;
} else {
$direction_multiplier = 1;
}
$adjustment = ( 86400 * $direction_multiplier ); // Adjust by 1 day before or after.
if ( $this->getPivotDayDirection() == 10 || $this->getPivotDayDirection() == 20 ) {
$holiday_epoch += $adjustment;
}
while ( $this->getDayOfWeek() != TTDate::getDayOfWeek( $holiday_epoch ) && $x < $x_max ) {
Debug::text( 'X: ' . $x . ' aTrying...' . TTDate::getDate( 'DATE+TIME', $holiday_epoch ), __FILE__, __LINE__, __METHOD__, 10 );
$holiday_epoch += $adjustment;
$x++;
}
}
}
if ( is_numeric( $holiday_epoch ) ) {
$holiday_epoch = TTDate::getNearestWeekDay( $holiday_epoch, $this->getAlwaysOnWeekDay(), $exclude_dates );
Debug::text( 'Next Date for: ' . $this->getName() . ' is: ' . TTDate::getDate( 'DATE+TIME', $holiday_epoch ), __FILE__, __LINE__, __METHOD__, 10 );
return $holiday_epoch;
}
Debug::text( ' Unable to get next date for holiday!', __FILE__, __LINE__, __METHOD__, 10 );
return false;
}
/**
* @param bool $ignore_warning
* @return bool
*/
function Validate( $ignore_warning = true ) {
//
// BELOW: Validation code moved from set*() functions.
//
// Company
$clf = TTnew( 'CompanyListFactory' ); /** @var CompanyListFactory $clf */
$this->Validator->isResultSetWithRows( 'company',
$clf->getByID( $this->getCompany() ),
TTi18n::gettext( 'Company is invalid' )
);
// Name
if ( $this->getName() !== false ) {
$this->Validator->isLength( 'name',
$this->getName(),
TTi18n::gettext( 'Name is invalid' ),
2, 50
);
if ( $this->Validator->isError( 'name' ) == false ) {
$this->Validator->isTrue( 'name',
$this->isUniqueName( $this->getName() ),
TTi18n::gettext( 'Name is already in use' )
);
}
}
// Special Day
$this->Validator->inArrayKey( 'special_day',
$this->getSpecialDay(),
TTi18n::gettext( 'Incorrect Special Day' ),
$this->getOptions( 'special_day' )
);
// Type
if ( $this->getType() !== false ) {
$this->Validator->inArrayKey( 'type',
$this->getType(),
TTi18n::gettext( 'Incorrect Type' ),
$this->getOptions( 'type' )
);
}
// 10 => TTi18n::gettext('Static'),
// 20 => TTi18n::gettext('Dynamic: Week Interval'),
// 30 => TTi18n::gettext('Dynamic: Pivot Day')
if ( in_array( $this->getType(), [ 20 ] ) ) { //20=Dynamic: Week Interval
// Week Interval
$this->Validator->isNumeric( 'week_interval',
$this->getWeekInterval(),
TTi18n::gettext( 'Incorrect Week Interval' )
);
// Day Of Week
$this->Validator->isNumeric( 'day_of_week',
$this->getDayOfWeek(),
TTi18n::gettext( 'Incorrect Day Of Week' )
);
}
// Pivot Day Direction
if ( in_array( $this->getType(), [ 30 ] ) && $this->getPivotDayDirection() !== false ) { //30=Dynamic: Pivot Day
$this->Validator->inArrayKey( 'pivot_day_direction',
$this->getPivotDayDirection(),
TTi18n::gettext( 'Incorrect Pivot Day Direction' ),
$this->getOptions( 'pivot_day_direction' )
);
}
if ( in_array( $this->getType(), [ 10, 30 ] ) ) { //10=Static, 30=Dynamic: Pivot Day
// Day Of Month
$this->Validator->isNumeric( 'day_of_month',
$this->getDayOfMonth(),
TTi18n::gettext( 'Incorrect Day Of Month' )
);
}
// Month
$this->Validator->isNumeric( 'month',
$this->getMonth(),
TTi18n::gettext( 'Incorrect Month' )
);
// Always on week day adjustment
$this->Validator->inArrayKey( 'always_week_day_id',
$this->getAlwaysOnWeekDay(),
TTi18n::gettext( 'Incorrect always on week day adjustment' ),
$this->getOptions( 'always_week_day' )
);
//
// ABOVE: Validation code moved from set*() functions.
//
//Don't allow deleting recurring holidays unless they are no longer in use by Holiday Policies and Remittances Agency's. Contributing Shift Policies use Holiday Policies not recurring holidays.
if ( $this->getDeleted() == true ) {
$hprhlf = TTNew( 'HolidayPolicyRecurringHolidayListFactory' ); /** @var HolidayPolicyRecurringHolidayListFactory $hprhlf */
$hprhlf->getByCompanyIdAndRecurringHolidayId( $this->getCompany(), $this->getId() );
if ( $hprhlf->getRecordCount() > 0 ) {
$this->Validator->isTRUE( 'in_use',
false,
TTi18n::gettext( 'This recurring holiday is currently in use' ) . ' ' . TTi18n::gettext( 'by holiday policies' ) );
}
$cgmlf = TTnew( 'CompanyGenericMapListFactory' ); /** @var CompanyGenericMapListFactory $cgmlf */
$cgmlf->getByCompanyIDAndObjectTypeAndMapID( $this->getCompany(), 5000, $this->getID() );
if ( $cgmlf->getRecordCount() > 0 ) {
$this->Validator->isTRUE( 'in_use',
false,
TTi18n::gettext( 'This recurring holiday is currently in use' ) . ' ' . TTi18n::gettext( 'by remittance agencies' ) );
}
}
return true;
}
/**
* @param $data
* @return bool
*/
function setObjectFromArray( $data ) {
if ( is_array( $data ) ) {
$variable_function_map = $this->getVariableToFunctionMap();
foreach ( $variable_function_map as $key => $function ) {
if ( isset( $data[$key] ) ) {
$function = 'set' . $function;
switch ( $key ) {
default:
if ( method_exists( $this, $function ) ) {
$this->$function( $data[$key] );
}
break;
}
}
}
$this->setCreatedAndUpdatedColumns( $data );
return true;
}
return false;
}
/**
* @param null $include_columns
* @return array
*/
function getObjectAsArray( $include_columns = null ) {
$data = [];
$variable_function_map = $this->getVariableToFunctionMap();
if ( is_array( $variable_function_map ) ) {
foreach ( $variable_function_map as $variable => $function_stub ) {
if ( $include_columns == null || ( isset( $include_columns[$variable] ) && $include_columns[$variable] == true ) ) {
$function = 'get' . $function_stub;
switch ( $variable ) {
case 'type':
case 'status':
$function = 'get' . $variable;
if ( method_exists( $this, $function ) ) {
$data[$variable] = Option::getByKey( $this->$function(), $this->getOptions( $variable ) );
}
break;
case 'next_date':
if ( method_exists( $this, $function ) ) {
$data[$variable] = TTDate::getAPIDate( 'DATE', $this->$function() );
}
break;
default:
if ( method_exists( $this, $function ) ) {
$data[$variable] = $this->$function();
}
break;
}
}
}
$this->getCreatedAndUpdatedColumns( $data, $include_columns );
}
return $data;
}
/**
* @param $log_action
* @return bool
*/
function addLog( $log_action ) {
return TTLog::addEntry( $this->getId(), $log_action, TTi18n::getText( 'Recurring Holiday' ) .': '. $this->getName(), null, $this->getTable(), $this );
}
}
?>