580 lines
14 KiB
PHP
580 lines
14 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 Core
|
|
*/
|
|
class OtherFieldFactory extends Factory {
|
|
protected $table = 'other_field';
|
|
protected $pk_sequence_name = 'other_field_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 'type':
|
|
$retval = [
|
|
2 => TTi18n::gettext( 'Company' ),
|
|
4 => TTi18n::gettext( 'Branch' ),
|
|
5 => TTi18n::gettext( 'Department' ),
|
|
10 => TTi18n::gettext( 'Employee' ),
|
|
12 => TTi18n::gettext( 'Employee Title' ),
|
|
15 => TTi18n::gettext( 'Punch' ),
|
|
18 => TTi18n::gettext( 'Schedule' ),
|
|
];
|
|
|
|
$product_edition = Misc::getCurrentCompanyProductEdition();
|
|
if ( $product_edition >= TT_PRODUCT_CORPORATE ) {
|
|
$retval[20] = TTi18n::gettext( 'Job' );
|
|
$retval[30] = TTi18n::gettext( 'Task' );
|
|
$retval[50] = TTi18n::gettext( 'Client' );
|
|
$retval[55] = TTi18n::gettext( 'Client Contact' );
|
|
//$retval[57] = TTi18n::gettext('Client Payment');
|
|
$retval[60] = TTi18n::gettext( 'Product' );
|
|
$retval[70] = TTi18n::gettext( 'Invoice' );
|
|
$retval[80] = TTi18n::gettext( 'Document' );
|
|
}
|
|
|
|
break;
|
|
case 'columns':
|
|
$retval = [
|
|
'-1010-type' => TTi18n::gettext( 'Type' ),
|
|
'-1021-other_id1' => TTi18n::gettext( 'Other ID1' ),
|
|
'-1022-other_id2' => TTi18n::gettext( 'Other ID2' ),
|
|
'-1023-other_id3' => TTi18n::gettext( 'Other ID3' ),
|
|
'-1024-other_id4' => TTi18n::gettext( 'Other ID4' ),
|
|
'-1025-other_id5' => TTi18n::gettext( 'Other ID5' ),
|
|
|
|
'-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 = [
|
|
'type_id', //Required by Flex when a supervisor logs in to handle other fields properly.
|
|
'type',
|
|
'other_id1',
|
|
'other_id2',
|
|
'other_id3',
|
|
'other_id4',
|
|
'other_id5',
|
|
];
|
|
break;
|
|
}
|
|
|
|
return $retval;
|
|
}
|
|
|
|
/**
|
|
* @param $data
|
|
* @return array
|
|
*/
|
|
function _getVariableToFunctionMap( $data ) {
|
|
$variable_function_map = [
|
|
'id' => 'ID',
|
|
'company_id' => 'Company',
|
|
'type_id' => 'Type',
|
|
'type' => false,
|
|
'other_id1' => 'OtherID1',
|
|
'other_id2' => 'OtherID2',
|
|
'other_id3' => 'OtherID3',
|
|
'other_id4' => 'OtherID4',
|
|
'other_id5' => 'OtherID5',
|
|
'other_id6' => 'OtherID6',
|
|
'other_id7' => 'OtherID7',
|
|
'other_id8' => 'OtherID8',
|
|
'other_id9' => 'OtherID9',
|
|
'other_id10' => 'OtherID10',
|
|
'deleted' => 'Deleted',
|
|
];
|
|
|
|
return $variable_function_map;
|
|
}
|
|
|
|
/**
|
|
* @return null
|
|
*/
|
|
function getCompanyObject() {
|
|
if ( is_object( $this->company_obj ) ) {
|
|
return $this->company_obj;
|
|
} else {
|
|
$clf = TTnew( 'CompanyListFactory' ); /** @var CompanyListFactory $clf */
|
|
$this->company_obj = $clf->getById( $this->getCompany() )->getCurrent();
|
|
|
|
return $this->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 $type
|
|
* @return bool
|
|
*/
|
|
function isUniqueType( $type ) {
|
|
$ph = [
|
|
'company_id' => TTUUID::castUUID( $this->getCompany() ),
|
|
'type_id' => (int)$type,
|
|
];
|
|
|
|
$query = 'select id from ' . $this->getTable() . '
|
|
where company_id = ?
|
|
AND type_id = ?
|
|
AND deleted = 0';
|
|
$type_id = $this->db->GetOne( $query, $ph );
|
|
Debug::Arr( $type_id, 'Unique Type: ' . $type, __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
if ( $type_id === false ) {
|
|
return true;
|
|
} else {
|
|
if ( $type_id == $this->getId() ) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return bool|int
|
|
*/
|
|
function getType() {
|
|
return $this->getGenericDataValue( 'type_id' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setType( $value ) {
|
|
$value = (int)trim( $value );
|
|
Debug::text( 'Attempting to set Type To: ' . $value, __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
return $this->setGenericDataValue( 'type_id', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID1() {
|
|
return $this->getGenericDataValue( 'other_id1' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID1( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id1', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID2() {
|
|
return $this->getGenericDataValue( 'other_id2' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID2( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id2', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID3() {
|
|
return $this->getGenericDataValue( 'other_id3' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID3( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id3', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID4() {
|
|
return $this->getGenericDataValue( 'other_id4' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID4( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id4', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID5() {
|
|
return $this->getGenericDataValue( 'other_id5' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID5( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id5', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID6() {
|
|
return $this->getGenericDataValue( 'other_id6' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID6( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id6', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID7() {
|
|
return $this->getGenericDataValue( 'other_id7' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID7( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id7', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID8() {
|
|
return $this->getGenericDataValue( 'other_id8' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID8( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id8', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID9() {
|
|
return $this->getGenericDataValue( 'other_id9' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID9( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id9', $value );
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
function getOtherID10() {
|
|
return $this->getGenericDataValue( 'other_id10' );
|
|
}
|
|
|
|
/**
|
|
* @param $value
|
|
* @return bool
|
|
*/
|
|
function setOtherID10( $value ) {
|
|
$value = trim( $value );
|
|
|
|
return $this->setGenericDataValue( 'other_id10', $value );
|
|
}
|
|
|
|
/**
|
|
* @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 'type':
|
|
$function = 'get' . $variable;
|
|
if ( method_exists( $this, $function ) ) {
|
|
$data[$variable] = Option::getByKey( $this->$function(), $this->getOptions( $variable ) );
|
|
}
|
|
break;
|
|
default:
|
|
if ( method_exists( $this, $function ) ) {
|
|
$data[$variable] = $this->$function();
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
$this->getCreatedAndUpdatedColumns( $data, $include_columns );
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
function Validate() {
|
|
//
|
|
// 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' )
|
|
);
|
|
// Type
|
|
if ( $this->getType() !== false ) {
|
|
$this->Validator->inArrayKey( 'type_id',
|
|
$this->getType(),
|
|
TTi18n::gettext( 'Incorrect Type' ),
|
|
$this->getOptions( 'type' )
|
|
);
|
|
if ( $this->Validator->isError( 'type_id' ) == false ) {
|
|
$this->Validator->isTrue( 'type_id',
|
|
$this->isUniqueType( $this->getType() ),
|
|
TTi18n::gettext( 'Type already exists' )
|
|
);
|
|
}
|
|
}
|
|
// Other ID1
|
|
if ( $this->getOtherID1() != '' ) {
|
|
$this->Validator->isLength( 'other_id1',
|
|
$this->getOtherID1(),
|
|
TTi18n::gettext( 'Other ID1 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID2
|
|
if ( $this->getOtherID2() != '' ) {
|
|
$this->Validator->isLength( 'other_id2',
|
|
$this->getOtherID2(),
|
|
TTi18n::gettext( 'Other ID2 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID3
|
|
if ( $this->getOtherID3() != '' ) {
|
|
$this->Validator->isLength( 'other_id3',
|
|
$this->getOtherID3(),
|
|
TTi18n::gettext( 'Other ID3 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID4
|
|
if ( $this->getOtherID4() != '' ) {
|
|
$this->Validator->isLength( 'other_id4',
|
|
$this->getOtherID4(),
|
|
TTi18n::gettext( 'Other ID4 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID5
|
|
if ( $this->getOtherID5() != '' ) {
|
|
$this->Validator->isLength( 'other_id5',
|
|
$this->getOtherID5(),
|
|
TTi18n::gettext( 'Other ID5 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID6
|
|
if ( $this->getOtherID6() != '' ) {
|
|
$this->Validator->isLength( 'other_id6',
|
|
$this->getOtherID6(),
|
|
TTi18n::gettext( 'Other ID6 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID7
|
|
if ( $this->getOtherID7() != '' ) {
|
|
$this->Validator->isLength( 'other_id7',
|
|
$this->getOtherID7(),
|
|
TTi18n::gettext( 'Other ID7 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID8
|
|
if ( $this->getOtherID8() != '' ) {
|
|
$this->Validator->isLength( 'other_id8',
|
|
$this->getOtherID8(),
|
|
TTi18n::gettext( 'Other ID8 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID9
|
|
if ( $this->getOtherID9() != '' ) {
|
|
$this->Validator->isLength( 'other_id9',
|
|
$this->getOtherID9(),
|
|
TTi18n::gettext( 'Other ID9 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
// Other ID10
|
|
if ( $this->getOtherID10() != '' ) {
|
|
$this->Validator->isLength( 'other_id10',
|
|
$this->getOtherID10(),
|
|
TTi18n::gettext( 'Other ID10 is invalid' ),
|
|
1, 255
|
|
);
|
|
}
|
|
//
|
|
// ABOVE: Validation code moved from set*() functions.
|
|
//
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param $log_action
|
|
* @return bool
|
|
*/
|
|
function addLog( $log_action ) {
|
|
return TTLog::addEntry( $this->getId(), $log_action, TTi18n::getText( 'Other Fields' ), null, $this->getTable(), $this );
|
|
}
|
|
}
|
|
|
|
?>
|