SproutCMS

class TreeAdminController

Any controller which is essentially a tree-based structure of nodes and sub-nodes.

Required fields for a tree controller table:
  id
  name
  parent_id
  record_order

• File: /sprout/Controllers/Admin/TreeAdminController.php
• Namespace: Sprout\Controllers\Admin
• Extends: ManagedAdminController
• This class is abstract

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-15
**/
class NewClassName extends TreeAdminController {
    
    /**
    * Save tree organise form submission, see {@see self::_extraOrganise}
    **/
    public function organiseAction () {
        // Method code goes here
    }
    
    /**
    * Returns the children for a specific item, in a format required by jqueryFileTree.
    * Uses the POST param 'dir', and is usually run through an AJAX call.
    **/
    public function filetreeOpen () {
        // Method code goes here
    }
    
    /**
    * Saves in the session data the currently open items in navigation tree
    * Uses the POST param 'dir', and is usually run through an AJAX call.
    **/
    public function filetreeClose () {
        // Method code goes here
    }
    
    /**
    * Shows the reorder screen (which is shown in a popup box) for re-ordering the top-level stuff
    **/
    public function reorderTop () {
        // Method code goes here
    }
    
    /**
    * Saves a tree reorder
    **/
    public function reorderSave ($parent_id) {
        // Method code goes here
    }
    
    /**
    * If the specified item needs a record number to be set,
    * Puts this item at the end of the list.
    **/
    protected function fixRecordOrder (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Tree organisation tool
    * Bulk renaming, reordering and reparenting
    **/
    public function _extraOrganise () {
        // Method code goes here
    }
    
    /**
    * Shows the reorder screen (which is shown in a popup box) for re-ordering the children items
    **/
    public function reorder ($id) {
        // Method code goes here
    }
    
    /**
    * Return HTML which represents the form for deleting a record
    **/
    public function _getDeleteForm (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Pre-render hook for editing
    **/
    protected function _editPreRender ($view, $item_id) {
        // Method code goes here
    }
    
    /**
    * Pre-render hook for adding
    **/
    protected function _addPreRender ($view) {
        // Method code goes here
    }
    
    /**
    * Returns the tools to show in the left navigation
    **/
    public function _getTools () {
        // Method code goes here
    }
    
    /**
    * Constructor
    **/
    public function __construct () {
        // Method code goes here
    }
    
    /**
    * Returns the contents of the navigation pane for the tree
    **/
    public function _getNavigation () {
        // Method code goes here
    }
    
}
?>

Tags:   module-api   api