Cost Center Report Controller Documentation

File: /controllers/costcenterReportController.php

Purpose: Generates detailed reports for cost center activities and expense allocations with date filtering

Last Updated: December 20, 2024

Total Functions: 2

Lines of Code: ~128

---

📋 Overview

The Cost Center Report Controller provides comprehensive reporting functionality for cost center activities, allowing users to view expense allocations, track cost center usage, and analyze spending patterns by date ranges and specific cost centers.

Primary Functions

• ✅ Display cost center selection interface
• ✅ Filter cost center activities by date range
• ✅ Show detailed cost center transactions
• ✅ Generate expense allocation reports
• ✅ Provide drill-down capabilities for expense details

Related Controllers

• • costcenterController.php - Cost center management
• • expensesController.php - Expense management
• • costcenterdetailController.php - Cost center transaction details

---

🗄️ Database Tables

Primary Tables (Direct Operations)

🔑 Key Functions

1. Default Action - Report Form Display

Location: Line 56

Purpose: Display cost center selection form for reporting

Function Signature:

// Triggered when: empty($do)

Process Flow:

1. Load all active cost centers for selection dropdown

2. Display report form with date range inputs

3. Present cost center selection interface

Implementation:

$allCostCenter = $CostcenterDAO->queryByCondation(0); // Get active cost centers only
$smarty->assign("allCostCenter", $allCostCenter);
$smarty->display("costcenterview/report.html");

---

2. search - Generate Cost Center Report

Location: Line 62

Purpose: Execute cost center activity report with filtering

Function Signature:

// Triggered when: do=search

Process Flow:

1. Retrieve search parameters from form

2. Build dynamic date filter query

3. Execute cost center detail query

4. Display results with original search form

Parameter Processing:

$costCenterId = filter_input(INPUT_POST, 'costCenterId');
$start_date = filter_input(INPUT_POST, 'start_date');
$end_date = filter_input(INPUT_POST, 'end_date');
$details = filter_input(INPUT_POST, 'detail');

Dynamic Query Building:

$costcenter = " where 1 ";

if ($start_date != '' && $end_date != '') {
    $costcenter .= ' and costdate >= "' . $start_date . '" and costdate <= "' . $end_date . '" and costcenterid = "' . $costCenterId . '"';
} else {
    if ($start_date != '') {
        $costcenter .= ' and costdate >= "' . $start_date . '" and costcenterid = "' . $costCenterId . '"';
    }
    if ($end_date != '') {
        $costcenter .= ' and costdate <= "' . $end_date . '" and costcenterid = "' . $costCenterId . '"';
    }
}

// Default to today if no date range provided
$today = date('Y-m-d');
if ($costcenter == " where 1 ") {
    $costcenter .= ' and costdate >= "' . $today . '" and costdate <= "' . $today . '" and costcenterid = "' . $costCenterId . '"';
}

Report Execution:

$allDetails = $CostcenterdetailEX->getbydate($costcenter);
$smarty->assign("allDetails", $allDetails);
$smarty->assign("details", $details);

---

🔄 Workflows

Workflow 1: Cost Center Report Generation

---

🌐 URL Routes & Actions

Search Report (do=search):

• • costCenterId - Cost center ID (required)
• • start_date - Start date (YYYY-MM-DD, optional)
• • end_date - End date (YYYY-MM-DD, optional)
• • detail - Detail level flag (optional)

---

🧮 Calculation Methods

Date Filter Logic

// Both dates provided
if ($start_date != '' && $end_date != '') {
    $filter = ' and costdate >= "' . $start_date . '" and costdate <= "' . $end_date . '"';
}

// Only start date
if ($start_date != '' && $end_date == '') {
    $filter = ' and costdate >= "' . $start_date . '"';
}

// Only end date  
if ($start_date == '' && $end_date != '') {
    $filter = ' and costdate <= "' . $end_date . '"';
}

// No dates - default to today
if ($start_date == '' && $end_date == '') {
    $today = date('Y-m-d');
    $filter = ' and costdate >= "' . $today . '" and costdate <= "' . $today . '"';
}

Cost Center Filter

// Always include cost center filter
$filter .= ' and costcenterid = "' . $costCenterId . '"';

---

🔒 Security & Permissions

Input Validation

$costCenterId = filter_input(INPUT_POST, 'costCenterId');
$start_date = filter_input(INPUT_POST, 'start_date');
$end_date = filter_input(INPUT_POST, 'end_date');
$details = filter_input(INPUT_POST, 'detail');

SQL Injection Prevention

• • Uses proper input filtering
• • Parameterized query building
• • Date format validation

Access Control

• • Session-based user authentication required
• • Cost center access may be restricted by user permissions

---

🐛 Common Issues & Troubleshooting

1. No Data Returned

Issue: Report shows no results for valid cost center

Cause: Date range too restrictive or no activities recorded

Debug:

-- Check if cost center has any activities
SELECT COUNT(*) FROM costcenterdetail WHERE costcenterid = [ID];

-- Check date range
SELECT MIN(costdate), MAX(costdate) FROM costcenterdetail WHERE costcenterid = [ID];

2. Invalid Date Range

Issue: Query returns unexpected results

Cause: Date format issues or reversed date range

Debug:

echo "Start Date: " . $start_date . "<br>";
echo "End Date: " . $end_date . "<br>";
echo "Query: " . $costcenter . "<br>";

3. Missing Cost Center Data

Issue: Cost center not appearing in dropdown

Cause: Cost center marked as deleted or inactive

Debug:

SELECT id, name, condation FROM costcenter WHERE id = [ID];
-- condation: 0 = active, 1 = deleted

---

🧪 Testing Scenarios

Test Case 1: Basic Report Generation

1. Select active cost center
2. Leave date range empty (should default to today)
3. Generate report
4. Verify today's activities shown
5. Check query building logic

Test Case 2: Date Range Filtering

1. Select cost center with known activities
2. Set specific date range covering activities
3. Generate report
4. Verify only activities in range shown
5. Test edge cases (same start/end date)

Test Case 3: Edge Case Testing

1. Test with cost center having no activities
2. Test with invalid date ranges
3. Test with future date ranges
4. Verify appropriate handling of empty results

---

📊 Performance Considerations

Database Optimization Tips

1. Indexes Required:

- costcenterdetail(costcenterid, costdate) - For filtered queries

- costcenter(condation) - For active cost center selection

2. Query Optimization:

- Use date range indexes effectively

- Avoid unnecessary data retrieval

- Efficient WHERE clause construction

3. Memory Management:

- Limit result sets for large date ranges

- Process large datasets in chunks

- Clear template variables appropriately

Performance Monitoring

-- Check query performance
EXPLAIN SELECT * FROM costcenterdetail 
WHERE costcenterid = ? 
AND costdate >= ? 
AND costdate <= ?;

---

📚 Related Documentation

• • CLAUDE.md - PHP 8.2 migration guide
• • costcenterController.md - Cost center management
• • expensesController.php - Expense management
• • Database Schema Documentation - Table relationships

---

Documented By: AI Assistant

Review Status: ✅ Complete

Next Review: When major changes occur