Documentation

ModerateInterface

A moderation component.

You'll likely want to extend the Moderate base class instead.

Table of Contents

Methods

approve()  : bool
Approve the specified item.
complete()  : void
Process actions after the transaction is complete.
delete()  : bool
Delete the specified item.
render()  : string
Render the moderation form.
setData()  : bool
Record extra data from the moderation form, if any.

Methods

approve()

Approve the specified item.

public approve(int $id) : bool

This is called from within a transaction.

Parameters
$id : int
Return values
bool

complete()

Process actions after the transaction is complete.

public complete() : void

delete()

Delete the specified item.

public delete(int $id) : bool

Usually the best is to use the controller _deleteSave method.

This is called from within a transaction.

Parameters
$id : int
Return values
bool

render()

Render the moderation form.

public render() : string
Return values
string

setData()

Record extra data from the moderation form, if any.

public setData(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int
$data : array<string|int, mixed>
Return values
bool
On this page

Search results