The majority of the forum module code is located here.
Classes
| Class | Description | |
|---|---|---|
| ACPLoader |
This is the control that loads all admin control panel sub-controls and the acp menu. (ie. it is the acp host)
| |
| AnswerController |
Communicates with the data store via the DAL for the Forum_Polls_Answers Answer items.
| |
| AnswerInfo |
All properties associated with the Forum_Polls_Answers table.
| |
| AttachmentController |
CRUD (and all db methods) Attachment Methods
| |
| AttachmentInfo |
A single instance of the AttachmentInfo Object.
| |
| AvatarControl |
A re-usable control for handling the various avatar types in the forum module.
| |
| BookmarkController |
Communicates with the Forum_Bookmarks table in the data store.
| |
| CleanupEmailQueuedTasks |
This is the Email Queue Task handler. It is designed to allow email notifications to be
sent using a background thread and to not worry about the ASP.NET default limitation of 25
threads since only one will be spawned to handle this.
This is all methods necessary to use the core Scheduler for tasks.
| |
| CompareForumPermissions |
Compares two sets of forum permission collections.
| |
| Configuration |
This houses all the configuration items for use through this entire module.
Most of these are module settings.
| |
| Constants |
This class contains a set of constants used throughout the module. THese are generally divided into two groups: Settings (for module settings) and misc. items.
| |
| Container |
Loads the proper control to display to the end user based on various parameters and settings.
| |
| Content |
This class handles all core content item integration methods. This is abstracted to create a centralized spot within the module to manage it's own content items.
| |
| ContentRemoved |
This is a page to handle if a thread was completely deleted.
It presents the user w/ an error message and a link back home
| |
| DataProvider |
The abstract provider class for the Forum module.
| |
| DNNForum |
This is initialized by the Forum_Container (dispatch).
| |
| EmailQueueTaskController |
Permits access to the data store for EmailQueueTask items.
| |
| EmailQueueTaskEmailsController |
Interacts w/ the data store for the outgoing emails for a task.
| |
| EmailQueueTaskEmailsInfo |
The EmailQueueTaskEmailsInfo represents an email queue task email item
| |
| EmailQueueTaskInfo |
The EmailItemInfo represents an Email Queue Task info Item
| |
| EmailTemplateController |
Used to communicate with the data store for access to Email templates.
| |
| EmailTemplateInfo |
An instance of the ForumEmailTemplateInfo object. This object is used for all email templates.
| |
| FilterWordCollection |
A collection of words to filter for and their replacements.
| |
| FilterWordInfo |
All properties associated with the Forum_FilterWords Word items.
| |
| ForumBaseControl |
Gets/Sets all the properties we need to use in the various forum views
which are loaded via the dispatch (Forum_Container) control.
| |
| ForumBaseObject |
The base object is responsible for common methods used to build the forum UI in vb code including:
ForumPost, ForumThread, ForumGroup, ForumThreadSearch, ForumPortalSearch, ForumModerate
| |
| ForumController |
Used to communicate with the data store about Forum specific items.
| |
| ForumEmail |
Constructs an outgoing email for all types of email communication.
| |
| ForumEmailDistributionController |
Communicates w/ the data store to retrieve a distribution arraylist of recipients for an outgoing email.
| |
| ForumEmailDistributionInfo |
Used for determing who to send an email to.
| |
| ForumInfo |
The forum Info object uses caching and handles the population of all
data specific to a single forum instance. Rendering for Group view
items is also handled here.
| |
| ForumKeywordController |
Connects the business layer to the data layer for forum Keywords (used for template parsing).
| |
| ForumModuleBase |
This class should be inherited by all controls that are registred as actions in DNN that should inherit PortalModuleBase.
| |
| ForumObject |
Creates an instance of the forum object and reads properties critical to its operation.
| |
| ForumPermissionCollection |
Basically a copy of the core ModulePermissionCollection.
| |
| ForumPermissionController |
Basically a copy of ModulePermissionController. This allows the forum
module ot implement permissions on a per module basis overriding module
permissions. (Only in the sense of further restriction, not less)
| |
| ForumPermissionInfo |
Basically a copy of the core ModulePermissionInfo class.
| |
| ForumPortalSettings |
Simply put, this is called to populate a 'fake' HttpContext object when HttpContext is not available (ie. scheduled tasks).
| |
| ForumPreConfig |
Runs only when a forum module is first placed on a page to set
configuration defaults and to create a new forum group and a new
default forum so user can use immediately
| |
| ForumTemplateController |
Forum Template Controller - These are DeletePost, MoveThread, etc.
| |
| ForumTreeview |
Used to build the DNNTree in User Settings, Search views.
| |
| ForumUserController |
Connector to the data layer for the forum user object
| |
| ForumUserInfo |
Everything necessary for a Forum User, all based on PortalID.
This means a forum user profile is specific to a portal instance.
| |
| GroupController |
CRUD (and all db methods) Group database methods
| |
| GroupInfo |
A single instance of the GroupInfo Object.
| |
| Groups |
This is the initial view seen by the forums module. (Group View)
All rendering is done in code to create UI or code is called from here (in utilities, for example).
| |
| KeywordInfo |
Keyword Info Object is used for retrieving what keywords to parse for based on content type
| |
| MCPLoader |
This is the control that loads all moderator control panel sub-controls and mcp menu. (ie. it is the mcp host)
| |
| ModuleSecurity |
The central class where all non-core security related checks should be done.
| |
| ModuleSettings |
The Settings ModuleSettingsBase is used to manage the
settings for the Forum Module. You only store settings here that you want to allow
to be changeable at the page level. This means you can copy existing versions of the module
based on (ModuleID) and display things different based on the page settings for this ModuleID.
| |
| PermissionInfo |
Basically a copy of core PermissionInfo
| |
| PollController |
Communicates with the Forum_Polls_Polls table in the data store.
| |
| PollInfo |
All properties associated with the Forum_Polls_Polls table in the data store.
| |
| PostConnector |
The purpose of the PostConnector class is to have a centralized spot where multiple areas within the Forum Module can post to the database. This also is abstracted so third party providers, such as metaPost, can easily post messages. This also paves the way for Quick Reply as well as SMTP replies.
| |
| PostController |
Communicates with the Forum_Posts table in the data store.
| |
| PostDelete |
All post deletes are done from this page.
| |
| PostEdit |
This is where all posts are added and/or edited from. It also fires off
email notification and factors in moderation.
| |
| PostInfo |
Creates an instance of the post info object
| |
| PostModerate |
This is the moderation queue page for a specific Forum.
| |
| PostModerationController |
Handles all database calls for moderator auditing and for tasks specific to a moderator
This does not include post moderation actions where posts are actually approved/rejected, etc.
just the auditing of those functions (database tracking)
| |
| PostReport |
Post abuse reporting is done from this screen.
| |
| PostReportedController |
Communicates with the Forum_Post_Reported table in the data store.
| |
| PostReportedInfo |
Constructs PostReported object based on the Forum_Post_Reported table, focusing on the posts.
| |
| Posts |
Renders the Posts view UI.
| |
| PostSearchInfo |
All properties associated with the Forum_Posts and Forum_Threads table that are used in ISearchable implementation.
| |
| PublicProfile |
This control now servers as a placeholder to redirect users to the core profile page (available in 5.3 and greater).
| |
| ReportedUserController |
Properties associated with reported forum users. This is a combination of the Forum_Users table as well as the Forum_Post_Reported table.
| |
| ReportedUserInfo |
Constructs PostReported object based on the Forum_Post_Reported table, focusing on the users.
| |
| RoleAvatarController |
CRUD (and all db methods) RoleAvatar Methods
| |
| RoleAvatarInfo |
A single instance of the RoleAvatarInfo Object.
| |
| Rss |
Used for all Forum RSS Feeds.
| |
| RssDocument |
Used to create RSS Feeds for forums.
| |
| SearchController |
This class connects the search custom business object to the data layer.
| |
| SearchPage |
Gathers search criteria from the end user then uses this to navigate
to the search results page.
| |
| SearchTerms |
A Helper class used to build the post/thread search self contained within the module. This is also the basis for "My Posts".
| |
| SqlDataProvider |
The Microsoft SQL specific provider to allow Forum module to communicate with a data store (ie. a concrete provider).
| |
| StartEmailQueuedTasks |
This is the Email Queue Task handler. It is designed to allow email notifications to be
sent using a background thread and to not worry about the ASP.NET default limitation of 25
threads since only one will be spawned to handle this.
This is all methods necessary to use the core Scheduler for tasks.
| |
| TemplateInfo |
An instance of the ForumTemplateInfo object. This object is used for all non-email templates.
| |
| Terms |
This class is used for managing taxonomy/folksonomy related terms via integration with the core.
| |
| ThreadController |
The ThreadController class includes the option interfaces such as ISearchable, IUpgradeable
in addition to the standard Get, GetAll, Update, Delete items to hook into the DAL
| |
| ThreadInfo |
An instance of the Thread object, based on the Forum_Threads and Forum_Posts tables.
| |
| ThreadMove |
Allows a moderator/admin to move a thread to a new forum.
| |
| ThreadRateInfo |
All properties associated with the Forum_ThreadRating table in the data store.
| |
| Threads |
This renders the threads view (second view in hierarchy of forum)
| |
| ThreadSearch |
This renders the search results view (similar to thread view - only reachable from modules search, user profile, or my settings)
| |
| ThreadSearchInfo |
All properites associated with the Forum_Threads and Forum_Posts tables exposed to module's search
| |
| ThreadSplit |
Allows a moderator/admin to move a thread to a new forum.
| |
| TrackingController |
This is what gets/sets the forum/thread notification options for subscriptions.
| |
| TrackingInfo |
Tracking info object.
| |
| UCPLoader |
This is the control that loads all user control panel sub-controls and ucp menu. (ie. it is the ucp host)
| |
| Unread |
This renders a list of threads containing unread posts (similar to threads view and aggregated view).
| |
| UserAnswerController |
Communicates with the Forum_Polls_UserAnswers table in the data store.
| |
| UserAnswerInfo |
All properties associated with the Forum_Polls_UserAnswers table in the data store.
| |
| UserForumsController |
Communicates with the Forum_UserForums table in the data store.
| |
| UserForumsInfo |
Represents single row of data for a userid/forumid read combination.
| |
| UserThreadsController |
Hanldes the Thread read status for a single user instance.
| |
| UserThreadsInfo |
Creates a custom business object that represents one row of data from the Forum_UserThreads table.
| |
| UserTrackingController |
Used to retrieve email subscribers for both the forum and the thread level subscriptions. Only used for displaying information.
| |
| UserTrackingInfo |
Properties associated with email subscribers, mainly pulled from TrackedForums and TrackedThreads tables.
| |
| WordFilterController |
Communicates with the Forum_WordFilter table in the data store.
|
Structures
| Structure | Description | |
|---|---|---|
| RssDocument..::..RssChannel |
RssChannel represents a ForumID.
| |
| RssDocument..::..RssItem |
RssItem represents a PostID.
| |
| SearchTerms..::..SearchTerm |
SearchTerms represent logic used to build the comparative parts of an SQL query.
|
Interfaces
| Interface | Description | |
|---|---|---|
| IEmailQueueable |
Interface used for consumption of modules wishing to schedule emails sends.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| AdminAjaxControl |
The various controls that are loaded into the ACP via Ajax.
| |
| AvatarControlType |
The various avatar types are handled differently so we need this variable to determine how the control behaves.
| |
| CompareOperator |
The compare operator is used for building dynamic SQL for search
| |
| EmailQueueTaskInfo..::..EnumEmailQueueTaskPriority |
This determines the priority of the sending queue items.
Logic is used in the sproc to retrieve what task to queue and send next based on the combination of priority here and the date created along w/ scheduled start date.
| |
| ForumBehavior |
Determines how a forum will behave in terms of viewing and post restrictions. Also includes if a forum is moderated or unmoderated.
| |
| ForumContentTypeID |
ForumContentType is used for determining which type of keywords should be retrieved from the database. These are used for showing what options are available to be rendered during parsing
| |
| ForumDisplayName |
The options available for how the user's name is displayed throughout the module.
| |
| ForumEmailType |
These are the various email template types available for parsing (if active) used in notification emails.
| |
| ForumPage |
This enum represents the available forum control views. All Container named ones load in the Forum_Container.ascx dynamically
| |
| ForumScope |
ForumScope is used for controlling which class to instantiate in the Forum_Container.ascx dispatch page.
| |
| ForumTemplateTypes |
These are the various template types used in this module. This is only partially implemented/active.
| |
| ForumTreeview..::..eImageType |
The image type to use to represent the various levels in the treeview.
| |
| ForumType |
Options for how a forum behaves. Notifications forums are forced subscriptions. Link forums are just links, no actual forum inside.
| |
| ModerateAction |
Determines the type of action the moderator is performing.
| |
| ModeratorAjaxControl |
The various controls that are loaded into the MCP via Ajax.
| |
| PermissionKeys |
The permission keys used for the module level permissions (ie. module settings).
| |
| PostAction |
The PostAction determines how a post is initially loaded in post edit and what other items to display in that screen. It also determines which sproc is called when submitting.
| |
| PosterRank |
The different levels of user post rankings, this is determined on a per portal basis by post count and settings (if enabled)
| |
| PostMessage |
Provides the status of an attempted post.
| |
| ShowPosterLocation |
Options available for displaying poster's location in each post.
| |
| ThreadStatus |
The different levels of forum thread status available to end users (if settings is enabled)
| |
| UserAjaxControl |
The various controls that are loaded into the UCP via Ajax.
| |
| UserAvatarType |
The type of user avatar being used.
|