TimeTrex API Manual

PurgeDatabase
in package

Class PurgeDatabase

Table of Contents

$parent_table_column_map  : mixed
$parent_table_map_array  : mixed
Execute()  : bool
getParentTableMap()  : mixed

Properties

$parent_table_column_map

public static mixed $parent_table_column_map = ['users' => 'user_id', 'report_schedule' => 'user_report_data_id']

$parent_table_map_array

public static mixed $parent_table_map_array = [ 'absence_policy' => ['company'], 'accrual' => ['users'], 'accrual_balance' => [ 'users', //'accrual_policy' 'accrual_policy_account', ], 'accrual_policy' => ['company'], 'accrual_policy_account' => ['company'], 'accrual_policy_milestone' => ['accrual_policy'], 'area_policy' => ['company'], 'area_policy_location' => ['area_policy'], //Can't automatically purge this table, as user_id is often NULL for company wide settings. //'bank_account' => array( // 'company', // 'users' // ), 'branch' => ['company'], 'bread_crumb' => ['users'], 'break_policy' => ['company'], 'client' => ['company'], 'client_balance' => ['client'], 'client_contact' => ['client'], 'client_group' => ['company'], 'client_payment' => ['client'], 'legal_entity' => ['company'], 'remittance_source_account' => ['legal_entity'], 'remittance_destination_account' => ['users'], 'payroll_remittance_agency' => ['legal_entity'], 'payroll_remittance_agency_event' => ['payroll_remittance_agency'], 'company_deduction' => ['company'], 'company_deduction_pay_stub_entry_account' => ['company_deduction'], 'company_generic_map' => ['company'], 'company_user_count' => ['company'], 'contributing_pay_code_policy' => ['company'], 'contributing_shift_policy' => ['company'], 'currency' => ['company'], 'currency_rate' => ['currency'], 'department' => ['company'], 'government_document' => ['users'], 'document' => ['company'], 'document_attachment' => ['document'], 'document_group' => ['company'], 'document_revision' => ['document'], 'exception' => ['exception_policy', 'users', 'punch', 'punch_control'], 'exception_policy' => ['exception_policy_control'], 'exception_policy_control' => ['company'], 'hierarchy_control' => ['company'], 'hierarchy_level' => ['hierarchy_control', 'users'], 'hierarchy_object_type' => ['hierarchy_control'], 'hierarchy_user' => ['hierarchy_control', 'users'], 'holiday_policy' => ['company'], 'holiday_policy_recurring_holiday' => ['holiday_policy', 'recurring_holiday'], 'holidays' => ['holiday_policy'], 'invoice' => ['client'], 'invoice_config' => ['company'], 'invoice_district' => ['company'], 'invoice_transaction' => [ 'client', 'product', //Invoice payments are product_id = 0 'invoice', ], 'job' => ['company'], 'job_group' => ['company'], 'job_item' => ['company'], 'job_item_amendment' => ['job'], 'job_item_group' => ['company'], 'geo_fence' => ['company'], 'qualification' => ['company'], 'qualification_group' => ['company'], 'user_education' => ['users'], 'user_license' => ['users'], 'user_skill' => ['users'], 'user_language' => ['users'], 'user_membership' => ['users'], 'user_review_control' => ['users'], 'user_review' => ['user_review_control'], 'kpi' => ['company'], 'kpi_group' => ['company'], 'ethnic_group' => ['company'], 'user_contact' => ['users'], 'user_setting' => ['users'], 'company_setting' => ['company'], 'job_vacancy' => ['company'], 'job_applicant' => ['company'], 'job_application' => ['job_applicant', 'job_vacancy'], 'job_applicant_location' => ['job_applicant'], 'job_applicant_employment' => ['job_applicant'], 'job_applicant_reference' => ['job_applicant'], 'job_applicant_education' => ['job_applicant'], 'job_applicant_skill' => ['job_applicant'], 'job_applicant_language' => ['job_applicant'], 'job_applicant_membership' => ['job_applicant'], 'job_applicant_license' => ['job_applicant'], 'recruitment_portal_config' => ['company'], 'recruitment_portal_field_map' => ['company'], 'expense_policy' => ['company'], 'user_expense' => ['users', 'expense_policy'], 'meal_policy' => ['company'], 'message_recipient' => ['users', 'message_sender'], 'message_sender' => ['users', 'message_control'], 'custom_field' => ['company'], 'over_time_policy' => ['company'], 'pay_code' => ['company'], 'pay_formula_policy' => ['company'], 'pay_period' => ['company', 'pay_period_schedule'], 'pay_period_schedule' => ['company'], 'pay_period_schedule_user' => ['pay_period_schedule', 'users'], 'pay_period_time_sheet_verify' => ['pay_period', 'users'], 'pay_stub' => ['pay_period', 'users'], 'pay_stub_amendment' => ['users'], 'pay_stub_entry' => ['pay_stub'], 'pay_stub_entry_account' => ['company'], 'pay_stub_transaction' => ['pay_stub'], 'pay_stub_entry_account_link' => ['company'], 'payment_gateway' => ['company'], 'payment_gateway_credit_card_type' => ['payment_gateway'], 'payment_gateway_currency' => ['payment_gateway'], 'permission' => ['permission_control'], 'permission_control' => ['company'], 'permission_user' => ['permission_control', 'users'], 'policy_group' => ['company'], 'policy_group_user' => ['policy_group', 'users'], 'premium_policy' => ['company'], 'premium_policy_branch' => ['premium_policy', 'branch'], 'premium_policy_department' => ['premium_policy', 'department'], 'premium_policy_job' => ['premium_policy', 'job'], 'premium_policy_job_group' => ['premium_policy', 'job_group'], 'premium_policy_job_item' => ['premium_policy', 'job_item'], 'premium_policy_job_item_group' => ['premium_policy', 'job_item_group'], 'product' => ['company'], 'product_group' => ['company'], 'product_price' => ['product'], 'punch' => ['punch_control'], 'punch_control' => ['users'], 'recurring_holiday' => ['company'], 'recurring_ps_amendment' => ['company'], 'recurring_ps_amendment_user' => ['recurring_ps_amendment', 'users'], 'recurring_schedule_control' => ['company'], 'recurring_schedule_template' => ['recurring_schedule_template_control'], 'recurring_schedule_template_control' => ['company'], //'recurring_schedule_user' => [ // 'recurring_schedule_control', // 'users', //], 'recurring_schedule' => ['recurring_schedule_control', 'users', 'company'], 'regular_time_policy' => ['company'], 'report_schedule' => ['user_report_data'], 'request' => ['users'], 'request_schedule' => ['request'], 'roe' => ['users'], 'round_interval_policy' => ['company'], 'schedule' => ['users', 'company'], 'schedule_policy' => ['company'], 'shipping_policy' => ['company'], 'shipping_policy_object' => ['shipping_policy'], 'shipping_table_rate' => ['shipping_policy'], 'station' => ['company'], 'station_branch' => ['station', 'branch'], 'station_department' => ['station', 'department'], 'station_exclude_user' => ['station', 'users'], 'station_include_user' => ['station', 'users'], 'station_user' => ['station', 'users'], 'station_user_group' => ['station'], 'system_log' => ['users'], 'system_log_detail' => ['system_log'], 'tax_policy' => ['company'], 'tax_policy_object' => ['tax_policy'], 'user_date_total' => ['users'], 'user_deduction' => ['users', 'company_deduction'], 'user_default' => ['company'], 'user_default_company_deduction' => ['user_default', 'company_deduction'], 'user_default_preference_notification' => ['user_default'], //Can't automatically purge this table, as user_id is often NULL for company wide settings. //'user_generic_data' => array( // 'users', // 'company' // ), 'user_generic_status' => ['users'], 'user_group' => ['company'], 'user_identification' => ['users'], 'user_preference' => ['users'], 'user_preference_notification' => ['users'], 'notification' => ['users'], 'device_token' => ['users'], //Can't automatically purge this table, as user_id is often NULL for company wide settings. //'user_report_data' => array( // 'company', // 'users' // ), 'report_custom_column' => ['company'], 'user_title' => ['company'], 'user_wage' => ['users'], 'users' => ['company'], 'wage_group' => ['company'], ]

Methods

Execute()

public static Execute() : bool
Tags
noinspection

PhpMissingBreakStatementInspection

Return values
bool

getParentTableMap()

public static getParentTableMap() : mixed
Tags
noinspection

PhpUndefinedFunctionInspection

Return values
mixed

Search results