class WorkflowEmbargoExpiryExtension extends DataExtension (View source)

Adds embargo period and expiry dates to content items

Properties

protected T $owner

The object this extension is applied to.

from  Extension
protected WorkflowService $workflowService
public bool $isWorkflowInEffect

Is a workflow in effect?

public static array $extendedMethodReturn

A basic extended validation routine method return format

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
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

{PublishItemWorkflowAction} for approval of requested publish dates

public
onAfterWrite()

Extend the owner's onAfterWrite() logic

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

Extend the owner's populateDefaults() logic

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
bool|null
can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canEdit(Member $member)

Add edit check for when publishing has been scheduled and if any workflow definitions want the item to be disabled.

public
bool|null
canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

public
updateCMSFields(FieldList $fields)

No description

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

public
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

public
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

public
updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

public
updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

public
clearPublishJob()

Clears any existing publish job against this dataobject

public
clearUnPublishJob()

Clears any existing unpublish job

protected
ensurePublishJob(int $when)

Ensure the existence of a publish job at the specified time

protected
ensureUnPublishJob(int $when)

Ensure the existence of an unpublish job at the specified time

public
onBeforeDuplicate($original, $doWrite)

No description

public
updateStatusFlags($flags)

Add badges to the site tree view to show that a page has been scheduled for publishing or unpublishing

public
getIntroMessageParts($key)

No description

public
getIntroMessage($key)

No description

public
getCMSValidator()

No description

public
array
extendedRequiredFieldsEmbargoExpiry($data)

This is called in the AWRequiredFields class, this validates whether an Embargo and Expiry are not equal and that Embargo is before Expiry, returning the appropriate message when it fails.

public
string
getUserDate(string $date)

Format a date according to member/user preferences

public
setIsWorkflowInEffect()

No description

public
getIsWorkflowInEffect()

No description

public
bool
getIsPublishScheduled()

Returns whether a publishing date has been set and is after the current date

public
bool
getIsUnPublishScheduled()

Returns whether an unpublishing date has been set and is after the current date

public
$this
setWorkflowService(WorkflowService $workflowService)

Set the workflow service instance

public
getWorkflowService()

Get the workflow service instance

PublishJob()

No description

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

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

augmentDatabase()

Update the database schema as required by this extension.

When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.

augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

{PublishItemWorkflowAction} for approval of requested publish dates

onAfterWrite()

Extend the owner's onAfterWrite() logic

See DataObject::onAfterWrite() for context.

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

populateDefaults()

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

onAfterBuild()

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

bool|null can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canEdit(Member $member)

Add edit check for when publishing has been scheduled and if any workflow definitions want the item to be disabled.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

array extraStatics(string $class = null, string $extension = null)

Define extra database fields

Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

Parameters

string $class

since this method might be called on the class directly

string $extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

updateCMSFields(FieldList $fields)

No description

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

Caution: Use FieldList->push() to add fields.

Parameters

FieldList $fields

FieldList without TabSet nesting

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

Parameters

FieldList $actions FieldList

updateSummaryFields(array $fields)

this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']

Parameters

array $fields

Array of field names

updateFieldLabels(array $labels)

this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']

Parameters

array $labels

Array of field labels

clearPublishJob()

Clears any existing publish job against this dataobject

clearUnPublishJob()

Clears any existing unpublish job

protected ensurePublishJob(int $when)

Ensure the existence of a publish job at the specified time

Parameters

int $when

Timestamp to start this job, or null to start immediately

protected ensureUnPublishJob(int $when)

Ensure the existence of an unpublish job at the specified time

Parameters

int $when

Timestamp to start this job, or null to start immediately

onBeforeDuplicate($original, $doWrite)

No description

Parameters

$original
$doWrite

updateStatusFlags($flags)

Add badges to the site tree view to show that a page has been scheduled for publishing or unpublishing

Parameters

$flags

getIntroMessageParts($key)

No description

Parameters

$key

getIntroMessage($key)

No description

Parameters

$key

getCMSValidator()

No description

array extendedRequiredFieldsEmbargoExpiry($data)

This is called in the AWRequiredFields class, this validates whether an Embargo and Expiry are not equal and that Embargo is before Expiry, returning the appropriate message when it fails.

Parameters

$data

Return Value

array

string getUserDate(string $date)

Format a date according to member/user preferences

Parameters

string $date

Return Value

string $date

setIsWorkflowInEffect()

No description

getIsWorkflowInEffect()

No description

bool getIsPublishScheduled()

Returns whether a publishing date has been set and is after the current date

Return Value

bool

bool getIsUnPublishScheduled()

Returns whether an unpublishing date has been set and is after the current date

Return Value

bool

$this setWorkflowService(WorkflowService $workflowService)

Set the workflow service instance

Parameters

WorkflowService $workflowService

Return Value

$this

WorkflowService getWorkflowService()

Get the workflow service instance

Return Value

WorkflowService

QueuedJobDescriptor PublishJob()

No description

Return Value

QueuedJobDescriptor

QueuedJobDescriptor UnPublishJob()

No description

Return Value

QueuedJobDescriptor