class ReviewContentHandler (View source)

Traits

A class that can be instantiated or replaced via DI

Properties

protected Controller $controller

Parent controller for this form

protected string $name

Form name to use

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

protected
bool
isContentReviewable(DataObject $record, Member|null $user = null)

Checks the user has been granted special permission to review the content of the page if not fallback to canEdit() permission.

public
__construct(Controller $controller = null, string $name = 'ReviewContentForm')

No description

public
Form(DataObject $object)

Bootstrap the form fields for the content review modal

public
HTTPResponse|string
submitReview(DataObject $record, array $data)

Validate, and save the submitted form's review

public
bool
canSubmitReview(DataObject $record)

Determine whether the user can submit a review

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

protected bool isContentReviewable(DataObject $record, Member|null $user = null)

Checks the user has been granted special permission to review the content of the page if not fallback to canEdit() permission.

Parameters

DataObject $record
Member|null $user

Return Value

bool

__construct(Controller $controller = null, string $name = 'ReviewContentForm')

No description

Parameters

Controller $controller
string $name

Form Form(DataObject $object)

Bootstrap the form fields for the content review modal

Parameters

DataObject $object

Return Value

Form

HTTPResponse|string submitReview(DataObject $record, array $data)

Validate, and save the submitted form's review

Parameters

DataObject $record
array $data

Return Value

HTTPResponse|string

Exceptions

ValidationException

bool canSubmitReview(DataObject $record)

Determine whether the user can submit a review

Parameters

DataObject $record

Return Value

bool