Generated from the current files by
tools/generate-api-documentation.php. Regenerate this file whenever API source, services, core classes, or configuration change.
This reference covers every PHP file and JSON configuration file under api/. For each PHP file it records its role, HTTP-method guards, includes, declared classes/functions, request fields detected in code, database tables referenced, and emitted events. Source comments and endpoint-specific guides add the business explanation where present.
api/routes.phpreadsroutefrom the query string, protects non-public routes withAuthMiddleware::check(), and loadsapi/<route>.php.- Endpoint files commonly load
auth_api.php, database connection code, and then useSecurity,SessionManager, andResponsehelpers. - Public endpoints are files under
api/<module>/v1/that do not begin with_.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: facilities.php Logged-in user's assigned facility profile. GET /api/admin/v1/facilities.php POST /api/admin/v1/facilities.php
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
function adminFacilityRequestfunction adminFacilityColumnsfunction adminFacilityColumnfunction adminFacilityJsonMasterfunction adminFacilityTypeNamefunction adminFacilityFindfunction adminFacilityDbExistsfunction adminFacilityNinExistsForOtherFacilityfunction adminFacilityValidateCoordinate
Request fields read from $request
fac_namefacility_namenin_noHealth_facilty_typefacility_typestate_iddivision_iddist_iddistrict_idblock_idlatitudelongitudeis_active
Database tables referenced
facilitiescolumnspreparefailed
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: users.php Logged-in facility user profile/password update. GET /api/admin/v1/users.php POST /api/admin/v1/users.php
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/Auth.php/../../core/Crypto.php
Declared classes and functions
function adminUsersRequestfunction adminUsersPasswordErrorsfunction adminUsersRowfunction adminUsersEncryptedProfilePayloadfunction adminUsersColumnExistsfunction adminUsersFind
Request fields read from $request
f_namem_namel_namemail_idmob_nopasswordconfirm_password
Database tables referenced
columnINFORMATION_SCHEMAs_useru_rolepreparefailed
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: action_plan.php Generate action plan from gap analysis.
Gap condition:
- score = 0
- score = 1
It returns:
- system suggested action_plan from framework JSON
- existing saved user action plan, if available
- achievability
- responsible person
- priority
- target date
- tracking status
Method: GET
URL: /api/assessment/v1/action_plan.php?assessment_id=1
Department-wise: /api/assessment/v1/action_plan.php?assessment_id=1&dept_id=25
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
gapframeworkassessment_masterfacilitiesassessment_departmentJSONassessment_responseassessment_action_planIFassessment_action_plan_library
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: action_plan_closure.php Update action plan closure status.
Rule: - If gap is closed: status = COMPLETED revised_score can be updated evidence is optional
- If gap is not closed: status = IN_PROGRESS or OPEN original score remains unchanged
Method: POST
Body: { "assessment_id": 1, "dept_id": 25, "checkpoint_id": 21070, "is_gap_closed": true, "revised_score": 2, "closure_remarks": "Training completed and equipment arranged", "closure_evidence_url": "" } POST /api/assessment/v1/action_plan_closure.php
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_iddept_idcheckpoint_idis_gap_closedrevised_scoreclosure_remarksclosure_evidence_url
Database tables referenced
actionassessment_masterassessment_departmentassessment_responseassessment_action_planpreparefailed
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: action_plan_save.php Save or update user action plan for gap checkpoint.
Method: POST
Body: { "assessment_id": 1, "dept_id": 25, "checkpoint_id": 21070, "system_action_plan": "Suggested plan from JSON", "user_action_plan": "User custom plan", "achievability": "ACHIEVABLE", "responsible_person": "Dr. Amit", "priority": "HIGH", "target_date": "2026-07-25", "status": "OPEN" }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_iddept_idcheckpoint_idsystem_action_planuser_action_planachievabilityresponsible_personprioritytarget_datestatus
Database tables referenced
userJSONassessment_masterassessment_departmentassessment_responseactionassessment_action_plansystem_action_planIFassessment_action_plan_library
Events dispatched
gap.action_plan.saved
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: action_plan_update.php Update existing action plan.
Method : POST
Body { "id":15, "user_action_plan":"Arrange training", "achievability":"ACHIEVABLE", "responsible_person":"Dr Kumar", "priority":"HIGH", "target_date":"2026-08-15", "status":"IN_PROGRESS" }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
iduser_action_planachievabilityprioritystatusresponsible_persontarget_date
Database tables referenced
existingassessment_action_plan
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: active_assessment.php Returns active assessment for logged-in user's facility.
Facility users receive their own active assessment. Assessor-led cycles are kept separate so they do not block the facility self-assessment flow. Method: GET
URL: /api/assessment/v1/active_assessment.php
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_master
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: assessor_info_get.php Get assessor / assessee information department-wise.
Method: GET
URL: /api/assessment/v1/assessor_info_get.php?assessment_id=1&dept_id=25
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/Crypto.php
Declared classes and functions
function currentAssessorContextfunction assessorInfoDepartmentStatusColumn
Request fields read from $request
None detected.
Database tables referenced
assessor_masterINFORMATION_SCHEMAassessment_masterassessment_department_statusassessment_assessor_info
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: assessor_info_save.php Save assessor / assessee information department-wise.
Rule:
- One assessor info per assessment + department.
- If already saved, return existing data and do not overwrite.
Method: POST
Body: { "assessment_id": 1, "dept_id": 25, "assessment_date": "2026-06-25", "assessment_type": "INTERNAL",
"assessor_name": "Dr. Manish", "assessor_designation": "Medical Officer", "assessor_mobile": "8294386969", "assessor_email": "manish@example.com",
"assessee_name": "Dr. Manish Kumar", "assessee_designation": "Department In-charge", "assessee_mobile": "9876543211", "assessee_email": "rManish_kumar@example.com",
"remarks": "Optional remarks" }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/AssessmentAccess.php/../../core/Crypto.php
Declared classes and functions
function assessorInfoEncryptedPayloadfunction currentAssessorContextfunction assessorInfoDepartmentStatusColumn
Request fields read from $request
assessment_iddept_idassessment_dateassessment_typeassessor_nameassessor_designationassessor_mobileassessor_emailassessee_nameassessee_designationassessee_mobileassessee_emailremarks
Database tables referenced
assessor_masterINFORMATION_SCHEMAassessment_masterassessment_department_statusitassessment_assessor_infofailed
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: cancel_assessment.php Cancels the ACTIVE assessment for the logged-in facility.
Method: POST
URL: /api/assessment/v1/cancel_assessment.php
Body: { "assessment_id": 1 }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/AssessmentAccess.php/../../core/ApiCache.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_id
Database tables referenced
assessment_master
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: complete-cycle.php Mark full assessment cycle as completed.
Rule: Cycle can be completed only when all active departments inside the cycle are completed.
URL: /api/assessment/v1/complete-cycle.php
Method: POST
Body: { "cycle_id": 1 }
Dependencies included
/../../core/Response.php/../../service/DynamicAssessmentService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
cycle_id
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: complete_department.php Complete department assessment.
Rule:
- Assessment must be ACTIVE.
- Department must be activated.
- Department must be IN_PROGRESS.
- Assessor information must be saved.
- At least one response must be saved.
Method: POST
Body: { "assessment_id": 1, "dept_id": 25, "force_complete": false }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/AssessmentAccess.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_iddept_idforce_complete
Database tables referenced
assessment_masterassessment_departmentassessment_assessor_infoassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: complete_assessment.php Complete full assessment.
Rule:
- Assessment must be ACTIVE.
- At least one department must be activated.
- All activated departments must be COMPLETED.
Method: POST
Body: { "assessment_id": 1 }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/AssessmentAccess.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_id
Database tables referenced
assessment_masterassessment_department
Events dispatched
assessment.completed
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: create_assessment.php Creates a new assessment for logged-in user's facility.
Rule:
- A facility can have one ACTIVE self-assessment. - Assessor-led assessments are separate and never block a facility from creating its own assessment. Method: POST
URL: /api/assessment/v1/create_assessment.php
Body: { "assessment_name": "Internal Assessment", "framework_code": "saqshi-nqas", "start_date": "2026-06-25", "end_date": "2026-07-25" }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/ApiCache.php
Declared classes and functions
function createAssessmentFrameworkLabelfunction createAssessmentFacilityNamefunction createAssessmentAutoName
Request fields read from $request
assessment_nameframework_codestart_dateend_date
Database tables referenced
creatingfacilitiesassessment_master
Events dispatched
assessment.created
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: Handles dashboard facility type id processing for this API workflow.
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
function dashboardFacilityTypeId
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: list.php Get department activation status list for facility + assessment period.
URL: /api/assessment/v1/department-status/list.php?fac_id=1&assessment_id=1
Dependencies included
/../../../core/Response.php/../../../service/DepartmentStatusService.php/../../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: save.php Save department activation/deactivation status for logged-in user's facility + assessment period.
Uses session:
- fac_id
- u_id
URL: /api/assessment/v1/department-status/save.php
Method: POST
Body bulk: { "assessment_id": 1, "departments": [ {"dept_id": 1, "is_active": 1}, {"dept_id": 2, "is_active": 0} ] }
Body single: { "assessment_id": 1, "dept_id": 1, "is_active": 1 }
Dependencies included
/../../../auth_api.php/../../../service/DepartmentStatusService.php/../../../assets/conn/db.php/../../../core/AssessmentAccess.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_idass_perioddepartmentsdept_idis_active
Database tables referenced
None detected.
Events dispatched
department.activation.saved
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: list.php List all framework departments for logged-in facility type and show activation status for current active assessment.
Method: GET
URL: /api/assessment/v1/department/list.php?framework=saqshi-nqas&assessment_id=1
Dependencies included
/../../../auth_api.php/../../../core/FrameworkEngine.php/../../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_masterfacilitiesframeworkDBassessment_department
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: save.php Activate departments for active assessment.
Rule:
- Department can be activated once.
- Once activated, it cannot be deactivated.
Method: POST
Body: { "assessment_id": 1, "departments": [ {"dept_id": 25}, {"dept_id": 26} ] }
Dependencies included
/../../../auth_api.php/../../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
assessment_iddepartments
Database tables referenced
assessment_mastertoassessment_departmentfailed
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: Read-only FHIR R4 projection of the logged-in facility's assessment summaries.
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
function fhirAssessmentDatefunction fhirAssessmentStatus
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: gap_analysis.php Generate gap analysis for assessment / department.
Gap means:
- Non Compliant score = 0
- Partially Compliant score = 1
Method: GET
URL: Full assessment: /api/assessment/v1/gap_analysis.php?assessment_id=1
Department: /api/assessment/v1/gap_analysis.php?assessment_id=1&dept_id=25
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentassessment_responseassessment_action_plan
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: get-cycle.php Fetch assessment cycle details with departments.
URL: /api/assessment/v1/get-cycle.php?cycle_id=1
Dependencies included
/../../core/Response.php/../../service/DynamicAssessmentService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: get_checkpoint.php Load one checkpoint at a time for department assessment.
Method: GET
URL: /api/assessment/v1/get_checkpoint.php ?assessment_id=1 &dept_id=25 &concern_id=4 &subtype_id=96 &checkpoint_id=0
checkpoint_id = 0 means first checkpoint.
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentassessment_assessor_infofacilitiesframeworkassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: list.php Lists all assessments for the logged-in user's facility.
Method: GET
URL: /api/assessment/v1/list.php
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/ApiCache.php/../../assets/conn/db.php
Declared classes and functions
function listFacilityTypeIdfunction listCheckpointMaxScorefunction listColumnExistsfunction listFrameworkTotalScore
Request fields read from $request
None detected.
Database tables referenced
INFORMATION_SCHEMAassessment_masterassessment_department_statusassessment_departmentassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: next_checkpoint.php Find next checkpoint for selected assessment department.
Method: GET
URL: /api/assessment/v1/next_checkpoint.php ?assessment_id=1 &dept_id=25 &concern_id=4 &subtype_id=96 &checkpoint_id=21070
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentfacilities
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: previous_checkpoint.php Find previous checkpoint for selected assessment department.
Method: GET
URL: /api/assessment/v1/previous_checkpoint.php ?assessment_id=1 &dept_id=25 &concern_id=4 &subtype_id=96 &checkpoint_id=21071
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentfacilities
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: progress.php Assessment progress summary.
Includes:
- Department progress
- Assessor info
- Original score
- Improved/revised score
- Gap closure summary
response assessment_id is the current assessment_id
Method: GET
URL: /api/assessment/v1/progress.php?assessment_id=1
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Crypto.php/../../assets/conn/db.php
Declared classes and functions
function progressFacilityTypeIdfunction progressCheckpointMaxScorefunction progressDepartmentBase
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentassessment_responseassessment_action_planassessment_assessor_info
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: resume.php Resume an assessment cycle.
URL: /api/assessment/v1/resume.php?cycle_id=1
Dependencies included
/../../core/Response.php/../../service/DynamicAssessmentService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: resume_department.php Resume department assessment.
It returns the checkpoint_id from where user should continue.
Logic:
- If current_checkpoint_id exists, resume from it.
- If not, return checkpoint_id = 0 so UI loads first checkpoint.
Method: GET
URL: /api/assessment/v1/resume_department.php?assessment_id=1&dept_id=25
Dependencies included
/../../auth_api.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
whereitassessment_masterassessment_departmentassessment_assessor_infoassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: save_response.php Save or update one checkpoint response.
New simplified flow:
- responses are stored by assessment_id in assessment_response
- response saved against assessment_id + dept_id + checkpoint_id
- current checkpoint is updated in assessment_department
Method: POST
Body: { "assessment_id": 1, "dept_id": 25, "checkpoint_id": 21070, "response_value": 2, "score": 2, "remarks": "", "evidence_url": "" }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/FrameworkEngine.php/../../service/ResponseTypeService.php/../../core/AssessmentAccess.php/../../core/ApiCache.php
Declared classes and functions
function responseDepartmentStatusAssessmentColumn
Request fields read from $request
assessment_iddept_idcheckpoint_idremarksevidence_url
Database tables referenced
oneINFORMATION_SCHEMAassessment_masterassessment_departmentassessment_assessor_infoframeworkresponseassessment_responseresponse_valuecurrentfailedassessment_department_status
Events dispatched
checklist.response.saved
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: score.php Calculate assessment score.
Supports:
- Full assessment score
- Department-wise score
Original score:
- assessment_response.score
Improved score:
- assessment_action_plan.revised_score if available
- otherwise original score
Simplified design:
- responses are stored by assessment_id in assessment_response
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../assets/conn/db.php
Declared classes and functions
function scoreFacilityTypeIdfunction scoreCheckpointMaxScorefunction scoreDepartmentBase
Request fields read from $request
None detected.
Database tables referenced
assessment_masterassessment_departmentcompletedassessment_responseassessment_action_plan
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: start.php Start / Create Dynamic Assessment Cycle
URL: /api/assessment/v1/start.php
Method: POST
Body: { "fac_id": 1, "ass_period": 1, "framework_code": "sample-framework", "instance_no": 1, "user_id": 1 }
Dependencies included
/../../auth_api.php/../../core/Response.php/../../service/DynamicAssessmentService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
fac_idass_periodframework_codeinstance_nouser_id
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: start_cycle.php Create or return existing assessment cycle for logged-in user's assigned facility.
Uses: $_SESSION['fac_id'] $_SESSION['u_id']
URL: /api/assessment/v1/start_cycle.php
Method: POST
Body: { "framework_code": "saqshi-nqas", "ass_period": 1, "instance_no": 1, "departments": [ {"dept_id": 1, "is_active": 1}, {"dept_id": 2, "is_active": 0} ] }
Dependencies included
/../../auth_api.php/../../core/Response.php/../../service/DynamicAssessmentService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
framework_codeass_periodinstance_nodepartments
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: start_department.php Start or resume department assessment.
New simplified flow:
assessment_master ↓ assessment_department ↓ assessment_assessor_info ↓ assessment_response
Method: POST
Body: { "assessment_id": 1, "dept_id": 25 }
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/AssessmentAccess.php/../../core/ApiCache.php
Declared classes and functions
function startDepartmentStatusAssessmentColumn
Request fields read from $request
assessment_iddept_id
Database tables referenced
INFORMATION_SCHEMAassessment_masterassessment_departmentassessment_department_statusassessment_assessor_infoassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
assessor.facility_mapped
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
assessor.saved
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/AssessorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
assessor.assessment_started
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: captcha.php Generates a small server-side math captcha for login. Method: GET URL: /api/auth/v1/captcha.php
Dependencies included
/../../public_api.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API auth/v1/csrf.php Purpose: csrf endpoint/support workflow.
Dependencies included
/../../public_api.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: login.php Secure login API for SaQshi.
Method: POST
URL: /api/auth/v1/login.php
Dependencies included
/../../public_api.php/../../core/Auth.php/../../core/Csrf.php/../../core/LoginCrypto.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
usernamepassword_enccaptcha
Database tables referenced
None detected.
Events dispatched
auth.login.startedauth.login.failedauth.login.auth_checkedauth.login.succeeded
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../public_api.php/../../core/LoginCrypto.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: logout.php Logout authenticated user.
Method: POST
URL: /api/auth/v1/logout.php
Dependencies included
/../../auth_api.php/../../core/Auth.php/../../core/Csrf.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: me.php Returns current logged-in user session details.
Method: GET
URL: /api/auth/v1/me.php
Dependencies included
/../../auth_api.php/../../core/Auth.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API auth/v1/validate.php Purpose: validate endpoint/support workflow.
Dependencies included
../../../service/AuthService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/current.php Purpose: current endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/dashboard.php Purpose: dashboard endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/history.php Purpose: history endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/list.php Purpose: list endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/renewal_status.php Purpose: renewal status endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/save.php Purpose: save endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
certification.updated
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/update.php Purpose: update endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
endpoint
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API certification/v1/validate.php Purpose: validate endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: SaQshi API chat/v1/clear.php Purpose: clear endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: SaQshi API chat/v1/history.php Purpose: history endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: SaQshi API chat/v1/send.php Purpose: send endpoint/support workflow.
Dependencies included
/_common.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../service/DeploymentConfigService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/../../auth_api.php/../../service/DeploymentConfigService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../public_api.php/../../service/DeploymentConfigService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: delete.php Delete an uploaded file owned by the local uploads folder.
Dependencies included
/../../auth_api.php
Declared classes and functions
None detected.
Request fields read from $request
urlfile_urlpath
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST - Source intent: upload.php Authenticated file upload endpoint. Used for: - assessment evidence - gap closure evidence - supporting documents
Dependencies included
/../../auth_api.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API framework/v1/assessment_methods.php Purpose: assessment methods endpoint/support workflow.
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Response.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: checkpoints.php Load checklist dynamically from nested SaQshi framework JSON.
Flow: Logged-in user facility → facility type → department → concern → subtype → assessment method → checkpoints
URL: /api/framework/v1/checkpoints.php ?framework=saqshi-nqas &assessment_id=1 &dept_id=1 &concern_id=1 &subtype_id=1 &assessment_method=SI
Dependencies included
/../../auth_api.php/../../core/Response.php/../../core/FrameworkEngine.php/../../service/DepartmentStatusService.php/../../service/ResponseTypeService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
nestedfacilitiesassessment_response
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: concerns.php Returns concerns for selected department based on logged-in user's assigned facility type.
Uses: $_SESSION['fac_id']
URL: /api/framework/v1/concerns.php?framework=saqshi-nqas&dept_id=1
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Response.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: departments.php Returns departments from framework JSON with runtime active/inactive status for a facility + assessment period.
URL: /api/framework/v1/departments.php?framework=sample-framework&facility_type=DH&fac_id=1&assessment_id=1
Dependencies included
/../../core/Response.php/../../core/FrameworkEngine.php/../../service/DepartmentStatusService.php/../../assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
framework
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: facility-types.php Load facility types from nested SaQshi JSON framework.
URL: /api/framework/v1/facility-types.php?framework=saqshi-nqas
Dependencies included
/../../core/Response.php/../../core/FrameworkEngine.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
nested
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API framework/v1/load.php Purpose: load endpoint/support workflow.
Dependencies included
/../../core/Response.php/../../core/FrameworkEngine.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: my_departments.php Returns departments applicable to logged-in user's facility.
Uses: $_SESSION['fac_id']
Files: api/config/masters/facilities.json api/config/frameworks/saqshi-nqas.json
URL: /api/framework/v1/my_departments.php?framework=saqshi-nqas
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: my_facility.php Returns logged-in user's assigned facility details from JSON master file.
Dependencies included
/../../auth_api.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
JSON
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: subtypes.php Returns subtypes/standards for selected department + concern based on logged-in user's assigned facility type.
Uses: $_SESSION['fac_id']
URL: /api/framework/v1/subtypes.php?framework=saqshi-nqas&dept_id=1&concern_id=1
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Response.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/DashboardService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/IndicatorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/IndicatorService.php/../../service/PerformanceService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/IndicatorService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/KPIService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/KPIService.php/../../service/PerformanceService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/KPIService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
performance.kpi.saved
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/OutcomeService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/OutcomeService.php/../../service/PerformanceService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/OutcomeService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
performance.outcome.saved
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/PerformanceService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: checkpoint_progress_report.php Download checkpoint progress report in checklist Excel format. Method: GET /api/reports/v1/checkpoint_progress_report.php?assessment_id=1
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Crypto.php/../../assets/conn/db.php
Declared classes and functions
function scorecardNormalizefunction scorecardDepartmentStatusColumnfunction scorecardFacilityfunction scorecardSharedStringsfunction scorecardCellTextfunction scorecardColumnIndexfunction scorecardSetCellfunction scorecardCreateRowfunction scorecardApplyStylefunction scorecardTemplateStylesfunction scorecardSetStyledCellfunction scorecardSetColumnWidthfunction scorecardRemoveMergesfunction scorecardAddMergefunction scorecardRemoveColumnsAfter
Request fields read from $request
None detected.
Database tables referenced
INFORMATION_SCHEMAassessment_masterassessment_department_statusassessment_responseassessment_cycle_responseassessment_action_planassessment_assessor_info
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET - Source intent: checkpoint_scorecard.php Download checkpoint score card in standard Excel format. Method: GET /api/reports/v1/checkpoint_scorecard.php?assessment_id=1
Dependencies included
/../../auth_api.php/../../core/FrameworkEngine.php/../../core/Crypto.php/../../assets/conn/db.php
Declared classes and functions
function scorecardNormalizefunction scorecardDepartmentStatusColumnfunction scorecardFacilityfunction scorecardSharedStringsfunction scorecardCellTextfunction scorecardColumnIndexfunction scorecardSetCellfunction scorecardCreateRowfunction scorecardApplyStylefunction scorecardTemplateStylesfunction scorecardSetStyledCell
Request fields read from $request
None detected.
Database tables referenced
INFORMATION_SCHEMAassessment_masterassessment_department_statusassessment_responseassessment_cycle_responseassessment_action_planassessment_assessor_info
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
POST
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
API
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
state.dashboard.viewed
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php/../../service/StateIndicatorAnalyticsService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php/../../service/StateReportService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard:
GET
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
workflow
Events dispatched
None detected.
- Role: HTTP endpoint
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/_bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Runtime dependency
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/core/Env.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Runtime dependency
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API assets/conn/session.php Purpose: session endpoint/support workflow.
Dependencies included
None detected.
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
s_user
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: auth_api.php Base file for APIs requiring authenticated session.
Dependencies included
/bootstrap.php/core/SessionManager.php/core/Csrf.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: bootstrap.php Global bootstrap for all SaQshi APIs. Loads security, session, response and common settings.
Dependencies included
/core/Security.php/core/Response.php/core/ErrorHandler.php/core/Env.php/core/SessionManager.php/core/Csrf.php/core/Event.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: First-deployment profile selector. Usage: php api/cli/configure-deployment-profile.php --profile=healthcare
Dependencies included
/service/DeploymentConfigService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
the
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Read-only deployment health check. Run: php api/cli/deployment-readiness.php [--json]
Dependencies included
/core/Env.php/assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/assets/conn/db.php/service/JobQueueService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API controllers/AssessmentController.php Purpose: reserved assessment controller extension point. Current assessment endpoints are implemented under api/assessment/v1. Add controller-level orchestration here only when shared assessment controller behavior is introduced.
Dependencies included
None detected.
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: public_api.php Base file for APIs that DO NOT require login.
Dependencies included
/bootstrap.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: API support file
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API routes.php Purpose: routes endpoint/support workflow.
Dependencies included
core/AuthMiddleware.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Internal endpoint helper
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles respond processing for this API workflow.
Dependencies included
/auth_api.php/assets/conn/db.php/service/CertificationService.php
Declared classes and functions
function respondfunction certificationPayloadfunction certificationFiltersfunction certificationHandle
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Internal endpoint helper
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles chat payload processing for this API workflow.
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../core/ErrorHandler.php/../../service/ChatAssistantService.php
Declared classes and functions
function chatPayloadfunction chatUserIdfunction chatFacilityIdfunction chatHandle
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Internal endpoint helper
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/../../auth_api.php/../../assets/conn/db.php/../../service/StateDashboardService.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Short-lived cache for read-heavy API payloads. It fails open when Redis is unavailable.
Dependencies included
None detected.
Declared classes and functions
class ApiCachefunction getfunction putfunction forgetfunction assessmentListTtlfunction clientfunction configfunction key
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Authorisation rules for facility access to assessment cycles.
Dependencies included
None detected.
Declared classes and functions
class AssessmentAccessfunction requireEditableByCurrentUser
Request fields read from $request
None detected.
Database tables referenced
assessment_master
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API core/AuditLogger.php Purpose: reserved audit logging extension point. Current event/audit behavior is handled through existing event and service flows. Add shared audit helpers here when a common audit logger is required.
Dependencies included
None detected.
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Auth.php Centralized authentication service for SaQshi.
Uses:
- s_user table
- u_role table
- login_attempts table
- SessionManager
login_attempts columns: id, username, ip_address, attempt_time, status
Dependencies included
/SessionManager.php/Crypto.php
Declared classes and functions
class Authfunction __constructfunction loginfunction logoutfunction mefunction findUserfunction findUserByIdfunction decryptUserProfileFieldsfunction passwordMustChangefunction columnExistsfunction passwordStatusfunction upgradePasswordHashfunction isLockedfunction recordAttemptfunction clearOldFailedAttemptsfunction loginAttemptTableExistsfunction limitAuditLockWaitfunction hashPasswordfunction successfunction error
Request fields read from $request
None detected.
Database tables referenced
s_useru_roleINFORMATION_SCHEMApreparelogin_attemptsexistswaiting
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides auth middleware behavior for SaQshi API workflows.
Dependencies included
None detected.
Declared classes and functions
class AuthMiddlewarefunction checkfunction role
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: ConfigLoader.php SaQshi Open Source Framework Loads JSON-based configuration files for frameworks, tenants, UI, dashboards, and reports.
Dependencies included
None detected.
Declared classes and functions
class ConfigLoaderfunction loadJsonfunction loadFrameworkfunction loadTenantfunction loadUifunction loadDashboardfunction loadReportfunction existsfunction listConfigsfunction setBasePathfunction sanitizeCode
Request fields read from $request
None detected.
Database tables referenced
a
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Crypto.php Small field encryption helper for sensitive profile data. Format: enc:v1:<base64(mode + nonce/iv + tag + ciphertext)>
Dependencies included
None detected.
Declared classes and functions
class Cryptofunction encryptfunction decryptfunction decryptFieldsfunction isEncryptedfunction needsEncryptionfunction keyfunction encryptFallbackfunction decryptFallbackPayloadfunction xorWithKeystream
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Csrf.php CSRF Protection for SaQshi APIs
Client must send: X-CSRF-TOKEN: token
OR csrf_token in POST/JSON body
Dependencies included
None detected.
Declared classes and functions
class Csrffunction generatefunction tokenfunction regeneratefunction validatefunction getTokenInfofunction extractRequestTokenfunction destroyfunction fail
Request fields read from $request
None detected.
Database tables referenced
sessionrequest
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/assets/conn/db.php
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles load processing for this API workflow.
Dependencies included
None detected.
Declared classes and functions
class Envfunction loadfunction get
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles register processing for this API workflow.
Dependencies included
None detected.
Declared classes and functions
class ErrorHandlerfunction registerfunction requestIdfunction friendlyMessagefunction logfunction handleExceptionfunction handleErrorfunction handleShutdownfunction sendFriendly
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: @var array<string, array<int, callable>>
Dependencies included
None detected.
Declared classes and functions
class Eventfunction listenfunction dispatchfunction traceRequestfunction defaultMetafunction redactfunction redactQueryStringfunction isSensitiveKeyfunction redactStringfunction safeSessionValuefunction writeLog
Request fields read from $request
None detected.
Database tables referenced
free
Events dispatched
event.name
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides framework engine behavior for SaQshi API workflows.
Dependencies included
/ConfigLoader.php
Declared classes and functions
class FrameworkEnginefunction __constructfunction loadfunction toArrayfunction getFacilityTypesfunction getFacilityTypeByIdfunction getDepartmentsfunction getDepartmentByIdfunction getConcernsfunction getConcernByIdfunction getSubtypesfunction getSubtypeByIdfunction getCheckpointsfunction getCheckpointByIdfunction calculateScorefunction calculateScoreForScopefunction resolveOptionScorefunction getMaxScorefunction validateFramework
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles openssl config path processing for this API workflow.
Dependencies included
None detected.
Declared classes and functions
class LoginCryptofunction opensslConfigPathfunction opensslErrorsfunction keyDirfunction privateKeyPathfunction publicKeyPathfunction publicKeyfunction decryptPasswordfunction ensureKeys
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Response.php SaQshi Standard JSON Response Handler
Dependencies included
None detected.
Declared classes and functions
class Responsefunction sendfunction successfunction createdfunction errorfunction validationfunction unauthorizedfunction forbiddenfunction notFoundfunction serverError
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API core/RoleMiddleware.php Purpose: reserved role middleware extension point. Current role checks are handled by bootstrap/session/service filters. Add reusable middleware here when API-wide role enforcement is centralized.
Dependencies included
None detected.
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi score calculation helper. Keep score math in a pure helper so reports, dashboards and tests can reuse the same calculation rules without loading endpoint/session/database code.
Dependencies included
None detected.
Declared classes and functions
class ScoreCalculatorfunction percentagefunction checkpointMaxScorefunction totalCheckpointScore
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Security.php Centralized security helper for SaQshi APIs.
Handles:
- Security headers
- JSON input parsing
- HTTP method enforcement
- Basic input sanitization helpers
- Secure error-safe response helpers
Dependencies included
None detected.
Declared classes and functions
class Securityfunction headersfunction requireMethodfunction requireAnyMethodfunction jsonInputfunction requireFieldsfunction cleanStringfunction intfunction boolfunction emailfunction tokenfunction hashEqualsfunction failfunction success
Request fields read from $request
None detected.
Database tables referenced
list
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SessionManager.php Centralized secure session management for SaQshi APIs.
Handles:
- Secure session start
- Login session creation
- Session timeout
- Session regeneration
- Logged-in user checks
- Common session getters
Dependencies included
None detected.
Declared classes and functions
class SessionManagerfunction startfunction configureStoragefunction sessionNamefunction configfunction loginfunction logoutfunction isLoggedInfunction requireLoginfunction userIdfunction usernamefunction roleIdfunction facilityIdfunction departmentIdfunction userfunction updateProfilefunction checkTimeoutfunction regeneratePeriodicallyfunction isSameClientfunction hashClientIpfunction hashUserAgentfunction jsonError
Request fields read from $request
None detected.
Database tables referenced
profile
Events dispatched
None detected.
- Role: Core infrastructure
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi API core/Validator.php Purpose: reserved validation extension point. Current validation is handled by endpoint-specific checks and validation services. Add shared validator helpers here when central validation is needed.
Dependencies included
None detected.
Declared classes and functions
None detected.
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Saves a selected group of facility mappings as one all-or-nothing action.
Dependencies included
/../core/Crypto.php/../core/Auth.php/../core/FrameworkEngine.php/DepartmentStatusService.php/EmailService.php/SmsService.php
Declared classes and functions
class AssessorServicefunction __constructfunction listAssessorsfunction saveAssessorfunction getAssessorfunction searchFacilitiesfunction listMappingsfunction saveMappingfunction saveMappingsfunction assessorDashboardfunction assessmentSummaryForFacilitiesfunction mappedFacilitiesForUserfunction assessmentReportRowsfunction facilitySummaryfunction startAssessmentfunction currentAssessorfunction createAssessorLoginUserfunction assessorRoleIdfunction temporaryPasswordfunction splitNamefunction mappedFacilitiesfunction withFacilityWorkflowfunction reconcileCompletedAssessmentfunction workflowForAssessmentfunction activeDepartmentsfunction assessorInfoCountfunction responseCountfunction responseTablefunction facilityAssessmentsfunction assessmentChecklistCountfunction facilityCqiSummaryfunction facilityPerformanceSummaryfunction moduleConfigfunction moduleEnabledfunction defaultFrameworkfunction activeAssessmentfunction frameworkDepartmentsfunction publicAssessorfunction facilityfunction usesJsonFacilitiesfunction jsonFacilitiesfunction facilityIdsMatchingfunction hydrateJsonFacilitiesfunction ensureTablesfunction ensureSchemaOncefunction ensureAssessmentColumnfunction ensureUserColumnfunction ensureUserColumnDefinitionfunction userColumnSupportsDefinitionfunction tableExistsfunction columnExistsfunction departmentStatusAssessmentColumnfunction tableColumnsfunction nullableIntfunction nullableDatefunction rowfunction rowsfunction scalarfunction execute
Request fields read from $request
None detected.
Database tables referenced
assessor_facility_mappingassessor_masters_userfacilitiesfac_ninassessment_masterstartingu_roleassessment_department_statusassessment_departmentassessment_assessor_infoassessment_action_planperformance_entriessearchIFCURRENT_TIMESTAMPINFORMATION_SCHEMA
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides auth service behavior for SaQshi API workflows.
Dependencies included
/../core/Crypto.php
Declared classes and functions
class AuthServicefunction loginfunction validatefunction logout
Request fields read from $request
None detected.
Database tables referenced
s_useru_role
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides certification expiry service behavior for SaQshi API workflows.
Dependencies included
None detected.
Declared classes and functions
class CertificationExpiryServicefunction calculateValidTofunction renewalStatusfunction normalizeStatusfunction validityYears
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides certification service behavior for SaQshi API workflows.
Dependencies included
/CertificationValidator.php/CertificationExpiryService.php
Declared classes and functions
class CertificationServicefunction configfunction ensureTablesfunction currentfunction listfunction savefunction updatefunction dashboardfunction historyfunction findByIdfunction rawByIdfunction presentfunction auditfunction ensureColumnfunction currentUserIdfunction sessionFacilityIdfunction withAssignedFacilityfunction facilityFromJson
Request fields read from $request
None detected.
Database tables referenced
IFCURRENT_TIMESTAMPcert_detailsprocessingpreparefailedcertification_historyjson
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides certification validator behavior for SaQshi API workflows.
Dependencies included
/CertificationExpiryService.php
Declared classes and functions
class CertificationValidatorfunction validatePayloadfunction isDate
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides chat assistant service behavior for SaQshi API workflows.
Dependencies included
/../core/SessionManager.php/ChatIntentService.php/ChatKnowledgeService.php/ChatDataService.php
Declared classes and functions
class ChatAssistantServicefunction ensureTablefunction sendfunction historyfunction clearfunction saveMessagefunction ensureColumn
Request fields read from $request
None detected.
Database tables referenced
processingIFai_chat_messages
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
/../core/SessionManager.php/StateDashboardService.php/AssessorService.php
Declared classes and functions
class ChatDataServicefunction answerfunction currentMonthStatusfunction pendingCqiStatusfunction facilityReportfunction formatFacilityDetailfunction findScopedMonitoringFacilityfunction findAssignedAssessorFacilityfunction monitoringFiltersfunction flattenHierarchyfunction matchFacilityfunction dash
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
None detected.
Declared classes and functions
class ChatIntentServicefunction matchfunction roleKeyfunction intentsfunction roleAllowedfunction normalize
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
None detected.
Declared classes and functions
class ChatKnowledgeServicefunction answerfunction answersfunction formatAnswer
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: DashboardService.php Performance dashboard service facade.
Dependencies included
/PerformanceService.php
Declared classes and functions
class DashboardServicefunction dashboardfunction summary
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: DepartmentStatusService.php Runtime department activation/deactivation service for facility + assessment period.
Dependencies included
None detected.
Declared classes and functions
class DepartmentStatusServicefunction __constructfunction saveStatusfunction saveBulkStatusfunction getStatusListfunction isDepartmentActivefunction assessmentColumnfunction columnExistsfunction successfunction errorfunction isSensitiveError
Request fields read from $request
None detected.
Database tables referenced
departmentassessment_department_statusis_activeINFORMATION_SCHEMA
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
None detected.
Declared classes and functions
class DeploymentConfigServicefunction currentfunction applyProfilefunction profilesfunction normalizeModulesfunction readJsonfunction writeJsonfunction defaultDomainfunction defaultModules
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: DynamicAssessmentService.php SaQshi Configurable Assessment Engine
Hierarchy: Facility + Period + Framework + Instance = Assessment Cycle One Cycle can have multiple Departments One Department can have multiple Checklist Responses
Dependencies included
/../core/FrameworkEngine.php
Declared classes and functions
class DynamicAssessmentServicefunction __constructfunction createCyclefunction addDepartmentsfunction saveResponsefunction getCyclefunction getResponsesfunction completeDepartmentfunction completeCyclefunction calculateCycleScorefunction calculateCheckpointScorefunction isDepartmentActivefunction markDepartmentInProgressfunction markCycleInProgressfunction getCycleIdfunction successfunction errorfunction isSensitiveError
Request fields read from $request
None detected.
Database tables referenced
assessment_cycleupdated_onassessment_cycle_departmentis_activeassessment_cycle_responseresponse_value
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
None detected.
Declared classes and functions
class EmailServicefunction __constructfunction sendfunction sendTemplatefunction loadConfigfunction logfunction sendHttpfunction headersfunction httpRequestfunction renderArrayfunction render
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: FormulaEngine.php Formula helper for Performance Monitoring.
Dependencies included
None detected.
Declared classes and functions
class FormulaEnginefunction configPathfunction formulasfunction findFormulafunction calculate
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: IndicatorService.php Generic KPI / Outcome indicator service per v3 design.
Dependencies included
/KPIService.php/OutcomeService.php/ValidationService.php
Declared classes and functions
class IndicatorServicefunction configPathfunction listfunction savefunction history
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Durable MySQL-backed queue. Workers claim one job at a time and can be run by Task Scheduler or a process manager.
Dependencies included
None detected.
Declared classes and functions
class JobQueueServicefunction __constructfunction enqueuefunction claimfunction completefunction fail
Request fields read from $request
None detected.
Database tables referenced
background_jobs
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: KPIService.php KPI list, save and history service.
Dependencies included
/PerformanceService.php
Declared classes and functions
class KPIServicefunction configPathfunction listfunction savefunction historyfunction saveEntryfunction entryHistory
Request fields read from $request
None detected.
Database tables referenced
performance_entriesindicator_code
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: OutcomeService.php Outcome list, save and history service.
Dependencies included
/KPIService.php
Declared classes and functions
class OutcomeServicefunction configPathfunction listfunction savefunction history
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: PerformanceService.php Shared helpers for Performance Monitoring.
Dependencies included
/FormulaEngine.php
Declared classes and functions
class PerformanceServicefunction tableNamefunction ensureTablefunction readJsonfunction rulesConfigfunction facilityTypeRulefunction assertIndicatorAllowedfunction configuredIndicatorCountfunction effectivePerformanceTypefunction facilityMetafunction departmentNamesfunction departmentNamefunction activeAssessmentfunction latestActiveAssessmentPeriodIdfunction activeDepartmentIdsfunction departmentStatusAssessmentColumnfunction filterByDepartmentIdsfunction flattenIndicatorsfunction normalizeIndicatorfunction dashboardfunction summaryfunction monthlyStatusfunction trendfunction indicatorTrends
Request fields read from $request
None detected.
Database tables referenced
nameprocessingIFCURRENT_TIMESTAMPassessment_masterassessment_department_statusINFORMATION_SCHEMAperformance_entries
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: SaQshi configurable checkpoint response handler. This keeps the checklist engine domain-neutral. Healthcare can keep the default 0/1/2 scoring, while education or other domains can use yes/no, dropdown, number, text or multi-field responses from framework JSON.
Dependencies included
None detected.
Declared classes and functions
class ResponseTypeServicefunction ensureSchemafunction evaluatefunction replaceFieldIndexfunction ensureColumnfunction normalizeDefinitionfunction payloadfunction optionsfunction matchOptionfunction maxOptionScorefunction formFieldsfunction summaryValuefunction field
Request fields read from $request
response_valueresponse_json
Database tables referenced
frameworkIFCURRENT_TIMESTAMPassessment_response_field_indexINFORMATION_SCHEMA
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
Dependencies included
None detected.
Declared classes and functions
class SmsServicefunction __constructfunction sendfunction sendTemplatefunction loadConfigfunction logfunction sendHttpfunction headersfunction httpRequestfunction renderArrayfunction render
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state assessment service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateAssessmentService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state certification service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateCertificationService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state cqiservice behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateCQIService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state dashboard service behavior for SaQshi API workflows.
Dependencies included
/CertificationService.php/CertificationExpiryService.php/PerformanceService.php/../core/FrameworkEngine.php
Declared classes and functions
class StateDashboardServicefunction requireStateRolefunction applyMonitoringScopefunction monitoringScopeForUserfunction dashboardfunction safeSectionfunction facilityCategoryfunction facilityTypeLabelfunction facilityTypeMapfunction certificationSummaryfunction certificationRowMatchesfunction certificationMapfunction updateCertificationStatusfunction assessmentProgressfunction assessmentDepartmentProgressfunction assessmentResponseProgressfunction assessmentActionPlanProgressfunction assessmentScoreBasefunction checkpointMaxScorefunction cqiSummaryfunction performanceSummaryfunction performanceDetailsForFacilitiesfunction performanceLatestSubmittedCountfunction facilityDetailfunction facilityHierarchyfunction facilityAssessmentSummaryfunction facilityPerformanceSummaryfunction facilityCqiSummaryfunction resolveFacilityIdfunction usersfunction updateUserStatusfunction attentionfunction currentMonthStatusfunction latestAssessmentAttentionfunction normalizeFiltersfunction paginationfunction paginationMetafunction facilitiesFromJsonfunction filteredFacilitiesfunction facilitiesByIdfunction facilityCoordinatesFromDbfunction mapBoundaryfunction mapConfigfunction mapMasterConfigfunction selectedMapStatefunction mapKeyfunction mapSourcePathfunction topologyToFeatureCollectionfunction topologyGeometriesfunction topologyGeometryfunction topologyLinefunction topologyArcfunction normalizeNinfunction dateOrEmptyfunction decodeJsonObjectfunction certStatusFromPayloadfunction normalizeCertStatusfunction latestCertificationHistoryfunction facilityWherefunction certWherefunction assessmentWherefunction actionPlanWherefunction performanceWherefunction tableExistsfunction columnExistsfunction departmentStatusAssessmentColumnfunction facilityTypeIdColumnfunction certFacilityColumnfunction scalarfunction onefunction rowsfunction percent
Request fields read from $request
None detected.
Database tables referenced
certification_historycertificationfailedassessment_masterassessment_department_statusassessment_departmentassessment_action_planfacilitiesperformance_entriess_useru_roleuserispreparejsondbpayloadexistsINFORMATION_SCHEMA
Events dispatched
state.certification.status_updatedstate.user.status_updated
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state facility category service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateFacilityCategoryService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state facility drilldown service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateFacilityDrilldownService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Handles analytics processing for this API workflow.
Dependencies included
None detected.
Declared classes and functions
class StateIndicatorAnalyticsServicefunction analyticsfunction streamZeroFacilityListfunction assessmentWeakIndicatorsfunction performanceWeakIndicatorsfunction weaknessLabelfunction facilityTypeNamefunction csvRowfunction responseTablefunction checkpointMapfunction performanceIndicatorMapfunction collectPerformanceIndicatorsfunction facilityWherefunction paginationfunction paginationMetafunction rowsfunction onefunction preparefunction tableExistsfunction columnExists
Request fields read from $request
None detected.
Database tables referenced
assessment_masterfacilitiesperformance_entriesprocessingexistsINFORMATION_SCHEMA
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state map service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateMapService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state performance service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StatePerformanceService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state report service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php/../core/Crypto.php
Declared classes and functions
class StateReportServicefunction streamCsvfunction exportCatalogfunction writeSummaryfunction writeFacilitiesfunction writeAssessmentsfunction writeCqifunction writePerformancefunction writeCertificationfunction responseTablefunction selectColumnfunction monthNamefunction writeAssessorActivityfunction domainLabelsfunction moduleEnabledfunction facilityTypeNamefunction departmentMapfunction checkpointMapfunction performanceIndicatorMapfunction collectPerformanceIndicatorsfunction indicatorFieldLabelsfunction facilityWhereLocalfunction facilityMasterRowsfunction matchesMasterFiltersfunction streamQueryfunction csvRowfunction prepareAndBindfunction tableExistsLocalfunction columnExistsLocal
Request fields read from $request
None detected.
Database tables referenced
isfacilitiesassessment_action_planassessment_masterperformance_entriescertification_historyprocessingassessor_masterexistsINFORMATION_SCHEMA
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: Provides state user admin service behavior for SaQshi API workflows.
Dependencies included
/StateDashboardService.php
Declared classes and functions
class StateUserAdminService
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
- Role: Service layer
- HTTP method guard: Not detected (internal/helper or legacy handling).
- Source intent: ValidationService.php Performance indicator validation helper.
Dependencies included
None detected.
Declared classes and functions
class ValidationServicefunction validateEntry
Request fields read from $request
None detected.
Database tables referenced
None detected.
Events dispatched
None detected.
Configuration files define static behaviour, validation rules, master data, certification settings, and performance settings. They do not expose HTTP endpoints.
- Role: Configuration
- JSON shape: object
- Top-level keys:
queue_driver,execution_mode,poll_seconds,scheduled_task,windows_service,redis_coordinated_worker
- Role: Configuration
- JSON shape: object
- Top-level keys:
enabled,driver,redis,assessment_list_ttl_seconds
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,types,assessment_modes,statuses,national_requires_state,allow_multiple_history,renewal_due_days
- Role: Configuration
- JSON shape: object
- Top-level keys:
cards
- Role: Configuration
- JSON shape: object
- Top-level keys:
required_fields,score
- Role: Configuration
- JSON shape: object
- Top-level keys:
intents
- Role: Configuration
- JSON shape: object
- Top-level keys:
answers
- Role: Configuration
- JSON shape: object
- Top-level keys:
tone,rules
- Role: Configuration
- JSON shape: object
- Top-level keys:
max_message_length,fallback_answer_key,blocked_terms
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,profile_code,profile_name,default_framework,branding,content,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,profile_code,profile_name,default_framework,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,profile_code,profile_name,default_framework,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,description,modules,role_visibility,active_profile,default_framework
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,profile_code,profile_name,default_framework,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,description,modules,role_visibility,active_profile,default_framework
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: object
- Top-level keys:
framework,settings,facility_types,departments,areas_of_concern,reports,dashboard
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: object
- Top-level keys:
type,arcs,transform,objects,crs
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: invalid JSON
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: list
- Top-level keys: Not applicable or list-based configuration.
- Role: Configuration
- JSON shape: object
- Top-level keys:
type,arcs,transform,objects,crs
- Role: Configuration
- JSON shape: object
- Top-level keys:
default_state,settings,states
- Role: Configuration
- JSON shape: object
- Top-level keys:
type,arcs,transform,objects,crs
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,description,modules,role_visibility,active_profile,default_framework
- Role: Configuration
- JSON shape: object
- Top-level keys:
domain,description,modules,role_visibility,active_profile,default_framework
- Role: Configuration
- JSON shape: object
- Top-level keys:
enabled,transport,from_email,from_name,log_path,templates,http
- Role: Configuration
- JSON shape: object
- Top-level keys:
enabled,transport,log_path,sender_id,templates,http
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,route,page,filters,summary_cards,widgets,status_rules,actions,api
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,variable_model,formulas
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,frequencies
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,sources,indicators
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,kpis
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,input_model,facility_type_count,indicator_total,facility_types
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,default_rule,facility_type_rules
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,targets
- Role: Configuration
- JSON shape: object
- Top-level keys:
module,config_type,version,description,scope,global_validation,field_validation,month_year_validation,formula_validation,save_validation,indicator_validation,messages
- Role: Configuration
- JSON shape: object
- Top-level keys:
profile_code,profile_name,recommended_for,default_framework,branding,content,modules,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
profile_code,profile_name,recommended_for,default_framework,branding,content,modules,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
profile_code,profile_name,recommended_for,default_framework,branding,content,modules,labels
- Role: Configuration
- JSON shape: object
- Top-level keys:
cookie_name,driver,redis,files
- Role: Configuration
- JSON shape: object
- Top-level keys:
info,item,variable
- Role: Configuration
- JSON shape: object
- Top-level keys:
status,description
After modifying an API file, service, core class or JSON configuration, run php tools/generate-api-documentation.php, review the generated diff, and update the relevant hand-written module guide with business rules, response examples and extension notes.