DMSInterface
interface DMSInterface (View source)
When storing a document, the DMS sucks up the file and stores it separately from the assets section.
When initializing the DMS, it should create some kind of storage system. For file-based storage, that could be a series of folders. Within the folders there are a number of files, keeping the same filename, but prefixed with an ID number, which corresponds to the document's ID. So "my-important-document" becomes: "/4000/4332~my-important-document" (folder structure to avoid storing too many files within one folder. Perhaps 10000 files per folder is a good amount)
Methods
Factory method that returns an instance of the DMS. This could be any class that implements the DMSInterface.
Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.
Returns a number of Document objects that match a full-text search of the Documents and their contents (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
Details
static DMSInterface
inst()
Factory method that returns an instance of the DMS. This could be any class that implements the DMSInterface.
DMSDocumentInstance
storeDocument($file)
Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.
When storing a document, sets the fields on the File has "tag" metadata.
DMSDocumentInterface
getByFullTextSearch($searchText, bool $showEmbargoed = false)
Returns a number of Document objects that match a full-text search of the Documents and their contents (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
ArrayList
getByPage(SiteTree $page, bool $showEmbargoed = false)
Returns a list of Document objects associated with a Page via intermediary document sets