Details
-
Type:
Sub-task
-
Status: Open
-
Priority:
Major
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: 6.0.0-b1
-
Component/s: None
-
Labels:None
Description
Audit model get() methods and use runtime capture to document the true object structures returned by each model.
Why this is needed:
- get() methods join related tables (e.g., Invoices::get() returns client info, line items, transactions)
- Models include computed fields (totals, formatted dates, status labels)
- Nested structures vary by context (service includes package, module, pricing)
- Some fields are conditionally included
- The database schema alone is insufficient to understand the full structure
Process:
1. Call actual model get() methods with real data
2. json_encode() the results
3. Capture the full structure including nested objects
Acceptance Criteria:
- Capture JSON output from each model's get() method
- Include all nested/related objects in the capture
- Note which fields are computed vs. stored
- Identify conditional fields and when they appear
- Document any variations in structure based on parameters or context
Activity
| Field | Original Value | New Value |
|---|---|---|
| Summary | Audit model get() methods to document actual returned structures | Audit and capture model get() method structures |
| Description |
Audit model get() methods to determine the true object structures returned by each model. Why this is needed: - get() methods join related tables (e.g., Invoices::get() returns client info, line items, transactions) - Models include computed fields (totals, formatted dates, status labels) - Nested structures vary by context (service includes package, module, pricing) - Some fields are conditionally included The database schema alone is insufficient to understand the full structure. Acceptance Criteria: - Document the actual returned structure of each model's get() method - Note which fields are computed vs. stored - Identify conditional fields and when they appear - List related tables that get joined in each get() method |
Audit model get() methods and use runtime capture to document the true object structures returned by each model.
Why this is needed: - get() methods join related tables (e.g., Invoices::get() returns client info, line items, transactions) - Models include computed fields (totals, formatted dates, status labels) - Nested structures vary by context (service includes package, module, pricing) - Some fields are conditionally included - The database schema alone is insufficient to understand the full structure Process: 1. Call actual model get() methods with real data 2. json_encode() the results 3. Capture the full structure including nested objects Acceptance Criteria: - Capture JSON output from each model's get() method - Include all nested/related objects in the capture - Note which fields are computed vs. stored - Identify conditional fields and when they appear - Document any variations in structure based on parameters or context |