Documentation

    API Documentation

    Table of Contents

    Namespaces

    SeedDMS

    Interfaces

    SeedDMS_Core_Storage
    Class with operations to put documents into the storage

    Classes

    SeedDMS_Core_UserAccess
    Class to represent a user access right.
    SeedDMS_Core_GroupAccess
    Class to represent a group access right.
    SeedDMS_Core_Attribute
    Class to represent an attribute in the document management system
    SeedDMS_Core_AttributeDefinition
    Class to represent an attribute definition in the document management system
    SeedDMS_Core_Decorator
    Class which implements a simple decorator pattern
    SeedDMS_Core_DMS
    Class to represent the complete document management system.
    SeedDMS_Core_Document
    Class to represent a document in the document management system
    SeedDMS_Core_DocumentContent
    Class to represent content of a document
    SeedDMS_Core_DocumentLink
    Class to represent a link between two document
    SeedDMS_Core_DocumentFile
    Class to represent a file attached to a document
    SeedDMS_Core_AddContentResultSet
    Class to represent a list of document contents
    SeedDMS_Core_DocumentCategory
    Class to represent a document category in the document management system
    SeedDMS_Core_Folder
    Class to represent a folder in the document management system
    SeedDMS_Core_Group
    Class to represent a user group in the document management system
    SeedDMS_Core_KeywordCategory
    Class to represent a keyword category in the document management system
    SeedDMS_Core_Notification
    Class to represent a notification
    SeedDMS_Core_Object
    Class to represent a generic object in the document management system
    SeedDMS_Core_Storage_File
    Class with operations to put documents into the storage
    SeedDMS_Core_User
    Class to represent a user in the document management system
    SeedDMS_Core_Workflow
    Class to represent an workflow in the document management system
    SeedDMS_Core_Workflow_State
    Class to represent a workflow state in the document management system
    SeedDMS_Core_Workflow_Action
    Class to represent a workflow action in the document management system
    SeedDMS_Core_Workflow_Transition
    Class to represent a workflow transition in the document management system
    SeedDMS_Core_Workflow_Transition_User
    Class to represent a user allowed to trigger a workflow transition
    SeedDMS_Core_Workflow_Transition_Group
    Class to represent a group allowed to trigger a workflow transition
    SeedDMS_Core_Workflow_Log
    Class to represent a group allowed to trigger a workflow transition
    SeedDMS_Core_DatabaseAccess
    Class to represent the database access for the document management This class uses PDO for the actual database access.
    SeedDMS_Core_File
    Class with file operations in the document management system

    Constants

    M_ALL  = 4
    Unrestricted access
    M_ANY  = -1
    Used to indicate that a search should return all results in the ACL table. See {@link SeedDMS_Core_Folder::getAccessList()}
    M_HIGHEST_RIGHT  = 4
    Highest access right
    M_LOWEST_RIGHT  = 1
    Lowest access right
    M_NONE  = 1
    No access at all
    M_READ  = 2
    Read access only
    M_READWRITE  = 3
    Read and write access only
    N_ADD_DOCUMENT  = 6
    Notify when version of document was deleted
    N_ALL  = 0
    Notify on all actions on the folder/document
    N_DELETE  = 1
    Notify when object has been deleted
    N_DELETE_VERSION  = 5
    Notify when version of document was deleted
    N_MOVE  = 2
    Notify when object has been moved
    N_NEW_VERSION  = 4
    Notify when document has new version
    N_UPDATE  = 3
    Notify when object has been updated (no new version)
    O_EQ  = "="
    Operation equal
    O_GTEQ  = ">="
    Operation greater than or equal
    O_LTEQ  = "<="
    Operation lower than or equal
    S_DRAFT_APP  = 1
    S_DRAFT_REV  = 0
    The different states a document can be in
    S_EXPIRED  = -3
    S_HIGHEST_STATUS  = 3
    S_IN_WORKFLOW  = 3
    S_LOG_ACCEPTED  = 1
    S_LOG_REJECTED  = -1
    S_LOG_SLEEPING  = -3
    S_LOG_USER_REMOVED  = -2
    S_LOG_WAITING  = 0
    The different states a workflow log can be in. This is used in all tables tblDocumentXXXLog
    S_LOWEST_STATUS  = -3
    S_OBSOLETE  = -2
    S_REJECTED  = -1
    S_RELEASED  = 2
    T_DOCUMENT  = 2
    Document notification
    T_FOLDER  = 1
    Folder notification

    Constants

    M_ANY

    Used to indicate that a search should return all results in the ACL table. See {@link SeedDMS_Core_Folder::getAccessList()}

    public mixed M_ANY = -1

    M_HIGHEST_RIGHT

    Highest access right

    public mixed M_HIGHEST_RIGHT = 4

    N_ADD_DOCUMENT

    Notify when version of document was deleted

    public mixed N_ADD_DOCUMENT = 6

    N_ALL

    Notify on all actions on the folder/document

    public mixed N_ALL = 0

    N_DELETE

    Notify when object has been deleted

    public mixed N_DELETE = 1

    N_DELETE_VERSION

    Notify when version of document was deleted

    public mixed N_DELETE_VERSION = 5

    N_NEW_VERSION

    Notify when document has new version

    public mixed N_NEW_VERSION = 4

    N_UPDATE

    Notify when object has been updated (no new version)

    public mixed N_UPDATE = 3

    S_DRAFT_REV

    The different states a document can be in

    public mixed S_DRAFT_REV = 0

    S_LOG_WAITING

    The different states a workflow log can be in. This is used in all tables tblDocumentXXXLog

    public mixed S_LOG_WAITING = 0 
    
                  
    
                  
                
    
              
    

              
            
    
          
    
          
    
            
    
              On this page

              
            
    
          
    
        
    
        
    
          
    
            
    
              
    
                Search results