HasCategoriesAdminController class - Documentation for SproutCMS

Info Page:

Page options:

class HasCategoriesAdminController

An abstract class for controllers of things which have categories.

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

Variables

Name	Visibility	Description
`$add_defaults`
`$category_archive`		Do we have the 'archive' feature for categories? You will need a "show_admin TINYINT UNSIGNED DEFAULT 1" column on the category table.
`$category_reorder`		Enables re-ordering for categories. You will need a "record_order" column on the category table.
`$category_single`		Enables single-cat mode. This uses radiobuttons instead of checkboxes in the category selection UI.
`$controller_name`
`$db`
`$friendly_name`
`$main_columns`

Functions

Name	Visibility	Description
__construct	public	Constructor
_deleteSave	public	Deletes an item and logs the deleted data
_extraMultiCategorise	public	Form to change the categories for a number of records
_getAddForm	public	Returns a page title and HTML for a form to add a record
_getContents	public	Returns the main list of records for this controller
_getContentsView	public	Return HTML for a resultset of items
_getContentsViewList	public	Formats a resultset of items into an Itemlist
_getDuplicateForm	public	Returns the edit form for duplicating a record
_getEditForm	public	Returns the edit form for adding a record
_getNavigation	public	Returns the contents of the navigation pane
_getRefineClause	protected	Return the WHERE clause to use for a given key which is provided by the RefineBar
_getTools	public	Additional categry tools
_importExtraOptions	protected	Called when the import form is being built.
_importPostRecord	protected	Called after a record has been inserted or updated.
catAllowAdd	public	Return true if categories are allowed to be added.
catAllowDelete	public	Return true if categories are allowed to be deleted.
catAllowEdit	public	Return true if categories are allowed to be edited.
getCategoryArchive	public	Returns TRUE if category archive is enabled, FALSE otherwise
postMultiCategorise	public	Change the categories for a number of records
updateCategories	protected	Updates the category table for this controller (so for articles, the updated table will be articles_cat_join)

public __construct

void $HasCategoriesAdminController->__construct ( );

Constructor

public _deleteSave

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

Deletes an item and logs the deleted data

This method should not be overridden unless absolutely necessary.

public _extraMultiCategorise

unknown $HasCategoriesAdminController->_extraMultiCategorise ( );

Form to change the categories for a number of records

public _getAddForm

array $HasCategoriesAdminController->_getAddForm ( );

Returns a page title and HTML for a form to add a record

public _getContents

unknown $HasCategoriesAdminController->_getContents ( );

Returns the main list of records for this controller

public _getContentsView

unknown $HasCategoriesAdminController->_getContentsView ( Traversable $items , string $mode , StdClass $category );

Return HTML for a resultset of items
The returned HTML will be sandwiched between the refinebar and the pagination bar.

public _getContentsViewList

unknown $HasCategoriesAdminController->_getContentsViewList ( Traversable $items , StdClass $category );

Formats a resultset of items into an Itemlist

public _getDuplicateForm

unknown $HasCategoriesAdminController->_getDuplicateForm ( int $id );

Returns the edit form for duplicating a record

public _getEditForm

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

Returns the edit form for adding a record

public _getNavigation

unknown $HasCategoriesAdminController->_getNavigation ( );

Returns the contents of the navigation pane

protected _getRefineClause

string $HasCategoriesAdminController->_getRefineClause ( string $key , string $val , array &$query_params );

Return the WHERE clause to use for a given key which is provided by the RefineBar

Allows custom non-table clauses to be added.
Is only called for key names which begin with an underscore.
The base table is aliased to 'item'.

public _getTools

unknown $HasCategoriesAdminController->_getTools ( );

Additional categry tools

protected _importExtraOptions

unknown $HasCategoriesAdminController->_importExtraOptions ( );

Called when the import form is being built.

Returns HTML of extra options to display, or null if no extra options.

protected _importPostRecord

unknown $HasCategoriesAdminController->_importPostRecord ( int $record_id , array $new_data , array $existing_record , string $type , boolean $raw_data );

Called after a record has been inserted or updated.

public catAllowAdd

unknown $HasCategoriesAdminController->catAllowAdd ( );

Return true if categories are allowed to be added.

public catAllowDelete

unknown $HasCategoriesAdminController->catAllowDelete ( mixed $category_id );

Return true if categories are allowed to be deleted.

public catAllowEdit

unknown $HasCategoriesAdminController->catAllowEdit ( mixed $category_id );

Return true if categories are allowed to be edited.

public getCategoryArchive

unknown $HasCategoriesAdminController->getCategoryArchive ( );

Returns TRUE if category archive is enabled, FALSE otherwise

public postMultiCategorise

void $HasCategoriesAdminController->postMultiCategorise ( );

Change the categories for a number of records

protected updateCategories

boolean $HasCategoriesAdminController->updateCategories ( mixed $item_id , array $categories );

Updates the category table for this controller (so for articles, the updated table will be articles_cat_join)
so that the records for the specified item match the category ids provided.

SproutCMS

Search documentation