<?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 UserGenericDataFactory extends Factory {
protected $table = 'user_generic_data';
protected $pk_sequence_name = 'user_generic_data_id_seq'; //PK Sequence name
public $name_validator_regex = '/^[a-zA-Z0-9-_ ,\.\'\/()\[\]|\x{0080}-\x{FFFF}]{1,250}$/iu';
/**
* @param $data
* @return array
*/
function _getVariableToFunctionMap( $data ) {
$variable_function_map = [
'id' => 'ID',
'company_id' => 'Company',
'user_id' => 'User',
'script' => 'Script',
'name' => 'Name',
'is_default' => 'Default',
'data' => 'Data',
'deleted' => 'Deleted',
];
return $variable_function_map;
}
/**
* @return bool|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|mixed
*/
function getScript() {
return $this->getGenericDataValue( 'script' );
}
/**
* @param $value
* @return bool
*/
function setScript( $value ) {
//Strip out double slashes, as sometimes those occur and they cause the saved settings to not appear.
$value = self::handleScriptName( trim( $value ) );
return $this->setGenericDataValue( 'script', $value );
}
/**
* @param $name
* @return bool
*/
function isUniqueName( $name ) {
if ( $this->getCompany() == false ) {
return false;
}
//Allow no user_id to be set yet, as that would be company generic data.
if ( $this->getScript() == false ) {
return false;
}
$name = trim( $name );
if ( $name == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $this->getCompany() ),
'script' => $this->getScript(),
'name' => TTi18n::strtolower( $name ),
];
$query = 'select id from ' . $this->getTable() . '
where
company_id = ?
AND script = ?
AND lower(name) = ? ';
if ( $this->getUser() != '' ) {
$query .= ' AND user_id = \'' . TTUUID::castUUID( $this->getUser() ) . '\'';
} else {
$query .= ' AND ( user_id = \'' . TTUUID::getZeroID() . '\' OR user_id is NULL )';
}
$query .= ' AND 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
*/
function getDefault() {
return $this->fromBool( $this->getGenericDataValue( 'is_default' ) );
}
/**
* @param $value
* @return bool
*/
function setDefault( $value ) {
return $this->setGenericDataValue( 'is_default', $this->toBool( $value ) );
}
/**
* @return bool|mixed
*/
function getData() {
$retval = json_decode( $this->getGenericDataValue( 'data' ), true ); //If the data is corrupted, stop any PHP warning.
if ( $retval !== false ) {
return $retval;
}
Debug::Text( 'Failed to unserialize data: "' . $this->getGenericDataValue( 'data' ) . '"', __FILE__, __LINE__, __METHOD__, 10 );
return false;
}
/**
* @param $value
* @return bool
*/
function setData( $value ) {
$this->setGenericDataValue( 'data', json_encode( $value ) );
return true;
}
/**
* @param bool $ignore_warning
* @return bool
*/
function Validate( $ignore_warning = true ) {
//
// BELOW: Validation code moved from set*() functions.
//
if ( $this->getDeleted() == false ) {
// Company
$clf = TTnew( 'CompanyListFactory' ); /** @var CompanyListFactory $clf */
$this->Validator->isResultSetWithRows( 'company',
$clf->getByID( $this->getCompany() ),
TTi18n::gettext( 'Invalid Company' )
);
// User
if ( $this->getUser() != '' && $this->getUser() != TTUUID::getZeroID() ) {
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
$this->Validator->isResultSetWithRows( 'user',
$ulf->getByID( $this->getUser() ),
TTi18n::gettext( 'Invalid Employee' )
);
}
// Script
$this->Validator->isLength( 'script',
$this->getScript(),
TTi18n::gettext( 'Invalid script' ),
1, 250
);
// Name
$this->Validator->isLength( 'name',
$this->getName(),
TTi18n::gettext( 'Invalid name' ),
1, 100
);
if ( $this->Validator->isError( 'name' ) == false ) {
$this->Validator->isTrue( 'name',
$this->isUniqueName( $this->getName() ),
TTi18n::gettext( 'Name already exists' )
);
}
$this->Validator->isRegEx( 'name',
$this->getName(),
TTi18n::gettext( 'Incorrect characters in name' ),
$this->name_validator_regex
);
//
// ABOVE: Validation code moved from set*() functions.
//
if ( $this->getName() == '' ) {
$this->Validator->isTRUE( 'name',
false,
TTi18n::gettext( 'Invalid name' ) );
}
}
return true;
}
/**
* @return bool
*/
function preSave() {
if ( $this->getUser() == '' ) {
$this->setUser( TTUUID::getZeroID() ); //Use 0 instead of NULL;
}
if ( $this->getDefault() == true ) {
//Remove default flag from all other entries.
$ugdlf = TTnew( 'UserGenericDataListFactory' ); /** @var UserGenericDataListFactory $ugdlf */
if ( $this->getUser() == TTUUID::getZeroID() || $this->getUser() == '' ) {
$ugdlf->getByCompanyIdAndScriptAndDefault( $this->getCompany(), $this->getScript(), true );
} else {
$ugdlf->getByUserIdAndScriptAndDefault( $this->getUser(), $this->getScript(), true );
}
if ( $ugdlf->getRecordCount() > 0 ) {
foreach ( $ugdlf as $ugd_obj ) {
if ( $ugd_obj->getId() != $this->getId() ) { //Don't remove default flag from ourselves when editing an existing record.
Debug::Text( ' Removing Default Flag From: ' . $ugd_obj->getId(), __FILE__, __LINE__, __METHOD__, 10 );
$ugd_obj->setDefault( false );
if ( $ugd_obj->isValid() ) {
$ugd_obj->Save();
}
}
}
}
}
return true;
}
/*
//Disable this for now, as it bombards the log with messages that are mostly useless.
function addLog( $log_action ) {
if ( $this->getUser() == FALSE AND $this->getDefault() == TRUE ) {
//Bypass logging on Company Default Save.
return TRUE;
}
return TTLog::addEntry( $this->getId(), $log_action, TTi18n::getText('Employee/Company Generic Data'), NULL, $this->getTable() );
}
*/
/**
* @param $script_name
* @return mixed
*/
static function handleScriptName( $script_name ) {
return str_replace( '//', '/', $script_name );
}
/**
* @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 ) {
default:
if ( method_exists( $this, $function ) ) {
$data[$variable] = $this->$function();
}
break;
}
}
}
$this->getCreatedAndUpdatedColumns( $data, $include_columns );
}
return $data;
}
}
?>