Report Documentation

Report Controller Documentation

File: /controllers/report.php

Purpose: Provides main reporting interface and navigation for comprehensive business reports

Last Updated: December 21, 2024

Total Functions: 2 (main actions)

Lines of Code: ~98

---

📋 Overview

The Report Controller serves as the central hub for the reporting system in the ERP application. It provides functionality for:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Referenced Tables (via included controllers)

Table NamePurposeUsage
**sellbill**Sales transactionsSales reports and analytics
**returnsellbill**Sales returnsReturn analysis
**sellbillandrutern**Combined transactionsComprehensive sales data
**client**Customer dataCustomer-based reporting
**user**System usersReport access control
**programsettings**System configurationReport settings
### Report-Specific Includes

The controller includes several specialized reporting modules:

---

🔑 Key Functions

1. Default Action - Main Report Interface

Location: Lines 83-88

Purpose: Display the primary reporting dashboard and navigation

Process Flow:

1. Display header template

2. Show main report interface

3. Display footer template with report flag

Template Structure: 

$smarty->display("report/show.html");

2. add - Report Main Dashboard

Location: Lines 90-94

Purpose: Display comprehensive reporting dashboard with authentication

Process Flow:

1. Check user authentication and permissions

2. Display header template

3. Show main reporting dashboard

4. Set offer client flag

5. Display footer template

Authentication Check: 

include_once("../public/authentication.php");

Dashboard Display: 

$smarty->display("report/showmain.html");
$smarty->assign("offerclient", 1);

---

🔄 Workflows

Workflow 1: Report Access and Navigation

┌─────────────────────────────────────────────────────────────┐
START: Access Reporting System
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
1User Authentication
- Verify user login status
- Check reporting permissions
- Validate user access level
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
2Display Report Dashboard
- Show available report categories
- Display user-specific report options
- Present report navigation menu
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
3Report Selection
User can choose from:
│
→ Customer Reports
│ │ └─ Debt analysis, payment history │
│
→ Sales Reports
│ │ └─ Sales analysis, product performance │
│
→ Inventory Reports
│ │ └─ Stock levels, movement history │
│
→ Financial Reports
│ │ └─ Income, expenses, profitability │
│
│ └─→ Custom Reports │
│ └─ User-defined report criteria │
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
4Report Generation
- Redirect to specialized report controller
- Process report parameters
- Generate and display report results
└─────────────────────────────────────────────────────────────┘

---

🌐 URL Routes & Actions

URL ParameterFunction CalledDescription
`do=` (empty)Default actionDisplay main report interface
`do=add`Add/MainDisplay authenticated reporting dashboard
### Navigation Structure

The report controller serves as a navigation hub that redirects to specialized controllers:

Customer Reports:

Sales Reports:

Inventory Reports:

Financial Reports:

---

🧮 Calculation Methods

Report Coordination

The controller acts primarily as a navigation interface and relies on included specialized controllers for actual calculations: 

// Core reporting functions included
include("reportfunctions.php");

// Specialized DAOs for data access
require_once('../models/dao/SellbillDAO.class.php');
require_once('../models/dto/Sellbill.class.php');
// ... additional DAO includes

Template Variables 

// Flag for report context
$smarty->assign("offerclient", 1);

// Report-specific variables set by individual functions
// (handled by specialized controllers)

---

🔒 Security & Permissions

Authentication Requirements 

// Authentication required for main dashboard
include_once("../public/authentication.php");

Access Control

Permission Levels

Individual reports may have different permission requirements:

---

📊 Performance Considerations

Lightweight Controller

Template Management

Resource Usage

---

🐛 Common Issues & Troubleshooting

1. Report Navigation Issues

Issue: Reports not accessible or throwing errors

Cause: Authentication or permission problems

Debug: 

// Check session status
if (!isset($_SESSION['userid'])) {
    echo "User not logged in";
}

// Verify user permissions
$userData = R::load('user', $_SESSION['userid']);
echo "User permissions: " . print_r($userData->permissions, true);

2. Template Not Found

Issue: Report templates not displaying

Cause: Missing template files or incorrect paths

Debug: 

// Check template existence
$template_path = "report/show.html";
if (!file_exists($smarty->template_dir . "/" . $template_path)) {
    echo "Template not found: " . $template_path;
}

3. Include File Errors

Issue: Required files not found

Cause: Missing or moved dependency files

Debug: 

// Verify include files exist
$required_files = [
    "../public/impOpreation.php",
    "../public/include_dao.php",
    "reportfunctions.php"
];

foreach ($required_files as $file) {
    if (!file_exists($file)) {
        echo "Missing required file: " . $file . "\n";
    }
}

---

🧪 Testing Scenarios

Test Case 1: Basic Navigation 

1. Access report controller without parameters
2. Verify main interface displays
3. Check navigation elements present
4. Test links to specialized reports

Test Case 2: Authenticated Dashboard 

1. Login with valid user credentials
2. Access report controller with do=add
3. Verify dashboard displays correctly
4. Check user-specific report options
5. Test permission-based access

Test Case 3: Report Integration 

1. Navigate to customer reports
2. Verify redirect to clientReportsController
3. Test parameter passing between controllers
4. Check report generation functions

Test Case 4: Permission Testing 

1. Test with different user permission levels
2. Verify appropriate reports are accessible
3. Check restricted report access
4. Test admin vs regular user access

---

📚 Related Documentation

---

🔧 Configuration & Setup

Required Files 

/controllers/report.php               - Main controller
/controllers/reportfunctions.php      - Core report functions
/views/report/show.html              - Main interface template
/views/report/showmain.html          - Dashboard template
/models/dao/                         - Data access objects
/models/dto/                         - Data transfer objects

Template Variables 

// Available in report templates
$smarty->assign("offerclient", 1);    // Client report flag

// User session variables
$_SESSION['userid']                   // Current user ID
$_SESSION['user_permissions']         // User permission level

Include Dependencies

The controller includes multiple specialized reporting components:

---

📈 Future Enhancements

Potential Improvements

1. Report Scheduling: Add automated report generation

2. Export Options: PDF, Excel, CSV export capabilities

3. Report Caching: Cache frequently accessed reports

4. Custom Reports: User-defined report builder

5. Dashboard Widgets: Interactive report summaries

6. Mobile Interface: Responsive report viewing

7. Real-time Reports: Live data updates

8. Report Sharing: User collaboration features

Architecture Considerations

---

Documented By: AI Assistant

Review Status: ✅ Complete

Next Review: When reporting features are expanded