SproutCMS

This is the code documentation for the SproutCMS project

class CategoryAdminController

This is a generic controller which category controllers should extend.

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-16
**/
class NewClassName extends CategoryAdminController {
    
    /**
    * Unarchive a category
    **/
    public function ajaxUnarchiveAction ($category_id) {
        // Method code goes here
    }
    
    /**
    * Archive a category
    **/
    public function ajaxArchiveAction ($category_id) {
        // Method code goes here
    }
    
    public function __construct () {
        // Method code goes here
    }
    
    /**
    * Proxy for top nav name =&gt; the main controller class
    **/
    public function getTopnavName () {
        // Method code goes here
    }
    
    /**
    * Proxy for navigation =&gt; the main controller class
    **/
    public function _getNavigation () {
        // Method code goes here
    }
    
    /**
    * Proxy for tools =&gt; the main controller class
    **/
    public function _getTools () {
        // Method code goes here
    }
    
    /**
    * Return the fields to show in the sidebar when adding or editing a record.
    * These fields are shown under a heading of &quot;Visibility&quot;
    * 
    * Key is the field name, value is the field label
    **/
    public function _getVisibilityFields () {
        // Method code goes here
    }
    
    /**
    * Returns the add form for adding a record
    **/
    public function _getAddForm () {
        // Method code goes here
    }
    
    /**
    * Saves the provided POST data into a new record in the database
    **/
    public function _addSave (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Return HTML which represents the form for editing a record
    **/
    public function _getEditForm (int $id) {
        // Method code goes here
    }
    
    /**
    * Saves the provided POST data the specified record
    **/
    public function _editSave (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Shows delete form for deleting this category
    **/
    public function _getDeleteForm (int $id) {
        // Method code goes here
    }
    
    /**
    * Deletes a category
    **/
    public function _deleteSave (int $id) {
        // Method code goes here
    }
    
    /**
    * Shows the reorder page for re-ordering the items for this category
    **/
    public function _extraReorder ($category_id) {
        // Method code goes here
    }
    
    /**
    * Saves a item reorder
    **/
    public function reorderSave ($category_id) {
        // Method code goes here
    }
    
    /**
    * Shows the reorder page for re-ordering the categories.
    **/
    public function _extraReorderCategories () {
        // Method code goes here
    }
    
    /**
    * Saves a item reorder
    **/
    public function reorderCategoriesSave () {
        // Method code goes here
    }
    
}
?>