<?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 PayrollDeduction
 */
class PayrollDeduction_Base {
	var $data = [];

	function setCompany( $company_id ) {
		$this->data['company_id'] = $company_id;

		return true;
	}

	function getCompany() {
		if ( isset( $this->data['company_id'] ) ) {
			return $this->data['company_id'];
		}

		return false;
	}

	function setUser( $user_id ) {
		$this->data['user_id'] = $user_id;

		return true;
	}

	function getUser() {
		if ( isset( $this->data['user_id'] ) ) {
			return $this->data['user_id'];
		}

		return false;
	}

	function setCountry( $country ) {
		$this->data['country'] = strtoupper( trim( $country ) );

		return true;
	}

	function getCountry() {
		if ( isset( $this->data['country'] ) ) {
			return $this->data['country'];
		}

		return false;
	}

	function setProvince( $province ) {
		$this->data['province'] = strtoupper( trim( $province ) );

		return true;
	}

	function getProvince() {
		if ( isset( $this->data['province'] ) ) {
			return $this->data['province'];
		}

		return false;
	}

	function setDistrict( $district ) {
		$this->data['district'] = strtoupper( trim( $district ) );

		return true;
	}

	function getDistrict() {
		if ( isset( $this->data['district'] ) ) {
			return $this->data['district'];
		}

		return false;
	}

	//
	// Generic
	//

	//10=Periodic (Default), 20=Non-Periodic.
	function setFormulaType( $type_id ) {
		$this->data['formula_type_id'] = $type_id;

		return true;
	}

	function getFormulaType() {
		if ( isset( $this->data['formula_type_id'] ) ) {
			return $this->data['formula_type_id'];
		}

		return 10;
	}

	function setUserValue1( $value ) {
		$this->data['user_value1'] = $value;

		return true;
	}

	function getUserValue1() {
		if ( isset( $this->data['user_value1'] ) ) {
			return $this->data['user_value1'];
		}

		return false;
	}

	function setUserValue2( $value ) {
		$this->data['user_value2'] = $value;

		return true;
	}

	function getUserValue2() {
		if ( isset( $this->data['user_value2'] ) ) {
			return $this->data['user_value2'];
		}

		return false;
	}

	function setUserValue3( $value ) {
		$this->data['user_value3'] = $value;

		return true;
	}

	function getUserValue3() {
		if ( isset( $this->data['user_value3'] ) ) {
			return $this->data['user_value3'];
		}

		return false;
	}

	function setUserValue4( $value ) {
		$this->data['user_value4'] = $value;

		return true;
	}

	function getUserValue4() {
		if ( isset( $this->data['user_value4'] ) ) {
			return $this->data['user_value4'];
		}

		return false;
	}

	function getDateEpoch() {
		return strtotime( $this->getDate() );
	}

	function getISODate( $epoch ) {
		return date( 'Ymd', $epoch );
	}

	function setDate( $epoch ) {
		$this->data['date'] = $this->getISODate( $epoch );

		return true;
	}

	function getDate() {
		if ( isset( $this->data['date'] ) ) {
			return $this->data['date'];
		}

		return false;
	}

	function setAnnualPayPeriods( $value ) {
		$this->data['annual_pay_periods'] = $value;

		return true;
	}

	function getAnnualPayPeriods() {
		if ( isset( $this->data['annual_pay_periods'] ) ) {
			return $this->data['annual_pay_periods'];
		}

		return false;
	}

	function setCurrentPayPeriod( $value ) {
		if ( $value <= 0 ) {
			$value = 1; //Make sure current pay period can never be less than 1.
		}

		$this->data['current_pay_period'] = $value;

		return true;
	}

	function getCurrentPayPeriod() {
		if ( isset( $this->data['current_pay_period'] ) ) {
			return $this->data['current_pay_period'];
		}

		return 1; //Always default to 1 to avoid division by 0 errors.
	}

	function setHireAdjustedAnnualPayPeriods( $value ) {
		$this->data['hire_adjusted_annual_pay_periods'] = $value;

		return true;
	}

	function getHireAdjustedAnnualPayPeriods() {
		if ( isset( $this->data['hire_adjusted_annual_pay_periods'] ) ) {
			return $this->data['hire_adjusted_annual_pay_periods'];
		}

		return $this->getAnnualPayPeriods(); //Default to the regular annual pay period.
	}

	function setHireAdjustedCurrentPayPeriod( $value ) {
		if ( $value <= 0 ) {
			$value = 1; //Make sure current pay period can never be less than 1.
		}

		$this->data['hire_adjusted_current_pay_period'] = $value;

		return true;
	}

	function getHireAdjustedCurrentPayPeriod() {
		if ( isset( $this->data['hire_adjusted_current_pay_period'] ) ) {
			return $this->data['hire_adjusted_current_pay_period'];
		}

		return $this->getCurrentPayPeriod(); //Default to the regular current pay period.
	}


	function setCurrentPayrollRunID( $value ) {
		$this->data['current_payroll_run_id'] = $value;

		return true;
	}

	function getCurrentPayrollRunID() {
		if ( isset( $this->data['current_payroll_run_id'] ) ) {
			return $this->data['current_payroll_run_id'];
		}

		return 1; //Always default to 1.
	}

	function getRemainingPayPeriods() {
		$retval = (int)bcsub( $this->getAnnualPayPeriods(), bcsub( $this->getCurrentPayPeriod(), 1 ) ); //Current pay period is considered a remaining one.
		Debug::Text( 'Pay Periods Remaining: ' . $retval . ' Annual PPs: ' . $this->getAnnualPayPeriods() . ' Current PP: ' . $this->getCurrentPayPeriod(), __FILE__, __LINE__, __METHOD__, 10 );

		return $retval;
	}

	function getCountryPrimaryCurrency() {
		if ( isset( $this->country_primary_currency ) && $this->country_primary_currency != '' ) {
			return $this->country_primary_currency;
		}

		return false;
	}

	function getCountryPrimaryCurrencyID() {
		$iso_code = $this->getCountryPrimaryCurrency(); //ISO Code

		if ( $iso_code != '' && TTUUID::isUUID( $this->getCompany() ) ) {
			$clf = new CurrencyListFactory();
			$clf->getByCompanyIdAndISOCode( $this->getCompany(), $iso_code );
			if ( $clf->getRecordCount() > 0 ) {
				$currency_id = $clf->getCurrent()->getId();

				//Debug::Text('Country Primary Currency ID: '. $currency_id , __FILE__, __LINE__, __METHOD__, 10 );
				return $currency_id;
			}
		}

		Debug::Text( 'Country Primary Currency does not exist: ' . $iso_code, __FILE__, __LINE__, __METHOD__, 10 );

		return false;
	}

	//Set the user currency for calculations
	function setUserCurrency( $currency_id ) {
		//Debug::Text('Settitng currency for calculate income tax: '. $currency_id, __FILE__, __LINE__, __METHOD__, 10 );

		$this->data['user_currency_id'] = $currency_id;

		return true;
	}

	//Get the user currency for calculations
	function getUserCurrency() {
		if ( isset( $this->data['user_currency_id'] ) ) {
			//Debug::Text('Currency income: '. $this->data['user_currency_id'], __FILE__, __LINE__, __METHOD__, 10);

			return $this->data['user_currency_id'];
		}

		//If no currency is set, return the country primary currency, so no conversion takes place.
		return false;
	}

	function setGrossPayPeriodIncome( $income ) {
		//A = Annual Taxable Income
		//Debug::text('Setting gross pay period income: '. $income, __FILE__, __LINE__, __METHOD__, 10);
		$income = $this->convertToCountryCurrency( $income );
		//Debug::text('Setting converted gross pay period income: '. $income, __FILE__, __LINE__, __METHOD__, 10);

		Debug::text( 'Gross Pay Period Income: I: ' . $income, __FILE__, __LINE__, __METHOD__, 10 );
		$this->data['gross_pay_period_income'] = $income;

		return true;
	}

	function getGrossPayPeriodIncome() {
		if ( isset( $this->data['gross_pay_period_income'] ) ) {
//			Debug::text( 'Gross Pay Period Income: I: ' . $this->data['gross_pay_period_income'], __FILE__, __LINE__, __METHOD__, 10 );

			return $this->data['gross_pay_period_income'];
		}

		return false;
	}

	function setYearToDateGrossIncome( $income ) {
		$income = $this->convertToCountryCurrency( $income );

		$this->data['gross_ytd_income'] = $income;

		return true;
	}

	function getYearToDateGrossIncome() {
		if ( isset( $this->data['gross_ytd_income'] ) ) {
			Debug::text( 'YTD Gross Income: I: ' . $this->data['gross_ytd_income'], __FILE__, __LINE__, __METHOD__, 10 );

			return $this->data['gross_ytd_income'];
		}

		return false;
	}

	function setYearToDateDeduction( $amount ) {
		$amount = $this->convertToCountryCurrency( $amount );

		$this->data['ytd_deduction'] = $amount;

		return true;
	}

	function getYearToDateDeduction() {
		if ( isset( $this->data['ytd_deduction'] ) ) {
			Debug::text( 'YTD Deduction: ' . $this->data['ytd_deduction'], __FILE__, __LINE__, __METHOD__, 10 );

			return $this->data['ytd_deduction'];
		}

		return false;
	}


	//This function convert '$amount' from the user currency, to the country currency for calculations
	function convertToCountryCurrency( $amount ) {
		$user_currency_id = $this->getUserCurrency();
		$country_currency_id = $this->getCountryPrimaryCurrencyID();

		if ( $user_currency_id !== false && $country_currency_id !== false ) {
			$retval = CurrencyFactory::convertCurrency( $this->getUserCurrency(), $this->getCountryPrimaryCurrencyID(), $amount );
		} else {
			//Conversion failed, return original amount.
			$retval = $amount;
		}

		return $retval;
	}

	//This function convert '$amount' from the country currency, to the user currency.
	function convertToUserCurrency( $amount ) {
		$user_currency_id = $this->getUserCurrency();
		$country_currency_id = $this->getCountryPrimaryCurrencyID();

		if ( $user_currency_id !== false && $country_currency_id !== false ) {
			$retval = CurrencyFactory::convertCurrency( $this->getCountryPrimaryCurrencyID(), $this->getUserCurrency(), $amount );
		} else {
			$retval = $amount;
		}

		return $retval;
	}

	function getAnnualizingFactor( $reverse = false ) {
		$retval = bcdiv( $this->getHireAdjustedAnnualPayPeriods(), $this->getHireAdjustedCurrentPayPeriod() );
		if ( $reverse == true ) {
			$retval = bcdiv( 1, $retval );
		}
		Debug::text( 'Annualizing Factor (S1): ' . $retval . ' Hire Adjusted: Annual PP: ' . $this->getHireAdjustedAnnualPayPeriods() . '(' . $this->getAnnualPayPeriods() . ') Current PP: ' . $this->getHireAdjustedCurrentPayPeriod() . '(' . $this->getCurrentPayPeriod() . ') Reverse: ' . (int)$reverse, __FILE__, __LINE__, __METHOD__, 10 );

		return $retval;
	}

	function calcNonPeriodicIncome( $ytd_gross_income, $gross_pp_income ) {
		$retval = bcmul( bcadd( $ytd_gross_income, $gross_pp_income ), $this->getAnnualizingFactor() );
		if ( $retval < 0 ) {
			$retval = 0;
		}
		Debug::text( 'Non-Periodic Income: ' . $retval . ' Gross: YTD: ' . $ytd_gross_income . ' PP: ' . $gross_pp_income, __FILE__, __LINE__, __METHOD__, 10 );

		return $retval;
	}

	function calcNonPeriodicDeduction( $annual_tax_payable, $ytd_deduction ) {
		$retval = bcsub( bcmul( $annual_tax_payable, $this->getAnnualizingFactor( true ) ), $ytd_deduction );
		if ( $retval < 0 ) {
			$retval = 0;
		}
		Debug::text( 'Non-Periodic Deduction: ' . $retval . ' Annual Tax Payable: ' . $annual_tax_payable . ' YTD Deduction: ' . $ytd_deduction, __FILE__, __LINE__, __METHOD__, 10 );

		return $retval;
	}

	function getDataFromRateArray( $epoch, $arr ) {
		if ( !is_array( $arr ) ) {
			return false;
		}

		if ( $epoch == '' ) {
			return false;
		}

		krsort( $arr, SORT_NUMERIC );
		foreach ( $arr as $date => $val ) {
			if ( strlen( $date ) == 8 ) {
				if ( $epoch >= $date ) {
					return $val;
				}
			} else {
				throw new Exception( 'Invalid PayrollDeduction date length: ' . $date ); //Catch typos in the ISO date where it might be 7 or 9 characters instead of 8.
			}
		}

		return false;
	}

}

?>