<?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\Core */ class APIException extends APIFactory { protected $main_class = 'ExceptionFactory'; /** * APIException 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( 'punch', 'enabled' ) || !( $this->getPermissionObject()->Check( 'punch', 'view' ) || $this->getPermissionObject()->Check( 'punch', 'view_child' ) ) ) ) { $name = 'list_columns'; } return parent::getOptions( $name, $parent ); } /** * Get default exception data for creating new exceptiones. * @return array */ function getExceptionDefaultData() { $company_obj = $this->getCurrentCompanyObject(); Debug::Text( 'Getting exception default data...', __FILE__, __LINE__, __METHOD__, 10 ); $data = [ 'company_id' => $company_obj->getId(), ]; return $this->returnHandler( $data ); } /** * Get exception data for one or more exceptiones. * @param array $data filter data * @param bool $disable_paging * @return array|bool */ function getException( $data = null, $disable_paging = false ) { $data = $this->initializeFilterAndPager( $data, $disable_paging ); if ( !$this->getPermissionObject()->Check( 'punch', 'enabled' ) || !( $this->getPermissionObject()->Check( 'punch', 'view' ) || $this->getPermissionObject()->Check( 'punch', 'view_own' ) || $this->getPermissionObject()->Check( 'punch', 'view_child' ) ) ) { return $this->getPermissionObject()->PermissionDenied(); //If they don't have permissions to view punches/timesheets, what good is it to show them exceptions? //$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( 'punch', 'view' ); //If no pay period is specified, force to showing exceptions only in non-closed pay periods. This is a performance optimization too. if ( !isset( $data['filter_data']['pay_period_status_id'] ) && !isset( $data['filter_data']['pay_period_id'] ) ) { $data['filter_data']['pay_period_status_id'] = [ 10, 12, 30 ]; //All but closed } $blf = TTnew( 'ExceptionListFactory' ); /** @var ExceptionListFactory $blf */ $type_ids = Misc::trimSortPrefix( $blf->getOptions( 'type' ) ); if ( !isset( $data['filter_data']['show_pre_mature'] ) || ( isset( $data['filter_data']['show_pre_mature'] ) && $data['filter_data']['show_pre_mature'] == false ) ) { unset( $type_ids[5] ); } $data['filter_data']['type_id'] = array_keys( $type_ids ); if ( DEPLOYMENT_ON_DEMAND == true ) { $blf->setQueryStatementTimeout( 60000 ); } $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'], $data['filter_data']['permission_children_ids'] ); $this->getProgressBarObject()->set( $this->getAPIMessageID(), $blf->getCurrentRow() ); } $this->getProgressBarObject()->stop( $this->getAPIMessageID() ); 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 exportException( $format = 'csv', $data = null, $disable_paging = true ) { $result = $this->stripReturnHandler( $this->getException( $data, $disable_paging ) ); return $this->exportRecords( $format, 'export_exceptions', $result, ( ( isset( $data['filter_columns'] ) ) ? $data['filter_columns'] : null ) ); } } ?>