•';
} else {
$content .= '
';
$content .= '
' . TTi18n::getText( 'Slow news day, nothing to see here yet' ) . '...
';
$content .= '
•';
}
return $this->returnHandler( $content );
break;
case 'schedule_summary':
case 'schedule_summary_child':
$api = TTNew( 'APISchedule' ); /** @var APISchedule $api */
$maximum_row_limit = ( isset( $data['rows_per_page'] ) && $data['rows_per_page'] > 0 ) ? $data['rows_per_page'] : $this->getCurrentUserPreferenceObject()->getItemsPerPage();
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
if ( $name == 'schedule_summary' ) {
$display_columns = [ 'id', 'date_stamp', 'status', 'status_id', 'start_time', 'end_time', 'total_time' ];
$parameters['filter_data'] = [ 'include_user_ids' => [ $this->getCurrentUserObject()->getId() ] ];
} else {
$display_columns = $api->getOptions( 'default_display_columns' );
$parameters['filter_data'] = [ 'exclude_user_ids' => [ $this->getCurrentUserObject()->getId(), '0' ] ];
}
$retarr['api_retval'] = [];
$api_result = $api->getCombinedSchedule( $parameters, TTDate::getDate( 'DATE', time() ), 'week', false );
if ( isset( $api_result['api_retval']['schedule_data'] ) ) {
$i = 0;
foreach ( $api_result['api_retval']['schedule_data'] as $val ) {
foreach ( $val as $val1 ) {
if ( $val1['status_id'] == 10 ) {
$val1['status'] = TTi18n::getText( 'Working' );
} else if ( $val1['status_id'] == 20 ) {
$val1['status'] = ( $val1['absence_policy'] != '' ) ? $val1['absence_policy'] : TTi18n::getText( 'N/A' );
}
$retarr['api_retval'][] = $val1;
}
if ( $i >= $maximum_row_limit ) {
array_splice( $retarr['api_retval'], $i );
break;
}
$i++;
}
}
unset( $api_result, $i, $maximum_row_limit );
break;
case 'user_active_shift_summary':
$api = TTNew( 'APIActiveShiftReport' ); /** @var APIActiveShiftReport $api */
$template_data = $api->getTemplate( 'by_status_by_type_by_employee' );
$template_data = Misc::trimSortPrefix( $template_data['api_retval'] );
$template_data['other']['maximum_row_limit'] = ( isset( $data['rows_per_page'] ) && $data['rows_per_page'] > 0 ) ? $data['rows_per_page'] : $this->getCurrentUserPreferenceObject()->getItemsPerPage();
$display_columns = $template_data['columns'];
$template_data = Misc::addSortPrefix( $template_data );
$retarr = $api->getActiveShiftReport( $template_data, 'raw' );
if ( is_array( $retarr['api_retval'] ) ) {
array_pop( $retarr['api_retval'] );
}
break;
case 'timesheet_verification_summary':
case 'timesheet_verification_summary_child':
$api = TTNew( 'APITimesheetSummaryReport' ); /** @var APITimesheetSummaryReport $api */
$template_data = $api->getTemplate( 'by_pay_period_by_employee+verified_time_sheet' );
$template_data = Misc::trimSortPrefix( $template_data['api_retval'] );
$template_data['other']['maximum_row_limit'] = ( isset( $data['rows_per_page'] ) && $data['rows_per_page'] > 0 ) ? $data['rows_per_page'] : $this->getCurrentUserPreferenceObject()->getItemsPerPage();
$display_columns = $template_data['columns'];
if ( $name == 'timesheet_verification_summary_child' ) {
$template_data['exclude_user_id'] = [ $this->getCurrentUserObject()->getId() ];
}
$template_data['sort'][] = [ 'verified_time_sheet' => 'asc' ];
$template_data['sort'][] = [ 'last_name' => 'asc' ];
$template_data = Misc::addSortPrefix( $template_data );
$retarr = $api->getTimesheetSummaryReport( $template_data, 'raw' );
if ( is_array( $retarr['api_retval'] ) ) {
array_pop( $retarr['api_retval'] );
}
break;
case 'message_summary':
$api = TTNew( 'APIMessageControl' ); /** @var APIMessageControl $api */
$display_columns = $api->getOptions( 'default_display_columns' );
$display_columns[] = 'status_id';
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
$parameters['filter_data'] = [ 'status_id' => 10, 'folder_id' => 10 ];
$retarr = $api->getMessageControl( $parameters );
break;
case 'exception_summary':
case 'exception_summary_child':
$ppslf = TTnew( 'PayPeriodScheduleListFactory' ); /** @var PayPeriodScheduleListFactory $ppslf */
if ( $name == 'exception_summary_child' ) {
$ppslf->getByCompanyId( $this->getCurrentCompanyObject()->getId() ); //Must be all PP schedules when showing subordinate exceptions.
} else {
$ppslf->getByCompanyIdAndUserId( $this->getCurrentCompanyObject()->getId(), $this->getCurrentUserObject()->getId() ); //Just current users PP schedule.
}
$pay_period_schedule_id = $ppslf->getIDSByListFactory( $ppslf );
//Get pay period schedule that this user belongs to
if ( is_array( $pay_period_schedule_id ) && count( $pay_period_schedule_id ) > 0 ) {
$pay_period_ids = [];
//Get last and this pay period IDs.
$pplf = TTnew( 'PayPeriodListFactory' ); /** @var PayPeriodListFactory $pplf */
$pplf->getThisPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate( $this->getCurrentCompanyObject()->getId(), $pay_period_schedule_id, time() );
if ( $pplf->getRecordCount() > 0 ) {
foreach ( $pplf as $pp_obj ) {
$pay_period_ids[] = $pp_obj->getId();
}
}
$pplf->getLastPayPeriodByCompanyIdAndPayPeriodScheduleIdAndDate( $this->getCurrentCompanyObject()->getId(), $pay_period_schedule_id, time() );
if ( $pplf->getRecordCount() > 0 ) {
foreach ( $pplf as $pp_obj ) {
//Only show last pay period if its not closed.
if ( $pp_obj->getStatus() != 20 ) {
$pay_period_ids[] = $pp_obj->getId();
}
}
}
if ( count( $pay_period_ids ) > 0 ) {
$api = TTNew( 'APIException' ); /** @var APIException $api */
if ( $name == 'exception_summary' ) { //Only show the users own exceptions
//No need to show first/last name as its only displaying their own exceptions anyways.
$display_columns = [
'date_stamp',
'severity',
'exception_policy_type',
'exception_policy_type_id',
];
} else {
//Showing other users exceptions, make sure first/last name is displayed.
$display_columns = $api->getOptions( 'default_display_columns' );
}
$display_columns[] = 'exception_color';
$display_columns[] = 'exception_background_color';
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
$parameters['filter_data'] = [ 'pay_period_id' => $pay_period_ids ];
if ( $name == 'exception_summary' ) { //Only show the users own exceptions
$parameters['filter_data']['user_id'] = $this->getCurrentUserObject()->getId();
} else { //Show all *but* the users own exceptions.
$parameters['filter_data']['exclude_user_id'] = $this->getCurrentUserObject()->getId();
}
$parameters['filter_data']['type_id'] = [ 50 ]; //Exclude pre-mature exceptions.
$retarr = $api->getException( $parameters );
}
}
break;
case 'request_summary':
$api = TTNew( 'APIRequest' ); /** @var APIRequest $api */
$display_columns = $api->getOptions( 'default_display_columns' );
$display_columns[] = 'status_id';
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
$parameters['filter_data'] = [ 'status_id' => 30 ];
$retarr = $api->getRequest( $parameters );
break;
case 'request_authorize_summary':
$api = TTNew( 'APIRequest' ); /** @var APIRequest $api */
$display_columns = $api->getOptions( 'default_display_columns' );
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
$parameters['filter_data'] = [];
$parameters['filter_data']['type_id'] = [ -1 ];
$parameters['filter_data']['status_id'] = 30; //Pending Auth
$parameters['filter_data']['hierarchy_level'] = 1;
$retarr = $api->getRequest( $parameters );
break;
case 'accrual_balance_summary':
$api = TTNew( 'APIAccrualBalance' ); /** @var APIAccrualBalance $api */
$display_columns = $api->getOptions( 'default_display_columns' );
//$display_columns[] = 'status_id';
$parameters = $this->buildDefaultDashletParameters( $display_columns, $data['rows_per_page'] );
$parameters['filter_data'] = [ 'status_id' => 10 ]; //Only active employees.
$retarr = $api->getAccrualBalance( $parameters );
break;
case 'custom_list':
/*
* Params=array('class' => , 'user_generic_data_id' => array() )
*/
if ( isset( $data['class'] ) && $data['class'] != '' ) {
Debug::Text( ' Class: ' . $data['class'], __FILE__, __LINE__, __METHOD__, 10 );
//Get saved search and layout.
if ( isset( $data['user_generic_data_id'] ) ) {
Debug::Text( ' Getting UserGenericData for ID: ' . $data['user_generic_data_id'], __FILE__, __LINE__, __METHOD__, 10 );
if ( $data['class'] == 'Request-Authorization' ) {
$api = TTNew( 'APIRequest' ); /** @var APIRequest $api */
$function_name = 'getRequest';
} else {
if ( $data['class'] == 'UserExpense-Authorization' ) {
$api = TTNew( 'APIUserExpense' ); /** @var APIUserExpense $api */
$function_name = 'getUserExpense';
} else {
$api = TTNew( 'API' . $data['class'] );
$function_name = 'get' . $data['class'];
}
}
$augd = TTNew( 'APIUserGenericData' ); /** @var APIUserGenericData $augd */
$retval = $this->stripReturnHandler( $augd->getUserGenericData( [ 'filter_data' => [ 'id' => TTUUID::castUUID( $data['user_generic_data_id'] ) ] ] ) );
if ( is_array( $retval ) && count( $retval ) == 1 ) {
if ( isset( $retval[0]['data'] ) ) {
$user_generic_data = $retval[0]['data'];
$display_columns = $user_generic_data['display_columns'];
}
} else {
//No user_generic_data specified, just use default display columns instead.
$display_columns = $api->getOptions( 'default_display_columns' );
$user_generic_data = [ 'display_columns' => $display_columns ];
}
unset( $retval );
if ( isset( $user_generic_data ) ) {
Debug::Arr( $user_generic_data, ' UserGenericData for Class: ' . $data['class'] . ' ID: ' . $data['user_generic_data_id'], __FILE__, __LINE__, __METHOD__, 10 );
if ( strpos( '-', $data['class'] ) === false ) {
Debug::Text( ' Getting Dashlet Data for Class: ' . $data['class'], __FILE__, __LINE__, __METHOD__, 10 );
$retarr = $api->$function_name( $this->buildFilterParameters( $data['class'], $user_generic_data, $data['rows_per_page'] ) );
}
//else {
//Special class, need to handle it manually.
//}
} else {
Debug::Text( 'ERROR: No UserGenericData available...', __FILE__, __LINE__, __METHOD__, 10 );
}
} else {
Debug::Text( 'ERROR: No UserGenericData ID specified...', __FILE__, __LINE__, __METHOD__, 10 );
}
} else {
Debug::Text( 'ERROR: No Class specified...', __FILE__, __LINE__, __METHOD__, 10 );
}
break;
case 'custom_report':
break;
}
if ( isset( $retarr ) ) {
$data = $retarr['api_retval'];
$retarr['api_retval'] = [ 'data' => $data, 'display_columns' => $display_columns ];
return $retarr;
}
return $this->returnHandler( false );
}
/**
* @return array
*/
function getDefaultDashlets() {
$parameters = [];
$permission = new Permission();
$permission_level = $permission->getLevel( $this->getCurrentUserObject()->getId(), $this->getCurrentCompanyObject()->getId() );
Debug::Text( 'Permission Level: ' . $permission_level, __FILE__, __LINE__, __METHOD__, 10 );
//Get available dashlets (as that performs permission checks), and only add ones that are available.
$dashlet_options = Misc::trimSortPrefix( $this->getOptions( 'dashlets' ) );
//Check if TimeSheet Verifications are even enabled, not need to display dashlets if they aren't.
$enabled_timesheet_verification = false;
$ppslf = TTNew( 'PayPeriodScheduleListFactory' ); /** @var PayPeriodScheduleListFactory $ppslf */
$ppslf->getByCompanyId( $this->getCurrentCompanyObject()->getId() );
if ( $ppslf->getRecordCount() > 0 ) {
foreach ( $ppslf as $pps_obj ) {
if ( in_array( $pps_obj->getTimeSheetVerifyType(), [ 20, 40 ] ) ) { //Check if TimeSheet Verification is enabled or not.
$enabled_timesheet_verification = true;
break;
}
}
}
//Note: Dashlet information including its name/title is saved to UserGenericData, which means if the user changes languages then the dashlet titles won't get changed unless they edit/save them, or restore defaults.
// This is required behavior since the user can rename the dashlets to whatever they want.
//Common to all levels.
( ( isset( $dashlet_options['news'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'news', TTi18n::getText( 'News' ) ) : null );
( ( isset( $dashlet_options['exception_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'exception_summary', TTi18n::getText( 'Exception Summary' ) ) : null );
( ( isset( $dashlet_options['message_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'message_summary', TTi18n::getText( 'Messages (UnRead)' ) ) : null );
if ( $permission_level >= 40 ) {
( ( isset( $dashlet_options['request_authorize_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'request_authorize_summary', TTi18n::getText( 'Request Authorizations' ) ) : null );
( ( isset( $dashlet_options['exception_summary_child'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'exception_summary_child', TTi18n::getText( 'Exceptions (Subordinates)' ) ) : null );
( ( isset( $dashlet_options['schedule_summary_child'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'schedule_summary_child', TTi18n::getText( 'Schedule Summary (Subordinates)' ) ) : null );
}
if ( $permission_level <= 40 ) {
( ( isset( $dashlet_options['timesheet_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'timesheet_summary', TTi18n::getText( 'TimeSheet Summary' ) ) : null );
}
( ( isset( $dashlet_options['schedule_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'schedule_summary', TTi18n::getText( 'Schedule Summary' ) ) : null );
if ( $permission_level <= 40 ) {
( ( isset( $dashlet_options['accrual_balance_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'accrual_balance_summary', TTi18n::getText( 'Accrual Balances' ) ) : null );
}
if ( $enabled_timesheet_verification == true ) {
if ( $permission_level == 40 ) {
( ( isset( $dashlet_options['timesheet_verification_summary_child'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'timesheet_verification_summary_child', TTi18n::getText( 'TimeSheet Verifications (Subordinates)' ) ) : null );
} else if ( $permission_level >= 50 ) {
( ( isset( $dashlet_options['timesheet_verification_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'timesheet_verification_summary', TTi18n::getText( 'TimeSheet Verifications' ) ) : null );
}
}
if ( $permission_level >= 40 ) {
( ( isset( $dashlet_options['user_active_shift_summary'] ) ) ? $parameters[] = $this->createDefaultDashletData( 'user_active_shift_summary', TTi18n::getText( 'Whos In/Out' ) ) : null );
}
$augd = TTNew( 'APIUserGenericData' ); /** @var APIUserGenericData $augd */
$retval = $augd->setUserGenericData( $parameters );
if ( $retval['api_retval'] == true ) {
$parameters = [
'name' => 'order_data',
'script' => 'global_dashboard_order',
'is_default' => true,
'data' => $retval['api_details']['details'],
];
$augd->setUserGenericData( $parameters );
return $augd->getUserGenericData( [ 'filter_data' => [ 'script' => 'global_dashboard', 'deleted' => false ] ] );
} else {
return $this->returnHandler( false );
}
}
/**
* @param $type
* @param $name
* @return array
*/
function createDefaultDashletData( $type, $name ) {
$result = [
'script' => 'global_dashboard',
'is_default' => false,
'name' => $name,
'data' => [
'dashlet_type' => $type,
'auto_refresh' => 0,
'rows_per_page' => 0,
],
];
return $result;
}
/**
* @return bool
*/
function removeAllDashlets() {
return true;
}
}
?>