TimeTrex Community Edition v16.2.0
This commit is contained in:
375
classes/modules/api/holiday/APIHoliday.class.php
Normal file
375
classes/modules/api/holiday/APIHoliday.class.php
Normal file
@ -0,0 +1,375 @@
|
||||
<?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\Holiday
|
||||
*/
|
||||
class APIHoliday extends APIFactory {
|
||||
protected $main_class = 'HolidayFactory';
|
||||
|
||||
/**
|
||||
* APIHoliday constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct(); //Make sure parent constructor is always called.
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default holiday data for creating new holidayes.
|
||||
* @return array
|
||||
*/
|
||||
function getHolidayDefaultData() {
|
||||
$company_obj = $this->getCurrentCompanyObject();
|
||||
|
||||
Debug::Text( 'Getting holiday default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
$data = [
|
||||
'company_id' => $company_obj->getId(),
|
||||
'date_stamp' => TTDate::getAPIDate( 'DATE', TTDate::getTime() ),
|
||||
];
|
||||
|
||||
return $this->returnHandler( $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get holiday data for one or more holidayes.
|
||||
* @param array $data filter data
|
||||
* @param bool $disable_paging
|
||||
* @return array|bool
|
||||
*/
|
||||
function getHoliday( $data = null, $disable_paging = false ) {
|
||||
//This is called from the Schedule view, so we need to relax permission for regular employees too.
|
||||
if ( !( $this->getPermissionObject()->Check( 'holiday_policy', 'enabled' ) || $this->getPermissionObject()->Check( 'schedule', 'enabled' ) )
|
||||
|| !( ( $this->getPermissionObject()->Check( 'holiday_policy', 'view' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_child' ) )
|
||||
|| ( $this->getPermissionObject()->Check( 'schedule', 'view' ) || $this->getPermissionObject()->Check( 'schedule', 'view_own' ) || $this->getPermissionObject()->Check( 'schedule', 'view_child' ) ) )
|
||||
) {
|
||||
return $this->getPermissionObject()->PermissionDenied();
|
||||
}
|
||||
/*
|
||||
if ( !$this->getPermissionObject()->Check('holiday_policy', 'enabled')
|
||||
OR !( $this->getPermissionObject()->Check('holiday_policy', 'view') OR $this->getPermissionObject()->Check('holiday_policy', 'view_own') OR $this->getPermissionObject()->Check('holiday_policy', 'view_child') )
|
||||
|
||||
) {
|
||||
return $this->getPermissionObject()->PermissionDenied();
|
||||
}
|
||||
*/
|
||||
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
||||
|
||||
$data['filter_data']['permission_children_ids'] = $this->getPermissionObject()->getPermissionChildren( 'holiday_policy', 'view' );
|
||||
|
||||
$blf = TTnew( 'HolidayListFactory' ); /** @var HolidayListFactory $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 getCommonHolidayData( $data ) {
|
||||
return Misc::arrayIntersectByRow( $this->stripReturnHandler( $this->getHoliday( $data, true ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate holiday data for one or more holidayes.
|
||||
* @param array $data holiday data
|
||||
* @return array
|
||||
*/
|
||||
function validateHoliday( $data ) {
|
||||
return $this->setHoliday( $data, true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set holiday data for one or more holidayes.
|
||||
* @param array $data holiday data
|
||||
* @param bool $validate_only
|
||||
* @param bool $ignore_warning
|
||||
* @return array|bool
|
||||
*/
|
||||
function setHoliday( $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( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'edit' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'edit_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'edit_child' ) || $this->getPermissionObject()->Check( 'holiday_policy', '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 . ' Holidays', __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( 'HolidayListFactory' ); /** @var HolidayListFactory $lf */
|
||||
$lf->StartTransaction();
|
||||
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
||||
//Modifying existing object.
|
||||
//Get holiday 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( 'holiday_policy', 'edit' )
|
||||
|| ( $this->getPermissionObject()->Check( 'holiday_policy', 'edit_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getID() ) === 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 {
|
||||
//Adding new object, check ADD permissions.
|
||||
$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check( 'holiday_policy', '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 );
|
||||
|
||||
$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, false, true ); //Enable System Job Queue status update.
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete one or more holidays.
|
||||
* @param array $data holiday data
|
||||
* @return array|bool
|
||||
*/
|
||||
function deleteHoliday( $data ) {
|
||||
if ( !is_array( $data ) ) {
|
||||
$data = [ $data ];
|
||||
}
|
||||
|
||||
if ( !is_array( $data ) ) {
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
if ( !$this->getPermissionObject()->Check( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'delete' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'delete_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'delete_child' ) ) ) {
|
||||
return $this->getPermissionObject()->PermissionDenied();
|
||||
}
|
||||
|
||||
Debug::Text( 'Received data for: ' . count( $data ) . ' Holidays', __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( 'HolidayListFactory' ); /** @var HolidayListFactory $lf */
|
||||
$lf->StartTransaction();
|
||||
if ( $id != '' ) {
|
||||
//Modifying existing object.
|
||||
//Get holiday 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( 'holiday_policy', 'delete' )
|
||||
|| ( $this->getPermissionObject()->Check( 'holiday_policy', '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, false, true ); //Enable System Job Queue status update.
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy one or more holidayes.
|
||||
* @param array $data holiday IDs
|
||||
* @return array
|
||||
*/
|
||||
function copyHoliday( $data ) {
|
||||
if ( !is_array( $data ) ) {
|
||||
$data = [ $data ];
|
||||
}
|
||||
|
||||
if ( !is_array( $data ) ) {
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
Debug::Text( 'Received data for: ' . count( $data ) . ' Holidays', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
$src_rows = $this->stripReturnHandler( $this->getHoliday( [ '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->setHoliday( $src_rows ); //Save copied rows
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
379
classes/modules/api/holiday/APIRecurringHoliday.class.php
Normal file
379
classes/modules/api/holiday/APIRecurringHoliday.class.php
Normal file
@ -0,0 +1,379 @@
|
||||
<?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\Holiday
|
||||
*/
|
||||
class APIRecurringHoliday extends APIFactory {
|
||||
protected $main_class = 'RecurringHolidayFactory';
|
||||
|
||||
/**
|
||||
* APIRecurringHoliday constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct(); //Make sure parent constructor is always called.
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get options for dropdown boxes.
|
||||
* @param bool|string $name Name of options to return, ie: 'columns', 'type', 'status'
|
||||
* @param mixed $parent Parent name/ID of options to return if data is in hierarchical format. (ie: Province)
|
||||
* @return bool|array
|
||||
*/
|
||||
function getOptions( $name = false, $parent = null ) {
|
||||
if ( $name == 'columns'
|
||||
&& ( !$this->getPermissionObject()->Check( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'view' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_child' ) ) ) ) {
|
||||
$name = 'list_columns';
|
||||
}
|
||||
|
||||
return parent::getOptions( $name, $parent );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default recurring holiday data for creating new recurring holidayes.
|
||||
* @return array
|
||||
*/
|
||||
function getRecurringHolidayDefaultData() {
|
||||
$company_obj = $this->getCurrentCompanyObject();
|
||||
|
||||
Debug::Text( 'Getting recurring holiday default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
$data = [
|
||||
'company_id' => $company_obj->getId(),
|
||||
'type_id' => 10,
|
||||
];
|
||||
|
||||
return $this->returnHandler( $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get recurring holiday data for one or more recurring holidayes.
|
||||
* @param array $data filter data
|
||||
* @param bool $disable_paging
|
||||
* @return array
|
||||
*/
|
||||
function getRecurringHoliday( $data = null, $disable_paging = false ) {
|
||||
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
||||
|
||||
if ( !$this->getPermissionObject()->Check( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'view' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'view_child' ) ) ) {
|
||||
//return $this->getPermissionObject()->PermissionDenied();
|
||||
$data['filter_columns'] = $this->handlePermissionFilterColumns( ( isset( $data['filter_columns'] ) ) ? $data['filter_columns'] : null, Misc::trimSortPrefix( $this->getOptions( 'list_columns' ) ) );
|
||||
}
|
||||
|
||||
$data['filter_data']['permission_children_ids'] = $this->getPermissionObject()->getPermissionChildren( 'holiday_policy', 'view' );
|
||||
|
||||
$blf = TTnew( 'RecurringHolidayListFactory' ); /** @var RecurringHolidayListFactory $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->setPagerObject( $blf );
|
||||
|
||||
$retarr = [];
|
||||
foreach ( $blf as $b_obj ) {
|
||||
$retarr[] = $b_obj->getObjectAsArray( $data['filter_columns'] );
|
||||
}
|
||||
|
||||
return $this->returnHandler( $retarr );
|
||||
}
|
||||
|
||||
return $this->returnHandler( true ); //No records returned.
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $format
|
||||
* @param array $data
|
||||
* @param bool $disable_paging
|
||||
* @return array|bool
|
||||
*/
|
||||
function exportRecurringHoliday( $format = 'csv', $data = null, $disable_paging = true ) {
|
||||
$result = $this->stripReturnHandler( $this->getRecurringHoliday( $data, $disable_paging ) );
|
||||
|
||||
return $this->exportRecords( $format, 'export_recurring_holiday', $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 getCommonRecurringHolidayData( $data ) {
|
||||
return Misc::arrayIntersectByRow( $this->stripReturnHandler( $this->getRecurringHoliday( $data, true ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate recurring holiday data for one or more recurring holidayes.
|
||||
* @param array $data recurring holiday data
|
||||
* @return array
|
||||
*/
|
||||
function validateRecurringHoliday( $data ) {
|
||||
return $this->setRecurringHoliday( $data, true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set recurring holiday data for one or more recurring holidayes.
|
||||
* @param array $data recurring holiday data
|
||||
* @param bool $validate_only
|
||||
* @param bool $ignore_warning
|
||||
* @return array|bool
|
||||
*/
|
||||
function setRecurringHoliday( $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( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'edit' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'edit_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'edit_child' ) || $this->getPermissionObject()->Check( 'holiday_policy', '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 . ' RecurringHolidays', __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 ) {
|
||||
foreach ( $data as $key => $row ) {
|
||||
$primary_validator = new Validator();
|
||||
$lf = TTnew( 'RecurringHolidayListFactory' ); /** @var RecurringHolidayListFactory $lf */
|
||||
$lf->StartTransaction();
|
||||
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
||||
//Modifying existing object.
|
||||
//Get recurring holiday 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( 'holiday_policy', 'edit' )
|
||||
|| ( $this->getPermissionObject()->Check( 'holiday_policy', 'edit_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy(), $lf->getCurrent()->getID() ) === 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 {
|
||||
//Adding new object, check ADD permissions.
|
||||
$primary_validator->isTrue( 'permission', $this->getPermissionObject()->Check( 'holiday_policy', '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 );
|
||||
|
||||
//Force Company ID to current company.
|
||||
$row['company_id'] = $this->getCurrentCompanyObject()->getId();
|
||||
|
||||
$lf->setObjectFromArray( $row );
|
||||
|
||||
$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();
|
||||
}
|
||||
|
||||
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete one or more recurring holidays.
|
||||
* @param array $data recurring holiday data
|
||||
* @return array|bool
|
||||
*/
|
||||
function deleteRecurringHoliday( $data ) {
|
||||
if ( !is_array( $data ) ) {
|
||||
$data = [ $data ];
|
||||
}
|
||||
|
||||
if ( !is_array( $data ) ) {
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
if ( !$this->getPermissionObject()->Check( 'holiday_policy', 'enabled' )
|
||||
|| !( $this->getPermissionObject()->Check( 'holiday_policy', 'delete' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'delete_own' ) || $this->getPermissionObject()->Check( 'holiday_policy', 'delete_child' ) ) ) {
|
||||
return $this->getPermissionObject()->PermissionDenied();
|
||||
}
|
||||
|
||||
Debug::Text( 'Received data for: ' . count( $data ) . ' RecurringHolidays', __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 ) {
|
||||
foreach ( $data as $key => $id ) {
|
||||
$primary_validator = new Validator();
|
||||
$lf = TTnew( 'RecurringHolidayListFactory' ); /** @var RecurringHolidayListFactory $lf */
|
||||
$lf->StartTransaction();
|
||||
if ( $id != '' ) {
|
||||
//Modifying existing object.
|
||||
//Get recurring holiday 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( 'holiday_policy', 'delete' )
|
||||
|| ( $this->getPermissionObject()->Check( 'holiday_policy', '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();
|
||||
}
|
||||
|
||||
return $this->handleRecordValidationResults( $validator, $validator_stats, $key, $save_result );
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy one or more recurring holidayes.
|
||||
* @param array $data recurring holiday IDs
|
||||
* @return array
|
||||
*/
|
||||
function copyRecurringHoliday( $data ) {
|
||||
if ( !is_array( $data ) ) {
|
||||
$data = [ $data ];
|
||||
}
|
||||
|
||||
if ( !is_array( $data ) ) {
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
|
||||
Debug::Text( 'Received data for: ' . count( $data ) . ' RecurringHolidays', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||||
|
||||
$src_rows = $this->stripReturnHandler( $this->getRecurringHoliday( [ '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->setRecurringHoliday( $src_rows ); //Save copied rows
|
||||
}
|
||||
|
||||
return $this->returnHandler( false );
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
Reference in New Issue
Block a user