dmBridge PHP API
Data Structures
Here are the data structures with brief descriptions:
CustomAuthenticationService
DMAbstractAuthenticationService
DMAbstractControllerA generic controller superclass from which all other controllers inherit
DMAbstractDataStoreQueryAbstract superclass inherited by queries that query a data store
DMAbstractDMBridgeModuleAn abstract main module class from which all dmBridge modules should inherit
DMAbstractForm
DMAbstractFormFieldAbstract base class for class representations of HTML form elements
DMAbstractQuery
DMAbstractRepresentationTransformer
DMAbstractSocialDataQueryAn abstract query from which all social data queries inherit
DMAbstractSocialEntityBase class from which social data classes inherit
DMAbstractTemplateHelper
DMAbstractView
DMAbstractViewerAn abstract object viewer class that all object viewer classes, whether built-in or custom-written, should extend
DMAPICollectionController
DMAPICommentController
DMAPIDocumentationController
DMAPIObjectController
DMAPISchemaControllerServes HTTP API XML schemas
DMAPIStatusController
DMAPITagController
DMAPIVocabularyControllerHandles vocabulary suggestions and frequency mappings
DMAtomRepresentationTransformer
DMAuthenticationService
DMAuthenticationServiceFactory
DMBridgeComponentAn enum-like class
DMBridgeControlPanelModule
DMBridgeDataStoreModule
DMBridgeModuleBase interface for dmBridge modules
DMBridgeRepresentationSchemaModule
DMBridgeTemplateHelperModule
DMBridgeVersion
DMCdmAuthenticationServiceAuthenticates DMUser objects against CONTENTdm(R) and sets the necessary cookie which authorizes them in the CONTENTdm(R) system
DMCheckboxFieldEncapsulates an HTML <input type="checkbox"> element
DMClassNotFoundException
DMCollectionEncapsulates a CONTENTdm(R) collection
DMCollectionFactory
DMCommentRepresents a user comment on an object
DMCommentQueryEncapsulates a query for comments
DMConfigIniManages all configuration operations involving the config.ini file
DMConfigXMLManages all configuration operations involving the config.xml file
DMConstraintException
DMControlPanelTemplateHelper
DMControlPanelView
DMCPAdminController
DMCPBasicController
DMCPBasicSettingsForm
DMCPCollectionController
DMCPCommentController
DMCPCommentSettingsForm
DMCPCQRController
DMCPEditCollectionForm
DMCPFeedController
DMCPFeedSettingsForm
DMCPMenuItemA menu item is a single textual hyperlink within a menu section, represented by DMCPMenuSection
DMCPMenuSectionA menu section contains one or more menu items, represented by DMCPMenuItem
DMCPModuleController
DMCPRatingController
DMCPRatingSettingsForm
DMCPReferenceURLController
DMCPTagController
DMCPTagSettingsForm
DMCPTemplateController
DMCPTemplateSetForm
DMCustomTemplateHelper
DMDataStore
DMDataStoreException
DMDataStoreFactoryAbstracts the data store
DMDataStoreQuery
DMDataStoreTypeAn enum-like class
DMDateTimeA custom date class that extends PHP's built-in DateTime class
DMDCElementEncapsulates a Dublin Core metadata element
DMDOMDocumentOverrides the saveHTML() method to prevent it from outputting enclosing html and body tags
DMEmailMessage
DMErrorException
DMException
DMExternalViewEncapsulates a view not within the HTML templates, as in the case of e.g
DMFacetTermEncapsulates a CONTENTdm(R) facet term, which has field nick, label, and value properties
DMFavoriteQueryEncapsulates a query for objects from a user's favorites
DMFavoritesTemplateHelper
DMFavoritesView
DMFeedRepresentationTransformer
DMFile
DMFileLinkViewerOutputs an anchor (<a>) tag to download an object's file
DMFileNotFoundException
DMFlashEncapsulates a temporary status message that is generated in response to some state-changing action on the server
DMFormField
DMFormFieldTypeAn enum-like class
DMGenericImageViewerOutputs an image (<img>) tag with the URL of the object's image embedded in the src attribute
DMGenericObjectViewerA general-purpose object viewer that outputs the URL of the file of the current in an <object> tag
DMGenericPDFViewer
DMGenericTemplateHelper
DMHiddenField
DMHTTPAPIRepresentationTransformerInterface to be implemented by all "representation transformers," which are classes that transform input into a given HTTP representation
DMHTTPClient
DMHTTPMessageAbstract class from which requests and responses inherit
DMHTTPMethodAn enum-like class encapsulating the available methods in HTTP 1.0/1.1
DMHTTPRepresentation
DMHTTPRequestEncapsulates an HTTP request
DMHTTPResponseEncapsulates an HTTP response
DMHTTPResponseFactory
DMIllegalArgumentException
DMInputTakes in user input via the URI query string and makes it available via convenient accessors
DMInternalErrorException
DMInternalURI
DMInternalView
DMIntroControllerA generic controller superclass from which all other controllers inherit
DMInvalidEmailException
DMInvalidRouteException
DMIOException
DMJSONPRepresentationTransformerV1
DMJSONRepresentationTransformer
DMJSONRepresentationTransformerV1
DMLanguage
DMLocalizedStringStatic class providing access to localized strings
DMLogEntryGeneric log entry class
DMLoggableAn interface to be implemented by anything that is going to get logged to the system log
DMLoggerLogs DMLoggables to the system log
DMLoginView
DMMailable
DMMailerEmails DMMailable objects
DMMediaTypeEncapsulates an RFC 2046 Internet media type, a.k.a
DMModel
DMModuleActivationExceptionManages all configuration operations involving the config.xml file
DMModuleManager
DMMonocle2Viewer
DMMonocleViewer
DMMySQLDataStoreAn instance of this class will be returned by DMDataStoreFactory::getDataStore() when pdo_mysql is the current data store
DMNewsItemRepresents a news item on the dmBridge blog
DMNoSuchFieldException
DMNoSuchMethodException
DMNullViewerA special viewer that is used automatically when there is an error using a normal viewer, such as in a file-not-found circumstance
DMObjectModels a real-world CONTENTdm(R) object (item) - not a PHP object
DMObjectCommentForm
DMObjectFactory
DMObjectQueryEncapsulates a CONTENTdm(R) search query
DMObjectResultsTemplateHelper
DMObjectResultsViewEncapsulates "compound object results view" within the HTML templates
DMObjectTemplateHelper
DMObjectViewEncapsulates "object view" within the HTML templates
DMObjectViewerDefinitionDefines the association between a media type and a dmBridge object viewer class
DMObjectViewerDelegateAn object viewer interface that all object viewer classes, whether built-in or custom, are required to implement
DMObjectViewerDelegateManagerProvides access to the list of known viewer delegates
DMPaginatedPDFViewer
DMPasswordFieldEncapsulates an HTML <input type="password"> element
DMPDFFile
DMPDODataStoreAn instance of this class will be returned by DMDataStoreFactory::getDataStore() when PDO is the current data store
DMPDOException
DMQueryA generic query interface that all queries should implement
DMQueryPredicateAn object encapsulation of the dmQuery() $searchstring parameter (see the CONTENTdm(R) API documentation)
DMQuickTimeViewerOutputs an <object> tag suitable for embedding QuickTime audio/video in a web page
DMRadioFieldEncapsulates an HTML <input type="radio"> element
DMRatingRepresents an individual rating that a user has given to an object
DMResultsTemplateHelper
DMResultsViewEncapsulates "results view" within the HTML templates
DMRouteMaps an incoming HTTP request to actionable information (controller, method, method parameters, etc.) in the Front Controller pattern
DMSearchTemplateHelper
DMSearchView
DMSecurityException
DMSelectFieldEncapsulates an HTML <select> element
DMSessionEncapsulates a session associated with an incoming HTTP request
DMShellCommand
DMSitemapRepresentationTransformer
DMSocialEntity
DMSQLiteDataStoreAn instance of this class will be returned by DMDataStoreFactory::getDataStore() when pdo_sqlite is the current data store
DMStringA collection of static string validation & manipulation methods
DMSystemErrorTemplateHelper
DMSystemErrorViewEncapsulates "error view" within the HTML templates
DMTagRepresents a tag that a user has given to an object
DMTagForm
DMTagQueryEncapsulates a query for tags
DMTEFavoriteControllerController for "favorites view" in the template engine
DMTemplateEncapsulates an HTML template file within a template set
DMTemplateEngineView
DMTemplateHelperInterface to be implemented by all template helper classes, whether built-in or provided by modules
DMTemplateSet
DMTEObjectControllerController for "object view" in the template engine
DMTESearchControllerController for the search form in the template engine
DMTESitemapControllerController for XML Sitemaps in the template engine
DMTEUserControllerController for user login/logout functionality in the template engine
DMTextareaFieldEncapsulates an HTML <textarea> element
DMTextFieldEncapsulates an HTML <input type="text"> field
DMUnavailableModelException
DMUpdateManagerUsed for remote version checking
DMURI
DMURIAddressableEncapsulates a URI-addressable resource
DMUser
DMXMLRepresentationTransformer
DMXMLRepresentationTransformerV1
SampleCustomViewerThis is a sample custom viewer
SampleModuleWelcome to the simplest possible dmBridge module!
SampleTemplateHelperThis is a sample template helper
UNLVHighlightThe main module class
UNLVHighlightAddForm
UNLVHighlightController
UNLVHighlightCPController
UNLVHighlightDataStore
UNLVHighlightDataStoreFactory
UNLVHighlightedObjectA convenient place to access the random object
UNLVHighlightGenericDataStoreA "generic" data store class that returns some generic, cross-DBMS-compatible SQL commands
UNLVHighlightMySQLDataStore
UNLVHighlightSQLiteDataStore
UNLVRandomThe main module class
UNLVRandomAddForm
UNLVRandomControllerUsed in the context of the HTTP API
UNLVRandomCPController
UNLVRandomDataStore
UNLVRandomDataStoreFactory
UNLVRandomMySQLDataStore
UNLVRandomObjectA convenient place to access the random object
UNLVRandomSQLiteDataStore
UNLVSpatialThe main module class
UNLVSpatialAbstractSpatialObject
UNLVSpatialControllerUsed in the context of the HTTP API
UNLVSpatialCPControllerUsed in the context of the Control Panel
UNLVSpatialGenericDataStoreA "generic" data store class that returns some generic, cross-DBMS-compatible SQL commands
UNLVSpatialIndexer
UNLVSpatialJSONPRepresentationV1
UNLVSpatialJSONRepresentationV1
UNLVSpatialMySQLDataStore
UNLVSpatialObject
UNLVSpatialObjectFactory
UNLVSpatialPointObject
UNLVSpatialQuery
UNLVSpatialQueryTermA query term which is mostly query-by-example
UNLVSpatialRectObject
UNLVSpatialSQLiteDataStore
UNLVSpatialTemplateHelperThese template helpers use version 3 of the Google Maps API
UNLVSpatialXMLRepresentationV1
 All Data Structures Functions Variables