ForumPostInfoProvider Class

Class providing ForumPostInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<ForumPostInfoProvider>
        CMS.DataEngine.AbstractInfoProvider<ForumPostInfo, ForumPostInfoProvider, ObjectQuery<ForumPostInfo>>
          CMS.DataEngine.AbstractInfoProvider<ForumPostInfo, ForumPostInfoProvider>
            CMS.Forums.ForumPostInfoProvider

Namespace: CMS.Forums
Assembly: CMS.Forums (in CMS.Forums.dll) Version: 9.0.0

Syntax

public class ForumPostInfoProvider : AbstractInfoProvider<ForumPostInfo, ForumPostInfoProvider>

The ForumPostInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	ForumPostInfoProvider

Fields

	Name	Description
Protected field	hashtableLock	Table lock for loading hashtables (Inherited from BaseAbstractInfoProvider.)
Protected field	infos	Info tables. (Inherited from BaseAbstractInfoProvider.)

Properties

	Name	Description
Protected property	DataSource	Data source for the provider (Inherited from BaseAbstractInfoProvider.)
Public property Static member	ForumPostIdLength	Post ID Path length. Default = 8 '00000001/000000001'
Public property	HashtableSettings	Hashtable settings (Inherited from BaseAbstractInfoProvider.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	InfoType	Returns the type of the info object for this provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsDataAvailable	Returns true if the data is available for this provider (Inherited from BaseAbstractInfoProvider.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Public property Static member	MaxPostLevel	Returns maximal available post level.
Protected property	ProviderName	Provider name (Inherited from BaseAbstractInfoProvider.)
Public property	StoreEmptyValuesInHashtables	If true, provider hashtables store empty values for not found objects to reduce database calls (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)

Methods

	Name	Description
Public method	AddSiteWhereCondition(String, Int32, String, Boolean)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	AddSiteWhereCondition(String, Int32, String, Boolean, String)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ApplySource<TQuery>	If the provider has a data source specified, applies this source to the given query. Returns the modified query. (Inherited from BaseAbstractInfoProvider.)
Protected method	BoundGetInfoByGuid(Guid)	Gets the info object by its GUID (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info object by its GUID and site ID (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoById	Gets the info by ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String)	Gets the info object by its code name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfoByName(String, Int32)	Gets the info object by its code name and site Id (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	BoundGetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clear hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateHashtables	Creates the provider hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(Int32)	Creates an instance of info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo(DataRow, Boolean)	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Protected method	DeleteData(Action<TQuery>)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteData(String)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteData(IWhereCondition)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteForumPostInfo(Int32)	Deletes specified forumPost.
Public method Static member	DeleteForumPostInfo(ForumPostInfo)	Deletes specified forumPost.
Protected method	DeleteForumPostInfoInternal	Deletes specified forumPost.
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	FilterSearchResults(ISearchDocument)	Returns '0' if current user is authorized to view current search document.
Public method Static member	FilterSearchResults(ISearchDocument, UserInfo)	Returns '0' if specified user is authorized to view current search document.
Public method	GetBindingWhereCondition(String, Int32)	Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetBindingWhereCondition(String, Object[])	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCacheDependency(DataSet, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetCacheDependency(BaseInfo, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetCompleteWhere	Creates complete where condition from parameters.
Protected method	GetCountInternal	Gets the number of items matching the given parameters. Does not check the license when retrieving data. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByColumn<T>	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByGuidColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByIntColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDataByStringColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(DataSet, String, String)	Gets the cache dependency keys for the given DataSet. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetDependencyCacheKeys(GeneralizedInfo, String, String)	Gets the cache dependency keys for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetDocumentPosts	Returns forum posts for specified document
Protected method	GetEmptyDataSet	Gets the empty data set to be filled by the data (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetExistingIDsInternal	Filters out all object IDs that do not exist in the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetForumPostInfo	Returns the ForumPostInfo structure for the specified forumPost.
Public method Static member	GetForumPostInfoByGUID	Returns object with specified GUID.
Protected method	GetForumPostInfoInternal(Guid)	Returns object with specified GUID.
Protected method	GetForumPostInfoInternal(Int32)	Returns the ForumPostInfo structure for the specified forumPost.
Public method Static member	GetForumPosts()	Gets all forum posts as object query
Public method Static member	GetForumPosts(String, String, Int32, String)	Returns forum post DataSet.
Protected method	GetForumPostsInternal	Returns forum post DataSet.
Protected method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetChildPosts	Returns all the child posts of the post.
Protected method	GetChildPostsInternal	Returns all the child posts of the post.
Protected method	GetInfo(Action<TQuery>)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(IWhereCondition)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfo(String, String)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameFromDB	Gets an instance of info object based on the given code name from database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName(String)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName(String, Boolean)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullNameInternal	Gets the info by its full name from the database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidFromDB	Gets an instance of info object based on the given GUID from database (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById(Int32)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById(Int32, Boolean)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIntColumn	Gets an instance of info object based on the integer column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByStringColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetParentWhereCondition	Gets the where condition to limit the objects to specific parent. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetPath	Returns PostIdPath in correct format.
Public method Static member	GetPostRootFromIDPath	Returns root post ID for given PostIDPath.
Public method Static member	GetPostURL	Returns link to selected post.
Protected method	GetSingleObject	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition(Int32)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition(Int32, Boolean)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetTypeInfo	Gets the type info for this provider (Inherited from BaseAbstractInfoProvider.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	IncrementPostViews	Increments the post views with the specified number.
Protected method	IncrementPostViewsInternal	Increments the post views with the specified number.
Protected method	Init	Initializes the provider variables. (Inherited from BaseAbstractInfoProvider.)
Protected method	InitHashtables	Initializes the hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadGeneration	Loads the specified generation of the objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadObjectsToHashtables	Loads the objects from a DataSet to the hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveStickyThreadDown	Moves sticky thread down.
Protected method	MoveStickyThreadDownInternal	Moves sticky thread down.
Public method Static member	MoveStickyThreadUp	Moves sticky thread up.
Protected method	MoveStickyThreadUpInternal	Moves sticky thread up.
Public method Static member	MoveThread	Moves the thread to other forum.
Protected method	MoveThreadInternal	Moves the thread to other forum.
Public method	NewTransaction	Creates a new transaction over this provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from BaseAbstractInfoProvider.)
Protected method	RecalculateData	Recalculates the value in the given column using the coefficient. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects. (Inherited from BaseAbstractInfoProvider.)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ReplaceData	Obsolete. Replaces the data in the given columns. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ResetToDefault	Resets the provider to default implementation (Inherited from AbstractInfoProvider<TProvider>.)
Public method Static member	Search	Returns post, forum, forum group joined tables with dependence on.
Protected method	SearchInternal	Returns post, forum, forum group joined tables with dependence on.
Public method Static member	SelectForumPosts(Int32, String)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String, String)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(String, String, Int32, String)	Returns the DataSet of forum posts joined with user, user settings and other tables.
Public method Static member	SelectForumPosts(Int32, String, String, String, Int32)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String, String, Int32, Boolean)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String, String, Int32, Boolean, Int32)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String, String, Int32, Boolean, Int32, String)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SelectForumPosts(Int32, String, String, String, Int32, Boolean, Int32, String, Int32, Int32, Int32)	Returns the DataSet of forum posts in specified subtree of forum posts.
Protected method	SelectForumPostsInternal(String, String, Int32, String)	Returns the DataSet of forum posts joined with user, user settings and other tables.
Protected method	SelectForumPostsInternal(Int32, String, String, String, Int32, Boolean, Int32, String, Int32, Int32, Int32)	Returns the DataSet of forum posts in specified subtree of forum posts.
Public method Static member	SendModeratorsEmail(Int32)	Send e-mail to moderators.
Public method Static member	SendModeratorsEmail(Int32, String, String)	Send e-mail to moderators.
Public method Static member	SendPostEmails(Int32)	Sends the new post acknowledgement to the users subscribed to the forum or forum thread where the post has been inserted.
Public method Static member	SendPostEmails(Int32, String, String)	Sends the new post acknowledgement to the users subscribed to the forum or forum thread where the post has been inserted.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TProvider>.)
Public method Static member	SetForumPostInfo(ForumPostInfo)	Sets (updates or inserts) specified forumPost.
Public method Static member	SetForumPostInfo(ForumPostInfo, String, String)	Sets (updates or inserts) specified forumPost.
Protected method	SetForumPostInfoInternal	Sets (updates or inserts) specified forumPost.
Protected method	SetInfo	Override to ensure SiteID is set (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public method	SortAlphabetically	Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SplitThread	Creates new thread from the given post.
Protected method	SplitThreadInternal	Creates new thread from the given post.
Public method Static member	StickThread	Stick thread.
Protected method	StickThreadInternal	Stick thread.
Protected method	TouchCacheDependencies	Touches the cache dependencies of the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UnstickThread	Stick thread.
Protected method	UnstickThreadInternal	Stick thread.
Public method Static member	UpdateCounts	Update thread and child-posts counts of specified post.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UpdatePostAttachmentCount	Counts number of attachments of post specified by postID and saves it into database.
Protected method	UpdatePostAttachmentCountInternal	Counts number of attachments of post specified by postID and saves it into database.
Public method Static member	UpdatePostCounts	Update direct-child-posts counts of specified post.
Protected method	UpdatePostCountsInternal	Update direct-child-posts counts of specified post.
Public method Static member	UpdateThreadCounts	Update thread sub-posts counts and last post information.
Protected method	UpdateThreadCountsInternal	Update thread sub-posts counts and last post information.
Public method	UseSource(TInfo[])	Sets the provider to use given data as data source (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	UseSource(DataQuerySource)	Sets the provider to use given data as data source (Inherited from BaseAbstractInfoProvider.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)