Check Report Controller Documentation

File: /controllers/checkReportController.php

Purpose: Maintenance module for managing product inspection status and repair reports

Last Updated: December 20, 2024

Total Functions: 3 (basic CRUD operations)

Lines of Code: ~98

---

📋 Overview

The Check Report Controller is a specialized maintenance management module that provides comprehensive tracking of products under inspection and repair. It handles:

• • Display of products currently under inspection
• • Product status tracking throughout repair stages
• • Problem identification and commenting system
• • Integration with maintenance workflow
• • Serial number-based product tracking
• • Supplier and history data correlation

Primary Functions

• ✅ Display products under inspection
• ✅ Track repair stage progression
• ✅ Show problem descriptions and comments
• ✅ Link product history and status
• ✅ Integrate with supplier information
• ✅ Provide maintenance overview

Related Controllers

• • MProducthistory - Product repair history
• • MComreceiptdetail - Commercial receipt details
• • Supplier - Supplier management
• • MCheck - Check/inspection records

---

🗄️ Database Tables

Primary Tables (Direct Operations)

🔑 Key Functions

1. Default Action (show) - Display Products Under Inspection

Location: Lines 53-90

Purpose: Main display function showing all products currently under inspection for the current branch

Function Signature:

// Triggered when: empty($do) OR $do == "all"
// Uses: $_SESSION['branchId'] for branch filtering

Process Flow:

1. Query all check records for current branch

2. For each product:

- Get latest status from product history

- Retrieve problem and comment data

- Combine all information for display

3. Load supplier data for reference

4. Set today's date

5. Display via maintenance template

Key Operations:

• • $mCheckEX->queryByBranchEX($_SESSION['branchId']) - Get branch products
• • $mProductHistoryEX->GetStatusOfSerialWithMaxDate($row->ourSerial) - Latest status
• • $MComreceiptDetailEX->getProblemAndcommentByOurserialEX($row->ourSerial) - Problem data

Template Variables:

• • $checkData - Main product inspection data
• • $suppliers - All supplier information
• • $today - Current date

---

2. Data Enhancement Process - Product Status Correlation

Location: Lines 56-69

Purpose: Enhance each product record with status, stage, and problem information

Process Flow:

foreach($checkData as $row) {
    // Get latest product history status
    $data = $mProductHistoryEX->GetStatusOfSerialWithMaxDate($row->ourSerial);
    $row->productHistoryStatus = $data->status;
    $row->stageFrom = $data->stageFrom;
    $row->m_stageTitle = $data->stageTitle;
    
    // Get problem and comment details
    $mydata = $MComreceiptDetailEX->getProblemAndcommentByOurserialEX($row->ourSerial);
    $row->problem = $mydata->problem;
    $row->comment = $mydata->comment;
}

Data Enhancement:

• • productHistoryStatus: Current repair status
• • stageFrom: Source stage of product
• • m_stageTitle: Current stage description
• • problem: Identified problem description
• • comment: Additional comments/notes

---

3. Template Assignment - Data Preparation for Display

Location: Lines 71-89

Purpose: Prepare all data for template rendering with maintenance headers

Template Setup:

$smarty->assign("checkData", $checkData);
$smarty->assign("suppliers", $suppliers);
$smarty->assign("today", $today);

// Maintenance module headers
$smarty->assign("title1", 'الصيانة');      // Maintenance
$smarty->assign("title2", 'إدارة الفحص');   // Inspection Management  
$smarty->assign("title3", 'عرض المنتجات تحت الفحص'); // Show Products Under Inspection

Footer Configuration:

• • $customValidation = 1 - Enable custom validation
• • $customCheckReport = 1 - Enable check report scripts
• • $GeneralSearch = 1 - Enable general search functionality

---

🔄 Workflows

Workflow 1: Product Inspection Display

---

🌐 URL Routes & Actions

• • $_SESSION['branchId'] - Current branch ID for filtering
• • $_SESSION['userid'] - User identification (implied)

---

🔍 Data Correlation Logic

Serial Number Tracking

The controller uses ourSerial as the primary key to correlate data across multiple tables:

// Primary product check record
$checkData = $mCheckEX->queryByBranchEX($_SESSION['branchId']);

// For each product, get related data by serial
foreach($checkData as $row) {
    // Latest repair status and stage
    $historyData = $mProductHistoryEX->GetStatusOfSerialWithMaxDate($row->ourSerial);
    
    // Problem description and comments
    $problemData = $MComreceiptDetailEX->getProblemAndcommentByOurserialEX($row->ourSerial);
}

Status Tracking Fields

• • status: Current repair/inspection status
• • stageFrom: Origin stage of the product
• • stageTitle: Human-readable stage description
• • problem: Identified problem description
• • comment: Additional technician comments

---

🧮 Business Logic

Branch-Based Filtering

All inspection data is filtered by the current user's branch:

$checkData = $mCheckEX->queryByBranchEX($_SESSION['branchId']);

Latest Status Determination

The system gets the most recent product history record for status determination:

$data = $mProductHistoryEX->GetStatusOfSerialWithMaxDate($row->ourSerial);

This ensures that only the current, most up-to-date status information is displayed.

---

🔒 Security & Permissions

Session-Based Access

• • Uses $_SESSION['branchId'] for branch-specific data access
• • Implicit user authentication through session management

Data Isolation

• • Branch-level data isolation prevents cross-branch data access
• • Each branch sees only their own inspection records

---

📊 Performance Considerations

Optimization Opportunities

1. N+1 Query Problem: The current implementation makes individual queries for each product's status and problems

2. Potential Solution: Implement batch queries or JOIN operations to reduce database calls

3. Index Requirements: Ensure indexes exist on:

- mcheck(branchId)

- mproducthistory(ourSerial, sysDate)

- mcomreceiptdetail(ourSerial)

Current Performance Impact

For each product under inspection, the system makes:

• • 1 query for product history status
• • 1 query for problem/comment data
• • Total: 2 × N queries (where N = number of products)

---

🐛 Common Issues & Troubleshooting

1. Missing Product Status

Issue: Product shows without status information

Cause: No records in mproducthistory table for the serial

Debug:

SELECT * FROM mproducthistory WHERE ourSerial = '[SERIAL]' ORDER BY sysDate DESC;

2. Empty Problem/Comment Data

Issue: Products show without problem descriptions

Cause: No corresponding records in mcomreceiptdetail

Debug:

SELECT * FROM mcomreceiptdetail WHERE ourSerial = '[SERIAL]';

3. Branch Filtering Issues

Issue: Wrong products displayed for branch

Cause: Incorrect $_SESSION['branchId'] or missing branch data

Fix:

// Verify session data
echo "Current Branch: " . $_SESSION['branchId'];

---

🧪 Testing Scenarios

Test Case 1: Basic Inspection Display

1. Login with branch-specific user
2. Navigate to check report controller
3. Verify products displayed are branch-specific
4. Check that status and problem data appear correctly

Test Case 2: Data Correlation Accuracy

1. Create test product with known serial
2. Add history and problem records
3. Verify all related data displays correctly
4. Check that latest status is shown

Test Case 3: Empty Data Handling

1. Test with products having no history
2. Test with products having no problems
3. Verify graceful handling of missing data
4. Check that display remains functional

---

📚 Related Documentation

• • CLAUDE.md - PHP 8.2 migration guide
• • Maintenance Module Documentation - Overall maintenance workflow
• • Product History Tracking - Repair stage management
• • Serial Number Management - Product identification system

---

Documented By: AI Assistant

Review Status: ✅ Complete

Next Review: When maintenance workflow changes occur