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

1422 lines
45 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\Payroll Agency
*/
class RemittanceDestinationAccountFactory extends Factory {
protected $table = 'remittance_destination_account';
protected $pk_sequence_name = 'remittance_destination_account_id_seq'; //PK Sequence name
protected $user_obj = null;
protected $remittance_source_account_obj = null;
private $enable_blank_remittance_source_account;
/**
* @param bool $name
* @param null $params
* @return array|bool|null
*/
function _getFactoryOptions( $name = false, $params = null ) {
$retval = null;
switch ( $name ) {
case 'status':
$retval = [
10 => TTi18n::gettext( 'Enabled' ),
20 => TTi18n::gettext( 'Disabled' ),
];
break;
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 'type':
$rsalf = TTnew( 'RemittanceSourceAccountListFactory' ); /** @var RemittanceSourceAccountListFactory $rsalf */
if ( isset( $params['legal_entity_id'] ) ) {
$rsalf->getByLegalEntityId( $params['legal_entity_id'] );
} else if ( isset( $params['company_id'] ) ) {
$rsalf->getByCompanyId( $params['company_id'] );
} else {
return false;
}
$type_options = $rsalf->getOptions( 'type' );
foreach ( $rsalf as $obj ) {
$retval[$obj->getType()] = $type_options[$obj->getType()];
}
if ( $retval == false || count( $retval ) == 0 ) {
$retval = [ 0 => TTi18n::gettext( '-- None --' ) ];
}
ksort( $retval );
Debug::Arr( $retval, 'Available account types for Legal Entity: ' . ( isset( $params['legal_entity_id'] ) ? $params['legal_entity_id'] : 'N/A' ), __FILE__, __LINE__, __METHOD__, 10 );
break;
case 'amount_type':
$retval = [
10 => TTi18n::gettext( 'Percent' ),
20 => TTi18n::gettext( 'Fixed Amount' ),
];
break;
case 'priority':
$retval = [
1 => '1 (' . TTi18n::gettext( 'First' ) . ')',
2 => '2',
3 => '3',
4 => '4',
5 => '5',
6 => '6',
7 => '7',
8 => '8',
9 => '9',
10 => '10 (' . TTi18n::gettext( 'Last' ) . ')',
];
break;
case 'columns':
$retval = [
'-1010-status' => TTi18n::gettext( 'Status' ),
'-1020-type' => TTi18n::gettext( 'Type' ),
'-1030-user_employee_number' => TTi18n::gettext( 'Employee #' ),
'-1040-user_first_name' => TTi18n::gettext( 'First Name' ),
'-1050-user_last_name' => TTi18n::gettext( 'Last Name' ),
'-1100-amount_type' => TTi18n::gettext( 'Amount Type' ),
'-1110-name' => TTi18n::gettext( 'Name' ),
'-1120-priority' => TTi18n::gettext( 'Priority' ),
'-1130-display_amount' => TTi18n::gettext( 'Amount' ), //Needs to be excluded from importing.
//Added to allow importing these columns
'-1140-amount' => TTi18n::gettext( 'Payment Amount' ),
'-1150-percent_amount' => TTi18n::gettext( 'Payment Percent Amount' ),
'-1160-remittance_source_account' => TTi18n::gettext( 'Remittance Source Account' ),
'-1500-value1' => TTi18n::gettext( 'Institution' ),
'-1510-value2' => TTi18n::gettext( 'Transit/Routing' ),
'-1520-value3' => TTi18n::gettext( 'Account' ),
'-1522-ach_transaction_type' => TTi18n::gettext( 'Account Type' ),
'-1900-in_use' => TTi18n::gettext( 'In Use' ),
'-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 = [
'user_first_name',
'user_last_name',
'status',
'type',
'name',
'description',
'priority',
'display_amount',
];
break;
case 'unique_columns': //Columns that are unique, and disabled for mass editing.
$retval = [
'user_id',
'value1',
'value1_1',
'value1_2',
//'value2',
'value3',
'value4',
'value5',
'value6',
'value7',
'value8',
'value9',
'value10',
];
break;
}
return $retval;
}
/**
* @param $data
* @return array
*/
function _getVariableToFunctionMap( $data ) {
$variable_function_map = [
'id' => 'ID',
'remittance_source_account_id' => 'RemittanceSourceAccount',
'remittance_source_account' => false,
'legal_entity_id' => false,
'user_id' => 'User',
'user' => false,
'user_employee_number' => false,
'user_first_name' => false,
'user_last_name' => false,
'status_id' => 'Status',
'status' => false,
'type_id' => 'Type',
'type' => false,
'name' => 'Name',
'description' => 'Description',
'currency_id' => 'Currency',
'currency' => false,
'priority' => 'Priority',
'amount_type_id' => 'AmountType',
'amount_type' => false,
'amount' => 'Amount',
'percent_amount' => 'PercentAmount',
'display_amount' => false, //must come after amount and percent_amount
'ach_transaction_type' => false, //Account Type (Checking/Savings)
'value1' => 'Value1',
'value2' => 'Value2',
'value3' => 'Value3', //encrypted account
'value4' => 'Value4',
'value5' => 'Value5',
'value6' => 'Value6',
'value7' => 'Value7',
'value8' => 'Value8',
'value9' => 'Value9',
'value10' => 'Value10',
'in_use' => false,
'deleted' => 'Deleted',
];
return $variable_function_map;
}
/**
* @return bool
*/
function getUserObject() {
return $this->getGenericObject( 'UserListFactory', $this->getUser(), 'user_obj' );
}
/**
* @return bool
*/
function getRemittanceSourceAccountObject() {
return $this->getGenericObject( 'RemittanceSourceAccountListFactory', $this->getRemittanceSourceAccount(), 'remittance_source_account_obj' );
}
/**
* @return bool|mixed
*/
function getRemittanceSourceAccount() {
return $this->getGenericDataValue( 'remittance_source_account_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setRemittanceSourceAccount( $value ) {
$value = TTUUID::castUUID( $value );
return $this->setGenericDataValue( 'remittance_source_account_id', $value );
}
/**
* @return 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 getLegalEntity() {
if ( is_object( $this->getRemittanceSourceAccountObject() ) ) {
return $this->getRemittanceSourceAccountObject()->getLegalEntity();
}
return false;
}
/**
* @return bool|mixed
*/
function getCurrency() {
return $this->getGenericDataValue( 'currency_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setCurrency( $value ) {
$value = TTUUID::castUUID( $value );
Debug::Text( 'Currency ID: ' . $value, __FILE__, __LINE__, __METHOD__, 10 );
return $this->setGenericDataValue( 'currency_id', $value );
}
/**
* @return bool|int
*/
function getStatus() {
return $this->getGenericDataValue( 'status_id' );
}
/**
* @param $value
* @return bool
*/
function setStatus( $value ) {
$value = (int)$value;
return $this->setGenericDataValue( 'status_id', $value );
}
/**
* @return bool|int
*/
function getType() {
return $this->getGenericDataValue( 'type_id' );
}
/**
* @param $value
* @return bool
*/
function setType( $value ) {
$value = (int)$value;
return $this->setGenericDataValue( 'type_id', $value );
}
/**
* @param $name
* @return bool
*/
function isUniqueName( $name ) {
$name = trim( $name );
if ( is_object( $this->getUserObject() ) ) {
$company_id = $this->getUserObject()->getCompany();
} else {
return false;
}
if ( $name == '' ) {
return false;
}
if ( $company_id == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'user_id' => TTUUID::castUUID( $this->getUser() ),
'name' => $name,
];
$uf = TTnew( 'UserFactory' ); /** @var UserFactory $uf */
$query = 'SELECT a.id
FROM ' . $this->getTable() . ' as a
LEFT JOIN ' . $uf->getTable() . ' as uf ON ( a.user_id = uf.id AND uf.deleted = 0 )
WHERE uf.company_id = ?
AND a.user_id = ?
AND lower(a.name) = lower(?)
AND a.deleted = 0';
$name_id = $this->db->GetOne( $query, $ph );
Debug::Arr( $name_id, 'Unique Name: ' . $name, __FILE__, __LINE__, __METHOD__, 10 );
if ( $name_id === false ) {
return true;
} else {
if ( $name_id == $this->getId() ) {
return true;
}
}
return false;
}
/**
* @return bool|mixed
*/
function getName() {
return $this->getGenericDataValue( 'name' );
}
/**
* @param $value
* @return bool
*/
function setName( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'name', $value );
}
/**
* @return bool|mixed
*/
function getDescription() {
return $this->getGenericDataValue( 'description' );
}
/**
* @param $value
* @return bool
*/
function setDescription( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'description', $value );
}
/**
* @return bool|int
*/
function getAmountType() {
return $this->getGenericDataValue( 'amount_type_id' );
}
/**
* @param int $value
* @return bool
*/
function setAmountType( $value ) {
$value = (int)trim( $value );
return $this->setGenericDataValue( 'amount_type_id', $value );
}
/**
* @return bool|string
*/
function getAmount() {
return Misc::removeTrailingZeros( $this->getGenericDataValue( 'amount' ), 2 );
}
/**
* @param $value
* @return bool
*/
function setAmount( $value ) {
$value = trim( $value );
if ( empty( $value ) ) {
$value = 0;
}
//Pull out only digits and periods.
$value = $this->Validator->stripNonFloat( $value );
return $this->setGenericDataValue( 'amount', $value );
}
/**
* @return string
*/
function getDisplayPercentAmount() {
return Misc::removeTrailingZeros( $this->getPercentAmount(), 0 ) . '%';
}
/**
* @return null
*/
function getPercentAmount() {
return $this->getGenericDataValue( 'percent_amount' );
}
/**
* @param $value
* @return bool
*/
function setPercentAmount( $value ) {
$value = (float)$value;
//$this->data['amount'] = number_format( $value, 2, '.', '');
return $this->setGenericDataValue( 'percent_amount', round( $value, 2 ) );
}
/**
* @return bool|mixed
*/
function getPriority() {
return $this->getGenericDataValue( 'priority' );
}
/**
* @param $value
* @return bool
*/
function setPriority( $value ) {
$value = trim( $value );
//Pull out only digits and periods.
$value = $this->Validator->stripNonNumeric( $value );
return $this->setGenericDataValue( 'priority', $value );
}
/**
* @return bool
*/
function getValue1() {
return $this->getGenericDataValue( 'value1' );
}
/**
* @param $value
* @return bool
*/
function setValue1( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value1', $value );
}
/**
* @return bool
*/
function getValue2() {
return $this->getGenericDataValue( 'value2' );
}
/**
* @param $value
* @return bool
*/
function setValue2( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value2', $value );
}
/**
* VALUE 3 is the account number. It must be stored encrypted.
* @param null $account
* @return bool|string
*/
function getSecureValue3( $account = null ) {
if ( $account == null ) {
$account = $this->getValue3();
}
return Misc::censorString( $account, '*', 1, 2, 1, 4 );
}
/**
* VALUE 3 is the account number. It must be stored encrypted. Use getSecureAccountNumber()
* @param null $value
* @return bool
*/
function getValue3( $value = null ) {
if ( $value == null ) {
$value = $this->getGenericDataValue( 'value3' );
}
$value = Misc::decrypt( $value );
//We must check is_numeric to ensure that the value properly decrypted.
if ( isset( $value ) && $this->Validator->isAlphaNumeric( null, $value ) == false ) {
Debug::Text( 'DECRYPTION FAILED: Your salt may have changed.', __FILE__, __LINE__, __METHOD__, 10 );
} else {
return $value;
}
return false;
}
/**
* VALUE 3 is the account number. It needs to be encrypted.
* @param $value
* @return bool
*/
function setValue3( $value ) {
//If X's are in the account number, skip setting it
// Also if a colon is in the account number, its likely an encrypted string, also skip.
//This allows them to change other data without seeing the account number.
//$value = $this->Validator->stripNonAlphaNumeric( trim( $value ) ); //Don't strip invalid characters to be a little more strict on ensuring what they input is correct.
$value = trim( $value );
if ( stripos( $value, '*' ) !== false || stripos( $value, ':' ) !== false ) {
return false;
}
if ( $value != '' ) { //Make sure we can clear out the value if needed. Misc::encypt() will return FALSE on a blank value.
$encrypted_value = Misc::encrypt( $value );
if ( $encrypted_value === false ) {
return false;
}
} else {
$encrypted_value = $value;
}
return $this->setGenericDataValue( 'value3', $encrypted_value );
}
/**
* @return bool
*/
function getValue4() {
return $this->getGenericDataValue( 'value4' );
}
/**
* @param $value
* @return bool
*/
function setValue4( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value4', $value );
}
/**
* @return bool
*/
function getValue5() {
return $this->getGenericDataValue( 'value5' );
}
/**
* @param $value
* @return bool
*/
function setValue5( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value5', $value );
}
/**
* @return bool
*/
function getValue6() {
return $this->getGenericDataValue( 'value6' );
}
/**
* @param $value
* @return bool
*/
function setValue6( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value6', $value );
}
/**
* @return bool
*/
function getValue7() {
return $this->getGenericDataValue( 'value7' );
}
/**
* @param $value
* @return bool
*/
function setValue7( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value7', $value );
}
/**
* @return bool
*/
function getValue8() {
return $this->getGenericDataValue( 'value8' );
}
/**
* @param $value
* @return bool
*/
function setValue8( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value8', $value );
}
/**
* @return bool
*/
function getValue9() {
return $this->getGenericDataValue( 'value9' );
}
/**
* @param $value
* @return bool
*/
function setValue9( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value9', $value );
}
/**
* @return bool
*/
function getValue10() {
return $this->getGenericDataValue( 'value10' );
}
/**
* @param $value
* @return bool
*/
function setValue10( $value ) {
$value = trim( $value );
return $this->setGenericDataValue( 'value10', $value );
}
/**
* @return bool
*/
function getEnableBlankRemittanceSourceAccount() {
if ( isset( $this->enable_blank_remittance_source_account ) ) {
return $this->enable_blank_remittance_source_account;
}
return false;
}
/**
* @param $bool
* @return bool
*/
function setEnableBlankRemittanceSourceAccount( $bool ) {
$this->enable_blank_remittance_source_account = $bool;
return true;
}
/**
* Migrates RemittanceDestinationAccount as best as it possibly can for an employee when switching legal entities.
* @param $user_obj object
* @param $data_diff array
* @return bool
*/
static function MigrateLegalEntity( $user_obj, $data_diff ) {
//Get all RemittanceSourceAccounts assign to the new legal entity so we can quickly loop over them.
$rsalf = TTnew( 'RemittanceSourceAccountListFactory' ); /** @var RemittanceSourceAccountListFactory $rsalf */
$rsalf->StartTransaction();
$rsalf->getByCompanyId( $user_obj->getCompany() );
$rdalf = TTnew( 'RemittanceDestinationAccountListFactory' ); /** @var RemittanceDestinationAccountListFactory $rdalf */
$rdalf->getByUserIdAndCompany( $user_obj->getId(), $user_obj->getCompany() );
if ( $rdalf->getRecordCount() > 0 ) {
Debug::text( 'Legal Entity changed. Trying to match all RemittanceDestiationAccount data to new entity for user: ' . $user_obj->getId(), __FILE__, __LINE__, __METHOD__, 10 );
foreach ( $rdalf as $rda_obj ) {
if ( $rda_obj->getStatus() != 10 ) { //Skip disabled accounts.
Debug::text( ' Skipping due to disabled RDA: ' . $rda_obj->getName() . '(' . $rda_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
continue;
}
if ( is_object( $rda_obj->getRemittanceSourceAccountObject() ) && $rda_obj->getRemittanceSourceAccountObject()->getLegalEntity() == TTUUID::getNotExistID() ) {
Debug::text( ' Skipping due to source account assigned to ANY legal entity, no need to make a change: ' . $rda_obj->getName() . '(' . $rda_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
continue;
}
$matched_remittance_source_account_id = [];
if ( $rsalf->getRecordCount() > 0 ) {
foreach ( $rsalf as $rsa_obj ) {
if ( ( $rsa_obj->getLegalEntity() == $user_obj->getLegalEntity() || $rsa_obj->getLegalEntity() == TTUUID::getNotExistID() )
&& $rda_obj->getType() == $rsa_obj->getType() ) {
Debug::text( ' Match Found! Remittance Source Account: ' . $rsa_obj->getName() . '(' . $rsa_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
$matched_remittance_source_account_id[] = $rsa_obj->getId();
} else {
Debug::text( ' NOT a Match... Remittance Source Account: ' . $rsa_obj->getName() . '(' . $rsa_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
}
}
}
if ( count( $matched_remittance_source_account_id ) == 1 ) {
//Create new RDA record because if the old one is assigned to any transactions it will fail anyways.
$tmp_rda_obj = clone $rda_obj;
$tmp_rda_obj->setId( false );
$tmp_rda_obj->setName( Misc::generateCopyName( $tmp_rda_obj->getName() ) );
$tmp_rda_obj->setRemittanceSourceAccount( $matched_remittance_source_account_id[0] );
if ( $tmp_rda_obj->isValid() ) {
$tmp_rda_obj->Save();
}
unset( $tmp_rda_obj );
} else {
Debug::text( ' No Match Found (' . count( $matched_remittance_source_account_id ) . ')! Disabling RemittanceDestinationAccount: ' . $rda_obj->getName() . '(' . $rda_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
}
//Always disable the old RDA, as a new one is created above if necessary.
$rda_obj->setStatus( 20 ); //Disabled
if ( $rda_obj->isValid() ) {
$rda_obj->Save();
} else {
Debug::text( ' ERROR! Validation failed when reassigning RemittanceDestination records: ' . $rda_obj->getName() . '(' . $rda_obj->getId() . ')', __FILE__, __LINE__, __METHOD__, 10 );
}
}
}
$rsalf->CommitTransaction();
unset( $rsalf, $rdalf, $rda_obj, $rsa_obj );
return true;
}
/**
* @param bool $ignore_warning
* @return bool
* @noinspection PhpStatementHasEmptyBodyInspection
*/
function Validate( $ignore_warning = true ) {
//
// BELOW: Validation code moved from set*() functions.
//
$country = is_object( $this->getRemittanceSourceAccountObject() ) ? $this->getRemittanceSourceAccountObject()->getCountry() : false;
if ( $this->getDeleted() == false ) {
// Remittance source account
if ( $this->getRemittanceSourceAccount() !== false && $this->getRemittanceSourceAccount() != TTUUID::getZeroID() && !$this->getEnableBlankRemittanceSourceAccount() ) {
$lf = TTnew( 'RemittanceSourceAccountListFactory' ); /** @var RemittanceSourceAccountListFactory $lf */
$this->Validator->isResultSetWithRows( 'remittance_source_account_id',
$lf->getByID( $this->getRemittanceSourceAccount() ),
TTi18n::gettext( 'Remittance source account is invalid' )
);
}
// User
if ( $this->Validator->getValidateOnly() == false ) {
if ( $this->getUser() == false ) {
$this->Validator->isTrue( 'user_id',
false,
TTi18n::gettext( 'Please specify employee' )
);
}
}
if ( ( $this->getUser() != false && $this->Validator->isError( 'user_id' ) == false ) ) {
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
$this->Validator->isResultSetWithRows( 'user_id',
$ulf->getByID( $this->getUser() ),
TTi18n::gettext( 'Invalid Employee' )
);
}
// Currency
if ( $this->getCurrency() !== false && $this->getCurrency() != TTUUID::getZeroID() ) {
$culf = TTnew( 'CurrencyListFactory' ); /** @var CurrencyListFactory $culf */
$this->Validator->isResultSetWithRows( 'currency_id',
$culf->getByID( $this->getCurrency() ),
TTi18n::gettext( 'Invalid Currency' )
);
}
// Status
if ( $this->Validator->getValidateOnly() == false ) {
if ( $this->getStatus() == false ) {
$this->Validator->isTrue( 'status_id',
false,
TTi18n::gettext( 'Please specify status' ) );
}
}
if ( $this->getStatus() !== false && $this->Validator->isError( 'status_id' ) == false ) {
$this->Validator->inArrayKey( 'status',
$this->getStatus(),
TTi18n::gettext( 'Incorrect Status' ),
$this->getOptions( 'status' )
);
}
// Type
if ( $this->Validator->getValidateOnly() == false ) { //Don't check the below when mass editing.
if ( $this->getType() == false ) {
$this->Validator->isTrue( 'type_id',
false,
TTi18n::gettext( 'Please specify type' )
);
}
}
if ( $this->getType() !== false && $this->Validator->isError( 'type_id' ) == false && $this->getRemittanceSourceAccount() != TTUUID::getZeroID() ) {
$this->Validator->inArrayKey( 'type_id',
$this->getType(),
TTi18n::gettext( 'Incorrect Type' ),
$this->getOptions( 'type', [ 'legal_entity_id' => $this->getLegalEntity() ] )
);
}
// Name
if ( $this->Validator->getValidateOnly() == false ) {
if ( $this->getName() == '' ) {
$this->Validator->isTRUE( 'name',
false,
TTi18n::gettext( 'Please specify a name' ) );
}
}
if ( $this->getName() != '' && $this->Validator->isError( 'name' ) == false ) {
$this->Validator->isLength( 'name',
$this->getName(),
TTi18n::gettext( 'Name is too short or too long' ),
2, 100
);
}
if ( $this->getName() != '' && $this->Validator->isError( 'name' ) == false && $this->getUser() != TTUUID::getZeroID() ) {
$this->Validator->isTrue( 'name',
$this->isUniqueName( $this->getName() ),
TTi18n::gettext( 'Name already exists' )
);
}
// Description
$this->Validator->isLength( 'description',
$this->getDescription(),
TTi18n::gettext( 'Description is invalid' ),
0, 255
);
// Amount type
if ( $this->Validator->getValidateOnly() == false ) {
if ( $this->getAmountType() == false ) {
$this->Validator->isTrue( 'amount_type_id',
false,
TTi18n::gettext( 'Please specify amount type' )
);
}
}
if ( $this->getAmountType() !== false && $this->Validator->isError( 'amount_type_id' ) == false ) {
$this->Validator->inArrayKey( 'amount_type_id',
$this->getAmountType(),
TTi18n::gettext( 'Incorrect amount type' ),
$this->getOptions( 'amount_type' )
);
}
// Amount
if ( $this->getAmount() != '' ) {
$this->Validator->isNumeric( 'amount',
$this->getAmount(),
TTi18n::gettext( 'Incorrect Amount' )
);
}
// Percent
if ( $this->getAmountType() == 10 && $this->getPercentAmount() != '' ) {
$this->Validator->isFloat( 'percent_amount',
$this->getPercentAmount(),
TTi18n::gettext( 'Invalid Percent' )
);
if ( $this->Validator->isError( 'percent_amount' ) == false ) {
$this->Validator->isLessThan( 'percent_amount',
$this->getPercentAmount(),
TTi18n::gettext( 'Percent must be less than 100%' ),
100
);
}
if ( $this->Validator->isError( 'percent_amount' ) == false ) {
$this->Validator->isGreaterThan( 'percent_amount',
$this->getPercentAmount(),
TTi18n::gettext( 'Percent must be more than 1%' ),
1
);
}
}
// Priority
if ( $this->Validator->getValidateOnly() == false ) {
if ( $this->getPriority() == false ) {
$this->Validator->isTrue( 'priority',
false,
TTi18n::gettext( 'Please specify priority' )
);
}
}
if ( $this->getPriority() !== false && $this->Validator->isError( 'priority' ) == false ) {
$this->Validator->isNumeric( 'priority',
$this->getPriority(),
TTi18n::gettext( 'Priority is invalid' )
);
}
// Value 4
if ( $this->getValue4() != '' ) {
$this->Validator->isLength( 'value4',
$this->getValue4(),
TTi18n::gettext( 'Value 4 is invalid' ),
1, 255
);
}
// Value 5
if ( $this->getValue5() != '' ) {
$this->Validator->isLength( 'value5',
$this->getValue5(),
TTi18n::gettext( 'Value 5 is invalid' ),
1, 255
);
}
// Value 6
if ( $this->getValue6() != '' ) {
$this->Validator->isLength( 'value6',
$this->getValue6(),
TTi18n::gettext( 'Value 6 is invalid' ),
1, 255
);
}
// Value 7
if ( $this->getValue7() != '' ) {
$this->Validator->isLength( 'value7',
$this->getValue7(),
TTi18n::gettext( 'Value 7 is invalid' ),
1, 255
);
}
// Value 8
if ( $this->getValue8() != '' ) {
$this->Validator->isLength( 'value8',
$this->getValue8(),
TTi18n::gettext( 'Value 8 is invalid' ),
1, 255
);
}
// Value 9
if ( $this->getValue9() != '' ) {
$this->Validator->isLength( 'value9',
$this->getValue9(),
TTi18n::gettext( 'Value 9 is invalid' ),
1, 255
);
}
// Value 10
if ( $this->getValue10() != '' ) {
$this->Validator->isLength( 'value10',
$this->getValue10(),
TTi18n::gettext( 'Value 10 is invalid' ),
1, 255
);
}
//
// ABOVE: Validation code moved from set*() functions.
//
//Make sure Source Account and Destination Account types match.
if ( $this->getRemittanceSourceAccount() !== false && $this->getType() !== false ) {
if ( is_object( $this->getRemittanceSourceAccountObject() ) ) {
if ( $this->getRemittanceSourceAccountObject()->getType() != $this->getType() ) {
$this->Validator->isTrue( 'remittance_source_account_id',
false,
TTi18n::gettext( 'Source Account is invalid, type mismatch' ) );
}
if ( $this->getStatus() == 10 && $this->getRemittanceSourceAccountObject()->getStatus() != 10 ) {
$this->Validator->isTrue( 'remittance_source_account_id',
false,
TTi18n::gettext( 'Source Account is disable, unable to link an enabled pay method to it' ) );
}
}
}
if ( $this->getAmountType() == 20 ) {
if ( (int)$this->getAmount() == 0 ) {
$this->Validator->isTrue( 'amount',
false,
TTi18n::gettext( 'Amount is 0 or not specified' )
);
}
} else {
if ( $this->getAmountType() == 10 ) {
if ( $this->getPercentAmount() == 0 || $this->getPercentAmount() == 0.00 ) {
$this->Validator->isTrue( 'percent_amount',
false,
TTi18n::gettext( 'Percent is 0 or not specified' )
);
} else {
if ( $this->getPercentAmount() < 0 || (int)$this->getPercentAmount() > 100 ) {
$this->Validator->isTrue( 'percent_amount',
false,
TTi18n::gettext( 'Percent is less than 0 or more than 100' )
);
}
}
}
}
if ( $this->Validator->getValidateOnly() == false ) { //Make sure we can mass edit type/source account, so validating these has to be delayed.
if ( $this->getStatus() == 10 ) { //10=Enabled - Only validate when status is enabled, so records that are invalid but used in the past can always be disabled.
if ( $this->getType() == 2000 ) {
/**
* Currently hiding these options from the UI because we aren't printing MICR codes yet so we don't want to validate them.
*/
// if ( strlen( $this->getValue2() ) < 2 OR strlen( $this->getValue2() ) > 15 ) {
// $this->Validator->isTrue( 'value2',
// FALSE,
// TTi18n::gettext('Invalid routing number length'));
// } else {
// $this->Validator->isNumeric( 'value2',
// $this->getValue2(),
// TTi18n::gettext('Invalid routing number, must be digits only'));
// }
// if ( strlen( $this->getValue3() ) < 3 OR strlen( $this->getValue3() ) > 20 ) {
// $this->Validator->isTrue( 'value3',
// FALSE,
// TTi18n::gettext('Invalid account number length'));
// } else {
// $this->Validator->isNumeric( 'value3',
// $this->getValue3(),
// TTi18n::gettext('Invalid account number, must be digits only'));
// }
} else {
if ( $this->getType() == 3000 && $country == 'US' && is_object( $this->getRemittanceSourceAccountObject() ) ) {
if ( $this->getValue1() == false ) {
$this->Validator->isTrue( 'value1_2', //JS uses value1_2 to reference this field.
false,
TTi18n::gettext( 'Account Type must be specified' ) );
}
if ( strlen( $this->getValue2() ) != 9 ) {
$this->Validator->isTrue( 'value2',
false,
TTi18n::gettext( 'Invalid routing number length' ) );
} else {
$this->Validator->isDigits( 'value2',
$this->getValue2(),
TTi18n::gettext( 'Invalid routing number, must be digits only' ) );
}
if ( $this->getValue3() !== false && ( strlen( $this->getValue3() ) < 3 || strlen( $this->getValue3() ) > 17 ) ) {
$this->Validator->isTrue( 'value3',
false,
TTi18n::gettext( 'Invalid account number length' ) );
} else {
$this->Validator->isAlphaNumeric( 'value3',
$this->getValue3(),
TTi18n::gettext( 'Invalid account number, must be alpha numeric only' ) );
}
} else if ( $this->getType() == 3000 && $country == 'CA' && is_object( $this->getRemittanceSourceAccountObject() ) ) {
if ( strlen( $this->getValue1() ) != 3 ) {
$this->Validator->isTrue( 'value1',
false,
TTi18n::gettext( 'Invalid institution number length' ) );
} else {
$this->Validator->isDigits( 'value1',
$this->getValue1(),
TTi18n::gettext( 'Invalid institution, must be digits only' ) );
}
if ( strlen( $this->getValue2() ) != 5 ) {
$this->Validator->isTrue( 'value2',
false,
TTi18n::gettext( 'Invalid transit number length' ) );
} else {
$this->Validator->isDigits( 'value2',
$this->getValue2(),
TTi18n::gettext( 'Invalid transit number, must be digits only' ) );
}
if ( $this->getValue3() !== false && ( strlen( $this->getValue3() ) < 3 || strlen( $this->getValue3() ) > 12 ) ) {
$this->Validator->isTrue( 'value3',
false,
TTi18n::gettext( 'Invalid account number length' ) );
} else {
$this->Validator->isDigits( 'value3',
$this->getValue3(),
TTi18n::gettext( 'Invalid account number, must be digits only' ) );
}
}
}
}
}
//Make sure the name does not contain the account number for security reasons.
// **NOTE: If the stripos() needle is a false, null, or an empty string and haystack is also empty it will return 0 rather than FALSE. So just use a random UUID to work around this.
$this->Validator->isTrue( 'name',
( ( stripos( $this->Validator->stripNonNumeric( $this->getName() ), ( ( $this->getValue3() == '' ) ? TTUUID::generateUUID() : $this->getValue3() ) ) !== false ) ? false : true ),
TTi18n::gettext( 'Account number must not be a part of the Name' ) );
//Make sure the description does not contain the account number for security reasons.
$this->Validator->isTrue( 'description',
( ( stripos( $this->Validator->stripNonNumeric( $this->getDescription() ), ( ( $this->getValue3() == '' ) ? TTUUID::generateUUID() : $this->getValue3() ) ) !== false ) ? false : true ),
TTi18n::gettext( 'Account number must not be a part of the Description' ) );
//Even if Payment Services is not enabled, we can still validate bank account information while being unauthenticated.
if ( PRODUCTION == true && $ignore_warning == false && $this->getStatus() == 10 && $this->getType() == 3000 && is_object( $this->getRemittanceSourceAccountObject() ) == true && is_object( $this->getRemittanceSourceAccountObject()->getLegalEntityObject() ) ) { //3000=EFT/ACH
$le_obj = $this->getRemittanceSourceAccountObject()->getLegalEntityObject();
if ( getTTProductEdition() >= TT_PRODUCT_PROFESSIONAL && is_object( $le_obj ) && is_object( $le_obj->getCompanyObject() ) && $le_obj->getCompanyObject()->getProductEdition() >= TT_PRODUCT_PROFESSIONAL ) {
try {
$tt_ps_api = $le_obj->getPaymentServicesAPIObject();
$retval = $tt_ps_api->validateBankAccount( $tt_ps_api->convertRemittanceDestinationAccountObjectToBankAccountArray( $this, $this->getRemittanceSourceAccountObject(), $this->getUserObject() ) );
if ( is_object( $retval ) && $retval->isValid() === false ) {
Debug::Text( 'ERROR! Unable to validate remittance destination account data through Payment Services API... (a)', __FILE__, __LINE__, __METHOD__, 10 );
$api_f = new APIRemittanceDestinationAccount();
$validation_arr = $api_f->convertAPIReturnHandlerToValidatorObject( $retval->getResultData() );
$this->Validator->merge( $validation_arr );
}
} catch ( Exception $e ) {
Debug::Text( 'ERROR! Unable to validate remittance destination account data... (b) Exception: ' . $e->getMessage(), __FILE__, __LINE__, __METHOD__, 10 );
}
}
}
}
$pstlf = TTnew( 'PayStubTransactionListFactory' ); /** @var PayStubTransactionListFactory $pstlf */
$pstlf->getByRemittanceDestinationAccountId( $this->getId(), 1 ); //Limit 1
if ( $pstlf->getRecordCount() > 0 ) {
//Ensure that only account detail items trigger this validation
// Allow remittance_source_account_id to be changed in case the employer changes bank accounts and needs to modify it on-mass for all employees.
// If we don't allow this then the employer would need to go back to their employees to get new bank account information and it would be hugely disruptive.
$disallowed_edit_fields = [ 'type_id' ]; //'remittance_source_account_id'
//There is a case where before a destination account is used, it changes from EFT/ACH to Check (this is intentionally allowed), so it has a bank account number associated with it that for some reason might not get cleared.
// Then as a check format it gets assigned to a pay stub, then the user tries to disable it. We need to make sure we don't check for value1,2,3 to change when its already a check format, but still check that the type doesn't change ever.
if ( $this->getType() == 3000 ) {
if ( $country == 'CA' ) {
$disallowed_edit_fields[] = 'value1'; //US must be able to change account type.
}
$disallowed_edit_fields[] = 'value2';
$disallowed_edit_fields[] = 'value3';
}
$changed_fields = array_keys( $this->getDataDifferences() );
$edited_fields_valid = true;
$first_invalid_key = null;
foreach ( $changed_fields as $key ) {
if ( in_array( $key, $disallowed_edit_fields ) ) {
$first_invalid_key = $key;
$edited_fields_valid = false;
break;
}
}
//Don't allow editing payment methods and changing the type or bank account details if transactions exist for it
$this->Validator->isTrue( $first_invalid_key,
$edited_fields_valid,
TTi18n::gettext( 'Payment Method is currently in use by Transactions, may need to create a new Payment Method instead' )
);
}
unset( $pstlf, $disallowed_edit_fields, $changed_fields, $edited_fields_valid, $first_invalid_key );
return true;
}
/**
* @return bool
*/
function preValidate() {
//Make sure if we are using a 'Check' format, we always clear bank format values, so we don't get into a situation where its a Check format and a bank account field is populated, which could cause validation errors.
if ( $this->getType() == 2000 ) {
$this->setValue1( '' );
$this->setValue2( '' );
$this->setValue3( '' );
}
if ( is_object( $this->getRemittanceSourceAccountObject() ) == true ) {
//FIXME: Remove this if we enable the currency field in the UI.
//This was done because we don't need to be able to edit the destination account currency via the UI at this time, and destinations currencies will match source currencies now.
$this->setCurrency( $this->getRemittanceSourceAccountObject()->getCurrency() );
} else {
Debug::Text( 'WARNING: Remittance Source Account is blank/invalid, disabling destination account...', __FILE__, __LINE__, __METHOD__, 10 );
$this->setCurrency( TTUUID::getZeroID() );
$this->setStatus( 20 );
}
if ( $this->getDeleted() == true ) {
$pstlf = TTnew( 'PayStubTransactionListFactory' ); /** @var PayStubTransactionListFactory $pstlf */
$pstlf->getByRemittanceDestinationAccountId( $this->getId() );
if ( $pstlf->getRecordCount() > 0 ) {
Debug::Text( 'Pay Stub Transactions exist for Remittance Destination Account ID: ' . $this->getID() . ' disabled instead of deleted', __FILE__, __LINE__, __METHOD__, 10 );
$this->setDeleted( false );
$this->setStatus( 20 );
}
}
return true;
}
/**
* @return bool
*/
function postSave() {
$this->removeCache( $this->getId() );
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 ) {
case 'ach_transaction_type':
$this->setValue1( $data[$key] );
break;
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 mixed
*/
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 'in_use':
case 'user_employee_number':
case 'user_first_name':
case 'user_last_name':
case 'remittance_source_account':
case 'currency_id':
case 'currency':
case 'legal_entity_id':
$data[$variable] = $this->getColumn( $variable );
break;
case 'type':
$rsaf = TTnew( 'RemittanceSourceAccountFactory' ); /** @var RemittanceSourceAccountFactory $rsaf */
$function = 'get' . $variable;
if ( method_exists( $this, $function ) ) {
$data[$variable] = Option::getByKey( $this->$function(), $rsaf->getOptions( $variable ) );
}
break;
case 'status':
$function = 'get' . $variable;
if ( method_exists( $this, $function ) ) {
$data[$variable] = Option::getByKey( $this->$function(), $this->getOptions( $variable ) );
}
break;
case 'amount_type':
$data[$variable] = Option::getByKey( $this->getAmountType(), $this->getOptions( $variable ) );
break;
case 'percent_amount':
$data[$variable] = $this->getDisplayPercentAmount();
break;
case 'display_amount':
if ( $this->getAmountType() == 10 ) { //Show percent sign at end, so the user can tell the difference.
$data[$variable] = $this->getDisplayPercentAmount();
} else {
$data[$variable] = $this->getAmount();
}
break;
case 'value3': //account number
$data[$variable] = $this->getSecureValue3();
break;
case 'ach_transaction_type':
if ( $this->getType() == 3000 && $this->getValue3() != '' ) { //US ACH
$data[$variable] = Option::getByKey( $this->getValue1(), $this->getOptions( $variable ) );
}
break;
default:
if ( method_exists( $this, $function ) ) {
$data[$variable] = $this->$function();
}
break;
}
}
}
$this->getPermissionColumns( $data, $this->getColumn( 'user_id' ), $this->getCreatedBy(), $permission_children_ids, $include_columns );
$this->getCreatedAndUpdatedColumns( $data, $include_columns );
}
return $data;
}
/**
* @param $log_action
* @return bool
*/
function addLog( $log_action ) {
return TTLog::addEntry( $this->getId(), $log_action, TTi18n::getText( 'Employee Payment Method' ) . ': ' . $this->getName(), null, $this->getTable(), $this );
}
}
?>
Reference in New Issue View Git Blame Copy Permalink