Superclass Methods for Tree Data Structure

​

Documentation: Advanced Datatable Structures

​

Part 1: Backend - Laravel AdminController Datatable Configuration

​

Configuration Properties

​

Routes and API Interaction

• Endpoint: All datatable interactions use the same endpoint: POST {controller-base}/index.
• Lazy Loading (Frontend): When table_lazy_load is set to 'frontend', your frontend datatable must make subsequent calls to this same endpoint to load children. The required payload depends on the table_structure_mode:
• Simple Tree: Send { "parentId": "ID_of_the_expanded_row" }.
• Compound Tree: Send { "parentType": "type_of_the_row", "parentId": "prefixed_ID_of_the_row" }.

​

Usage Examples

​

Scenario 1: Standard Flat Table (Default)

// In YourController.php
public function __construct()
{
    parent::__construct();
    $this->model = new YourModel();
    $this->table_structure_mode = 'flat'; // This is the default
}

​

Scenario 2: Simple Tree with Backend Lazy Loading

• Controller (CategoryController.php)

public function __construct()
{
    parent::__construct();
    $this->model = new Category();

    $this->table_structure_mode = 'simple_tree';
    $this->table_lazy_load = 'backend'; // API builds the paginated tree
    $this->table_tree_parent_field = 'parent_id';
    $this->table_tree_root_parent_value = null;
}

• API Response: The data array will contain only root-level items, but each item that has children will contain a children array with its descendants.

​

Scenario 3: Simple Tree with Frontend Lazy Loading

• Controller (OrgChartController.php)

public function __construct()
{
    parent::__construct();
    $this->model = new Employee();

    $this->table_structure_mode = 'simple_tree';
    $this->table_lazy_load = 'frontend'; // Frontend is responsible for fetching children
    $this->table_tree_parent_field = 'manager_id';
}

• API Interaction:

1. Initial Load: POST /api/org-chart/index with pagination params returns paginated root-level employees. Each will have a _hasChildren: true flag if they manage others.
2. Expanding a Row: When the user expands an employee with ID 123, the frontend makes a new call: POST /api/org-chart/index with the body {"parentId": "123"}.
3. The API responds with a flat array of all employees who report directly to employee 123.

​

Scenario 4: Compound Tree (Frontend Lazy Loading Only)

• Controller (DocumentBrowserController.php)

public function __construct()
{
    parent::__construct();

    $this->table_structure_mode = 'compound_tree';
    // table_lazy_load is automatically 'frontend' for this mode.

    $this->table_compound_tree_config = [
        'group' => [
            'model' => \App\Models\Dms\DocGroup::class,
            'prefix' => 'group',
            'parent_type' => null,
            'primary_key' => 'id',
            // ... other keys
        ],
        'section' => [
            'model' => \App\Models\Dms\DocSection::class,
            'prefix' => 'section',
            'parent_type' => 'group',
            'foreign_key' => 'groupId',
            'primary_key' => 'id',
            // ... other keys
        ],
    ];
}

• API Interaction:

1. Initial Load: POST /api/doc-browser/index returns paginated root nodes (e.g., _type: 'group').
2. Expanding a Row: To expand a group with prefixed ID group-45, the frontend calls POST /api/doc-browser/index with the body {"parentType": "group", "parentId": "group-45"}.
3. The API responds with a flat array of all sections belonging to that group.

​

Dokumentasi (Bahasa Indonesia)

​

Struktur Datatable Lanjutan

​

Bagian 1: Backend - Konfigurasi Datatable AdminController

​

Properti Konfigurasi

​

Routes dan Interaksi API

• Endpoint: Semua interaksi datatable menggunakan endpoint yang sama: POST {controller-base}/index.
• Lazy Loading (Frontend): Ketika table_lazy_load diatur ke 'frontend', datatable di frontend Anda harus melakukan panggilan berikutnya ke endpoint yang sama untuk memuat turunan. Payload yang diperlukan tergantung pada table_structure_mode:
• Simple Tree: Kirim { "parentId": "ID_baris_yang_diekspansi" }.
• Compound Tree: Kirim { "parentType": "tipe_baris", "parentId": "ID_dengan_prefix" }.

​

Contoh Penggunaan

​

Skenario 1: Tabel Datar Standar (Default)

// Di YourController.php
public function __construct()
{
    parent::__construct();
    $this->model = new YourModel();
    $this->table_structure_mode = 'flat'; // Ini adalah default
}

​

Skenario 2: Pohon Sederhana dengan Backend Lazy Loading

• Controller (CategoryController.php)

public function __construct()
{
    parent::__construct();
    $this->model = new Category();

    $this->table_structure_mode = 'simple_tree';
    $this->table_lazy_load = 'backend'; // API membangun pohon terpaginasi
    $this->table_tree_parent_field = 'parent_id';
    $this->table_tree_root_parent_value = null;
}

• Respon API: Array data akan berisi item level akar saja, tetapi setiap item yang memiliki turunan akan berisi array children dengan data turunannya.

​

Skenario 3: Pohon Sederhana dengan Frontend Lazy Loading

• Controller (OrgChartController.php)

public function __construct()
{
    parent::__construct();
    $this->model = new Employee();

    $this->table_structure_mode = 'simple_tree';
    $this->table_lazy_load = 'frontend'; // Frontend bertanggung jawab mengambil data turunan
    $this->table_tree_parent_field = 'manager_id';
}

• Interaksi API:

1. Panggilan Awal: POST /api/org-chart/index dengan parameter paginasi akan mengembalikan karyawan level akar yang terpaginasi. Masing-masing akan memiliki flag _hasChildren: true jika mereka memiliki bawahan.
2. Mengekspansi Baris: Saat pengguna mengekspansi seorang karyawan dengan ID 123, frontend membuat panggilan baru: POST /api/org-chart/index dengan body {"parentId": "123"}.
3. API akan merespons dengan array datar dari semua karyawan yang melapor langsung ke karyawan 123.

​

Skenario 4: Pohon Gabungan (Frontend Lazy Loading Only)

• Controller (DocumentBrowserController.php)

public function __construct()
{
    parent::__construct();

    $this->table_structure_mode = 'compound_tree';
    // table_lazy_load secara otomatis menjadi 'frontend' untuk mode ini.

    $this->table_compound_tree_config = [
    'group' => [
    'model' => \App\Models\Dms\DocGroup::class,
    'prefix' => 'group',
    'parent_type' => null,
    'primary_key' => 'id',
    // ... key lainnya
    ],
    'section' => [
    'model' => \App\Models\Dms\DocSection::class,
    'prefix' => 'section',
    'parent_type' => 'group',
    'foreign_key' => 'groupId',
    'primary_key' => 'id',
    // ... key lainnya
    ],
    ];
}

• Interaksi API:

1. Panggilan Awal: POST /api/doc-browser/index mengembalikan node akar yang terpaginasi (misal, _type: 'group').
2. Mengekspansi Baris: Untuk mengekspansi sebuah grup dengan ID ber-prefix group-45, frontend memanggil POST /api/doc-browser/index dengan body {"parentType": "group", "parentId": "group-45"}.
3. API merespons dengan array datar dari semua seksi yang dimiliki oleh grup tersebut.