class ContentReviewCMSExtension extends LeftAndMainExtension (View source)

CMSPageEditController extension to receive the additional action button from SiteTreeContentReview::updateCMSActions()

Traits

Properties

protected T $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

public
init()

No description

public
accessedCMS()

No description

public
augmentNewSiteTreeItem($item)

No description

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
Form|null
ReviewContentForm(HTTPRequest $request)

URL handler for the "content due for review" form

public
Form|null
getReviewContentForm(int $id)

Return a handler for "content due for review" forms, according to the given object ID

public
DBHTMLText|HTTPResponse|null
savereview(array $data, Form $form)

Action handler for processing the submitted content review

protected
getReviewContentHandler()

Return a handler or reviewing content

protected
findRecord(array $data)

Find the page this form is updating

protected
bool
getSchemaRequested()

Check if the current request has a X-Formschema-Request header set.

protected
getSchemaResponse(string $schemaID, Form $form = null, ValidationResult $errors = null, array $extraData = [])

Generate schema for the given form based on the X-Formschema-Request header value

Details

__construct()

No description

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

init()

No description

accessedCMS()

No description

augmentNewSiteTreeItem($item)

No description

Parameters

$item

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

Form|null ReviewContentForm(HTTPRequest $request)

URL handler for the "content due for review" form

Parameters

HTTPRequest $request

Return Value

Form|null

Form|null getReviewContentForm(int $id)

Return a handler for "content due for review" forms, according to the given object ID

Parameters

int $id

Return Value

Form|null

DBHTMLText|HTTPResponse|null savereview(array $data, Form $form)

Action handler for processing the submitted content review

Parameters

array $data
Form $form

Return Value

DBHTMLText|HTTPResponse|null

protected ReviewContentHandler getReviewContentHandler()

Return a handler or reviewing content

Return Value

ReviewContentHandler

protected SiteTree findRecord(array $data)

Find the page this form is updating

Parameters

array $data

Form data

Return Value

SiteTree Record

Exceptions

HTTPResponse_Exception

protected bool getSchemaRequested()

Check if the current request has a X-Formschema-Request header set.

Used by conditional logic that responds to validation results

Return Value

bool

protected HTTPResponse getSchemaResponse(string $schemaID, Form $form = null, ValidationResult $errors = null, array $extraData = [])

Generate schema for the given form based on the X-Formschema-Request header value

Parameters

string $schemaID

ID for this schema. Required.

Form $form

Required for 'state' or 'schema' response

ValidationResult $errors

Required for 'error' response

array $extraData

Any extra data to be merged with the schema response

Return Value

HTTPResponse