📚 ERP Documentation Viewer

Beautiful, colorful documentation for your ERP system

Restaurant Kitchen Printer Controller Documentation

File: /controllers/restaurantKitchenPrinter.php

Purpose: Manages kitchen printer interface for restaurant order printing and display

Last Updated: December 19, 2024

Total Functions: 0 (Display-only controller)

Lines of Code: 86

---

📋 Overview

The Restaurant Kitchen Printer Controller provides a specialized interface for kitchen printers and display systems. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Read Access)

Table NamePurposeKey Columns
**restaurantkitchenprint**Kitchen print jobsPrint queue and status tracking
**programsettings**System configurationKitchen display settings
### Reference Tables

Table NamePurposeRelationship
**user**System usersKitchen user tracking (optional)
**youtubelink**Entertainment linksKitchen display integration
### Archive Integration

FilePurposeUsage
**dbNames.txt**Database listDynamic database selection
Archive databasesHistorical dataKitchen access to past orders
### Table Structure Details

restaurantkitchenprint columns:

programsettings structure:

---

🔧 Key Functions

1. Default Action (Kitchen Home)

Purpose: Display kitchen printer home interface

Called By: Direct access (no do parameter)

Line: 52-69

Process Flow:

┌─ Set Database ────────┐
Read from archive
dbNames.txt file
Use latest DB name
└───────────────────────┘
▼
▼
┌─ Load Settings ───────┐
Get program settings
for kitchen display
└───────────────────────┘
▼
▼
┌─ Get Printer Param ───┐
Extract printer ID
from URL parameter
└───────────────────────┘
▼
▼
┌─ Display Interface ───┐
Show kitchen home
template
└───────────────────────┘

Code Example: 

// Read database names from archive
$databsesNames = file_get_contents("../views/default/archiveview/dbNames.txt");
$databsesNames = trim($databsesNames);
$databases = array_reverse(explode(",", $databsesNames));
$_SESSION['dbname'] = $databases[0];  // Use latest database

// Load program settings
$programsettingsdata = $ProgramsettingDAO->load(1);
$smarty->assign('programsettingsdata', $programsettingsdata);

// Get printer parameter
$printer = $_GET['printer'];
$smarty->assign('printer', $printer);

2. Success Handler

Purpose: Display success page for kitchen operations

Called By: ?do=sucess

Line: 70-73

3. Error Handler

Purpose: Display error page for kitchen operations

Called By: ?do=error

Line: 74-78

4. No-Login Configuration

Purpose: Configure template for machine access without authentication

Line: 18, 79

Configuration: 

$smarty->assign("itIsMachine_NoLogin", 1);  // Disable login requirements
$smarty->assign("restaurantKitchenPrinter", 1);  // Kitchen context flag

---

🔄 Business Logic Flow

Kitchen Printer Initialization

▼
▼
┌─────────────────┐ ┌──────────────────┐
Skip Login
itIsMachine=1
└─────────────────┘ └──────────────────┘
▼
┌─────────────────┐ ┌──────────────────┐
Load Settings
Program config
└─────────────────┘ └──────────────────┘
└────────┬─────────────────┘
▼
┌─────────────────────────────────┐
Display Kitchen Interface
- No authentication required
- Direct printer access
- Simplified UI for kitchen
└─────────────────────────────────┘

Database Archive Integration

▼
▼
┌─────────────────┐
Read Archive
Database List
└─────────────────┘
▼
▼
┌─────────────────┐
Array Reverse
Get Latest DB
└─────────────────┘
▼
▼
┌─────────────────┐
Set Session DB
Use Latest
└─────────────────┘
▼
▼
┌─────────────────┐
Kitchen Access
Current Data
└─────────────────┘

Printer-Specific Access

▼
▼
┌─────────────────┐
Extract Printer
Parameter
└─────────────────┘
▼
▼
┌─────────────────┐
Assign to
Template
└─────────────────┘
▼
▼
┌─────────────────┐
Kitchen Display
for Printer
└─────────────────┘

---

⚠️ Common Issues

1. Database Archive Access

Issue: Kitchen must access latest database automatically

Solution: dbNames.txt file maintains list of available databases

2. No Authentication Requirements

Issue: Kitchen machines need direct access without user login

Solution: itIsMachine_NoLogin flag bypasses authentication

3. Printer-Specific Configuration

Issue: Different kitchen printers may need different configurations

Solution: Printer parameter allows customization per device

4. Archive File Dependencies

Issue: Missing or corrupted dbNames.txt breaks kitchen access

Solution: File should be maintained by backup/archive systems

---

🔗 Dependencies

Required Files

DAO Classes

Model Classes

Templates

Special Configuration

Archive Files

---

Integration Notes:

↑