\DMS
Synopsis
class DMS
extends SS_Object
implements
DMSInterface
{
- // members
- private static string $folder_name = 'assets/_dmsassets';
- private static integer $folder_size = 1000;
- private static DMSInterface $instance;
- private static string $shortcode_handler_key = 'dms_document_link';
- // methods
- public static DMSInterface inst()
- public string getStoragePath()
- public string transformFileToFilePath()
- public DMSDocument storeDocument()
- public DocumentInterface getByFullTextSearch()
- public void getByPage()
- public void getDocumentSetsByPage()
- public $this createStorageFolder()
- public int getStorageFolder()
- public string getShortcodeHandlerKey()
Hierarchy
Tasks
Line | Task |
---|---|
133 | Implement getByFullTextSearch() method. |
Members
private
- $folder_name
—
string
Folder to store the documents in - $folder_size
—
int
How many documents to store in a single folder. The square of this number is the maximum number of documents. - $instance
—
DMSInterface
Singleton instance of a DMSInterface - $shortcode_handler_key
—
string
The shortcode handler key. Can be changed by user code.
Methods
public
- createStorageFolder() — Creates a storage folder for the given path
- 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()
- getDocumentSetsByPage()
- getShortcodeHandlerKey() — Get the shortcode handler key
- getStorageFolder() — Calculates the storage path from a database DMSDocument ID
- getStoragePath() — Get the storage path for DMS documents
- 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.
- transformFileToFilePath() — Gets a file path from either a File or a string