CategoryAdminController class - Documentation for SproutCMS

Info Page:

Page options:

class CategoryAdminController

This is a generic controller which category controllers should extend.

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

Variables

Name	Visibility	Description
`$add_defaults`
`$add_view_name`		The view to use for adding new category records. Loaded in a popup
`$controller_name`
`$edit_view_name`		The view to use for editing existing category records
`$friendly_name`
`$main_columns`
`$parent_inst`		Instance of the parent controller

Functions

Name	Visibility	Description
__construct	public
_addSave	public	Saves the provided POST data into a new record in the database
_deleteSave	public	Deletes a category
_editSave	public	Saves the provided POST data the specified record
_extraReorder	public	Shows the reorder page for re-ordering the items for this category
_extraReorderCategories	public	Shows the reorder page for re-ordering the categories.
_getAddForm	public	Returns the add form for adding a record
_getDeleteForm	public	Shows delete form for deleting this category
_getEditForm	public	Return HTML which represents the form for editing a record
_getNavigation	public	Proxy for navigation => the main controller class
_getTools	public	Proxy for tools => the main controller class
_getVisibilityFields	public	Return the fields to show in the sidebar when adding or editing a record.
ajaxArchiveAction	public	Archive a category
ajaxUnarchiveAction	public	Unarchive a category
getParentInst	public	Return the instance of the parent controller
getTopnavName	public	Proxy for top nav name => the main controller class
reorderCategoriesSave	public	Saves a item reorder
reorderSave	public	Saves a item reorder

public __construct

void $CategoryAdminController->__construct ( );

This function does not have a description

public _addSave

unknown $CategoryAdminController->_addSave ( int &$item_id );

Saves the provided POST data into a new record in the database

public _deleteSave

unknown $CategoryAdminController->_deleteSave ( int $id );

Deletes a category

public _editSave

unknown $CategoryAdminController->_editSave ( int $item_id );

Saves the provided POST data the specified record

public _extraReorder

unknown $CategoryAdminController->_extraReorder ( mixed $category_id );

Shows the reorder page for re-ordering the items for this category

public _extraReorderCategories

unknown $CategoryAdminController->_extraReorderCategories ( );

Shows the reorder page for re-ordering the categories.

public _getAddForm

string $CategoryAdminController->_getAddForm ( );

Returns the add form for adding a record

public _getDeleteForm

unknown $CategoryAdminController->_getDeleteForm ( int $id );

Shows delete form for deleting this category

public _getEditForm

unknown $CategoryAdminController->_getEditForm ( int $id );

Return HTML which represents the form for editing a record

public _getNavigation

unknown $CategoryAdminController->_getNavigation ( );

Proxy for navigation => the main controller class

public _getTools

unknown $CategoryAdminController->_getTools ( );

Proxy for tools => the main controller class

public _getVisibilityFields

array $CategoryAdminController->_getVisibilityFields ( );

Return the fields to show in the sidebar when adding or editing a record.
These fields are shown under a heading of "Visibility"

Key is the field name, value is the field label

public ajaxArchiveAction

void $CategoryAdminController->ajaxArchiveAction ( mixed $category_id );

Archive a category

public ajaxUnarchiveAction

void $CategoryAdminController->ajaxUnarchiveAction ( mixed $category_id );

Unarchive a category

public getParentInst

unknown $CategoryAdminController->getParentInst ( );

Return the instance of the parent controller

public getTopnavName

unknown $CategoryAdminController->getTopnavName ( );

Proxy for top nav name => the main controller class

public reorderCategoriesSave

void $CategoryAdminController->reorderCategoriesSave ( );

Saves a item reorder

public reorderSave

void $CategoryAdminController->reorderSave ( mixed $category_id );

Saves a item reorder

SproutCMS

Search documentation