Moderate class - Documentation for SproutCMS

Info Page:

Page options:

class Moderate

File: /sprout/Helpers/Moderate.php
Namespace: Sprout\Helpers
This class is abstract

Variables

Name	Visibility	Description
`$db`
`$friendly_name`

Functions

Name	Visibility	Description
__construct	public
approve	public	Approve the specified item.
delete	public	Delete the specified item.
getFriendlyName	public	Return the 'friendly' name of this item
getList	public	Return an array of one or more items which need moderating.

public __construct

void $Moderate->__construct ( );

This function does not have a description

public approve

void $Moderate->approve ( mixed $id );

Approve the specified item.
This is called from within a transaction.

public delete

void $Moderate->delete ( mixed $id );

Delete the specified item.
Usually the best is to use the controller _deleteSave method.
This is called from within a transaction.

public getFriendlyName

unknown $Moderate->getFriendlyName ( );

Return the 'friendly' name of this item

public getList

unknown $Moderate->getList ( );

Return an array of one or more items which need moderating.

The array should have the following format:
[] = array('id' => 'html')
     id      record identifier
     html    record preview html

Return NULL on error

SproutCMS

Search documentation