399 lines
16 KiB
PHP
399 lines
16 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\KPI
|
||
|
|
*/
|
||
|
|
class APIKPI extends APIFactory {
|
||
|
|
protected $main_class = 'KPIFactory';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* APIKPI 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( 'kpi', 'enabled' )
|
||
|
|
|| !( $this->getPermissionObject()->Check( 'kpi', 'view' ) || $this->getPermissionObject()->Check( 'kpi', 'view_own' ) || $this->getPermissionObject()->Check( 'kpi', 'view_child' ) ) ) ) {
|
||
|
|
$name = 'list_columns';
|
||
|
|
}
|
||
|
|
|
||
|
|
return parent::getOptions( $name, $parent );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get default KPI data for creating new KPIs.
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getKPIDefaultData() {
|
||
|
|
$company_obj = $this->getCurrentCompanyObject();
|
||
|
|
|
||
|
|
Debug::Text( 'Getting KPI default data...', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$data = [
|
||
|
|
'company_id' => $company_obj->getId(),
|
||
|
|
'minimum_rate' => 1,
|
||
|
|
'maximum_rate' => 10,
|
||
|
|
'display_order'=> 1000,
|
||
|
|
];
|
||
|
|
|
||
|
|
return $this->returnHandler( $data );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get KPI data for one or more KPIs.
|
||
|
|
* @param array $data filter data
|
||
|
|
* @param bool $disable_paging
|
||
|
|
* @return array|bool
|
||
|
|
*/
|
||
|
|
function getKPI( $data = null, $disable_paging = false ) {
|
||
|
|
$data = $this->initializeFilterAndPager( $data, $disable_paging );
|
||
|
|
|
||
|
|
if ( $this->getPermissionObject()->checkAuthenticationType( 700 ) == false ) { //700=HTTP Auth with username/password
|
||
|
|
return $this->getPermissionObject()->AuthenticationTypeDenied();
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !$this->getPermissionObject()->Check( 'kpi', 'enabled' )
|
||
|
|
|| !( $this->getPermissionObject()->Check( 'kpi', 'view' ) || $this->getPermissionObject()->Check( 'kpi', 'view_own' ) || $this->getPermissionObject()->Check( 'kpi', 'view_child' ) ) ) {
|
||
|
|
return $this->getPermissionObject()->PermissionDenied();
|
||
|
|
}
|
||
|
|
$data['filter_data']['permission_children_ids'] = $this->getPermissionObject()->getPermissionChildren( 'kpi', 'view' );
|
||
|
|
|
||
|
|
$klf = TTnew( 'KPIListFactory' ); /** @var KPIListFactory $klf */
|
||
|
|
$klf->getAPISearchByCompanyIdAndArrayCriteria( $this->getCurrentCompanyObject()->getId(), $data['filter_data'], $data['filter_items_per_page'], $data['filter_page'], null, $data['filter_sort'] );
|
||
|
|
Debug::Text( 'Record Count: ' . $klf->getRecordCount(), __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
if ( $klf->getRecordCount() > 0 ) {
|
||
|
|
$this->setPagerObject( $klf );
|
||
|
|
$retarr = [];
|
||
|
|
foreach ( $klf as $kpi_obj ) {
|
||
|
|
$retarr[] = $kpi_obj->getObjectAsArray( $data['filter_columns'], $data['filter_data']['permission_children_ids'] );
|
||
|
|
}
|
||
|
|
|
||
|
|
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 exportKPI( $format = 'csv', $data = null, $disable_paging = true ) {
|
||
|
|
$result = $this->stripReturnHandler( $this->getKPI( $data, $disable_paging ) );
|
||
|
|
|
||
|
|
return $this->exportRecords( $format, 'export_kpi', $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 getCommonKPIData( $data ) {
|
||
|
|
return Misc::arrayIntersectByRow( $this->stripReturnHandler( $this->getKPI( $data, true ) ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Validate KPI data for one or more KPIs.
|
||
|
|
* @param array $data KPI data
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function validateKPI( $data ) {
|
||
|
|
return $this->setKPI( $data, true );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set KPI data for one or more KPIs.
|
||
|
|
* @param array $data KPI data
|
||
|
|
* @param bool $validate_only
|
||
|
|
* @param bool $ignore_warning
|
||
|
|
* @return array|bool
|
||
|
|
*/
|
||
|
|
function setKPI( $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()->checkAuthenticationType( 700 ) == false ) { //700=HTTP Auth with username/password
|
||
|
|
return $this->getPermissionObject()->AuthenticationTypeDenied();
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !$this->getPermissionObject()->Check( 'kpi', 'enabled' )
|
||
|
|
|| !( $this->getPermissionObject()->Check( 'kpi', 'edit' ) || $this->getPermissionObject()->Check( 'kpi', 'edit_own' ) || $this->getPermissionObject()->Check( 'kpi', 'edit_child' ) || $this->getPermissionObject()->Check( 'kpi', 'add' ) ) ) {
|
||
|
|
return $this->getPermissionObject()->PermissionDenied();
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $validate_only == true ) {
|
||
|
|
Debug::Text( 'Validating Only!', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$permission_children_ids = false;
|
||
|
|
} else {
|
||
|
|
//Get Permission Hierarchy Children first, as this can be used for viewing, or editing.
|
||
|
|
$permission_children_ids = $this->getPermissionChildren();
|
||
|
|
}
|
||
|
|
|
||
|
|
[ $data, $total_records ] = $this->convertToMultipleRecords( $data );
|
||
|
|
Debug::Text( 'Received data for: ' . $total_records . ' KPIs', __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( 'KPIListFactory' ); /** @var KPIListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( isset( $row['id'] ) && $row['id'] != '' ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get KPI 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( 'kpi', 'edit' )
|
||
|
|
|| ( $this->getPermissionObject()->Check( 'kpi', 'edit_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy() ) === true )
|
||
|
|
|| ( $this->getPermissionObject()->Check( 'kpi', 'edit_child' ) && $this->getPermissionObject()->isChild( $lf->getCurrent()->getCreatedBy(), $permission_children_ids ) === 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( 'kpi', 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( 'kpi', $this->getPermissionObject()->Check( 'kpi', 'add' ), TTi18n::gettext( 'Add permission denied' ) );
|
||
|
|
|
||
|
|
//Because this class has sub-classes that depend on it, when adding a new record we need to make sure the ID is set first,
|
||
|
|
//so the sub-classes can depend on it. We also need to call Save( TRUE, TRUE ) to force a lookup on isNew()
|
||
|
|
$row['id'] = $lf->getNextInsertId();
|
||
|
|
}
|
||
|
|
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 );
|
||
|
|
Debug::Arr( $row, '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( true, true ); //Force lookup on isNew()
|
||
|
|
}
|
||
|
|
$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 KPIs.
|
||
|
|
* @param array $data KPI data
|
||
|
|
* @return array|bool
|
||
|
|
*/
|
||
|
|
function deleteKPI( $data ) {
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
$data = [ $data ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( $this->getPermissionObject()->checkAuthenticationType( 700 ) == false ) { //700=HTTP Auth with username/password
|
||
|
|
return $this->getPermissionObject()->AuthenticationTypeDenied();
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !$this->getPermissionObject()->Check( 'kpi', 'enabled' )
|
||
|
|
|| !( $this->getPermissionObject()->Check( 'kpi', 'delete' ) || $this->getPermissionObject()->Check( 'kpi', 'delete_own' ) || $this->getPermissionObject()->Check( 'kpi', 'delete_child' ) ) ) {
|
||
|
|
return $this->getPermissionObject()->PermissionDenied();
|
||
|
|
}
|
||
|
|
|
||
|
|
$permission_children_ids = $this->getPermissionChildren();
|
||
|
|
|
||
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' KPIs', __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( 'KPIListFactory' ); /** @var KPIListFactory $lf */
|
||
|
|
$lf->StartTransaction();
|
||
|
|
if ( $id != '' ) {
|
||
|
|
//Modifying existing object.
|
||
|
|
//Get KPI 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( 'kpi', 'delete' )
|
||
|
|
|| ( $this->getPermissionObject()->Check( 'kpi', 'delete_own' ) && $this->getPermissionObject()->isOwner( $lf->getCurrent()->getCreatedBy() ) === true )
|
||
|
|
|| ( $this->getPermissionObject()->Check( 'kpi', 'delete_child' ) && $this->getPermissionObject()->isChild( $lf->getCurrent()->getCreatedBy(), $permission_children_ids ) === true )
|
||
|
|
) {
|
||
|
|
|
||
|
|
Debug::Text( 'Record Exists, deleting record ID: ' . $id, __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
$lf = $lf->getCurrent();
|
||
|
|
} else {
|
||
|
|
$primary_validator->isTrue( 'kpi', 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 KPIs.
|
||
|
|
* @param array $data KPI IDs
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function copyKPI( $data ) {
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
$data = [ $data ];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( !is_array( $data ) ) {
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
|
||
|
|
Debug::Text( 'Received data for: ' . count( $data ) . ' KPIs', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
Debug::Arr( $data, 'Data: ', __FILE__, __LINE__, __METHOD__, 10 );
|
||
|
|
|
||
|
|
$src_rows = $this->stripReturnHandler( $this->getKPI( [ '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]['user'] ); //Clear fields that can't be copied
|
||
|
|
$src_rows[$key]['name'] = Misc::generateCopyName( $row['name'], false, 100 ); //Generate unique name
|
||
|
|
}
|
||
|
|
|
||
|
|
//Debug::Arr($src_rows, 'bSRC Rows: ', __FILE__, __LINE__, __METHOD__, 10);
|
||
|
|
return $this->setKPI( $src_rows ); //Save copied rows
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->returnHandler( false );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
?>
|