Programsettings Documentation

Program Settings Controller Documentation

File: /controllers/programsettingsController.php

Purpose: Manages system-wide configuration, company settings, and global behavior

Last Updated: December 19, 2024

Total Functions: 5

Lines of Code: ~903

---

📋 Overview

The Program Settings Controller is the central component for managing system-wide configuration and global settings in the ERP system. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Direct Operations)

Table NamePurposeKey Columns
**programsettings**System configurationprogramsettingsid, companyname, address, phone, email, logo, timezone
**ebillsetting**E-invoice configurationid, eunitInTax, eTaxNum, eTaxNumBranch, eGovernorate, eCity
**transfersell**Transfer settingsSpecial business transfer settings
### Configuration Categories in programsettings Table

CategoryPurposeKey Fields
**Company Info**Business identitycompanyname, address, phone, email, website, logo
**Financial**Money settingscurrency, roundnumbers, vatValue, valueadded
**Product Settings**Item behaviorparcode, limitamount, measuringunit, updateproductprice
**UI Settings**Display optionssearchlimit, colortype, noOfDecimalPlaces
**Restaurant**POS featuresisRestaurent, isCafe, restaurantStoreId, takeAwayClient
**Printing**Output optionsprintingpapersize, saveprinting, deptprinting
**E-Invoice**Tax complianceebill, saudielectronicinvoice, vatvalueqr
**Integration**External systemsqrerp, webApiId, tamweenBakery
### Reference Tables

Table NamePurposeRelationship
**store**Warehousesprogramsettings.restaurantStoreId
**usergroup**User rolesUsed for pharmacy group settings
**productcat**Product categoriesUsed for medical categories
**expensestype**Expense typesUsed for dollar expense types
---

🔧 Key Functions

1. Default Display - Load Configuration Form

Location: Line 117

Purpose: Load and display the comprehensive system settings form

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Current
Settings
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
┌─────────▼───────┐ ┌──────────▼──────┐ ┌──────────▼──────┐
Assign Smarty
Variables
└─────────────────┘ └─────────────────┘ └─────────────────┘

2. update() - Update System Configuration

Location: Line 171

Purpose: Comprehensive update of all system settings with validation and processing

Function Signature: 

function update()

Key Parameters (via $_POST - over 200 settings):

Company Information:

System Behavior:

Product Settings:

Financial Configuration:

Restaurant/POS Settings:

E-Invoice Configuration:

3. affectTableStructureWithDecimalPlaces() - Database Schema Updates

Location: Line 847

Purpose: Modify database table structure based on decimal place settings

Parameters:

Process:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Calculate
New Precision
└─────────────────┘ └──────────────────┘ └─────────────────┘

Tables Modified:

4. CURL_IT() - External API Communication

Location: Line 863

Purpose: Send company data to external QR ERP system

5. addPreDigitsToNum() - Barcode Formatting

Location: Line 888

Purpose: Format numbers with leading zeros for barcode generation

---

🔄 Business Logic Flow

Settings Update Workflow

┌─────────────────┐
Form Submission
(200+ Fields)
└─────────┬───────┘
▼
┌─────────▼───────┐ ┌──────────────────┐
Validate Input
& Type Cast
└─────────────────┘ └──────────────────┘
┌─────────▼───────┐ ┌──────────▼──────┐
Array Processing│───▶│ Load Existing
(Comma-separated│
│ values) │ └─────────────────┘
└─────────────────┘ │
┌─────────▼───────┐ ┌──────────▼──────┐
Database Update
(Programsettings│
│ & Ebillsetting)│ └─────────────────┘
└─────────────────┘ │
┌─────────▼───────┐ ┌──────────▼──────┐
Cache
Invalidation
└─────────────────┘ └─────────────────┘

Restaurant Service Configuration

┌─────────────────┐
Restaurant
Settings
└─────────┬───────┘
▼
┌───────────────────────┼───────────────────────┐
│
┌─────▼─────┐ ┌─────────▼────────┐ ┌─────▼─────┐
Hall
Service
└───────────┘ └──────────────────┘ └───────────┘
│
┌─────▼─────┐ ┌─────────▼────────┐ ┌─────▼─────┐
Table
Management│
└───────────┘ └──────────────────┘ └───────────┘

---

⚠️ Common Issues

Image Upload Processing

Issue: Multiple image uploads with different resize requirements 

// ✅ IMPLEMENTED: Lines 428-444 - Different upload handlers
updateImages() // For logos (250x250)
updateImagesWithoutresiz() // For headers (original size)

Database Schema Changes

Issue: Decimal precision changes require table structure modifications 

// ✅ SOLUTION: Lines 844-861 - Dynamic ALTER TABLE queries
affectTableStructureWithDecimalPlaces($noOfDecimalPlacesBillTotal, $noOfDecimalPlaces);

Barcode Generation

Issue: Barcode digit changes require regenerating all product codes 

// ✅ IMPLEMENTED: Lines 788-810 - Barcode regeneration
if ($oldParcodeDigits != $parcodeDigits) {
    $availableParcodeEX->truncate();
    $availableParcodeEX->callGenerateParcodesSP($parcodeDigits);
}

Performance Considerations

---

🔗 Dependencies

Required DAOs

Required Files

External Dependencies

---

🚀 Performance Notes

The Program Settings Controller serves as the nerve center of the ERP system, controlling global behavior and ensuring consistent operation across all modules.