394 lines
12 KiB
PHP
394 lines
12 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\Policy
|
||
|
|
*/
|
||
|
|
class ContributingPayCodePolicyFactory extends Factory {
|
||
|
|
protected $table = 'contributing_pay_code_policy';
|
||
|
|
protected $pk_sequence_name = 'contributing_pay_code_policy_id_seq'; //PK Sequence name
|
||
|
|
|
||
|
|
protected $company_obj = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $name
|
||
|
|
* @param null $parent
|
||
|
|
* @return array|null
|
||
|
|
*/
|
||
|
|
function _getFactoryOptions( $name, $parent = null ) {
|
||
|
|
$retval = null;
|
||
|
|
switch ( $name ) {
|
||
|
|
case 'columns':
|
||
|
|
$retval = [
|
||
|
|
'-1010-name' => TTi18n::gettext( 'Name' ),
|
||
|
|
'-1020-description' => TTi18n::gettext( 'Description' ),
|
||
|
|
|
||
|
|
'-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 = [
|
||
|
|
'name',
|
||
|
|
'description',
|
||
|
|
'updated_date',
|
||
|
|
'updated_by',
|
||
|
|
];
|
||
|
|
break;
|
||
|
|
case 'unique_columns': //Columns that are unique, and disabled for mass editing.
|
||
|
|
$retval = [
|
||
|
|
'name',
|
||
|
|
];
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $retval;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function _getVariableToFunctionMap( $data ) {
|
||
|
|
$variable_function_map = [
|
||
|
|
'id' => 'ID',
|
||
|
|
'company_id' => 'Company',
|
||
|
|
'name' => 'Name',
|
||
|
|
'description' => 'Description',
|
||
|
|
'pay_code' => 'PayCode',
|
||
|
|
|
||
|
|
'in_use' => false,
|
||
|
|
'deleted' => 'Deleted',
|
||
|
|
];
|
||
|
|
|
||
|
|
return $variable_function_map;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function getCompanyObject() {
|
||
|
|
return $this->getGenericObject( 'CompanyListFactory', $this->getCompany(), 'company_obj' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return bool|mixed
|
||
|
|
*/
|
||
|
|
function getCompany() {
|
||
|
|
return $this->getGenericDataValue( 'company_id' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $value UUID
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setCompany( $value ) {
|
||
|
|
$value = TTUUID::castUUID( $value );
|
||
|
|
Debug::Text( 'Company ID: ' . $value, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
return $this->setGenericDataValue( 'company_id', $value );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $name
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function isUniqueName( $name ) {
|
||
|
|
$name = trim( $name );
|
||
|
|
if ( $name == '' ) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
$ph = [
|
||
|
|
'company_id' => TTUUID::castUUID( $this->getCompany() ),
|
||
|
|
'name' => TTi18n::strtolower( $name ),
|
||
|
|
];
|
||
|
|
|
||
|
|
$query = 'select id from ' . $this->getTable() . ' where company_id = ? AND lower(name) = ? AND deleted=0';
|
||
|
|
$id = $this->db->GetOne( $query, $ph );
|
||
|
|
Debug::Arr( $id, 'Unique: ' . $name, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
if ( $id === false ) {
|
||
|
|
return true;
|
||
|
|
} else {
|
||
|
|
if ( $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 mixed
|
||
|
|
*/
|
||
|
|
function getPayCode() {
|
||
|
|
//Since Validate() calls this function, it causes problems with caching.
|
||
|
|
// As we set the new pay codes it purges the cache, then immediately after in Validate() we
|
||
|
|
// get the data again which populates the cache with new pay codes, then we rollback the transaction and cache is now poisoned.
|
||
|
|
// So the next time the cache is obtained its incorrect, as it has the pay codes that were committed then rolledback.
|
||
|
|
//
|
||
|
|
// This can be replicated by Editing Contributing Pay Codes, removing all but one PayCode (go from 3 to 1), then clicking Save. Edit again, and all the original
|
||
|
|
// pay codes are still there.
|
||
|
|
//
|
||
|
|
// It seems if we use getCompanyGenericMapData(), it caches in local memory and prevents the bug from happening.
|
||
|
|
// But there is still a brief moment where the cache is poisoned.
|
||
|
|
//
|
||
|
|
// Another possible fix may be to detect when in a transaction, and log all removeCache() calls, and disable caching to those cache_ids in the same transaction.
|
||
|
|
//return CompanyGenericMapListFactory::getArrayByCompanyIDAndObjectTypeIDAndObjectID( $this->getCompany(), 90, $this->getID() );
|
||
|
|
|
||
|
|
return $this->getCompanyGenericMapData( $this->getCompany(), 90, $this->getID(), 'pay_code_map' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $ids UUID
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function setPayCode( $ids ) {
|
||
|
|
Debug::text( 'Setting Pay Code IDs...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
return CompanyGenericMapFactory::setMapIDs( $this->getCompany(), 90, $this->getID(), (array)$ids, false, true );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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' )
|
||
|
|
);
|
||
|
|
// Name
|
||
|
|
if ( $this->Validator->getValidateOnly() == false ) { //Don't check the below when mass editing, but must check when adding a new record..
|
||
|
|
if ( $this->getName() == '' ) {
|
||
|
|
$this->Validator->isTRUE( 'name',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'Please specify a name' ) );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if ( $this->getName() !== false ) {
|
||
|
|
if ( $this->getName() != '' && $this->Validator->isError( 'name' ) == false ) {
|
||
|
|
$this->Validator->isLength( 'name',
|
||
|
|
$this->getName(),
|
||
|
|
TTi18n::gettext( 'Name is too short or too long' ),
|
||
|
|
2, 75
|
||
|
|
);
|
||
|
|
}
|
||
|
|
if ( $this->getName() != '' && $this->Validator->isError( 'name' ) == false ) {
|
||
|
|
$this->Validator->isTrue( 'name',
|
||
|
|
$this->isUniqueName( $this->getName() ),
|
||
|
|
TTi18n::gettext( 'Name is already in use' )
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// Description
|
||
|
|
if ( $this->getDescription() != '' ) {
|
||
|
|
$this->Validator->isLength( 'description',
|
||
|
|
$this->getDescription(),
|
||
|
|
TTi18n::gettext( 'Description is invalid' ),
|
||
|
|
1, 250
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// ABOVE: Validation code moved from set*() functions.
|
||
|
|
//
|
||
|
|
if ( $this->getDeleted() != true && $this->Validator->getValidateOnly() == false ) { //Don't check the below when mass editing.
|
||
|
|
|
||
|
|
//During InstallSchema_1064 we create ContributingPayCodePolicies without any pay codes.
|
||
|
|
if ( $this->getPayCode() === false || count( (array)$this->getPayCode() ) == 0 ) {
|
||
|
|
$this->Validator->isTrue( 'pay_code',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'Please select at least one pay code.' )
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $this->getDeleted() == true ) {
|
||
|
|
$cpcplf = TTNew( 'ContributingShiftPolicyListFactory' ); /** @var ContributingShiftPolicyListFactory $cpcplf */
|
||
|
|
$cpcplf->getByCompanyIdAndContributingPayCodePolicyId( $this->getCompany(), $this->getId() );
|
||
|
|
if ( $cpcplf->getRecordCount() > 0 ) {
|
||
|
|
$this->Validator->isTRUE( 'in_use',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'This contributing pay code policy is currently in use' ) . ' ' . TTi18n::gettext( 'by contributing shift policies' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
$cdlf = TTNew( 'CompanyDeductionListFactory' ); /** @var CompanyDeductionListFactory $cdlf */
|
||
|
|
$cdlf->getByCompanyIdAndContributingPayCodePolicyId( $this->getCompany(), $this->getId() );
|
||
|
|
if ( $cdlf->getRecordCount() > 0 ) {
|
||
|
|
$this->Validator->isTRUE( 'in_use',
|
||
|
|
false,
|
||
|
|
TTi18n::gettext( 'This contributing pay code policy is currently in use' ) . ' ' . TTi18n::gettext( 'by tax/deductions' ) );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
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 ) {
|
||
|
|
default:
|
||
|
|
if ( method_exists( $this, $function ) ) {
|
||
|
|
$this->$function( $data[$key] );
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->setCreatedAndUpdatedColumns( $data );
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param null $include_columns
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getObjectAsArray( $include_columns = null ) {
|
||
|
|
$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':
|
||
|
|
$data[$variable] = $this->getColumn( $variable );
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
if ( method_exists( $this, $function ) ) {
|
||
|
|
$data[$variable] = $this->$function();
|
||
|
|
}
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$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( 'Contributing Time Policy' ) .': '. $this->getName(), null, $this->getTable(), $this );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|