SproutCMS

This is the code documentation for the SproutCMS project

class ListAdminController

Any controller which is essentially a short list of items, which are not substantial enough
to warrant a categories system

Required fields for a list controller table:
  id
  name
  record_order

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-15
**/
class NewClassName extends ListAdminController {
    
    /**
    * 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
    }
    
    /**
    * Saves a reorder
    **/
    public function reorderSave () {
        // Method code goes here
    }
    
    /**
    * Shows the reorder screen (which is shown in a popup box) for re-ordering the children items
    **/
    public function reorder () {
        // Method code goes here
    }
    
    /**
    * Constructor
    **/
    public function __construct () {
        // Method code goes here
    }
    
    /**
    * Returns the contents of the navigation pane for the list
    **/
    public function _getNavigation () {
        // Method code goes here
    }
    
    /**
    * Returns the tools to show in the left navigation
    **/
    public function _getTools () {
        // Method code goes here
    }
    
}
?>