378 lines
14 KiB
PHP
378 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 API\Report
|
||
|
|
*/
|
||
|
|
class APIReportSchedule extends APIFactory {
|
||
|
|
protected $main_class = 'ReportScheduleFactory';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* APIReportSchedule constructor.
|
||
|
|
*/
|
||
|
|
public function __construct() {
|
||
|
|
parent::__construct(); //Make sure parent constructor is always called.
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get default report_schedule data for creating new report_schedulees.
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getReportScheduleDefaultData() {
|
||
|
|
//$company_obj = $this->getCurrentCompanyObject();
|
||
|
|
|
||
|
|
Debug::Text( 'Getting report_schedule default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
//Default schedule to non-busy times of the day, and only weekdays to reduce load.
|
||
|
|
$data = [
|
||
|
|
'status_id' => 10,
|
||
|
|
'minute' => [ 0 ],
|
||
|
|
'hour' => [ 1 ],
|
||
|
|
'day_of_month' => [ '*' ],
|
||
|
|
'month' => [ '*' ],
|
||
|
|
'day_of_week' => [ 1, 2, 3, 4, 5 ], //Any day, if we limit to just Mon-Fri, it could confuse people who try to restrict to a DOM.
|
||
|
|
];
|
||
|
|
|
||
|
|
return $this->returnHandler( $data );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get report_schedule data for one or more report_schedulees.
|
||
|
|
* @param array $data filter data
|
||
|
|
* @param bool $disable_paging
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getReportSchedule( $data = null, $disable_paging = false ) {
|
||
|
|
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
||
|
|
|
||
|
|
//Only allow getting report data for currently logged in user.
|
||
|
|
$data['filter_data']['user_id'] = $this->getCurrentUserObject()->getId();
|
||
|
|
|
||
|
|
$blf = TTnew( 'ReportScheduleListFactory' ); /** @var ReportScheduleListFactory $blf */
|
||
|
|
$blf->getAPISearchByCompanyIdAndArrayCriteria( $this->getCurrentCompanyObject()->getId(), $data['filter_data'], $data['filter_items_per_page'], $data['filter_page'], null, $data['filter_sort'] );
|
||
|
|
Debug::Text( 'Record Count: ' . $blf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
if ( $blf->getRecordCount() > 0 ) {
|
||
|
|
$this->getProgressBarObject()->start( $this->getAPIMessageID(), $blf->getRecordCount() );
|
||
|
|
|
||
|
|
$this->setPagerObject( $blf );
|
||
|
|
|
||
|
|
$retarr = [];
|
||
|
|
foreach ( $blf as $b_obj ) {
|
||
|
|
$retarr[] = $b_obj->getObjectAsArray( $data['filter_columns'] );
|
||
|
|
|
||
|
|
$this->getProgressBarObject()->set( $this->getAPIMessageID(), $blf->getCurrentRow() );
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->getProgressBarObject()->stop( $this->getAPIMessageID() );
|
||
|
|
|
||
|
|
return $this->returnHandler( $retarr );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( true ); //No records returned.
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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 getCommonReportScheduleData( $data ) {
|
||
|
|
return Misc::arrayIntersectByRow( $this->stripReturnHandler( $this->getReportSchedule( $data, true ) ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate report_schedule data for one or more report_schedulees.
|
||
|
|
* @param array $data report_schedule data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function validateReportSchedule( $data ) {
|
||
|
|
return $this->setReportSchedule( $data, true );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set report_schedule data for one or more report_schedulees.
|
||
|
|
* @param array $data report_schedule data
|
||
|
|
* @param bool $validate_only
|
||
|
|
* @param bool $ignore_warning
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function setReportSchedule( $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 ( $validate_only == true ) {
|
||
|
|
Debug::Text( 'Validating Only!', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
}
|
||
|
|
|
||
|
|
[ $data, $total_records ] = $this->convertToMultipleRecords( $data );
|
||
|
|
Debug::Text( 'Received data for: ' . $total_records . ' ReportSchedules', __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( 'ReportScheduleListFactory' ); /** @var ReportScheduleListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get report_schedule object, so we can only modify just changed data for specific records if needed.
|
||
|
|
//$lf->getByIdAndCompanyId( $row['id'], $this->getCurrentCompanyObject()->getId() );
|
||
|
|
$lf->getByIDAndUserID( $row['id'], $this->getCurrentUserObject()->getId() );
|
||
|
|
if ( $lf->getRecordCount() == 1 ) {
|
||
|
|
//Object exists, check edit permissions
|
||
|
|
Debug::Text( 'Row Exists, getting current data for ID: ' . $row['id'], __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$lf = $lf->getCurrent(); //Make the current $lf variable the current object, otherwise getDataDifferences() fails to function.
|
||
|
|
$row = array_merge( $lf->getObjectAsArray(), $row );
|
||
|
|
} else {
|
||
|
|
//Object doesn't exist.
|
||
|
|
$primary_validator->isTrue( 'id', false, TTi18n::gettext( 'Edit permission denied, record does not exist' ) );
|
||
|
|
}
|
||
|
|
} //else {
|
||
|
|
//Adding new object, check ADD permissions.
|
||
|
|
//$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check('report_schedule', '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 report_schedules.
|
||
|
|
* @param array $data report_schedule data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function deleteReportSchedule( $data ) {
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
$data = [ $data ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' ReportSchedules', __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( 'ReportScheduleListFactory' ); /** @var ReportScheduleListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( $id != '' ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get report_schedule object, so we can only modify just changed data for specific records if needed.
|
||
|
|
//$lf->getByIdAndCompanyId( $id, $this->getCurrentCompanyObject()->getId() );
|
||
|
|
$lf->getByIDAndUserID( $id, $this->getCurrentUserObject()->getId() );
|
||
|
|
if ( $lf->getRecordCount() == 1 ) {
|
||
|
|
//Object exists, check edit permissions
|
||
|
|
Debug::Text( 'Record Exists, deleting record ID: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$lf = $lf->getCurrent();
|
||
|
|
} 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 report_schedulees.
|
||
|
|
* @param array $data report_schedule IDs
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function copyReportSchedule( $data ) {
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
$data = [ $data ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' ReportSchedules', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$src_rows = $this->stripReturnHandler( $this->getReportSchedule( [ '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'] ); //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->setReportSchedule( $src_rows ); //Save copied rows
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns array of report output formats.
|
||
|
|
* @param int $user_report_data_id UserReportData ID
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getReportOutputFormatOptions( $user_report_data_id ) {
|
||
|
|
$urpdlf = TTnew( 'UserReportDataListFactory' ); /** @var UserReportDataListFactory $urpdlf */
|
||
|
|
$urpdlf->getById( $user_report_data_id );
|
||
|
|
if ( $urpdlf->getRecordCount() > 0 ) {
|
||
|
|
$urd_obj = $urpdlf->getCurrent();
|
||
|
|
if ( is_object( $urd_obj ) ) {
|
||
|
|
$report_obj = $urd_obj->getObjectHandler();
|
||
|
|
|
||
|
|
return $this->returnHandler( $report_obj->getOptions( 'output_format' ) );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $email
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
function UnsubscribeEmail( $email ) {
|
||
|
|
if ( $email != '' && $this->getPermissionObject()->Check( 'company', 'edit' ) ) {
|
||
|
|
return ReportScheduleFactory::UnsubscribeEmail( $email );
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|