AssetControlExtension
class AssetControlExtension extends DataExtension (View source)
This class provides the necessary business logic to ensure that any assets attached to a record are safely deleted, published, or protected during certain operations.
This class will respect the canView() of each object, and will use it to determine whether or not public users can access attached assets. Public and live records will have their assets promoted to the public store.
Assets which exist only on non-live stages will be protected.
Assets which are no longer referenced will be flushed via explicit delete calls to the underlying filesystem.
Properties
DataObject|Versioned | $owner | A {see \SilverStripe\ORM\DataObject}, potentially decorated with {see \SilverStripe\Versioned\Versioned} extension. |
|
static private bool | $keep_archived_assets | When archiving versioned dataobjects, should assets be archived with them? If false, assets will be deleted when the dataobject is archived. |
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 {@link DataObject::$extensions} or {@link Object::add_extension()}.
Invoke extension point. This will prefer explicit extend
prefixed
methods.
Edit the given query object to support queries for this extension
Ensure that changes to records flush overwritten files, and update the visibility of other assets.
Ensure that deletes records remove their underlying file assets, without affecting other staged records.
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 canEdit() 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 form in the CMS by the extension. By default, no changes are made. {@link DataObject->getCMSFields()}.
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. {@link DataObject->getFrontEndFields()}
This is used to provide modifications to the form actions used in the CMS. {@link 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']
Details
__construct()
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()
object
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 {@link DataObject::$extensions} or {@link 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 {@link Versioned->augmentDatabase} for an example.
augmentWrite(array $manipulation)
Augment a write-record request.
onBeforeWrite()
Ensure that changes to records flush overwritten files, and update the visibility of other assets.
onAfterWrite()
Extend the owner's onAfterWrite() logic
See {@link DataObject::onAfterWrite()} for context.
onBeforeDelete()
Extend the owner's onBeforeDelete() logic
See {@link DataObject::onBeforeDelete()} for context.
onAfterDelete()
Ensure that deletes records remove their underlying file assets, without affecting other staged records.
requireDefaultRecords()
Extend the owner's requireDefaultRecords() logic
See {@link DataObject::requireDefaultRecords()} for context.
populateDefaults()
Extend the owner's populateDefaults() logic
See {@link DataObject::populateDefaults()} for context.
onAfterBuild()
Extend the owner's onAfterBuild() logic
See {@link 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 {@link DataObject::can()} and {@link DataObject::extendedCan()} for context.
bool|null
canEdit(Member $member)
Influence the owner's canEdit() 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 {@link DataObject::canEdit()} and {@link DataObject::extendedCan()} for context.
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 {@link 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 {@link 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)
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. {@link DataObject->getCMSFields()}.
Please consider using {@link updateFormFields()} to globally add formfields to the record. The method {@link updateCMSFields()} should just be used to add or modify tabs, or fields which are specific to the CMS-context.
Caution: Use {@link FieldList->addFieldToTab()} to add fields.
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)
This function is used to provide modifications to the Validators used on a DataObject.
Caution: Use {@link CompositeValidator->addValidator()} to add Validators.
updateFrontEndFields(FieldList $fields)
This function is used to provide modifications to the form used for front end forms. {@link DataObject->getFrontEndFields()}
Caution: Use {@link FieldList->push()} to add fields.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. {@link 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']