Inventory by Barcode Controller Documentation

File: /controllers/inventorybybarcodeController.php

Purpose: Barcode-based inventory counting and management system

Last Updated: December 20, 2024

Total Functions: 4+

Lines of Code: ~254

---

📋 Overview

The Inventory by Barcode Controller provides a streamlined interface for inventory management using barcode scanning. It offers:

• • Multi-store barcode inventory processing
• • Products without inventory tracking
• • Simplified inventory entry workflow
• • Real-time inventory updates
• • Store-based inventory management
• • Progress tracking for inventory completion

Primary Functions

• ✅ Barcode-based inventory interface
• ✅ Multi-store inventory selection
• ✅ Real-time inventory processing
• ✅ Products without inventory reports
• ✅ Simplified quantity adjustment
• ✅ Store progress tracking

Related Controllers

• • inventoryController.php - Full inventory management
• • inventoryexpirationController.php - Product expiration tracking
• • storedetailController.php - Store quantity management

---

🗄️ Database Tables

Primary Tables (Direct Operations)

🔑 Key Functions

1. Default Action - Store Selection Interface

Location: Line 70

Purpose: Display store selection interface for barcode inventory

Process Flow:

1. Load YouTube tutorial links

2. Load program settings

3. Load available stores using getStores()

4. Display via invoicesearningsreportview/byparcode.html template

Template Variables:

• • Programsettingdata - System configuration
• • storesData - Available stores for selection
• • youtubes - Tutorial links

---

2. start Action - Initialize Barcode Inventory

Location: Line 88

Purpose: Start barcode inventory process for selected stores

Function Flow:

1. Process store selection from $_POST['storeId']

2. Handle "all stores" or specific store selection

3. Build query string for store filtering

4. Load selected stores data

5. Prepare JSON data for front-end processing

6. Display inventory interface

Store Selection Logic:

$choosenStores = filter_input(INPUT_POST, 'storeId', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY);
if (in_array("all", $choosenStores)) {
    $ids = 'all';
    $queryString = " where conditions = 0 order by storeId asc ";
} else {
    $ids = '';
    foreach ($choosenStores as $value) {
        $ids .= $value . ",";
    }
    $ids = rtrim($ids, ',');
    $queryString = " where conditions = 0 and storeId in($ids) order by storeId asc ";
}

Template Variables:

• • stores - Selected store objects
• • stores_json - JSON encoded stores for JavaScript
• • storesCount - Number of selected stores
• • ids - Store IDs string

---

3. doinventory Action - Process Barcode Inventory

Location: Line 107

Purpose: Process inventory adjustments from barcode scanning

Function Flow:

1. Call add() function to process adjustments

2. Handle success/error scenarios

3. Redirect back to barcode controller

4. Display completion message

Error Handling:

• • Try-catch wrapper for inventory processing
• • User-friendly error messages in Arabic
• • Automatic redirection to starting page

---

4. add() - Core Inventory Processing

Location: Line 194

Purpose: Process individual inventory items from barcode input

Function Signature:

function add()

Process Flow:

1. Get iteration count from $_POST['hidden_itr']

2. Get store ID from $_POST['ids']

3. For each inventory item:

- Extract new quantity ($_POST['pronum' . $i])

- Get product ID ($_POST['productid' . $i])

- Get store detail ID and old quantity

- Calculate quantity difference

- Update store quantities

- Generate store reports

Quantity Change Detection:

if ($oldQty > $newQty) {
    $status = "بالنقص";    // Decrease
    $actualQty = $oldQty - $newQty;
    $type = 1;
} else if ($oldQty < $newQty) {
    $status = "بالزيادة";   // Increase
    $actualQty = $newQty - $oldQty;
    $type = 0;
} else {
    $status = "لم يتغير";   // No change
    $actualQty = $newQty;
    $type = 0;
}

Store Report Generation:

$storeReport->processname = "تم إعادة جرد المنتج بالباركود بالقيمة الحالية " . $status;
$storeReport->productafter = $newQty;
$storeReport->productbefore = $oldQty;
$storeReport->productid = $productId;
$storeReport->productquantity = $actualQty;
$storeReport->storeid = $storeid;
$storeReport->tablename = "inventoryController.php";  // Links to main inventory

---

5. productwithoutInventory Action - Uninventoried Products Report

Location: Line 123

Purpose: Generate report of products that haven't been inventoried

Function Flow:

1. Load all stores for selection

2. Process search parameters (date range, stores)

3. Build complex query to find products without inventory records

4. Display products missing from inventory process

Search Parameters:

• • from/to - Date range for inventory records
• • storeId - Store filter (array or "all")

Query Logic:

$queryStringJoin = ' and storereport.tablename = "inventoryController.php" ';
$queryString = " where storereport.storereportid is NULL ";

$noInventory = $storeDetailExt->queryProductsNotInInventoryNoServiceFatma($queryStringJoin, $queryString);

Data Processing:

• • Groups products by product ID
• • Stores quantities per store in storeName array property
• • Creates comprehensive view of uninventoried items

---

6. getStores() - Store Loading Helper

Location: Line 187

Purpose: Load active stores for selection

Returns: Array of store objects with conditions = 0

---

🔄 Workflows

Workflow 1: Barcode Inventory Process

---

Workflow 2: Products Without Inventory Report

---

🌐 URL Routes & Actions

Start Inventory (do=start):

• • storeId[] - Array of store IDs or "all"

Process Inventory (do=doinventory):

• • hidden_itr - Number of items being processed
• • ids - Store ID being processed
• • pronum{N} - New quantity for item N
• • productid{N} - Product ID for item N
• • detailid{N}_{storeId} - Store detail ID
• • storeQty{N}_{storeId} - Previous quantity

Products Without Inventory (do=productwithoutInventory):

• • from/to - Date range (optional)
• • storeId[] - Store filter array (optional)

---

🧮 Calculation Methods

Quantity Adjustment Calculation

// Same logic as main inventory controller
if ($oldQty > $newQty) {
    $actualQty = $oldQty - $newQty;  // Shortage
    $type = 1;  // Decrease
} else if ($oldQty < $newQty) {
    $actualQty = $newQty - $oldQty;  // Overage
    $type = 0;  // Increase
}

Progress Tracking

• • Tracks number of stores processed
• • Counts products inventoried per store
• • Provides completion percentage

---

🔒 Security & Permissions

Authentication Required

• • All actions require valid session
• • User authentication via ../public/authentication.php

Input Validation

• • Store ID array validation and sanitization
• • Numeric quantity validation
• • Product existence verification

Data Protection

• • No daily entries generated (simplified process)
• • Links all reports to main inventory controller
• • Maintains audit trail through store reports

---

📊 Performance Considerations

Optimization Features

1. Simplified Processing: No daily entry generation for faster processing

2. Batch Operations: Processes multiple items in single transaction

3. JSON Data: Pre-loads store data for client-side processing

4. Minimal Queries: Efficient update patterns

Scalability

• • Suitable for high-volume barcode scanning
• • Handles multiple stores efficiently
• • Optimized for mobile devices

---

🐛 Common Issues & Troubleshooting

1. Store Selection Issues

Issue: "All stores" selection not working

Cause: Array processing of mixed values

Debug:

// Check POST data structure
var_dump($_POST['storeId']);

// Verify store filtering
$stores = $storeEX->queryAllQueryStringSimple($queryString);
echo count($stores) . " stores found";

2. Barcode Processing Errors

Issue: Product quantities not updating

Cause: Missing store detail records or invalid product IDs

Fix:

-- Check store detail existence
SELECT * FROM storedetail 
WHERE productid = [PRODUCTID] AND storeid = [STOREID];

-- Verify product exists
SELECT productId, productName FROM product WHERE productId = [PRODUCTID];

3. Progress Tracking Issues

Issue: Progress not updating correctly

Cause: JavaScript/AJAX communication problems

Debug:

• • Check browser console for JavaScript errors
• • Verify AJAX endpoints responding correctly
• • Test with simple products first

4. Products Without Inventory Query Performance

Issue: Report takes too long to generate

Cause: Complex LEFT JOIN on large datasets

Optimization:

-- Add indexes for better performance
CREATE INDEX idx_storereport_product_table ON storereport(productid, tablename);
CREATE INDEX idx_storedetail_product_store ON storedetail(productid, storeid);

---

🧪 Testing Scenarios

Test Case 1: Multi-Store Barcode Inventory

1. Select multiple stores for inventory
2. Start barcode inventory process
3. Scan products and enter quantities
4. Verify updates across selected stores
5. Check store reports generated correctly

Test Case 2: All Stores Inventory

1. Select "all stores" option
2. Verify all active stores included
3. Process inventory for multiple stores
4. Check data consistency across stores

Test Case 3: Products Without Inventory Report

1. Set date range for inventory records
2. Select specific stores
3. Generate uninventoried products report
4. Verify products with no inventory records shown
5. Check store-specific quantity display

Test Case 4: Error Handling

1. Enter invalid product ID
2. Try negative quantities
3. Test with missing store details
4. Verify error messages and recovery

---

📚 Related Documentation

• • CLAUDE.md - PHP 8.2 migration guide
• • inventoryController.md - Full inventory management
• • inventoryexpirationController.md - Expiration tracking
• • storedetailController.md - Store management

---

Documented By: AI Assistant

Review Status: ✅ Complete

Next Review: When major changes occur