SolidCharity/TimeTrex
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
472f000c1b
TimeTrex/classes/modules/payperiod/PayPeriodListFactory.class.php

2009 lines
67 KiB
PHP
Raw Blame History

<?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\PayPeriod
*/
class PayPeriodListFactory extends PayPeriodFactory implements IteratorAggregate {
/**
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return $this
*/
function getAll( $limit = null, $page = null, $where = null, $order = null ) {
$query = '
select *
from ' . $this->getTable() . '
WHERE deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, null, $limit, $page );
return $this;
}
/**
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getById( $id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
$this->rs = $this->getCache( $id );
if ( $this->rs === false ) {
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where id = ?
AND deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
$this->saveCache( $this->rs, $id );
}
return $this;
}
/**
* @param string[] $ids UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByIdList( $ids, $where = null, $order = null ) {
if ( $ids == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.id in ( ' . $this->getListSQL( $ids, $ph, 'uuid' ) . ' )
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string|string[] $ids UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @param bool $enable_names
* @return array|bool
*/
function getByIdListArray( $ids, $where = null, $order = null, $enable_names = true ) {
if ( $ids == '' ) {
return false;
}
$result = $this->getByIdList( $ids, $where, $order );
$pay_period_schedule_id = [];
foreach ( $result as $pay_period ) {
$pay_period_schedule_id[$pay_period->getPayPeriodScheduleObject()->getId()] = $pay_period->getPayPeriodScheduleObject()->getName();
}
$use_names = false;
if ( $enable_names == true && empty( $pay_period_schedule_id ) == false && $pay_period_schedule_id != TTUUID::getZeroID() ) {
$use_names = true;
}
$pay_period_list = [];
foreach ( $result as $pay_period ) {
//Debug::Text('Pay Period: '. $pay_period->getId(), __FILE__, __LINE__, __METHOD__, 10);
/*
if ( $use_names == TRUE ) {
$pay_period_schedule_name = '('.$pay_period->getPayPeriodScheduleObject()->getName().') ';
}
*/
//$pay_period_list[$pay_period->getId()] = $pay_period_schedule_name . TTDate::getDate('DATE', $pay_period->getStartDate() ).' -> '. TTDate::getDate('DATE', $pay_period->getEndDate() );
$pay_period_list[$pay_period->getId()] = $pay_period->getName( $use_names );
}
if ( empty( $pay_period_list ) == false ) {
return $pay_period_list;
}
return false;
}
/**
* @param $lf
* @param bool $include_blank
* @param bool $sort_prefix
* @return array|bool
*/
function getArrayByListFactory( $lf, $include_blank = true, $sort_prefix = false ) {
if ( !is_object( $lf ) ) {
return false;
}
Debug::Text( 'Total Rows: ' . $lf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
$list = [];
if ( $include_blank == true ) {
$list[TTUUID::getZeroID()] = '--';
}
$use_names = false;
//Get all pay period schedules, if more than one pay period schedule is in use, include PP schedule name.
$pay_period_schedule_id = [];
$i = 0;
foreach ( $lf as $obj ) {
if ( !isset( $pay_period_schedule_id[$obj->getPayPeriodSchedule()] ) ) {
$pay_period_schedule_id[$obj->getPayPeriodSchedule()] = true;
$i++;
}
if ( $i >= 2 ) {
$use_names = true;
break;
}
}
$prefix = null;
$i = 0;
foreach ( $lf as $obj ) {
if ( $sort_prefix == true ) {
$prefix = '-' . str_pad( $i, 4, 0, STR_PAD_LEFT ) . '-';
}
$list[$prefix . $obj->getID()] = $obj->getName( $use_names, true );
$i++;
}
if ( empty( $list ) == false ) {
return $list;
}
return false;
}
/**
* @param string $id UUID
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByPayPeriodScheduleId( $id, $limit = null, $page = null, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'transaction_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where pay_period_schedule_id = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $id UUID
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyId( $id, $limit = null, $page = null, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'start_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.deleted=0 AND b.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param int|int[] $status_ids
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndStatus( $company_id, $status_ids, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $status_ids == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.status_id in ( ' . $this->getListSQL( $status_ids, $ph, 'int' ) . ' )
AND a.deleted=0 AND b.deleted=0
';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param int[] $status_ids
* @param int $transaction_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndStatusAndTransactionDate( $company_id, $status_ids, $transaction_date, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $status_ids == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'transaction_date' => $this->db->BindTimeStamp( $transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.transaction_date <= ?
AND a.status_id in ( ' . $this->getListSQL( $status_ids, $ph, 'int' ) . ' )
AND ( a.deleted=0 AND b.deleted=0 )
';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string|string[] $id UUID
* @param string $company_id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByIdAndCompanyId( $id, $company_id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $company_id == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND id in ( ' . $this->getListSQL( $id, $ph, 'uuid' ) . ' )
AND deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndEndDate( $company_id, $end_date, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $end_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND start_date <= ?
AND end_date > ?
AND deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param int $transaction_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndTransactionDate( $company_id, $transaction_date, $where = null, $order = null ) {
if ( $transaction_date == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $transaction_date ),
'end_date' => $this->db->BindTimeStamp( $transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.end_date <= ?
AND a.transaction_date > ?
AND a.deleted=0
AND b.deleted=0
';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndTransactionStartDateAndTransactionEndDate( $company_id, $start_date, $end_date, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $start_date == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $start_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.transaction_date >= ?
AND a.transaction_date <= ?
AND a.deleted=0 AND b.deleted=0
';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserId( $user_id, $limit = null, $page = null, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'start_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ppsuf = new PayPeriodScheduleUserFactory();
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
];
$query = '
SELECT a.*
FROM ' . $this->getTable() . ' as a,
' . $ppsuf->getTable() . ' as c,
' . $ppsf->getTable() . ' as b
WHERE a.pay_period_schedule_id = c.pay_period_schedule_id
AND a.pay_period_schedule_id = b.id
AND c.user_id = ?
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $user_id UUID
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdAndStartDateAndEndDate( $user_id, $start_date, $end_date, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.start_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsuf = new PayPeriodScheduleUserFactory();
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'start_date' => $this->db->BindTimeStamp( $start_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
];
//No pay period
$query = '
SELECT a.*
FROM ' . $this->getTable() . ' as a,
' . $ppsuf->getTable() . ' as c,
' . $ppsf->getTable() . ' as b
WHERE a.pay_period_schedule_id = c.pay_period_schedule_id
AND a.pay_period_schedule_id = b.id
AND c.user_id = ?
AND a.start_date >= ?
AND a.end_date <= ?
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
* @param string $company_id UUID
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIdAndOverlapStartDateAndEndDate( $company_id, $start_date, $end_date, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.start_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $start_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
'start_date2' => $this->db->BindTimeStamp( $start_date ),
'end_date2' => $this->db->BindTimeStamp( $end_date ),
'start_date3' => $this->db->BindTimeStamp( $start_date ),
'end_date3' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND
(
( a.start_date >= ? AND a.start_date <= ? )
OR
( a.end_date >= ? AND a.end_date <= ? )
OR
( a.start_date <= ? AND a.end_date >= ? )
)
AND ( a.deleted=0 AND b.deleted=0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* Gets all pay periods that start or end between the two dates. Ideal for finding all pay periods that affect a given week.
* @param string $user_id UUID
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdAndOverlapStartDateAndEndDate( $user_id, $start_date, $end_date, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
$ppsuf = new PayPeriodScheduleUserFactory();
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'start_date' => $this->db->BindTimeStamp( $start_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
'start_date2' => $this->db->BindTimeStamp( $start_date ),
'end_date2' => $this->db->BindTimeStamp( $end_date ),
'start_date3' => $this->db->BindTimeStamp( $start_date ),
'end_date3' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
SELECT a.*
FROM ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsuf->getTable() . ' as c ON ( a.pay_period_schedule_id = c.pay_period_schedule_id )
LEFT JOIN ' . $ppsf->getTable() . ' as b ON ( a.pay_period_schedule_id = b.id )
WHERE
c.user_id = ?
AND
(
( a.start_date >= ? AND a.start_date <= ? )
OR
( a.end_date >= ? AND a.end_date <= ? )
OR
( a.start_date <= ? AND a.end_date >= ? )
)
AND ( a.deleted=0 AND b.deleted=0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Query($query, $ph, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdAndEndDate( $user_id, $end_date, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $end_date == '' || $end_date <= 0 ) {
return false;
}
$ppsuf = new PayPeriodScheduleUserFactory();
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'start_date' => $this->db->BindTimeStamp( $end_date ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
SELECT a.*
FROM ' . $this->getTable() . ' as a,
' . $ppsuf->getTable() . ' as c,
' . $ppsf->getTable() . ' as b
WHERE a.pay_period_schedule_id = c.pay_period_schedule_id
AND a.pay_period_schedule_id = b.id
AND c.user_id = ?
AND a.start_date <= ?
AND a.end_date >= ?
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param int $transaction_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdAndTransactionDate( $user_id, $transaction_date, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $transaction_date == '' ) {
return false;
}
$ppsuf = new PayPeriodScheduleUserFactory();
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'start_date' => $this->db->BindTimeStamp( $transaction_date ),
'end_date' => $this->db->BindTimeStamp( $transaction_date ),
];
$query = '
SELECT a.*
FROM ' . $this->getTable() . ' as a,
' . $ppsuf->getTable() . ' as c,
' . $ppsf->getTable() . ' as b
WHERE a.pay_period_schedule_id = c.pay_period_schedule_id
AND a.pay_period_schedule_id = b.id
AND c.user_id = ?
AND a.start_date <= ?
AND a.transaction_date > ?
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $pay_period_schedule_id UUID
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getConflictingByPayPeriodScheduleIdAndStartDateAndEndDate( $pay_period_schedule_id, $start_date, $end_date, $id = null, $where = null, $order = null ) {
Debug::Text( 'Pay Period Schedule ID: ' . $pay_period_schedule_id . ' Start Date: ' . $start_date . ' End Date: ' . $end_date . ' ID: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
if ( $pay_period_schedule_id == '' ) {
return false;
}
if ( $start_date == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
if ( $id == '' ) {
$id = TTUUID::getZeroId(); //Leaving this as NULL can cause the SQL query to not return rows when it should.
}
$start_datestamp = $this->db->BindDate( $start_date );
$end_datestamp = $this->db->BindDate( $end_date );
$start_timestamp = $this->db->BindTimeStamp( $start_date );
$end_timestamp = $this->db->BindTimeStamp( $end_date );
$ph = [
'pay_period_schedule_id' => TTUUID::castUUID( $pay_period_schedule_id ),
'start_date_a' => $start_datestamp,
'end_date_b' => $end_datestamp,
'id' => TTUUID::castUUID( $id ),
'start_date1' => $start_timestamp,
'end_date1' => $end_timestamp,
'start_date2' => $start_timestamp,
'end_date2' => $end_timestamp,
'start_date3' => $start_timestamp,
'end_date3' => $end_timestamp,
'start_date4' => $start_timestamp,
'end_date4' => $end_timestamp,
'start_date5' => $start_timestamp,
'end_date5' => $end_timestamp,
];
//Add filter on date_stamp for optimization
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id = ?
AND a.start_date >= ?
AND a.end_date <= ?
AND a.id != ?
AND
(
( a.start_date >= ? AND a.end_date <= ? )
OR
( a.start_date >= ? AND a.start_date < ? )
OR
( a.end_date > ? AND a.end_date <= ? )
OR
( a.start_date <= ? AND a.end_date >= ? )
OR
( a.start_date = ? AND a.end_date = ? )
)
AND ( a.deleted = 0 )
ORDER BY start_date';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $id UUID
* @param int $start_transaction_date EPOCH
* @param int $end_transaction_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate( $id, $start_transaction_date, $end_transaction_date, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $start_transaction_date == '' ) {
return false;
}
if ( $end_transaction_date == '' ) {
return false;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
'start_date' => $this->db->BindTimeStamp( $start_transaction_date ),
'end_date' => $this->db->BindTimeStamp( $end_transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id = ?
AND a.transaction_date >= ?
AND a.transaction_date <= ?
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $id UUID
* @param $end_date
* @param null $limit
* @param null $page
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
* @throws DBError
*/
function getByPayPeriodScheduleIdAndEndDateBefore( $id, $end_date, $limit = null, $page = null, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $end_date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
'end_date' => $this->db->BindTimeStamp( $end_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id = ?
AND a.end_date < ?
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param string $id UUID
* @param int $start_transaction_date EPOCH
* @param int $end_transaction_date EPOCH
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIDAndPayPeriodScheduleIdAndStartTransactionDateAndEndTransactionDate( $company_id, $id, $start_transaction_date, $end_transaction_date, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $id == '' ) {
return false;
}
if ( $start_transaction_date == '' ) {
return false;
}
if ( $end_transaction_date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $start_transaction_date ),
'end_date' => $this->db->BindTimeStamp( $end_transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsf->getTable() . ' as ppsf ON ( a.pay_period_schedule_id = ppsf.id )
where ppsf.company_id = ?
AND a.transaction_date >= ?
AND a.transaction_date <= ?
AND a.pay_period_schedule_id in ( ' . $this->getListSQL( $id, $ph, 'uuid' ) . ' )
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param string|string[] $id UUID
* @param int|int[] $status_id
* @param int $start_transaction_date EPOCH
* @param int $end_transaction_date EPOCH
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIDAndPayPeriodScheduleIdAndStatusAndStartTransactionDateAndEndTransactionDate( $company_id, $id, $status_id, $start_transaction_date, $end_transaction_date, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $id == '' ) {
return false;
}
if ( $status_id == '' ) {
return false;
}
if ( $start_transaction_date == '' ) {
return false;
}
if ( $end_transaction_date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $start_transaction_date ),
'end_date' => $this->db->BindTimeStamp( $end_transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsf->getTable() . ' as ppsf ON ( a.pay_period_schedule_id = ppsf.id )
where ppsf.company_id = ?
AND a.transaction_date >= ?
AND a.transaction_date <= ?
AND a.pay_period_schedule_id in ( ' . $this->getListSQL( $id, $ph, 'uuid' ) . ' )
AND a.status_id in ( ' . $this->getListSQL( $status_id, $ph, 'int' ) . ' )
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param string $id UUID
* @param int $date EPOCH
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByCompanyIDAndPayPeriodScheduleIdAndAnyDate( $company_id, $id, $date, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $date ),
'end_date' => $this->db->BindTimeStamp( $date ),
'transaction_date' => $this->db->BindTimeStamp( $date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsf->getTable() . ' as ppsf ON ( a.pay_period_schedule_id = ppsf.id )
where ppsf.company_id = ?
AND ( a.start_date >= ? OR a.end_date >= ? OR a.transaction_date >= ? )
AND a.pay_period_schedule_id in ( ' . $this->getListSQL( $id, $ph, 'uuid' ) . ' )
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param string $company_id UUID
* @param string[] $id UUID
* @param int $date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate( $company_id, $id, $date, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
//ID can be blank/NULL, which means we search all pay_period schedules.
if ( $date == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ppsuf = new PayPeriodScheduleUserFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'start_date' => $this->db->BindTimeStamp( $date ),
'end_date' => $this->db->BindTimeStamp( $date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsf->getTable() . ' as ppsf ON ( a.pay_period_schedule_id = ppsf.id )
where ppsf.company_id = ?
AND a.start_date <= ?
AND a.end_date >= ?
AND EXISTS ( SELECT 1 FROM ' . $ppsuf->getTable() . ' as ppsuf WHERE a.pay_period_schedule_id = ppsuf.pay_period_schedule_id )';
$query .= ( isset( $id ) ) ? $this->getWhereClauseSQL( 'a.pay_period_schedule_id', $id, 'uuid_list', $ph ) : null;
$query .= ' AND ( a.deleted = 0 AND ppsf.deleted = 0)';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param string $id UUID
* @param int $date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate( $company_id, $id, $date, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
//ID can be blank/NULL, which means we search all pay_period schedules.
if ( $date == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ppsf = new PayPeriodScheduleFactory();
$ppsuf = new PayPeriodScheduleUserFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'end_date' => $this->db->BindTimeStamp( $date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a,
( select
b.pay_period_schedule_id,
max(b.start_date) as start_date
FROM ' . $this->getTable() . ' as b
LEFT JOIN ' . $ppsf->getTable() . ' as ppsf ON ( b.pay_period_schedule_id = ppsf.id )
where ppsf.company_id = ?
AND b.end_date < ?
AND EXISTS ( SELECT 1 FROM ' . $ppsuf->getTable() . ' as ppsuf WHERE b.pay_period_schedule_id = ppsuf.pay_period_schedule_id )
AND ( b.deleted = 0 AND ppsf.deleted = 0 )
GROUP BY b.pay_period_schedule_id
) as pp2
where a.pay_period_schedule_id = pp2.pay_period_schedule_id
AND a.start_date = pp2.start_date ';
$query .= ( isset( $id ) ) ? $this->getWhereClauseSQL( 'a.pay_period_schedule_id', $id, 'uuid_list', $ph ) : null;
$query .= ' AND ( a.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
return $this;
}
/**
* @param string $id UUID
* @param int $transaction_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByPayPeriodScheduleIdAndTransactionDate( $id, $transaction_date, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $transaction_date == '' ) {
return false;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
'start_date' => $this->db->BindTimeStamp( $transaction_date ),
'end_date' => $this->db->BindTimeStamp( $transaction_date ),
];
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id = ?
AND a.start_date <= ?
AND a.transaction_date > ?
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
//Debug::Text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $id UUID
* @return bool|PayPeriodListFactory
*/
function getPreviousPayPeriodById( $id ) {
if ( $id == '' ) {
return false;
}
$pplf = new PayPeriodListFactory();
$pay_period_obj = $pplf->getById( $id )->getCurrent();
$pay_period_schedule_id = $pay_period_obj->getPayPeriodSchedule();
if ( $pay_period_schedule_id == '' ) {
return false;
}
$ph = [
'pay_period_schedule_id' => TTUUID::castUUID( $pay_period_schedule_id ),
'start_date' => $this->db->BindTimeStamp( $pay_period_obj->getStartDate() ),
];
$query = '
select *
from ' . $this->getTable() . '
where pay_period_schedule_id = ?
AND start_date < ?
AND deleted=0
ORDER BY start_date desc
LIMIT 1';
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param $status
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByStatus( $status, $where = null, $order = null ) {
if ( $status == '' ) {
return false;
}
$ph = [
'status_id' => $status,
];
$query = '
select *
from ' . $this->getTable() . '
where status_id = ?
AND deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_ids UUID
* @param int $status_ids
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdListAndNotStatus( $user_ids, $status_ids, $where = null, $order = null ) {
if ( $user_ids == '' ) {
return false;
}
if ( $status_ids == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ppsuf = new PayPeriodScheduleUserFactory();
$ph = [];
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id in
( select distinct(x.pay_period_schedule_id)
from
' . $ppsuf->getTable() . ' as x,
' . $ppsf->getTable() . ' as z
where x.user_id in ( ' . $this->getListSQL( $user_ids, $ph, 'uuid' ) . ' )
AND z.deleted=0)
AND a.status_id not in ( ' . $this->getListSQL( $status_ids, $ph, 'int' ) . ' )
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_ids UUID
* @param int $status_ids
* @param int $start_date EPOCH
* @param int $end_date EPOCH
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getByUserIdListAndNotStatusAndStartDateAndEndDate( $user_ids, $status_ids, $start_date, $end_date, $where = null, $order = null ) {
if ( $user_ids == '' ) {
return false;
}
if ( $status_ids == '' ) {
return false;
}
if ( (int)$start_date == 0 ) {
return false;
}
if ( (int)$end_date == 0 ) {
$end_date = ( TTDate::getTime() + ( 86400 * 355 ) ); //Only check ahead one year of open pay periods.
}
$ppsf = new PayPeriodScheduleFactory();
$ppsuf = new PayPeriodScheduleUserFactory();
$ph = [];
$user_ids_sql = $this->getListSQL( $user_ids, $ph, 'uuid' );
$ph['start_date'] = $this->db->BindTimeStamp( $start_date );
$ph['end_date'] = $this->db->BindTimeStamp( $end_date );
//Start Date arg should be greater then pay period END DATE.
//So recurring PS amendments start_date can fall anywhere in the pay period and still get applied.
$query = '
select a.*
from ' . $this->getTable() . ' as a
where a.pay_period_schedule_id in
( select distinct(x.pay_period_schedule_id)
from
' . $ppsuf->getTable() . ' as x,
' . $ppsf->getTable() . ' as z
where x.user_id in ( ' . $user_ids_sql . ' )
AND z.deleted=0)
AND a.end_date >= ?
AND a.start_date <= ?
AND a.status_id not in ( ' . $this->getListSQL( $status_ids, $ph, 'int' ) . ' )
AND a.deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool
*/
function getFirstStartDateAndLastEndDateByPayPeriodScheduleId( $id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $order == null ) {
$order = [];
$strict = false;
} else {
$strict = true;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = 'select min(start_date) as first_start_date,
max(end_date) as last_end_date,
count(*) as total
from ' . $this->getTable() . '
where pay_period_schedule_id = ?
AND deleted=0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$retarr = $this->db->GetRow( $query, $ph );
return $retarr;
}
/**
* @param string $company_id UUID
* @return array|bool
*/
function getYearsArrayByCompanyId( $company_id ) {
if ( $company_id == '' ) {
return false;
}
$ppsf = new PayPeriodScheduleFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
];
$query = '
select distinct(extract(year from a.transaction_date))
from ' . $this->getTable() . ' as a,
' . $ppsf->getTable() . ' as b
where a.pay_period_schedule_id = b.id
AND a.company_id = ?
AND a.deleted=0
AND b.deleted=0
ORDER by extract(year from a.transaction_date) desc
';
//$query .= $this->getWhereSQL( $where );
//$query .= $this->getSortSQL( $order );
$year_arr = $this->db->getCol( $query, $ph );
$retarr = [];
foreach ( $year_arr as $year ) {
$retarr[$year] = $year;
}
return $retarr;
}
/**
* @param string $id UUID
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getPayPeriodsWithPayStubsByCompanyId( $id, $limit = null, $page = null, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'a.transaction_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$psf = new PayStubFactory();
//Make sure just one row per pay period is returned.
/*
//This is way too slow on older versions of PGSQL.
$query = '
select a.*
from '. $this->getTable() .' as a
where a.company_id = ?
AND ( a.deleted = 0 )
AND EXISTS ( select id from '. $psf->getTable() .' as b WHERE a.id = b.pay_period_id AND b.deleted = 0)';
*/
$query = ' select distinct a.*
from ' . $this->getTable() . ' as a
LEFT JOIN ' . $psf->getTable() . ' as b on ( a.id = b.pay_period_id )
where a.company_id = ?
AND ( a.deleted = 0 AND b.deleted = 0 )';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
return $this;
}
/**
* @param $company_id
* @param $id
* @param null $transaction_date
* @param null $pay_period_schedule
* @param null $limit
* @param null $page
* @param null $where
* @param null $order
* @return $this|bool
* @throws DBError
*/
function getByCompanyIdAndRemittanceAgencyIdAndTransactionDateAndPayPeriodSchedule( $company_id, $id, $transaction_date = null, $pay_period_schedule = null, $limit = null, $page = null, $where = null, $order = null ) {
Debug::Text( 'Remittance Agency ID: ' . $id . ' Company ID: ' . $company_id . ' Transaction Date: ' . $transaction_date, __FILE__, __LINE__, __METHOD__, 10 );
if ( $id == '' ) {
return false;
}
if ( $company_id == '' ) {
return false;
}
if ( $order == null ) {
$order = [ 'pp.transaction_date' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$udf = new UserDeductionFactory();
$cdf = new CompanyDeductionFactory();
$ppsuf = new PayPeriodScheduleUserFactory();
$ph = [
'payroll_remittance_agency_id' => TTUUID::castUUID( $id ),
'transaction_date' => $this->db->BindTimeStamp( $transaction_date ),
'company_id' => TTUUID::castUUID( $company_id ),
];
$query = '
SELECT DISTINCT pp.* FROM ' . $this->getTable() . ' AS pp
LEFT JOIN ' . $ppsuf->getTable() . ' AS ppsu ON pp.pay_period_schedule_id = ppsu.pay_period_schedule_id
LEFT JOIN ' . $udf->getTable() . ' AS ud ON ppsu.user_id = ud.user_id
LEFT JOIN ' . $cdf->getTable() . ' AS cd ON ud.company_deduction_id = cd.id
WHERE cd.payroll_remittance_agency_id = ?
AND pp.transaction_date > ?
AND pp.company_id = ?
';
if ( is_array( $pay_period_schedule ) && $pay_period_schedule[0] != TTUUID::getNotExistID() && $pay_period_schedule[0] != TTUUID::getZeroID() ) {
$query .= 'AND pp.pay_period_schedule_id in ( ' . $this->getListSQL( $pay_period_schedule, $ph, 'uuid' ) . ' )
';
}
$query .= 'AND pp.deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
return $this;
}
/**
* Gets the maximum date range to cover the start/end date of the specified pay period IDs.
* @param string $company_id UUID
* @param string $pay_period_id UUID
* @return array|bool
*/
function getStartAndEndDateRangeFromCompanyIdAndPayPeriodId( $company_id, $pay_period_id ) {
$pplf = TTnew( 'PayPeriodListFactory' ); /** @var PayPeriodListFactory $pplf */
$pplf->getByIdAndCompanyId( $pay_period_id, TTUUID::castUUID( $company_id ) );
if ( $pplf->getRecordCount() > 0 ) {
$filter_start_date = false;
$filter_end_date = false;
foreach ( $pplf as $pp_obj ) {
if ( $filter_start_date == false || $pp_obj->getStartDate() < $filter_start_date ) {
$filter_start_date = $pp_obj->getStartDate();
}
if ( $filter_end_date == false || $pp_obj->getEndDate() > $filter_end_date ) {
$filter_end_date = $pp_obj->getEndDate();
}
}
Debug::text( ' Found Pay Periods: ' . $pplf->getRecordCount() . ' Start Date: ' . TTDate::getDate( 'DATE', $filter_start_date ) . ' End Date: ' . TTDate::getDate( 'DATE', $filter_end_date ), __FILE__, __LINE__, __METHOD__, 10 );
$retval = [ 'start_date' => $filter_start_date, 'end_date' => $filter_end_date ];
} else {
Debug::text( 'WARNING: No pay period found...', __FILE__, __LINE__, __METHOD__, 10 );
$retval = false;
}
unset( $pplf, $pp_obj );
return $retval;
}
/**
* Get last 6mths worth of pay periods and prepare a JS array so they can be highlighted in the calendar.
* @param bool $include_all_pay_period_schedules
* @return bool|mixed
*/
function getJSCalendarPayPeriodArray( $include_all_pay_period_schedules = false ) {
global $current_company, $current_user;
if ( !is_object( $current_company ) ) {
return false;
}
if ( !is_object( $current_company ) ) {
return false;
}
if ( !is_object( $current_user ) ) {
return false;
}
if ( $include_all_pay_period_schedules == true ) {
$cache_id = 'JSCalendarPayPeriodArray_' . $current_company->getId() . '_0';
} else {
$cache_id = 'JSCalendarPayPeriodArray_' . $current_company->getId() . '_' . $current_user->getId();
}
$retarr = $this->getCache( $cache_id );
if ( $retarr === false ) {
$pplf = new PayPeriodListFactory();
if ( $include_all_pay_period_schedules == true ) {
$pplf->getByCompanyId( $current_company->getId(), 13 );
} else {
$pplf->getByUserId( $current_user->getId(), 13 );
}
$retarr = false;
if ( $pplf->getRecordCount() > 0 ) {
foreach ( $pplf as $pp_obj ) {
//$retarr['start_date'][] = TTDate::getDate('Ymd', $pp_obj->getStartDate() );
$retarr['end_date'][] = TTDate::getDate( 'Ymd', $pp_obj->getEndDate() );
$retarr['transaction_date'][] = TTDate::getDate( 'Ymd', $pp_obj->getTransactionDate() );
}
}
$this->saveCache( $retarr, $cache_id );
}
return $retarr;
}
/**
* @param string $company_id UUID
* @param $filter_data
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|PayPeriodListFactory
*/
function getAPISearchByCompanyIdAndArrayCriteria( $company_id, $filter_data, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( !is_array( $order ) ) {
//Use Filter Data ordering if its set.
if ( isset( $filter_data['sort_column'] ) && $filter_data['sort_order'] ) {
$order = [ Misc::trimSortPrefix( $filter_data['sort_column'] ) => $filter_data['sort_order'] ];
}
}
$additional_order_fields = [ 'status_id', 'type_id', 'period_id', 'pay_period_schedule' ];
$sort_column_aliases = [
'status' => 'status_id',
'type' => 'type_id',
'period' => 'period_id',
'total_punches' => false, //Don't sort by this.
'total_manual_timesheets' => false,
'total_absences' => false,
'pending_requests' => false,
'exceptions_critical' => false,
'exceptions_high' => false,
'exceptions_medium' => false,
'exceptions_low' => false,
'verified_timesheets' => false,
'pending_timesheets' => false,
'total_timesheets' => false,
'ps_amendments' => false,
'pay_stubs' => false,
'pay_stubs_open' => false,
];
$order = $this->getColumnsFromAliases( $order, $sort_column_aliases );
if ( $order == null ) {
//When showing future pay periods, always sort by transaction_date by default, so you can clearly see the pay periods in order.
// Otherwise "period_id=future" will be sorted to the end of the list, and it might look like future pay periods are incorrect because they skipped all the "real" future pay period records that already exist.
if ( isset( $filter_data['show_future_pay_periods'] ) && $filter_data['show_future_pay_periods'] == true ) {
$order = [ 'transaction_date' => 'desc', 'end_date' => 'desc', 'start_date' => 'desc', 'pay_period_schedule_id' => 'asc' ];
} else {
$order = [ 'period_id' => 'asc', 'transaction_date' => 'desc', 'end_date' => 'desc', 'start_date' => 'desc', 'pay_period_schedule_id' => 'asc' ];
}
$strict = false;
} else {
//Always try to order by status first so INACTIVE employees go to the bottom.
if ( !isset( $order['transaction_date'] ) ) {
$order['transaction_date'] = 'desc';
}
$strict = true;
}
//Debug::Arr($order, 'Order Data:', __FILE__, __LINE__, __METHOD__, 10);
//Debug::Arr($filter_data, 'Filter Data:', __FILE__, __LINE__, __METHOD__, 10);
$ppsf = new PayPeriodScheduleFactory();
$uf = new UserFactory();
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
];
//Need to use a sub-query so we can put period_id in the WHERE clause.
$query = '
SELECT * FROM (
SELECT
a.*,
b.name as pay_period_schedule,
b.type_id as type_id,
(
CASE WHEN a.status_id = 30
THEN 30
ELSE ( CASE WHEN a.start_date > NOW()
THEN 100
ELSE ( CASE WHEN a.status_id = 30 OR ( a.status_id != 20 AND now() >= a.end_date AND now() <= a.transaction_date )
THEN 10
ELSE ( CASE WHEN a.end_date < now()
THEN 50
ELSE 20
END
) END
) END
) END
) as period_id,
y.first_name as created_by_first_name,
y.middle_name as created_by_middle_name,
y.last_name as created_by_last_name,
z.first_name as updated_by_first_name,
z.middle_name as updated_by_middle_name,
z.last_name as updated_by_last_name
FROM ' . $this->getTable() . ' as a
LEFT JOIN ' . $ppsf->getTable() . ' as b ON ( a.pay_period_schedule_id = b.id AND b.deleted = 0 )
LEFT JOIN ' . $uf->getTable() . ' as y ON ( a.created_by = y.id AND y.deleted = 0 )
LEFT JOIN ' . $uf->getTable() . ' as z ON ( a.updated_by = z.id AND z.deleted = 0 )
WHERE a.company_id = ?
) as tmp
WHERE 1=1
';
$query .= ( isset( $filter_data['permission_children_ids'] ) ) ? $this->getWhereClauseSQL( 'created_by', $filter_data['permission_children_ids'], 'uuid_list', $ph ) : null;
$query .= ( isset( $filter_data['id'] ) ) ? $this->getWhereClauseSQL( 'id', $filter_data['id'], 'uuid_list', $ph ) : null;
$query .= ( isset( $filter_data['exclude_id'] ) ) ? $this->getWhereClauseSQL( 'id', $filter_data['exclude_id'], 'not_uuid_list', $ph ) : null;
if ( isset( $filter_data['status'] ) && !is_array( $filter_data['status'] ) && trim( $filter_data['status'] ) != '' && !isset( $filter_data['status_id'] ) ) {
$filter_data['status_id'] = Option::getByFuzzyValue( $filter_data['status'], $this->getOptions( 'status' ) );
}
$query .= ( isset( $filter_data['status_id'] ) ) ? $this->getWhereClauseSQL( 'status_id', $filter_data['status_id'], 'numeric_list', $ph ) : null;
if ( isset( $filter_data['type'] ) && !is_array( $filter_data['type'] ) && trim( $filter_data['type'] ) != '' && !isset( $filter_data['type_id'] ) ) {
$filter_data['type_id'] = Option::getByFuzzyValue( $filter_data['type'], $ppsf->getOptions( 'type' ) );
}
$query .= ( isset( $filter_data['type_id'] ) ) ? $this->getWhereClauseSQL( 'type_id', $filter_data['type_id'], 'numeric_list', $ph ) : null;
$query .= ( isset( $filter_data['period_id'] ) ) ? $this->getWhereClauseSQL( 'period_id', $filter_data['period_id'], 'numeric_list', $ph ) : null;
$query .= ( isset( $filter_data['pay_period_schedule_id'] ) ) ? $this->getWhereClauseSQL( 'pay_period_schedule_id', $filter_data['pay_period_schedule_id'], 'uuid_list', $ph ) : null;
$query .= ( isset( $filter_data['pay_period_schedule'] ) ) ? $this->getWhereClauseSQL( 'pay_period_schedule', $filter_data['pay_period_schedule'], 'text', $ph ) : null;
$query .= ( isset( $filter_data['name'] ) ) ? $this->getWhereClauseSQL( 'pay_period_schedule', $filter_data['name'], 'text', $ph ) : null;
if ( isset( $filter_data['start_date'] ) && !is_array( $filter_data['start_date'] ) && trim( $filter_data['start_date'] ) != '' ) {
$ph[] = $this->db->BindTimeStamp( (int)TTDate::parseDateTime( $filter_data['start_date'] ) );
$query .= ' AND start_date >= ?';
}
if ( isset( $filter_data['end_date'] ) && !is_array( $filter_data['end_date'] ) && trim( $filter_data['end_date'] ) != '' ) {
$ph[] = $this->db->BindTimeStamp( (int)TTDate::parseDateTime( $filter_data['end_date'] ) );
$query .= ' AND end_date <= ?';
}
if ( isset( $filter_data['transaction_start_date'] ) && !is_array( $filter_data['transaction_start_date'] ) && trim( $filter_data['transaction_start_date'] ) != '' ) {
$ph[] = $this->db->BindTimeStamp( (int)TTDate::parseDateTime( $filter_data['transaction_start_date'] ) );
$query .= ' AND transaction_date >= ?';
}
if ( isset( $filter_data['transaction_end_date'] ) && !is_array( $filter_data['transaction_end_date'] ) && trim( $filter_data['transaction_end_date'] ) != '' ) {
$ph[] = $this->db->BindTimeStamp( (int)TTDate::parseDateTime( $filter_data['transaction_end_date'] ) );
$query .= ' AND transaction_date <= ?';
}
$query .= ( isset( $filter_data['created_by'] ) ) ? $this->getWhereClauseSQL( [ 'created_by', 'created_by_first_name', 'created_by_last_name' ], $filter_data['created_by'], 'user_id_or_name', $ph ) : null;
$query .= ( isset( $filter_data['updated_by'] ) ) ? $this->getWhereClauseSQL( [ 'updated_by', 'updated_by_first_name', 'updated_by_last_name' ], $filter_data['updated_by'], 'user_id_or_name', $ph ) : null;
$query .= '
AND deleted = 0
';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict, $additional_order_fields );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
return $this;
}
/**
* @param string $user_id UUID
* @param int $date_stamp EPOCH
* @return bool
*/
static function findPayPeriod( $user_id, $date_stamp ) {
if ( TTDate::isValidDate( $date_stamp ) == true && $user_id != '' ) {
$pplf = TTnew( 'PayPeriodListFactory' ); /** @var PayPeriodListFactory $pplf */
$pplf->getByUserIdAndEndDate( $user_id, $date_stamp );
if ( $pplf->getRecordCount() == 1 ) {
$pay_period_id = $pplf->getCurrent()->getID();
//Debug::Text(' Found Pay Period ID: '. $pay_period_id .' For User ID: '. $user_id .' Date: '. TTDate::getDate('DATE+TIME', $date_stamp ), __FILE__, __LINE__, __METHOD__, 10);
return $pay_period_id;
}
}
Debug::Text( 'Unable to find pay period for User ID: ' . $user_id . ' Date Stamp: ' . $date_stamp, __FILE__, __LINE__, __METHOD__, 10 );
return false;
}
}
?>
Reference in New Issue View Git Blame Copy Permalink