\DMSDocumentSet
A document set is attached to Pages, and contains many DMSDocuments
Synopsis
class DMSDocumentSet
extends DataObject
{
- // members
- private static array $db = ;
- private static array $has_one = ;
- private static array $many_many = ;
- private static array $many_many_extraFields = ;
- private static array $summary_fields = ;
- // methods
- public DataList|null getDocuments()
- public FieldList getCMSFields()
- protected $this addRequirements()
- public void addQueryFields()
- public void onBeforeWrite()
- public void saveLinkedDocuments()
- protected DataList addEmbargoConditions()
- protected DataList addQueryBuilderSearchResults()
- public array getDocumentDisplayFields()
- protected void validate()
- public void canView()
- public void canCreate()
- public void canEdit()
- public void canDelete()
- public bool getGlobalPermission()
Hierarchy
Extends
- DataObject
Members
private
- $db
- $has_one
- $many_many
- $many_many_extraFields
- $summary_fields
Methods
protected
- addEmbargoConditions() — Add embargo date conditions to a search query
- addQueryBuilderSearchResults() — Remove all ManuallyAdded = 0 original results and add in the new documents returned by the search context
- addRequirements() — Add required CSS and Javascript requirements for managing documents
- validate()
public
- addQueryFields() — Adds the query fields to build the document logic to the DMSDocumentSet.
- canCreate()
- canDelete()
- canEdit()
- canView()
- getCMSFields() — Put the "documents" list into the main tab instead of its own tab, and replace the default "Add Document" button with a customised button for DMS documents
- getDocumentDisplayFields() — Customise the display fields for the documents GridField
- getDocuments() — Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
- getGlobalPermission() — Checks if a then given (or logged in) member is either an ADMIN, SITETREE_EDIT_ALL or has access to the DMSDocumentAdmin module, in which case permissions is granted.
- onBeforeWrite()
- saveLinkedDocuments() — Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.