• Home
• Engage
• Dnn
• Publish
• Item

C# Class Engage.Dnn.Publish.Item

Show file Open project: EngageSoftware/Engage-Publish

Private Properties

Property	Type	Description
DeleteItem	void
GetAnyPublishModule	DotNetNuke.Entities.Modules.ModuleInfo
GetApprovalStatusTypeName	string
GetChildren	System.Data.DataSet
GetItemTypes	System.Data.DataTable
GetParentCategoryId	int
MakeUrlAbsolute	string
SendApprovalEmail	void
SendStatusUpdateEmail	void
SendTemplatedEmail	void

Public Methods

Method	Description
AddItem ( IDbTransaction trans, int itemTypeId, int portalId, int moduleId, System.Guid itemIdentifier ) : int
AddItemVersion ( IDbTransaction trans, int itemId, int originalItemVersionId, string name, string description, string startDate, string endDate, int languageId, int authorUserId, string metaKeywords, string metaDescription, string metaTitle, int displayTabId, bool disabled, string thumbnail, System.Guid itemVersionIdentifier, string url, bool newWindow, int revisingUserId ) : int
AddItemVersion ( int itemId, int originalItemVersionId, string name, string description, string startDate, string endDate, int languageId, int authorUserId, string metaKeywords, string metaDescription, string metaTitle, int displayTabId, bool disabled, string thumbnail, System.Guid itemVersionIdentifier, string url, bool newWindow, int revisingUserId ) : int
AddView ( int userId, int tabId, string ipAddress, string userAgent, string httpReferrer, string siteUrl ) : void
ClearItemsCommentCount ( int portalId ) : void	Clears the comment count on the item table to 0 for all items within a portal
ClearItemsViewCount ( int portalId ) : void	Clears the view count on the item table to 0 for all items within a portal
CorrectDates ( ) : void
DeleteItem ( int itemId, int portalId ) : void
DisplayOnCurrentPage ( ) : bool
DoesItemExist ( string name, int authorUserId ) : bool
DoesItemExist ( string name, int authorUserId, int categoryId ) : bool	Checks to see if an item exists by a specific name, from a specific author, in a specific category.
ForceDisplayOnPage ( ) : bool	Determines whether this Item should be forced to always display on its assigned DisplayTabId, or whether it can display on any tab.
GetAllChildren ( int parentItemId, int relationshipTypeId, int portalId ) : DataSet
GetAllChildren ( int itemTypeId, int parentItemId, int relationshipTypeId, int portalId ) : DataSet
GetAllChildren ( int itemTypeId, int parentItemId, int relationshipTypeId, int otherRelationshipTypeId, int portalId ) : DataSet
GetAllChildrenAsDataReader ( int itemTypeId, int parentItemId, int relationshipTypeId, int otherRelationshipTypeId, int portalId ) : IDataReader
GetItem ( int itemId, int portalId, int itemTypeId, bool isCurrent ) : Item
GetItemIdFromVersion ( int itemVersionId ) : int
GetItemIdFromVersion ( int itemVersionId, int portalId ) : int
GetItemType ( int itemId ) : string
GetItemType ( int itemId, int portalId ) : string
GetItemTypeId ( int itemId ) : int
GetItemTypeId ( int itemId, int portalId ) : int
GetItemTypes ( int portalId ) : DataTable
GetItemVersions ( int itemId, int portalId ) : DataSet
GetItems ( int parentItemId, int portalId, int relationshipTypeId ) : DataSet
GetItems ( int parentItemId, int portalId, int relationshipTypeId, int itemTypeId ) : DataSet
GetItems ( int parentItemId, int portalId, int relationshipTypeId, int otherRelationshipTypeId, int itemTypeId ) : DataSet
GetItems ( int itemTypeId, int portalId ) : IDataReader
GetParentItems ( int itemId, int portalId, int relationshipTypeId ) : DataSet
GetRelatedArticle ( int articlePortalId ) : Article	this is a single article to be displayed as a sub section of a page.
GetRelatedArticles ( int articlePortalId ) : Engage.Dnn.Publish.Article[]	Gets all articles related to this article
IsLinkable ( ) : bool	This method currently verifies that the item is assigned to a display page. Future versions will eliminate this requirement all together but for now this is needed by ItemLink.aspx when linking occurs. This could be used to test other settings to be valid before displaying.
RunPublishStats ( ) : void	Runs the stored procedure to calculate the views and comment counts for all items.
Save ( int revisingUserId ) : void
UpdateApprovalStatus ( ) : void
UpdateDescription ( ) : void
UpdateItem ( IDbTransaction trans, int itemId, int moduleId ) : void
UpdateItemVersion ( IDbTransaction trans, int itemId, int itemVersionId, int approvalStatusId, int userId, string approvalComments ) : void

Protected Methods

Method	Description
Item ( ) : System
LoadItemVersionSettings ( ) : void
LoadRelationships ( ) : void	Loads the ItemRelationships for this Item, clearing any _relationships already in the Item.Relationships collection.
LoadTags ( ) : void	Loads the ItemTags for this Item, clearing any tags already in the Item.Tags collection.
ResolveIds ( int currentModuleId ) : void
SaveInfo ( IDbTransaction trans, int revisingId ) : void
SaveItemVersionSettings ( ) : void
SaveItemVersionSettings ( IDbTransaction trans ) : void
SaveRelationships ( IDbTransaction trans ) : void
SaveTags ( ) : void
SaveTags ( IDbTransaction trans ) : void	if we remove a tag from a version we should decrement the TotalItems for a tag.
UpdateApprovalStatus ( IDbTransaction trans ) : void

Private Methods

Method	Description
DeleteItem ( int itemId ) : void
GetAnyPublishModule ( ) : DotNetNuke.Entities.Modules.ModuleInfo	Gets an instance of Engage: Publish within this item's portal.
GetApprovalStatusTypeName ( ) : string
GetChildren ( int parentItemId, int relationshipTypeId, int portalId ) : DataSet
GetItemTypes ( ) : DataTable
GetParentCategoryId ( ) : int
MakeUrlAbsolute ( string url ) : string	Makes the URL absolute, based on the current request.
SendApprovalEmail ( ) : void	Sends an email to the users in the Utility.PublishEmailNotificationRole indicating that an item was approved.
SendStatusUpdateEmail ( ) : void	Sends an email to the author of an item's version indicating that the version's status changed.
SendTemplatedEmail ( DotNetNuke.Entities.Users.UserInfo revisingUser, IEnumerable emailRecipients, string emailBodyTemplate, string emailSubject ) : void	Sends an email with a templated body to the given recipients' email.

Method Details