📚 ERP Documentation Viewer

Beautiful, colorful documentation for your ERP system

Alternative Store Movement Controller Documentation

File: /controllers/otherstoremovementController.php

Purpose: Manages alternative inventory movements including transfers, adjustments, and special stock operations with comprehensive audit trails

Last Updated: December 20, 2024

Total Functions: 15+

Lines of Code: ~27,869 (Large and complex controller)

---

📋 Overview

The Alternative Store Movement Controller handles specialized inventory operations that don't fit into the standard sales/purchase workflows. This includes:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Movement Tables

Table NamePurposeKey Columns
**otherstoremovement**Alternative movement recordsotherstoremovementid, productid, quantity, movementtype, fromstoreid, tostoreid, userid, movementdate
**storemovement**Standard movement trackingstoremovementid, productid, fromstoreid, tostoreid, quantity, movementdate, conditions
**storereport**Movement audit reportsstorereportid, productid, storeid, quantity, reportdate, reporttype
### Inventory Core Tables

Table NamePurposeKey Columns
**storedetail**Product inventory by storestoredetailid, storeid, productid, productquantity, productBuyPrice, productSellPrice
**store**Store/warehouse masterstoreId, storeName, storeLocation, conditions
**product**Product master dataproductid, productname, productcode, productcategory
### Variation Tracking Tables

Table NamePurposeKey Columns
**sizecolorstoredetail**Size/color variant trackingsizecolorstoredetailid, storedetailid, size, color, quantity
**productserial**Serial number trackingproductserialid, productid, serialnumber, sold, storeid
### Supporting Tables

Table NamePurposeKey Columns
**buypriceshistorybook**Purchase price historybuypriceshistorybookid, productid, buyprice, quantity, buydate
**dailyentry**Accounting entriesdailyentryid, entryComment, entryDate
**usergroup**User permission groupsusergroupid, usergroupname, permissions
**programsettings**System configurationprogramsettingsid, settingkey, settingvalue
---

🔑 Key Functions

1. Default Action - Movement Form Display

Location: Line 189

Purpose: Display the movement creation form with store and product selections

Process Flow:

1. Check user permissions and authentication

2. Load store negative balance settings

3. Configure search parameters (single store vs multi-store)

4. Load product data based on user store access

5. Prepare form with necessary dropdown data

6. Display movement form template

Key Features:

---

2. add - Create New Movement

Location: Line [Multiple locations for different movement types]

Purpose: Process new inventory movement transactions

Movement Types Supported:

Process Flow:

1. Input Validation: Validate movement parameters and permissions

2. Inventory Checking: Verify source store has sufficient quantity

3. Transaction Processing:

- Update source store inventory (decrease)

- Update destination store inventory (increase)

- Handle size/color variants if applicable

- Process serial numbers for tracked products

4. Price History Updates: Update purchase price history

5. Movement Logging: Create detailed audit records

6. Accounting Integration: Generate daily entries

7. Report Generation: Update movement reports

---

3. show - Display Movement History

Location: Line [Various show functions]

Purpose: Display movement history with filtering and search capabilities

Filter Options:

Display Features:

---

4. edit - Modify Existing Movement

Location: Line [Edit functions]

Purpose: Allow modification of movement records (with restrictions)

Editable Fields:

Restrictions:

---

5. delete / tempdelete - Remove Movements

Location: Line [Delete functions]

Purpose: Reverse inventory movements with complete audit trail

Deletion Types:

Process Flow:

1. Validation: Check movement can be deleted

2. Inventory Reversal: Reverse all quantity changes

3. Accounting Reversal: Reverse daily entries

4. Audit Trail: Maintain deletion audit record

5. Status Update: Update movement status

---

6. Serial Number Management Functions

Location: Various locations throughout controller

Purpose: Handle serialized product tracking

Functions Include:

---

7. Size/Color Variant Functions

Location: Multiple locations

Purpose: Manage product variations with size and color attributes

Functions Include:

---

8. Price History Functions

Location: Price history management sections

Purpose: Maintain accurate purchase price tracking

Functions Include:

---

🔄 Workflows

Workflow 1: Store-to-Store Transfer

┌─────────────────────────────────────────────────────────────┐
START: Need to Transfer Inventory
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
1Select Transfer Parameters
- Source store (must have inventory)
- Destination store
- Product and quantity to transfer
- Reason for transfer
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
2Validate Transfer Feasibility
- Check source store has sufficient quantity
- Verify user has permission for both stores
- Validate product exists in source store
- Check negative inventory settings
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
3Process Inventory Updates
SOURCE STORE:
→ Reduce product quantity
→ Update size/color variants (if applicable)
│ └─→ Handle serial numbers (if tracked) │
DESTINATION STORE:
→ Increase product quantity
→ Create/update product record if needed
→ Transfer size/color variants
│ └─→ Update serial number locations │
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
4Update Price History
- Record buy price at destination store
- Update price history for transferred quantity
- Maintain weighted average calculations
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
5Create Movement Records
- Insert otherstoremovement record
- Create storereport entry
- Log detailed audit information
- Link to user and timestamp
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
6Generate Accounting Entries
IF accounting integration enabled:
→ Debit: Destination Store Inventory Account
│ └─→ Credit: Source Store Inventory Account │
Create daily entry with movement details
└─────────────────────────────────────────────────────────────┘

Workflow 2: Inventory Adjustment Process

┌─────────────────────────────────────────────────────────────┐
START: Stock Discrepancy Found
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
1Determine Adjustment Type
→ Physical Count Higher: Increase Adjustment
→ Physical Count Lower: Decrease Adjustment
→ Product Damaged: Write-off Adjustment
│ └─→ Data Correction: System Error Adjustment │
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
2Document Adjustment Reason
- Detailed explanation required
- Supporting documentation (photos, reports)
- Authorization level verification
- Adjustment amount and justification
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
3Process Quantity Adjustment
INCREASE ADJUSTMENT:
→ Add quantity to store inventory
→ Update size/color variants if applicable
│ └─→ Create "found" serial numbers if needed │
DECREASE ADJUSTMENT:
→ Reduce quantity from store inventory
→ Update/remove variants as needed
│ └─→ Mark serial numbers as "lost" or "damaged" │
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
4Update Financial Records
- Calculate adjustment value (quantity × average cost)
- Update inventory valuation
- Adjust price history records
- Update cost accounting
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
5Create Adjustment Entry
INCREASE: Dr: Inventory, Cr: Adjustment Income
DECREASE: Dr: Adjustment Expense, Cr: Inventory
Include detailed notes and authorization info
└────────────────────┬────────────────────────────────────────┘
▼
▼
┌─────────────────────────────────────────────────────────────┐
6Generate Audit Reports
- Adjustment summary report
- Before/after inventory levels
- Cost impact analysis
- Authorization trail documentation
└─────────────────────────────────────────────────────────────┘

---

🌐 URL Routes & Actions

URL ParameterFunction CalledDescription
`do=` (empty)DefaultDisplay movement form
`do=add``add()`Create new movement
`do=show``show()`Display movement history
`do=edit``edit()`Load movement for editing
`do=update``update()`Update movement record
`do=delete``delete()`Remove movement
`do=tempdelete``tempdelete()`Soft delete movement
`do=executeOperation`Batch operationsProcess multiple movements
### Required Parameters by Action

Add Movement (do=add):

Show Movements (do=show):

---

🔧 Technical Features

Concurrency Control

Data Validation

Audit Trail Features

Performance Optimizations

---

🔒 Security & Permissions

User Access Control 

// Store-based permission checking
if ($_SESSION['storeids'] == 0) {
    // User has access to all stores
} else {
    // Restrict to user's assigned stores only
    $allowedStores = explode(',', $_SESSION['storeids']);
}

Operation Permissions

Data Protection

---

📊 Performance Considerations

Query Optimization

1. Store Filtering: Index on (storeid, movementdate)

2. Product Filtering: Index on (productid, movementdate)

3. User Filtering: Index on (userid, movementdate)

4. Date Range Queries: Proper date indexing

Memory Management

Scalability Factors

Recommended Optimizations 

-- Key indexes for performance
CREATE INDEX idx_otherstoremovement_store_date ON otherstoremovement(fromstoreid, movementdate);
CREATE INDEX idx_otherstoremovement_product_date ON otherstoremovement(productid, movementdate);
CREATE INDEX idx_storedetail_store_product ON storedetail(storeid, productid);
CREATE INDEX idx_productserial_product ON productserial(productid, sold);

---

🐛 Common Issues & Troubleshooting

1. Negative Inventory Errors

Issue: System prevents movements that would create negative inventory

Cause: Insufficient quantity in source store

Solutions:

2. Serial Number Conflicts

Issue: Serial numbers show as duplicated or missing

Cause: Improper serial tracking during movements

Debug Steps: 

-- Check for duplicate serials
SELECT serialnumber, COUNT(*) 
FROM productserial 
GROUP BY serialnumber 
HAVING COUNT(*) > 1;

-- Verify serial ownership
SELECT ps.*, sd.storeid 
FROM productserial ps
JOIN storedetail sd ON ps.productid = sd.productid
WHERE ps.serialnumber = '[SERIAL]';

3. Price History Inconsistencies

Issue: Average costs appear incorrect after movements

Cause: Price history not properly updated during transfers

Verification: 

-- Check price history for product
SELECT * FROM buypriceshistorybook 
WHERE productid = [ID] 
ORDER BY buydate DESC;

-- Recalculate weighted average
SELECT 
    productid,
    SUM(quantity * buyprice) / SUM(quantity) as weighted_avg
FROM buypriceshistorybook 
WHERE productid = [ID]
GROUP BY productid;

4. Performance Issues with Large Datasets

Issue: Movement history queries take too long

Cause: Large movement history without proper indexing

Solutions:

---

🧪 Testing Scenarios

Test Case 1: Basic Store Transfer 

1. Create product in Store A with quantity 100
2. Transfer 50 units to Store B
3. Verify Store A quantity = 50
4. Verify Store B quantity = 50
5. Check movement audit record created
6. Confirm price history updated

Test Case 2: Serial Number Tracking 

1. Add serialized product with 5 units
2. Assign unique serial numbers to each unit
3. Transfer 2 units with serials to different store
4. Verify serials moved to correct store
5. Check remaining serials stay in original store

Test Case 3: Size/Color Variants 

1. Create product with size/color variants
2. Set different quantities per variant
3. Transfer specific variants to new store
4. Verify only selected variants moved
5. Check variant quantities accurate in both stores

Test Case 4: Inventory Adjustment 

1. Set initial product quantity to 100
2. Perform physical count showing 95
3. Create decrease adjustment for 5 units
4. Verify system quantity matches physical count
5. Check adjustment entry in accounting

---

📚 Related Documentation

---

Documented By: AI Assistant

Review Status: ✅ Complete

Next Review: When major changes occur

Note: This controller is exceptionally large and complex. This documentation covers the major functions and workflows, but additional detailed analysis may be needed for specific advanced features.

↑