460 lines
18 KiB
PHP
460 lines
18 KiB
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".
|
|
*
|
|
********************************************************************************/
|
|
|
|
|
|
/**
|
|
* @package Modules\Company
|
|
*/
|
|
class PayrollRemittanceAgencyListFactory extends PayrollRemittanceAgencyFactory 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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
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 $id UUID
|
|
* @param int $limit Limit the number of records returned
|
|
* @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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
function getByRemittanceSourceAccountId( $id, $limit = null, $where = null, $order = null ) {
|
|
if ( $id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$ph = [
|
|
'remittance_source_account_id' => TTUUID::castUUID( $id ),
|
|
];
|
|
|
|
$query = '
|
|
select *
|
|
from ' . $this->getTable() . '
|
|
where remittance_source_account_id = ?
|
|
AND deleted = 0';
|
|
$query .= $this->getWhereSQL( $where );
|
|
$query .= $this->getSortSQL( $order );
|
|
|
|
$this->rs = $this->ExecuteSQL( $query, $ph, $limit );
|
|
|
|
return $this;
|
|
}
|
|
|
|
|
|
/**
|
|
* @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|PayrollRemittanceAgencyListFactory
|
|
* @throws DBError
|
|
*/
|
|
function getByCompanyId( $company_id, $where = null, $order = null ) {
|
|
|
|
if ( $company_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$lef = new LegalEntityFactory();
|
|
|
|
$ph = [
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
];
|
|
|
|
$query = '
|
|
select a.*
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as b ON ( a.legal_entity_id = b.id )
|
|
where b.company_id = ?
|
|
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 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|PayrollRemittanceAgencyListFactory
|
|
* @throws DBError
|
|
*/
|
|
function getByCompanyIdAndContactUserId( $company_id, $contact_user_id, $limit = null, $where = null, $order = null ) {
|
|
if ( $company_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $contact_user_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$lef = new LegalEntityFactory();
|
|
$praef = new PayrollRemittanceAgencyEventFactory();
|
|
|
|
$ph = [
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
'contact_user_id' => TTUUID::castUUID( $contact_user_id ),
|
|
'contact_user_id_b' => TTUUID::castUUID( $contact_user_id ),
|
|
];
|
|
|
|
$query = '
|
|
select DISTINCT a.*
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as b ON ( a.legal_entity_id = b.id )
|
|
LEFT JOIN ' . $praef->getTable() . ' as praef ON ( a.id = praef.payroll_remittance_agency_id AND praef.deleted = 0 )
|
|
where b.company_id = ?
|
|
AND ( a.contact_user_id = ? OR praef.reminder_user_id = ? )
|
|
AND ( a.deleted = 0 AND b.deleted = 0 )';
|
|
$query .= $this->getWhereSQL( $where );
|
|
$query .= $this->getSortSQL( $order );
|
|
|
|
|
|
$this->rs = $this->ExecuteSQL( $query, $ph, $limit );
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param 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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
function getByIdAndCompanyId( $id, $company_id, $where = null, $order = null ) {
|
|
if ( $id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $company_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$lef = new LegalEntityFactory();
|
|
|
|
$ph = [
|
|
'id' => TTUUID::castUUID( $id ),
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
];
|
|
|
|
$query = '
|
|
select a.*
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as b ON ( a.legal_entity_id = b.id )
|
|
where a.id = ?
|
|
AND b.company_id = ?
|
|
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 $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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
function getByLegalEntityIdAndCompanyId( $id, $company_id, $where = null, $order = null ) {
|
|
if ( $id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $company_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$lef = new LegalEntityFactory();
|
|
|
|
$ph = [
|
|
'legal_entity_id' => TTUUID::castUUID( $id ),
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
];
|
|
|
|
$query = '
|
|
select a.*
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as b ON ( a.legal_entity_id = b.id )
|
|
where a.legal_entity_id = ?
|
|
AND b.company_id = ?
|
|
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 $id UUID
|
|
* @param string $agency_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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
function getByLegalEntityIdAndAgencyIDAndCompanyId( $id, $agency_id, $company_id, $where = null, $order = null ) {
|
|
if ( $id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $agency_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $company_id == '' ) {
|
|
return false;
|
|
}
|
|
|
|
$lef = new LegalEntityFactory();
|
|
|
|
$ph = [
|
|
'legal_entity_id' => TTUUID::castUUID( $id ),
|
|
'agency_id' => (string)$agency_id, //This is a string
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
];
|
|
|
|
$query = '
|
|
select a.*
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as b ON ( a.legal_entity_id = b.id )
|
|
where a.legal_entity_id = ?
|
|
AND a.agency_id = ?
|
|
AND b.company_id = ?
|
|
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 $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|PayrollRemittanceAgencyListFactory
|
|
*/
|
|
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', 'legal_entity_legal_name', 'agency', 'uf.last_name', 'rsaf.name' ];
|
|
|
|
$sort_column_aliases = [
|
|
'status' => 'status_id',
|
|
'type' => 'type_id',
|
|
'agency' => 'agency_id',
|
|
'contact_user' => 'uf.last_name',
|
|
'remittance_source_account' => 'rsaf.name',
|
|
];
|
|
|
|
$order = $this->getColumnsFromAliases( $order, $sort_column_aliases );
|
|
if ( $order == null ) {
|
|
$order = [ 'status_id' => 'asc', 'legal_name' => 'asc', 'name' => 'asc' ];
|
|
$strict = false;
|
|
} else {
|
|
//Always try to order by status first so INACTIVE employees go to the bottom.
|
|
if ( !isset( $order['status_id'] ) ) {
|
|
$order = Misc::prependArray( [ 'status_id' => 'asc' ], $order );
|
|
}
|
|
//Always sort by last name, first name after other columns
|
|
if ( !isset( $order['name'] ) ) {
|
|
$order['name'] = 'asc';
|
|
}
|
|
$strict = true;
|
|
}
|
|
//Debug::Arr($order, 'Order Data:', __FILE__, __LINE__, __METHOD__, 10);
|
|
//Debug::Arr($filter_data, 'Filter Data:', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
$uf = new UserFactory();
|
|
$lef = new LegalEntityFactory();
|
|
$rsaf = new RemittanceSourceAccountFactory();
|
|
|
|
$ph = [
|
|
'company_id' => TTUUID::castUUID( $company_id ),
|
|
];
|
|
|
|
// (
|
|
// CASE WHEN EXISTS ( select 1 from ' . $cdf->getTable() . ' as z where z.payroll_remittance_agency_id = a.id and z.deleted = 0 )
|
|
// THEN 1 ELSE 0
|
|
// END
|
|
// ) as in_use,
|
|
//
|
|
//in_use doesn't make sense here, as several agencies are for reporting only (ie: New Hires, Social Security Administration) and will not have Tax/Deduction records assigned to them.
|
|
$query = '
|
|
select
|
|
_ADODB_COUNT
|
|
a.*,
|
|
uf.first_name,
|
|
uf.last_name,
|
|
lef.legal_name as legal_entity_legal_name,
|
|
rsaf.name as remittance_source_account,
|
|
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
|
|
_ADODB_COUNT
|
|
from ' . $this->getTable() . ' as a
|
|
LEFT JOIN ' . $lef->getTable() . ' as lef ON ( a.legal_entity_id = lef.id AND lef.deleted = 0 )
|
|
LEFT JOIN ' . $rsaf->getTable() . ' as rsaf ON ( a.remittance_source_account_id = rsaf.id AND rsaf.deleted = 0 )
|
|
LEFT JOIN ' . $uf->getTable() . ' as uf ON ( a.contact_user_id = uf.id AND uf.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 lef.company_id = ?';
|
|
|
|
$query .= ( isset( $filter_data['permission_children_ids'] ) ) ? $this->getWhereClauseSQL( 'a.created_by', $filter_data['permission_children_ids'], 'uuid_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['id'] ) ) ? $this->getWhereClauseSQL( 'a.id', $filter_data['id'], 'uuid_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['legal_entity_id'] ) ) ? $this->getWhereClauseSQL( 'a.legal_entity_id', $filter_data['legal_entity_id'], 'uuid_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['agency_id'] ) ) ? $this->getWhereClauseSQL( 'a.agency_id', $filter_data['agency_id'], 'upper_text_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['exclude_id'] ) ) ? $this->getWhereClauseSQL( 'a.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( 'a.status_id', $filter_data['status_id'], 'numeric_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['type_id'] ) ) ? $this->getWhereClauseSQL( 'a.type_id', $filter_data['type_id'], 'numeric_list', $ph ) : null;
|
|
|
|
$query .= ( isset( $filter_data['name'] ) ) ? $this->getWhereClauseSQL( 'a.name', $filter_data['name'], 'text', $ph ) : null;
|
|
|
|
$query .= ( isset( $filter_data['country'] ) ) ? $this->getWhereClauseSQL( 'a.country', $filter_data['country'], 'upper_text_list', $ph ) : null;
|
|
$query .= ( isset( $filter_data['province'] ) ) ? $this->getWhereClauseSQL( 'a.province', $filter_data['province'], 'upper_text_list', $ph ) : null;
|
|
|
|
if ( isset( $filter_data['company_deduction_id'] ) && empty( $filter_data['company_deduction_id'] ) == false ) {
|
|
$cdf = new CompanyDeductionFactory();
|
|
$query .= ' AND a.id IN ( SELECT DISTINCT payroll_remittance_agency_id FROM '. $cdf->getTable() .' as pra WHERE '. $this->getWhereClauseSQL( 'pra.id', $filter_data['company_deduction_id'], 'uuid_list', $ph, null, false ) .' ) ';
|
|
}
|
|
|
|
$query .= ( isset( $filter_data['created_date'] ) ) ? $this->getWhereClauseSQL( 'a.created_date', $filter_data['created_date'], 'date_range', $ph ) : null;
|
|
$query .= ( isset( $filter_data['updated_date'] ) ) ? $this->getWhereClauseSQL( 'a.updated_date', $filter_data['updated_date'], 'date_range', $ph ) : null;
|
|
|
|
|
|
$query .= ( isset( $filter_data['created_by'] ) ) ? $this->getWhereClauseSQL( [ 'a.created_by', 'y.first_name', 'y.last_name' ], $filter_data['created_by'], 'user_id_or_name', $ph ) : null;
|
|
$query .= ( isset( $filter_data['updated_by'] ) ) ? $this->getWhereClauseSQL( [ 'a.updated_by', 'z.first_name', 'z.last_name' ], $filter_data['updated_by'], 'user_id_or_name', $ph ) : null;
|
|
|
|
$query .= ' AND a.deleted = 0 ';
|
|
$query .= $this->getWhereSQL( $where );
|
|
$query .= $this->getSortSQL( $order, $strict, $additional_order_fields );
|
|
|
|
//Debug::Query($query, $ph, __FILE__, __LINE__, __METHOD__, 10);
|
|
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
|
|
|
|
return $this;
|
|
}
|
|
|
|
}
|
|
|
|
?>
|