WorkflowEmbargoExpiryExtension
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
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Edit the given query object to support queries for this extension
Update the database schema as required by this extension.
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.
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.
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.
Define extra database fields
This function is used to provide modifications to the Validators used on a DataObject.
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
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']
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']
Ensure the existence of an unpublish job at the specified time
Add badges to the site tree view to show that a page has been scheduled for publishing or unpublishing
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.
Returns whether a publishing date has been set and is after the current date
Returns whether an unpublishing date has been set and is after the current date
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
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
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().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
Edit the given query object to support queries for this extension
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.
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.
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.
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.
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.
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.
updateCMSFields(FieldList $fields)
No description
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.
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.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
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']
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']
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
protected
ensureUnPublishJob(int $when)
Ensure the existence of an unpublish job at the specified time
onBeforeDuplicate($original, $doWrite)
No description
updateStatusFlags($flags)
Add badges to the site tree view to show that a page has been scheduled for publishing or unpublishing
getIntroMessageParts($key)
No description
getIntroMessage($key)
No description
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.
string
getUserDate(string $date)
Format a date according to member/user preferences
setIsWorkflowInEffect()
No description
getIsWorkflowInEffect()
No description
bool
getIsPublishScheduled()
Returns whether a publishing date has been set and is after the current date
bool
getIsUnPublishScheduled()
Returns whether an unpublishing date has been set and is after the current date
$this
setWorkflowService(WorkflowService $workflowService)
Set the workflow service instance
WorkflowService
getWorkflowService()
Get the workflow service instance
QueuedJobDescriptor
PublishJob()
No description
QueuedJobDescriptor
UnPublishJob()
No description