Usergroup Documentation

User Group Controller Documentation

File: /controllers/usergroupController.php

Purpose: Manages user groups, roles, permissions, and access control policies

Last Updated: December 19, 2024

Total Functions: 12

Lines of Code: ~940

---

📋 Overview

The User Group Controller is the core component for managing user roles and permissions in the ERP system. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Direct Operations)

Table NamePurposeKey Columns
**usergroup**User roles/groupsusergroupid, usergroupname, usergroupdescription, level, conditions
**relusergroupproperties**Group permissionsrelusergrouppropertiesid, usergroupid, propertyid, propertyvalue, theorder
**properties**Permission definitionspropertyid, propertyname, propertyparent, propertytype
### Permission Control Fields in usergroup Table

Field CategoryPurposeKey Fields
**Business Permissions**Core operationsclientnegative, suplliernegative, storenegative, priceupdate
**Financial Control**Money operationsdirectDiscount, percentageDiscount, allowEditDelInBills
**Display Settings**UI customizationshowSellAllPrice, showSellHalfPrice, showBuyPrice, hidemenu
**Restaurant Features**POS operationsautoKitchenPrint, sendKitchen, hall, takeAway, delivery
**Security Settings**Access controlallowBillDelete, billDeletePassword, editUserPrivlage
**Report Access**Data visibilitynetprofit, showsIndexStatistics, downloadClientPhones
### Reference Tables

Table NamePurposeRelationship
**user**System usersusergroup.usergroupid → user.usergroupid
**properties**Permission catalogProperty-based permission system
---

🔧 Key Functions

1. add() - Create New User Group

Location: Line 248

Purpose: Create a new user group with complete permission set

Function Signature: 

function add()

Parameters (via $_POST):

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Validate Input
└─────────────────┘ └──────────────────┘ └─────────────────┘
▼
┌─────────────────┐ ┌──────────────────┐ │
Success Response│◀───│ Save Permissions
└─────────────────┘ └──────────────────┘
▼
┌──────────────────┐
Loop Through
Properties (1-N)
└──────────────────┘

2. show() - Display All User Groups

Location: Line 441

Purpose: Retrieve and display all user groups with ordering

Returns: Array of user group data ordered by name

3. edit() - Load User Group for Editing

Location: Line 561

Purpose: Load user group data and associated permissions

Parameters:

Returns: Array containing:

4. update() - Update User Group

Location: Line 580

Purpose: Update user group and permissions using dynamic query building

Key Features:

5. copyUserGroup() - Duplicate User Group

Location: Line 696

Purpose: Create a copy of existing user group with all permissions

Parameters:

Process Flow:

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
Load Source
Group & Props
└─────────────────┘ └──────────────────┘ └─────────────────┘
│
┌─────────▼───────┐ ┌──────────▼──────┐ ┌──────────▼──────┐
Reset Group ID
to NULL
└─────────────────┘ └─────────────────┘ └─────────────────┘

6. executeOperation() - Bulk Operations

Location: Line 449

Purpose: Perform bulk operations on multiple user groups

Operations:

7. tempdelete() - Soft Delete Group

Location: Line 485

Purpose: Temporarily disable user group (conditions = 1)

8. deleteFinaly() - Permanent Delete Group

Location: Line 528

Purpose: Permanently remove user group with validation

Validation: Checks if group has associated users before deletion

9. getUpdateQuery() - Dynamic Query Builder

Location: Line 723

Purpose: Build dynamic UPDATE SQL based on submitted form fields

Features:

---

🔄 Business Logic Flow

Permission Management Architecture

┌─────────────────┐
Properties
(Master List)
└─────────┬───────┘
▼
┌─────────▼───────┐ ┌──────────────────┐
User Group
Creation
└─────────────────┘ └──────────────────┘
┌─────────▼───────┐ │
Users Assigned
to Group
└─────────────────┘ │
┌─────────▼───────┐ │
Permission
Inheritance
└─────────────────┘

Restaurant/POS Permission System

┌─────────────────┐
Restaurant
Operations
└─────────┬───────┘
▼
┌───────────────────────┼───────────────────────┐
│
┌─────▼─────┐ ┌─────────▼────────┐ ┌─────▼─────┐
Kitchen
Printing
└───────────┘ │ Delivery) │ └───────────┘
└──────────────────┘

Financial Control Matrix

PermissionScopeImpact
`clientnegative`Customer debtAllow negative balances
`suplliernegative`Supplier debtAllow negative balances
`storenegative`InventoryAllow negative stock
`directDiscount`SalesDirect discount entry
`percentageDiscount`SalesPercentage-based discounts
`priceupdate`ProductsModify product prices
`allowEditDelInBills`BillsEdit/delete sales bills
`allowBillDelete`SecurityDelete bills (with password)
---

⚠️ Common Issues

Session Cache Management

Issue: Header cache needs clearing when permissions change 

// ✅ IMPLEMENTED: Line 685-686
$fh = fopen('../temp__cashedheader/cashedheader_' . $_SESSION['dbname'] . '_' . $_SESSION['userid'] . '.html', 'w');
fclose($fh);

User Group Dependencies

Issue: Cannot delete groups with associated users 

// ✅ VALIDATION: Line 541-542
$userValidation = $myUserRecord->queryByUsergroupid($userGroupId);
if (count($userValidation) <= 0) {
    // Safe to delete
}

Permission Property Synchronization

Issue: New properties don't appear in old groups 

// ✅ SOLUTION: Line 342 - Uses queryAllbillsettingsNotDeleted_f()
// Automatically includes new properties with default values

---

🔗 Dependencies

Required DAOs

Required Files

Permission Categories

1. Basic Access - Menu visibility, page access

2. Financial - Money operations, discounts, pricing

3. Inventory - Stock control, negative quantities

4. Restaurant - Kitchen, halls, service types

5. Security - Bill deletion, user management

6. Reporting - Statistics, exports, data access

7. UI Control - Price visibility, menu hiding

---

🚀 Performance Notes

The User Group Controller is the foundation of the ERP system's security model, providing fine-grained access control across all business operations.