TypeClient Documentation

Type Client Controller Documentation

File: /controllers/typeClientController.php

Purpose: Manages client types/categories, classifications, and related business information

Last Updated: December 20, 2024

Total Functions: 8

Lines of Code: 313

---

📋 Overview

The Type Client Controller manages client type/category classification in the ERP system. It handles:

Primary Functions

Related Controllers

---

🗄️ Database Tables

Primary Tables (Direct Operations)

Table NamePurposeKey Columns
**typeclient**Client type master datatypeId, typeName, typeDate, conditions, comments, webApiId, nameCompanyClaimsOfficer, mobile, email, taxRegistration, address, obgyTypeId
### Related Tables

Table NamePurposeRelationship
**client**Client master dataclient.clienttypeid → typeclient.typeId
**sellbill**Sales billssellbill.sellbilltypeclientid → typeclient.typeId
**programsettings**System configurationGlobal settings lookup
**youtubelink**Help video linksGeneral help system
### Reference Tables

Table NamePurposeRelationship
**user**System usersCreated/modified by tracking
**webapi**External API integrationtypeclient.webApiId → webapi.id
---

🔧 Key Functions

1. add() - Create New Client Type

Location: Line 198

Purpose: Creates a new client type/category with all business details

Function Signature: 

function add()

Parameters (via $_POST):

Process Flow:

┌─────────────────┐
Receive Form
Data via $_POST
└─────────┬───────┘
▼
┌─────────────────┐
Set Default
conditions = 0
└─────────┬───────┘
▼
┌─────────────────┐
└─────────┬───────┘
▼
┌─────────────────┐
Insert to DB
Return ID
└─────────────────┘

Code Example: 

$type->typeName = $_POST['typename'];
$type->conditions = 0; // Active by default
$type->typeDate = date("Y-m-d");
$type->comments = $_POST['comments'];
$type->webApiId = (int) $_POST['webApiId'];
$type->nameCompanyClaimsOfficer = $_POST['nameCompanyClaimsOfficer'];
// ... other fields
$id = $TypeClientDAO->insert($type);

---

2. show() - Display All Client Types

Location: Line 223

Purpose: Retrieves all client types for display

Function Signature: 

function show()

Return Value: Array of all client type records

Process Flow:

┌─────────────────┐
Call queryAll()
from DAO
└─────────┬───────┘
▼
┌─────────────────┐
Return Array
of All Types
└─────────────────┘

---

3. edit() - Load Client Type for Editing

Location: Line 231

Purpose: Load specific client type data for editing form

Function Signature: 

function edit()

Parameters:

Return Value: Client type object data

Process Flow:

┌─────────────────┐
Get ID from
$_GET['id']
└─────────┬───────┘
▼
┌─────────────────┐
Load Record
using DAO
└─────────┬───────┘
▼
┌─────────────────┐
Return Object
Data
└─────────────────┘

---

4. update() - Update Client Type

Location: Line 240

Purpose: Update existing client type with new information

Function Signature: 

function update()

Parameters (via $_POST):

Process Flow:

┌─────────────────┐
Receive Updated
Form Data
└─────────┬───────┘
▼
┌─────────────────┐
Populate Object
with New Data
└─────────┬───────┘
▼
┌─────────────────┐
Update Date to
Current Date
└─────────┬───────┘
▼
┌─────────────────┐
Call DAO update
Method
└─────────────────┘

---

5. delete() - Permanent Delete

Location: Line 267

Purpose: Permanently delete a client type from database

Function Signature: 

function delete()

Parameters:

Process Flow:

┌─────────────────┐
Get ID from URL
Parameter
└─────────┬───────┘
▼
┌─────────────────┐
Call DAO delete
Method
└─────────┬───────┘
▼
┌─────────────────┐
Record Removed
from Database
└─────────────────┘

⚠️ Warning: This is a hard delete. Check for dependencies before deletion.

---

6. tempdelete() - Soft Delete

Location: Line 274

Purpose: Temporarily hide client type (soft delete)

Function Signature: 

function tempdelete($clientid)

Parameters:

Return Value: Status message ("success" or error message)

Process Flow:

┌─────────────────┐
Get Client ID
└─────────┬───────┘
▼
┌─────────────────┐
Validate ID
not empty
└─────────┬───────┘
▼
┌─────────────────┐ ┌─────────────────┐
Call Extended
DAO deletetemp()│
└─────────┬───────┘ └─────────────────┘
▼
┌─────────────────┐
Return Success
└─────────────────┘

---

7. returndelete() - Restore Deleted

Location: Line 294

Purpose: Restore temporarily deleted client type

Function Signature: 

function returndelete($clientid)

Parameters:

Return Value: Status message ("success" or error message)

Process Flow:

┌─────────────────┐
Get Client ID
└─────────┬───────┘
▼
┌─────────────────┐
Validate ID
not empty
└─────────┬───────┘
▼
┌─────────────────┐ ┌─────────────────┐
Call Extended
DAO returndelete│
└─────────┬───────┘ └─────────────────┘
▼
┌─────────────────┐
Return Success
└─────────────────┘

---

🔄 Business Logic Flow

Complete CRUD Workflow

┌─────────────────┐
Main Controller
Entry Point
└─────────┬───────┘
▼
┌──────────────────────────────────────────┐
Route by $do parameter
│
▼
│
│ │ │ │ │ │ └─── Soft Delete
│ │ │ │ │ └─────── Hard Delete
│ │ │ │ └─────────── Update Record
│ │ │ └───────────────── Load for Edit
│ │ └─────────────────────── Display All
│ └───────────────────────────── Create New
└─────────────────────────────────── Display Form

Error Handling Pattern

┌─────────────────┐
Try-Catch Block
Around Function
└─────────┬───────┘
▼
┌─────────────────┐ ┌─────────────────┐
Success Path
Return ID/
Redirect
└─────────────────┘ └─────────────────┘

---

⚠️ Common Issues

1. PHP 8.2 Compatibility

2. Foreign Key Constraints

3. Data Validation

4. Concurrency

---

🔗 Dependencies

Required Files

DAO Classes

Template Dependencies

External Integrations

---

🎯 Usage Examples

Creating a New Client Type 

// POST data for new retail client type
$_POST = [
    'typename' => 'Retail Customer',
    'comments' => 'Regular retail customers with standard pricing',
    'webApiId' => 1,
    'nameCompanyClaimsOfficer' => 'John Doe',
    'mobile' => '+1234567890',
    'email' => 'john@company.com',
    'taxRegistration' => 'TAX123456',
    'address' => '123 Business St, City',
    'obgyTypeId' => 0
];

// Controller call: ?do=add
// Result: New client type created, redirect to success

Querying Client Types in Other Controllers 

// Used in sellbillController.php
$allTypeClient = R::getAll('select typeId,typeName from typeclient where conditions=0');

// Used in claims system
$typeclients = R::getAll('SELECT * FROM typeclient WHERE typeId in (0,1,2,3)');

---

🔍 Business Rules

1. Default Status: New client types are created with conditions = 0 (active)

2. Date Tracking: typeDate is automatically set to current date on create/update

3. Soft Delete: Prefer temporary delete over permanent deletion for data integrity

4. WebAPI Integration: Support for external system integration via webApiId

5. Specialized Types: Support for obstetrics/gynecology specific classifications

6. Business Information: Comprehensive contact and tax information tracking

---

Performance Notes:

Security Notes: