Sunnysideup\DMS\Interfaces\DMSInterface
Synopsis
interface DMSInterface
{
- // methods
- public static DMSInterface inst()
- public DMSDocumentInstance storeDocument()
- public DMSDocumentInterface getByFullTextSearch()
- public ArrayList getByPage()
- public ArrayList getDocumentSetsByPage()
Methods
public
- getByFullTextSearch() — 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)
- getByPage() — Returns a list of Document objects associated with a Page via intermediary document sets
- getDocumentSetsByPage() — Returns a list of Document Set objects associated with a Page
- inst() — Factory method that returns an instance of the DMS. This could be any class that implements the DMSInterface.
- storeDocument() — Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.