TimeTrex/maint/AddPayPeriod.php

<?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".
 *
 ********************************************************************************/

/*
 * Adds pay periods X hrs in advance, so schedules/shifts have something to attach to.
 * This file should/can be run as often as it needs to (once an hour)
 *
 */
require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'global.inc.php' );
require_once( dirname( __FILE__ ) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'CLI.inc.php' );

$current_epoch = TTDate::getTime();

//If offset is only 24hrs then adding user_date rows can happen before the pay period was added.
$offset = ( 86400 * 14 ); //14 days - Every pay period schedule below can overwrite this.

$ppslf = new PayPeriodScheduleListFactory();

$clf = new CompanyListFactory();
$clf->getByStatusID( [ 10, 20, 23 ], null, [ 'a.id' => 'asc' ] ); //10=Active, 20=Hold, 23=Expired
if ( $clf->getRecordCount() > 0 ) {
	$system_job_queue_batch_id = TTUUID::generateUUID();

	foreach ( $clf as $c_obj ) {
		if ( in_array( $c_obj->getStatus(), [ 10, 20, 23 ] ) ) { //10=Active, 20=Hold, 23=Expired
			if ( !isset( $config_vars['other']['enable_job_queue'] ) || $config_vars['other']['enable_job_queue'] == true ) {
				SystemJobQueue::Add( TTi18n::getText( 'Add Pay Periods' ), $system_job_queue_batch_id, 'PayPeriodScheduleFactory', 'createPayPeriodsForJobQueue', [ $c_obj->getID() ], 110 );
			} else {
				//Get all pay period schedules.
				$ppslf->getByCompanyId( $c_obj->getId() );
				foreach ( $ppslf as $pay_period_schedule_obj ) {
					/** @var PayPeriodScheduleFactory $pay_period_schedule_obj */
					$end_date = null;

					//Create pay periods X days in the future as set in Pay Period Schedule by the user.
					$offset = ( $pay_period_schedule_obj->getCreateDaysInAdvance() * 86400 );

					$i = 0;
					$max = 53; //Never create more than this number of pay periods in a row.
					$repeat_pay_period_creation = true;
					while ( $i <= $max && $repeat_pay_period_creation === true ) {
						//Repeat function until returns false. (No more pay periods to create)
						$repeat_pay_period_creation = $pay_period_schedule_obj->createNextPayPeriod( $end_date, $offset );

						$i++;
					}

					if ( PRODUCTION == true && DEMO_MODE == false ) {
						$pay_period_schedule_obj->forceClosePreviousPayPeriods( $current_epoch );
					}

					unset( $pay_period_schedule_obj );
				}
			}
		}
	}
}
?>