Store Controller Documentation

File: /controllers/storeController.php

Purpose: Manages warehouse/store operations, inventory evaluation, and store configurations

Last Updated: December 19, 2024

Total Functions: 9

Lines of Code: 643

---

📋 Overview

The Store Controller is responsible for managing warehouse/store operations in the ERP system. It handles:

• • Creating and editing store/warehouse records
• • Managing store inventory evaluation
• • Store visibility and permissions
• • Inventory value calculations with different pricing methods
• • Store location and branch associations
• • Store operations (hide/show/delete)

Primary Functions

• ✅ Create new stores/warehouses
• ✅ Edit existing stores
• ✅ Delete stores (with validation)
• ✅ View store inventory with evaluation
• ✅ Hide/show stores (soft delete)
• ✅ Calculate store inventory values
• ✅ Batch operations on stores
• ✅ Store branch management
• ✅ Inventory pricing evaluation

Related Controllers

• • buyBillController.php - Purchase operations
• • sellbillController.php - Sales operations
• • productController.php - Product management
• • storedetailController.php - Store inventory details
• • storemovementController.php - Stock transfers between stores
• • storereportController.php - Store reports and valuations
• • branchController.php - Branch management

---

🗄️ Database Tables

Primary Tables (Direct Operations)

🔧 Key Functions

1. add() - Create New Store

Signature: add(): void

Purpose: Creates a new store/warehouse with accounting integration

Parameters: Gets data from $_POST array

Process Flow:

Key Logic:

• • Validates store name and details
• • Creates accounting tree elements (main + intermediate)
• • Sets creation date and user
• • Stores branch association
• • Creates API integration ID

SQL Operations:

INSERT INTO store (storeName, storeDescription, branchId, storeDate, userId, ...)
SELECT * FROM accountstree WHERE id = ?
UPDATE store SET treeId = ?, treeIdBetween = ? WHERE storeId = ?

2. show() - Display Store Inventory

Signature: show(): array

Purpose: Retrieves and calculates store inventory with evaluation pricing

Returns: Array of store data with calculated values

Process Flow:

Pricing Evaluation Methods:

• • first: First purchase price
• • last: Last purchase price
• • mean: Average purchase price
• • last_discount: Last price with discount
• • mean_discount: Average price with discount
• • generalPrice: Overall average price
• • tax: Last price with tax
• • mean_tax: Average price with tax

Key Logic:

foreach ($storeData as $story) {
    switch ($Programsettingdata->Inventoryevaluation) {
        case "first":
            $totQtyPrice = (float) $story->tot_productBuyPrice;
            break;
        case "last":
            $totQtyPrice = (float) $story->tot_lastbuyprice;
            break;
        // ... other methods
    }
    $story->totQtyPrice2 = $totQtyPrice;
}

3. delete($storeId) - Delete Store

Signature: delete($storeId): array

Purpose: Safely deletes a store after validation

Parameters:

• • $storeId (int): Store ID to delete

Returns: Array [message, status_code]

Process Flow:

Validation Logic:

• • Checks if store has products in storedetail table
• • Prevents deletion if dependencies exist
• • Removes accounting tree elements
• • Returns appropriate status code

4. edit() - Load Store for Editing

Signature: edit(): object

Purpose: Retrieves store data for editing form

Parameters: Gets storeId from $_GET

Returns: Store object with all properties

5. update() - Update Store

Signature: update(): void

Purpose: Updates existing store record with new data

Parameters: Gets data from $_POST array

Process Flow:

Key Logic:

• • Updates both main and intermediate tree element names
• • Preserves accounting integration
• • Updates modification user and date

6. executeOperation() - Batch Operations

Signature: executeOperation(): void

Purpose: Performs batch operations on selected stores

Parameters: Gets operation type and selected items from $_POST

Supported Operations:

1. Hide Stores (1): Soft delete multiple stores

2. Show Stores (2): Restore hidden stores

3. Delete Stores (3): Permanently delete stores

Process Flow:

7. tempdelete($storeId) - Hide Store

Signature: tempdelete($storeId): string

Purpose: Hides store (soft delete) by setting conditions = 1

Parameters:

• • $storeId (int): Store ID to hide

Returns: Success or error message

8. returndelete($storeId) - Restore Store

Signature: returndelete($storeId): string

Purpose: Restores hidden store by setting conditions = 0

Parameters:

• • $storeId (int): Store ID to restore

Returns: Success or error message

---

🔄 Workflows

Store Creation Workflow

Inventory Evaluation Workflow

Store Deletion Workflow

---

🌐 URL Routes & Actions

All main actions support CURL requests by setting $_POST['curlpost'] = 1:

• • Returns JSON responses instead of redirects
• • Includes status codes and messages
• • Arabic and English error messages

---

🐛 Known Issues & Fixes

1. Store Deletion Validation

Issue: Need to check for inventory before deletion

Fix: Validates storedetail records before allowing deletion

Code Fix:

$storedetailData = $myStoredetailRecord->queryByStoreid($storeId);
if (count($storedetailData) <= 0) {
    // Safe to delete
} else {
    // Cannot delete - has inventory
}

2. Inventory Evaluation Performance

Issue: Multiple pricing calculations can be slow

Fix: Use appropriate database indexes and optimize queries

3. Tree Element Cleanup

Issue: Orphaned tree elements when deletion fails

Fix: Proper transaction handling and rollback

Code Fix:

try {
    delTreeElementById($oldStore->treeId);
    delTreeElementById($oldStore->treeIdBetween);
    $myStoreRecord->delete($storeId);
} catch (Exception $e) {
    // Rollback tree deletions
}

---

🔒 Security & Permissions

Authentication Requirements

• • All operations require valid user session
• • Authentication checked via ../public/authentication.php
• • User ID tracked in all operations

Data Validation

• • Store name validation (required, not empty)
• • Store ID validation for operations
• • Branch ID validation against existing branches
• • User permission checks for store access

SQL Injection Prevention

• • Uses DAO pattern with prepared statements
• • Input sanitization for all user data
• • Parameter binding for all queries

---

🧪 Testing & Debugging

Test Cases

Store Creation

1. Valid Store Creation

- Input: Valid store name, description, branch

- Expected: Store created, tree elements added, success response

2. Duplicate Store Name

- Input: Existing store name

- Expected: Validation error, no database changes

3. Invalid Branch

- Input: Non-existent branch ID

- Expected: Foreign key constraint error

Store Deletion

1. Empty Store Deletion

- Input: Store with no inventory

- Expected: Store and tree elements deleted, success response

2. Store with Inventory

- Input: Store with existing storedetail records

- Expected: Deletion prevented, error message

3. Invalid Store ID

- Input: Non-existent store ID

- Expected: Error response, no database changes

Debugging Tips

1. Check Tree Integration:

SELECT * FROM accountstree WHERE id IN (SELECT treeId FROM store WHERE storeId = ?)

2. Verify Store Dependencies:

SELECT COUNT(*) FROM storedetail WHERE storeid = ?

3. Monitor Inventory Values:

SELECT * FROM store_evaluation_view WHERE storeId = ?

---

⚡ Performance Considerations

Query Optimization

• • Store List: Use pagination for large datasets
• • Inventory Evaluation: Consider caching calculated values
• • Tree Operations: Batch tree updates when possible

Indexing Recommendations

-- Store table indexes
CREATE INDEX idx_store_conditions ON store(conditions);
CREATE INDEX idx_store_branch ON store(branchId);
CREATE INDEX idx_store_user ON store(userId);

-- Store detail indexes
CREATE INDEX idx_storedetail_store ON storedetail(storeid);

Memory Management

• • Avoid loading all store data at once
• • Use streaming for large inventory reports
• • Implement proper result set pagination

Caching Strategy

• • Cache program settings for inventory evaluation
• • Store calculated inventory values temporarily
• • Use session caching for user store permissions

---

📚 Related Documentation

• • Product Controller - Product management
• • Buy Bill Controller - Purchase operations affecting store inventory
• • Sell Bill Controller - Sales operations affecting store inventory
• • Store Detail Controller - Detailed inventory operations
• • Branch Controller - Branch management for store assignments
• • Accounting Integration - Tree element management for stores

---

Last Updated: December 19, 2024

Version: 1.0

Maintainer: ERP Development Team