ListAdminController class - Documentation for SproutCMS

Info Page:

Page options:

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

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

Variables

Name	Visibility	Description
`$main_order`

Functions

Name	Visibility	Description
__construct	public	Constructor
_deleteSave	public	Deletes an item and logs the deleted data
_getNavigation	public	Returns the contents of the navigation pane for the list
_getTools	public	Returns the tools to show in the left navigation
fixRecordOrder	protected	If the specified item needs a record number to be set,
reorder	public	Shows the reorder screen (which is shown in a popup box) for re-ordering the children items
reorderSave	public	Saves a reorder

public __construct

void $ListAdminController->__construct ( );

Constructor

public _deleteSave

bool $ListAdminController->_deleteSave ( int $item_id );

Deletes an item and logs the deleted data

public _getNavigation

unknown $ListAdminController->_getNavigation ( );

Returns the contents of the navigation pane for the list

public _getTools

unknown $ListAdminController->_getTools ( );

Returns the tools to show in the left navigation

protected fixRecordOrder

void $ListAdminController->fixRecordOrder ( int $item_id );

If the specified item needs a record number to be set,
Puts this item at the end of the list.

public reorder

void $ListAdminController->reorder ( );

Shows the reorder screen (which is shown in a popup box) for re-ordering the children items

public reorderSave

void $ListAdminController->reorderSave ( );

Saves a reorder

SproutCMS

Search documentation