472 lines
13 KiB
PHP
472 lines
13 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\Users
|
||
|
|
*/
|
||
|
|
class BankAccountFactory extends Factory {
|
||
|
|
protected $table = 'bank_account';
|
||
|
|
protected $pk_sequence_name = 'bank_account_id_seq'; //PK Sequence name
|
||
|
|
|
||
|
|
protected $user_obj = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $name
|
||
|
|
* @param null $parent
|
||
|
|
* @return array|null
|
||
|
|
*/
|
||
|
|
function _getFactoryOptions( $name, $parent = null ) {
|
||
|
|
|
||
|
|
$retval = null;
|
||
|
|
switch ( $name ) {
|
||
|
|
case 'ach_transaction_type': //ACH transactions require a transaction code that matches the bank account.
|
||
|
|
$retval = [
|
||
|
|
22 => TTi18n::getText( 'Checking' ),
|
||
|
|
32 => TTi18n::getText( 'Savings' ),
|
||
|
|
];
|
||
|
|
break;
|
||
|
|
case 'columns':
|
||
|
|
$retval = [
|
||
|
|
|
||
|
|
'-1010-first_name' => TTi18n::gettext( 'First Name' ),
|
||
|
|
'-1020-last_name' => TTi18n::gettext( 'Last Name' ),
|
||
|
|
|
||
|
|
'-1090-title' => TTi18n::gettext( 'Title' ),
|
||
|
|
'-1099-user_group' => TTi18n::gettext( 'Group' ),
|
||
|
|
'-1100-default_branch' => TTi18n::gettext( 'Branch' ),
|
||
|
|
'-1110-default_department' => TTi18n::gettext( 'Department' ),
|
||
|
|
|
||
|
|
'-5010-transit' => TTi18n::gettext( 'Transit/Routing' ),
|
||
|
|
'-5020-account' => TTi18n::gettext( 'Account' ),
|
||
|
|
'-5030-institution' => TTi18n::gettext( 'Institution' ),
|
||
|
|
|
||
|
|
'-2000-created_by' => TTi18n::gettext( 'Created By' ),
|
||
|
|
'-2010-created_date' => TTi18n::gettext( 'Created Date' ),
|
||
|
|
'-2020-updated_by' => TTi18n::gettext( 'Updated By' ),
|
||
|
|
'-2030-updated_date' => TTi18n::gettext( 'Updated Date' ),
|
||
|
|
];
|
||
|
|
break;
|
||
|
|
case 'list_columns':
|
||
|
|
$retval = Misc::arrayIntersectByKey( $this->getOptions( 'default_display_columns' ), Misc::trimSortPrefix( $this->getOptions( 'columns' ) ) );
|
||
|
|
break;
|
||
|
|
case 'default_display_columns': //Columns that are displayed by default.
|
||
|
|
$retval = [
|
||
|
|
'first_name',
|
||
|
|
'last_name',
|
||
|
|
'account',
|
||
|
|
'institution',
|
||
|
|
];
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $retval;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function _getVariableToFunctionMap( $data ) {
|
||
|
|
$variable_function_map = [
|
||
|
|
'id' => 'ID',
|
||
|
|
'company_id' => 'Company',
|
||
|
|
'user_id' => 'User',
|
||
|
|
'first_name' => false,
|
||
|
|
'last_name' => false,
|
||
|
|
|
||
|
|
'institution' => 'Institution',
|
||
|
|
'transit' => 'Transit',
|
||
|
|
'account' => 'Account',
|
||
|
|
|
||
|
|
'default_branch' => false,
|
||
|
|
'default_department' => false,
|
||
|
|
'user_group' => false,
|
||
|
|
'title' => false,
|
||
|
|
|
||
|
|
'deleted' => 'Deleted',
|
||
|
|
];
|
||
|
|
|
||
|
|
return $variable_function_map;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function getUserObject() {
|
||
|
|
return $this->getGenericObject( 'UserListFactory', $this->getUser(), 'user_obj' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
function getCompany() {
|
||
|
|
return $this->getGenericDataValue( 'company_id' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $value UUID
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setCompany( $value ) {
|
||
|
|
$value = TTUUID::castUUID( $value );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'company_id', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
function getUser() {
|
||
|
|
return $this->getGenericDataValue( 'user_id' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $value UUID
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setUser( $value ) {
|
||
|
|
$value = TTUUID::castUUID( $value );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'user_id', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function isUnique() {
|
||
|
|
if ( $this->getCompany() == false ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( TTUUID::isUUID( $this->getUser() ) && $this->getUser() != TTUUID::getZeroID() && $this->getUser() != TTUUID::getNotExistID() ) {
|
||
|
|
$ph = [
|
||
|
|
'company_id' => TTUUID::castUUID( $this->getCompany() ),
|
||
|
|
'user_id' => TTUUID::castUUID( $this->getUser() ),
|
||
|
|
];
|
||
|
|
|
||
|
|
$query = 'select id from ' . $this->getTable() . ' where company_id = ? AND user_id = ? AND deleted = 0';
|
||
|
|
} else {
|
||
|
|
$ph = [
|
||
|
|
'company_id' => TTUUID::castUUID( $this->getCompany() ),
|
||
|
|
];
|
||
|
|
|
||
|
|
$query = 'select id from ' . $this->getTable() . ' where company_id = ? AND user_id is NULL AND deleted = 0';
|
||
|
|
}
|
||
|
|
$id = $this->db->GetOne( $query, $ph );
|
||
|
|
Debug::Arr( $ph, 'Unique ID: ' . $id . ' Query: ' . $query, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
if ( $id === false ) {
|
||
|
|
return true;
|
||
|
|
} else {
|
||
|
|
if ( $id == $this->getId() ) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
function getInstitution() {
|
||
|
|
return $this->getGenericDataValue( 'institution' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $value
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setInstitution( $value ) {
|
||
|
|
$value = trim( $value );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'institution', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
function getTransit() {
|
||
|
|
return $this->getGenericDataValue( 'transit' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $value
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setTransit( $value ) {
|
||
|
|
$value = trim( $value );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'transit', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param null $value
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
function getSecureAccount( $value = null ) {
|
||
|
|
if ( $value == '' ) {
|
||
|
|
$value = $this->getAccount();
|
||
|
|
}
|
||
|
|
|
||
|
|
//Replace the middle digits leaving only 2 digits on each end, or just 1 digit on each end if the account is too short.
|
||
|
|
$replace_length = ( ( strlen( $value ) - 4 ) >= 4 ) ? ( strlen( $value ) - 4 ) : 3;
|
||
|
|
$start_digit = ( strlen( $value ) >= 7 ) ? 2 : 1;
|
||
|
|
|
||
|
|
$account = str_replace( substr( $value, $start_digit, $replace_length ), str_repeat( '*', $replace_length ), $value );
|
||
|
|
|
||
|
|
return $account;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
function getAccount() {
|
||
|
|
return $this->getGenericDataValue( 'account' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $value
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setAccount( $value ) {
|
||
|
|
//If *'s are in the account number, skip setting it
|
||
|
|
//This allows them to change other data without seeing the account number.
|
||
|
|
if ( stripos( $value, '*' ) !== false ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
$value = $this->Validator->stripNonNumeric( trim( $value ) );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'account', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param bool $ignore_warning
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function Validate( $ignore_warning = true ) {
|
||
|
|
//
|
||
|
|
// BELOW: Validation code moved from set*() functions.
|
||
|
|
//
|
||
|
|
// Company
|
||
|
|
$clf = TTnew( 'CompanyListFactory' ); /** @var CompanyListFactory $clf */
|
||
|
|
$this->Validator->isResultSetWithRows( 'company',
|
||
|
|
$clf->getByID( $this->getCompany() ),
|
||
|
|
TTi18n::gettext( 'Company is invalid' )
|
||
|
|
);
|
||
|
|
// Employee
|
||
|
|
if ( $this->getUser() != TTUUID::getZeroID() ) {
|
||
|
|
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
|
||
|
|
$this->Validator->isResultSetWithRows( 'user',
|
||
|
|
$ulf->getByID( $this->getUser() ),
|
||
|
|
TTi18n::gettext( 'Invalid Employee' )
|
||
|
|
);
|
||
|
|
}
|
||
|
|
// Institution
|
||
|
|
if ( $this->getInstitution() != '' ) {
|
||
|
|
$this->Validator->isNumeric( 'institution',
|
||
|
|
$this->getInstitution(),
|
||
|
|
TTi18n::gettext( 'Invalid institution number, must be digits only' )
|
||
|
|
);
|
||
|
|
if ( $this->Validator->isError( 'institution' ) == false ) {
|
||
|
|
$this->Validator->isLength( 'institution',
|
||
|
|
$this->getInstitution(),
|
||
|
|
TTi18n::gettext( 'Invalid institution number length' ),
|
||
|
|
2,
|
||
|
|
3
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// Transit
|
||
|
|
$this->Validator->isNumeric( 'transit',
|
||
|
|
$this->getTransit(),
|
||
|
|
TTi18n::gettext( 'Invalid transit number, must be digits only' )
|
||
|
|
);
|
||
|
|
if ( $this->Validator->isError( 'transit' ) == false ) {
|
||
|
|
$this->Validator->isLength( 'transit',
|
||
|
|
$this->getTransit(),
|
||
|
|
TTi18n::gettext( 'Invalid transit number length' ),
|
||
|
|
2,
|
||
|
|
15
|
||
|
|
);
|
||
|
|
}
|
||
|
|
// Account
|
||
|
|
$this->Validator->isLength( 'account',
|
||
|
|
$this->getAccount(),
|
||
|
|
TTi18n::gettext( 'Invalid account number length' ),
|
||
|
|
3,
|
||
|
|
20
|
||
|
|
);
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// ABOVE: Validation code moved from set*() functions.
|
||
|
|
//
|
||
|
|
if ( $this->getAccount() == false ) {
|
||
|
|
$this->Validator->isTRUE( 'account',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'Bank account not specified' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
//Make sure this entry is unique.
|
||
|
|
if ( $this->getDeleted() == false && $this->isUnique() == false ) {
|
||
|
|
$this->Validator->isTRUE( 'user_id',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'Bank account already exists for this employee' ) );
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function preSave() {
|
||
|
|
if ( $this->getUser() == false ) {
|
||
|
|
Debug::Text( 'Clearing User value, because this is strictly a company record', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
//$this->setUser( TTUUID::getZeroID() ); //COMPANY record.
|
||
|
|
}
|
||
|
|
|
||
|
|
//PGSQL has a NOT NULL constraint on Instituion number prior to schema v1014A.
|
||
|
|
if ( $this->getInstitution() == false ) {
|
||
|
|
$this->setInstitution( '000' );
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $data
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setObjectFromArray( $data ) {
|
||
|
|
if ( is_array( $data ) ) {
|
||
|
|
$variable_function_map = $this->getVariableToFunctionMap();
|
||
|
|
foreach ( $variable_function_map as $key => $function ) {
|
||
|
|
if ( isset( $data[$key] ) ) {
|
||
|
|
|
||
|
|
$function = 'set' . $function;
|
||
|
|
switch ( $key ) {
|
||
|
|
default:
|
||
|
|
if ( method_exists( $this, $function ) ) {
|
||
|
|
$this->$function( $data[$key] );
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->setCreatedAndUpdatedColumns( $data );
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param null $include_columns
|
||
|
|
* @param bool $permission_children_ids
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getObjectAsArray( $include_columns = null, $permission_children_ids = false ) {
|
||
|
|
$data = [];
|
||
|
|
$variable_function_map = $this->getVariableToFunctionMap();
|
||
|
|
if ( is_array( $variable_function_map ) ) {
|
||
|
|
foreach ( $variable_function_map as $variable => $function_stub ) {
|
||
|
|
if ( $include_columns == null || ( isset( $include_columns[$variable] ) && $include_columns[$variable] == true ) ) {
|
||
|
|
|
||
|
|
$function = 'get' . $function_stub;
|
||
|
|
switch ( $variable ) {
|
||
|
|
case 'account':
|
||
|
|
$data[$variable] = $this->getSecureAccount();
|
||
|
|
break;
|
||
|
|
case 'first_name':
|
||
|
|
case 'last_name':
|
||
|
|
case 'title':
|
||
|
|
case 'user_group':
|
||
|
|
case 'currency':
|
||
|
|
case 'default_branch':
|
||
|
|
case 'default_department':
|
||
|
|
$data[$variable] = $this->getColumn( $variable );
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
if ( method_exists( $this, $function ) ) {
|
||
|
|
$data[$variable] = $this->$function();
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$this->getPermissionColumns( $data, $this->getUser(), $this->getCreatedBy(), $permission_children_ids, $include_columns );
|
||
|
|
$this->getCreatedAndUpdatedColumns( $data, $include_columns );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $data;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $log_action
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function addLog( $log_action ) {
|
||
|
|
if ( $this->getUser() == '' ) {
|
||
|
|
$log_description = TTi18n::getText( 'Company' );
|
||
|
|
} else {
|
||
|
|
$log_description = TTi18n::getText( 'Employee' );
|
||
|
|
|
||
|
|
$u_obj = $this->getUserObject();
|
||
|
|
if ( is_object( $u_obj ) ) {
|
||
|
|
$log_description .= ': ' . $u_obj->getFullName( false, true );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return TTLog::addEntry( $this->getId(), $log_action, TTi18n::getText( 'Bank Account' ) . ' - ' . $log_description, null, $this->getTable(), $this );
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|