440 lines
18 KiB
PHP
440 lines
18 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 API\Users
|
|
*/
|
|
class APIUserPreference extends APIFactory {
|
|
protected $main_class = 'UserPreferenceFactory';
|
|
|
|
/**
|
|
* APIUserPreference constructor.
|
|
*/
|
|
public function __construct() {
|
|
parent::__construct(); //Make sure parent constructor is always called.
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get default UserPreference data for creating new UserPreferencees.
|
|
* @return array
|
|
*/
|
|
function getUserPreferenceDefaultData() {
|
|
$company_id = $this->getCurrentCompanyObject()->getId();
|
|
|
|
Debug::Text( 'Getting UserPreference default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
//Get New Hire Defaults.
|
|
$udlf = TTnew( 'UserDefaultListFactory' ); /** @var UserDefaultListFactory $udlf */
|
|
$udlf->getByCompanyId( $company_id );
|
|
if ( $udlf->getRecordCount() > 0 ) {
|
|
Debug::Text( 'Using User Defaults, as they exist...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
$udf_obj = $udlf->getCurrent();
|
|
|
|
$data = [
|
|
'company_id' => $company_id,
|
|
'language' => $udf_obj->getLanguage(),
|
|
'date_format' => $udf_obj->getDateFormat(),
|
|
'time_format' => $udf_obj->getTimeFormat(),
|
|
'time_zone' => $udf_obj->getTimeZone(),
|
|
'time_unit_format' => $udf_obj->getTimeUnitFormat(),
|
|
'distance_format' => $udf_obj->getDistanceFormat(),
|
|
'items_per_page' => $udf_obj->getItemsPerPage(),
|
|
'start_week_day' => $udf_obj->getStartWeekDay(),
|
|
//'enable_email_notification_exception' => $udf_obj->getEnableEmailNotificationException(),
|
|
//'enable_email_notification_message' => $udf_obj->getEnableEmailNotificationMessage(),
|
|
//'enable_email_notification_home' => $udf_obj->getEnableEmailNotificationHome(),
|
|
//'enable_email_notification_pay_stub' => $udf_obj->getEnableEmailNotificationPayStub(),
|
|
//'enable_auto_context_menu' => true,
|
|
'enable_save_timesheet_state' => true,
|
|
'notification_duration' => 120,
|
|
'notification_status_id' => 0,
|
|
];
|
|
} else {
|
|
$data = [
|
|
'company_id' => $company_id,
|
|
'language' => 'en',
|
|
'time_unit_format' => 20, //Hours
|
|
'distance_format' => 10, // Kilometers
|
|
'items_per_page' => 25,
|
|
//'enable_email_notification_exception' => true,
|
|
//'enable_email_notification_message' => true,
|
|
//'enable_email_notification_home' => false,
|
|
//'enable_email_notification_pay_stub' => true,
|
|
//'enable_auto_context_menu' => true,
|
|
'enable_save_timesheet_state' => true,
|
|
'notification_duration' => 120,
|
|
'notification_status_id' => 0,
|
|
];
|
|
}
|
|
|
|
return $this->returnHandler( $data );
|
|
}
|
|
|
|
/**
|
|
* Get UserPreference data for one or more UserPreferencees.
|
|
* @param array $data filter data
|
|
* @param bool $disable_paging
|
|
* @return array|bool
|
|
*/
|
|
function getUserPreference( $data = null, $disable_paging = false ) {
|
|
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'user_preference', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user_preference', 'view' ) || $this->getPermissionObject()->Check( 'user_preference', 'view_own' ) || $this->getPermissionObject()->Check( 'user_preference', 'view_child' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
//Get Permission Hierarchy Children first, as this can be used for viewing, or editing.
|
|
$data['filter_data']['permission_children_ids'] = $this->getPermissionObject()->getPermissionChildren( 'user_preference', 'view' );
|
|
|
|
$uplf = TTnew( 'UserPreferenceListFactory' ); /** @var UserPreferenceListFactory $uplf */
|
|
$uplf->getAPISearchByCompanyIdAndArrayCriteria( $this->getCurrentCompanyObject()->getId(), $data['filter_data'], $data['filter_items_per_page'], $data['filter_page'], null, $data['filter_sort'] );
|
|
Debug::Text( 'Record Count: ' . $uplf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
|
|
if ( $uplf->getRecordCount() > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $uplf->getRecordCount() );
|
|
|
|
$this->setPagerObject( $uplf );
|
|
|
|
$retarr = [];
|
|
foreach ( $uplf as $ut_obj ) {
|
|
$retarr[] = $ut_obj->getObjectAsArray( $data['filter_columns'], $data['filter_data']['permission_children_ids'] );
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $uplf->getCurrentRow() );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->returnHandler( $retarr );
|
|
}
|
|
|
|
return $this->returnHandler( true ); //No records returned.
|
|
}
|
|
|
|
/**
|
|
* Export data to csv
|
|
* @param string $format file format (csv)
|
|
* @param array $data filter data
|
|
* @param bool $disable_paging
|
|
* @return array
|
|
*/
|
|
function exportUserPreference( $format = 'csv', $data = null, $disable_paging = true ) {
|
|
$result = $this->stripReturnHandler( $this->getUserPreference( $data, $disable_paging ) );
|
|
|
|
return $this->exportRecords( $format, 'export_employee_preference', $result, ( ( isset( $data['filter_columns'] ) ) ? $data['filter_columns'] : null ) );
|
|
}
|
|
|
|
/**
|
|
* Get only the fields that are common across all records in the search criteria. Used for Mass Editing of records.
|
|
* @param array $data filter data
|
|
* @return array
|
|
*/
|
|
function getCommonUserPreferenceData( $data ) {
|
|
return Misc::arrayIntersectByRow( $this->stripReturnHandler( $this->getUserPreference( $data, true ) ) );
|
|
}
|
|
|
|
/**
|
|
* Validate UserPreference data for one or more UserPreferencees.
|
|
* @param array $data UserPreference data
|
|
* @return array
|
|
*/
|
|
function validateUserPreference( $data ) {
|
|
return $this->setUserPreference( $data, true );
|
|
}
|
|
|
|
/**
|
|
* Set UserPreference data for one or more UserPreferencees.
|
|
* @param array $data UserPreference data
|
|
* @param bool $validate_only
|
|
* @param bool $ignore_warning
|
|
* @return array|bool
|
|
*/
|
|
function setUserPreference( $data, $validate_only = false, $ignore_warning = true ) {
|
|
$validate_only = (bool)$validate_only;
|
|
$ignore_warning = (bool)$ignore_warning;
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'user_preference', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user_preference', 'edit' ) || $this->getPermissionObject()->Check( 'user_preference', 'edit_own' ) || $this->getPermissionObject()->Check( 'user_preference', 'edit_child' ) || $this->getPermissionObject()->Check( 'user_preference', 'add' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
if ( $validate_only == true ) {
|
|
Debug::Text( 'Validating Only!', __FILE__, __LINE__, __METHOD__, 10 );
|
|
}
|
|
|
|
[ $data, $total_records ] = $this->convertToMultipleRecords( $data );
|
|
Debug::Text( 'Received data for: ' . $total_records . ' UserPreferences', __FILE__, __LINE__, __METHOD__, 10 );
|
|
//Debug::Arr($data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
|
$validator = $save_result = []; $key = false;
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $total_records );
|
|
|
|
foreach ( $data as $key => $row ) {
|
|
$primary_validator = new Validator();
|
|
$lf = TTnew( 'UserPreferenceListFactory' ); /** @var UserPreferenceListFactory $lf */
|
|
$lf->StartTransaction();
|
|
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
|
//Modifying existing object.
|
|
//Get UserPreference object, so we can only modify just changed data for specific records if needed.
|
|
$lf->getByIdAndCompanyId( $row['id'], $this->getCurrentCompanyObject()->getId() );
|
|
if ( $lf->getRecordCount() == 1 ) {
|
|
//Object exists, check edit permissions
|
|
if (
|
|
$validate_only == true
|
|
||
|
|
(
|
|
$this->getPermissionObject()->Check( 'user_preference', 'edit' )
|
|
|| ( $this->getPermissionObject()->Check( 'user_preference', 'edit_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getUser() ) === true )
|
|
) ) {
|
|
|
|
Debug::Text( 'Row Exists, getting current data for ID: ' . $row['id'], __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf = $lf->getCurrent();
|
|
$row = array_merge( $lf->getObjectAsArray(), $row );
|
|
} else {
|
|
$primary_validator->isTrue( 'permission', false, TTi18n::gettext( 'Edit permission denied' ) );
|
|
}
|
|
} else {
|
|
//Object doesn't exist.
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Edit permission denied, record does not exist' ) );
|
|
}
|
|
} else {
|
|
//Always allow the currently logged in user to create preferences in case the record isn't there.
|
|
if ( !( isset( $row['user_id'] ) && $row['user_id'] == $this->getCurrentUserObject()->getId() ) ) {
|
|
//Adding new object, check ADD permissions.
|
|
$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check( 'user', 'add' ), TTi18n::gettext( 'Add permission denied' ) );
|
|
}
|
|
}
|
|
Debug::Arr( $row, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$is_valid = $primary_validator->isValid();
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
|
Debug::Text( 'Setting object data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$lf->setObjectFromArray( $row );
|
|
|
|
//Force Company ID to current company.
|
|
//$lf->setCompany( $this->getCurrentCompanyObject()->getId() );
|
|
|
|
$is_valid = $lf->isValid( $ignore_warning );
|
|
if ( $is_valid == true ) {
|
|
Debug::Text( 'Saving data...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
if ( $validate_only == true ) {
|
|
$save_result[$key] = true;
|
|
} else {
|
|
$save_result[$key] = $lf->Save();
|
|
}
|
|
$validator_stats['valid_records']++;
|
|
}
|
|
}
|
|
|
|
if ( $is_valid == false ) {
|
|
Debug::Text( 'Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
|
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
|
} else if ( $validate_only == true ) {
|
|
$lf->FailTransaction();
|
|
}
|
|
|
|
|
|
$lf->CommitTransaction();
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $key );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
/**
|
|
* Delete one or more UserPreferences.
|
|
* @param array $data UserPreference data
|
|
* @return array|bool
|
|
*/
|
|
function deleteUserPreference( $data ) {
|
|
if ( !is_array( $data ) ) {
|
|
$data = [ $data ];
|
|
}
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
if ( !$this->getPermissionObject()->Check( 'user_preference', 'enabled' )
|
|
|| !( $this->getPermissionObject()->Check( 'user_preference', 'delete' ) || $this->getPermissionObject()->Check( 'user_preference', 'delete_own' ) || $this->getPermissionObject()->Check( 'user_preference', 'delete_child' ) ) ) {
|
|
return $this->getPermissionObject()->PermissionDenied();
|
|
}
|
|
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' UserPreferences', __FILE__, __LINE__, __METHOD__, 10 );
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$total_records = count( $data );
|
|
$validator = $save_result = []; $key = false;
|
|
$validator_stats = [ 'total_records' => $total_records, 'valid_records' => 0 ];
|
|
if ( is_array( $data ) && $total_records > 0 ) {
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $total_records );
|
|
|
|
foreach ( $data as $key => $id ) {
|
|
$primary_validator = new Validator();
|
|
$lf = TTnew( 'UserPreferenceListFactory' ); /** @var UserPreferenceListFactory $lf */
|
|
$lf->StartTransaction();
|
|
if ( $id != '' ) {
|
|
//Modifying existing object.
|
|
//Get UserPreference object, so we can only modify just changed data for specific records if needed.
|
|
$lf->getByIdAndCompanyId( $id, $this->getCurrentCompanyObject()->getId() );
|
|
if ( $lf->getRecordCount() == 1 ) {
|
|
//Object exists, check edit permissions
|
|
if ( $this->getPermissionObject()->Check( 'user_preference', 'delete' )
|
|
|| ( $this->getPermissionObject()->Check( 'user_preference', 'delete_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getID() ) === true ) ) {
|
|
Debug::Text( 'Record Exists, deleting record ID: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf = $lf->getCurrent();
|
|
} else {
|
|
$primary_validator->isTrue( 'permission', false, TTi18n::gettext( 'Delete permission denied' ) );
|
|
}
|
|
} else {
|
|
//Object doesn't exist.
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, record does not exist' ) );
|
|
}
|
|
} else {
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Delete permission denied, record does not exist' ) );
|
|
}
|
|
|
|
//Debug::Arr($lf, 'AData: ', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
$is_valid = $primary_validator->isValid();
|
|
if ( $is_valid == true ) { //Check to see if all permission checks passed before trying to save data.
|
|
Debug::Text( 'Attempting to delete record...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
$lf->setDeleted( true );
|
|
|
|
$is_valid = $lf->isValid();
|
|
if ( $is_valid == true ) {
|
|
Debug::Text( 'Record Deleted...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
$save_result[$key] = $lf->Save();
|
|
$validator_stats['valid_records']++;
|
|
}
|
|
}
|
|
|
|
if ( $is_valid == false ) {
|
|
Debug::Text( 'Data is Invalid...', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$lf->FailTransaction(); //Just rollback this single record, continue on to the rest.
|
|
|
|
$validator[$key] = $this->setValidationArray( [ $primary_validator, $lf ] );
|
|
}
|
|
|
|
$lf->CommitTransaction();
|
|
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $key );
|
|
}
|
|
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
|
|
|
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
/**
|
|
* Copy one or more UserPreferencees.
|
|
* @param array $data UserPreference IDs
|
|
* @return array
|
|
*/
|
|
function copyUserPreference( $data ) {
|
|
if ( !is_array( $data ) ) {
|
|
$data = [ $data ];
|
|
}
|
|
|
|
if ( !is_array( $data ) ) {
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' UserPreferences', __FILE__, __LINE__, __METHOD__, 10 );
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
|
|
$src_rows = $this->stripReturnHandler( $this->getUserPreference( [ 'filter_data' => [ 'id' => $data ] ], true ) );
|
|
if ( is_array( $src_rows ) && count( $src_rows ) > 0 ) {
|
|
Debug::Arr( $src_rows, 'SRC Rows: ', __FILE__, __LINE__, __METHOD__, 10 );
|
|
foreach ( $src_rows as $key => $row ) {
|
|
unset( $src_rows[$key]['id'], $src_rows[$key]['manual_id'] ); //Clear fields that can't be copied
|
|
$src_rows[$key]['name'] = Misc::generateCopyName( $row['name'] ); //Generate unique name
|
|
}
|
|
|
|
//Debug::Arr($src_rows, 'bSRC Rows: ', __FILE__, __LINE__, __METHOD__, 10);
|
|
|
|
return $this->setUserPreference( $src_rows ); //Save copied rows
|
|
}
|
|
|
|
return $this->returnHandler( false );
|
|
}
|
|
|
|
/**
|
|
* @param null $user_name
|
|
* @param int $type_id ID
|
|
* @param null $selected_schedule
|
|
* @return array|bool
|
|
*/
|
|
function getScheduleIcalendarURL( $user_name = null, $type_id = null, $selected_schedule = null ) {
|
|
$current_user_prefs = $this->getCurrentUserObject()->getUserPreferenceObject();
|
|
if ( is_object( $current_user_prefs ) ) {
|
|
return $this->returnHandler( $current_user_prefs->getScheduleIcalendarURL( $user_name, $type_id, $selected_schedule ) );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
?>
|