C# Class Engage.Dnn.Publish.Item

Summary description for ItemInfo.
Inheritance: Engage.Dnn.Publish.Portability.TransportableElement
Afficher le fichier Open project: EngageSoftware/Engage-Publish

Private Properties

Свойство 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

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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

Méthode 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

AddItem() public static méthode

public static AddItem ( IDbTransaction trans, int itemTypeId, int portalId, int moduleId, System.Guid itemIdentifier ) : int
trans IDbTransaction
itemTypeId int
portalId int
moduleId int
itemIdentifier System.Guid
Résultat int

AddItemVersion() public static méthode

public static 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
trans IDbTransaction
itemId int
originalItemVersionId int
name string
description string
startDate string
endDate string
languageId int
authorUserId int
metaKeywords string
metaDescription string
metaTitle string
displayTabId int
disabled bool
thumbnail string
itemVersionIdentifier System.Guid
url string
newWindow bool
revisingUserId int
Résultat int

AddItemVersion() public static méthode

public static 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
itemId int
originalItemVersionId int
name string
description string
startDate string
endDate string
languageId int
authorUserId int
metaKeywords string
metaDescription string
metaTitle string
displayTabId int
disabled bool
thumbnail string
itemVersionIdentifier System.Guid
url string
newWindow bool
revisingUserId int
Résultat int

AddView() public méthode

public AddView ( int userId, int tabId, string ipAddress, string userAgent, string httpReferrer, string siteUrl ) : void
userId int
tabId int
ipAddress string
userAgent string
httpReferrer string
siteUrl string
Résultat void

ClearItemsCommentCount() public static méthode

Clears the comment count on the item table to 0 for all items within a portal
public static ClearItemsCommentCount ( int portalId ) : void
portalId int The Portal in which the items will be cleared
Résultat void

ClearItemsViewCount() public static méthode

Clears the view count on the item table to 0 for all items within a portal
public static ClearItemsViewCount ( int portalId ) : void
portalId int The Portal in which the items will be cleared
Résultat void

CorrectDates() public méthode

public CorrectDates ( ) : void
Résultat void

DeleteItem() public static méthode

public static DeleteItem ( int itemId, int portalId ) : void
itemId int
portalId int
Résultat void

DisplayOnCurrentPage() public méthode

public DisplayOnCurrentPage ( ) : bool
Résultat bool

DoesItemExist() public static méthode

public static DoesItemExist ( string name, int authorUserId ) : bool
name string
authorUserId int
Résultat bool

DoesItemExist() public static méthode

Checks to see if an item exists by a specific name, from a specific author, in a specific category.
public static DoesItemExist ( string name, int authorUserId, int categoryId ) : bool
name string The name of the item
authorUserId int The ID of the author
categoryId int The ID of the category
Résultat bool

ForceDisplayOnPage() public méthode

Determines whether this Item should be forced to always display on its assigned DisplayTabId, or whether it can display on any tab.
public ForceDisplayOnPage ( ) : bool
Résultat bool

GetAllChildren() public static méthode

public static GetAllChildren ( int parentItemId, int relationshipTypeId, int portalId ) : DataSet
parentItemId int
relationshipTypeId int
portalId int
Résultat System.Data.DataSet

GetAllChildren() public static méthode

public static GetAllChildren ( int itemTypeId, int parentItemId, int relationshipTypeId, int portalId ) : DataSet
itemTypeId int
parentItemId int
relationshipTypeId int
portalId int
Résultat System.Data.DataSet

GetAllChildren() public static méthode

public static GetAllChildren ( int itemTypeId, int parentItemId, int relationshipTypeId, int otherRelationshipTypeId, int portalId ) : DataSet
itemTypeId int
parentItemId int
relationshipTypeId int
otherRelationshipTypeId int
portalId int
Résultat System.Data.DataSet

GetAllChildrenAsDataReader() public static méthode

public static GetAllChildrenAsDataReader ( int itemTypeId, int parentItemId, int relationshipTypeId, int otherRelationshipTypeId, int portalId ) : IDataReader
itemTypeId int
parentItemId int
relationshipTypeId int
otherRelationshipTypeId int
portalId int
Résultat IDataReader

GetItem() public static méthode

public static GetItem ( int itemId, int portalId, int itemTypeId, bool isCurrent ) : Item
itemId int
portalId int
itemTypeId int
isCurrent bool
Résultat Item

GetItemIdFromVersion() public static méthode

public static GetItemIdFromVersion ( int itemVersionId ) : int
itemVersionId int
Résultat int

GetItemIdFromVersion() public static méthode

public static GetItemIdFromVersion ( int itemVersionId, int portalId ) : int
itemVersionId int
portalId int
Résultat int

GetItemType() public static méthode

public static GetItemType ( int itemId ) : string
itemId int
Résultat string

GetItemType() public static méthode

public static GetItemType ( int itemId, int portalId ) : string
itemId int
portalId int
Résultat string

GetItemTypeId() public static méthode

public static GetItemTypeId ( int itemId ) : int
itemId int
Résultat int

GetItemTypeId() public static méthode

public static GetItemTypeId ( int itemId, int portalId ) : int
itemId int
portalId int
Résultat int

GetItemTypes() public static méthode

public static GetItemTypes ( int portalId ) : DataTable
portalId int
Résultat System.Data.DataTable

GetItemVersions() public static méthode

public static GetItemVersions ( int itemId, int portalId ) : DataSet
itemId int
portalId int
Résultat System.Data.DataSet

GetItems() public static méthode

public static GetItems ( int parentItemId, int portalId, int relationshipTypeId ) : DataSet
parentItemId int
portalId int
relationshipTypeId int
Résultat System.Data.DataSet

GetItems() public static méthode

public static GetItems ( int parentItemId, int portalId, int relationshipTypeId, int itemTypeId ) : DataSet
parentItemId int
portalId int
relationshipTypeId int
itemTypeId int
Résultat System.Data.DataSet

GetItems() public static méthode

public static GetItems ( int parentItemId, int portalId, int relationshipTypeId, int otherRelationshipTypeId, int itemTypeId ) : DataSet
parentItemId int
portalId int
relationshipTypeId int
otherRelationshipTypeId int
itemTypeId int
Résultat System.Data.DataSet

GetItems() public static méthode

public static GetItems ( int itemTypeId, int portalId ) : IDataReader
itemTypeId int
portalId int
Résultat IDataReader

GetParentItems() public static méthode

public static GetParentItems ( int itemId, int portalId, int relationshipTypeId ) : DataSet
itemId int
portalId int
relationshipTypeId int
Résultat System.Data.DataSet

GetRelatedArticle() public méthode

this is a single article to be displayed as a sub section of a page.
public GetRelatedArticle ( int articlePortalId ) : Article
articlePortalId int Portal in which the related article lives
Résultat Article

GetRelatedArticles() public méthode

Gets all articles related to this article
public GetRelatedArticles ( int articlePortalId ) : Engage.Dnn.Publish.Article[]
articlePortalId int The Portal in which the related articles live
Résultat Engage.Dnn.Publish.Article[]

IsLinkable() public méthode

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.
public IsLinkable ( ) : bool
Résultat bool

Item() protected méthode

protected Item ( ) : System
Résultat System

LoadItemVersionSettings() protected méthode

protected LoadItemVersionSettings ( ) : void
Résultat void

LoadRelationships() protected méthode

Loads the ItemRelationships for this Item, clearing any _relationships already in the Item.Relationships collection.
protected LoadRelationships ( ) : void
Résultat void

LoadTags() protected méthode

Loads the ItemTags for this Item, clearing any tags already in the Item.Tags collection.
protected LoadTags ( ) : void
Résultat void

ResolveIds() protected méthode

protected ResolveIds ( int currentModuleId ) : void
currentModuleId int
Résultat void

RunPublishStats() public static méthode

Runs the stored procedure to calculate the views and comment counts for all items.
public static RunPublishStats ( ) : void
Résultat void

Save() public abstract méthode

public abstract Save ( int revisingUserId ) : void
revisingUserId int
Résultat void

SaveInfo() protected méthode

protected SaveInfo ( IDbTransaction trans, int revisingId ) : void
trans IDbTransaction
revisingId int
Résultat void

SaveItemVersionSettings() protected méthode

protected SaveItemVersionSettings ( ) : void
Résultat void

SaveItemVersionSettings() protected méthode

protected SaveItemVersionSettings ( IDbTransaction trans ) : void
trans IDbTransaction
Résultat void

SaveRelationships() protected méthode

protected SaveRelationships ( IDbTransaction trans ) : void
trans IDbTransaction
Résultat void

SaveTags() protected méthode

protected SaveTags ( ) : void
Résultat void

SaveTags() protected méthode

if we remove a tag from a version we should decrement the TotalItems for a tag.
protected SaveTags ( IDbTransaction trans ) : void
trans IDbTransaction
Résultat void

UpdateApprovalStatus() public abstract méthode

public abstract UpdateApprovalStatus ( ) : void
Résultat void

UpdateApprovalStatus() protected méthode

protected UpdateApprovalStatus ( IDbTransaction trans ) : void
trans IDbTransaction
Résultat void

UpdateDescription() public méthode

public UpdateDescription ( ) : void
Résultat void

UpdateItem() public static méthode

public static UpdateItem ( IDbTransaction trans, int itemId, int moduleId ) : void
trans IDbTransaction
itemId int
moduleId int
Résultat void

UpdateItemVersion() public static méthode

public static UpdateItemVersion ( IDbTransaction trans, int itemId, int itemVersionId, int approvalStatusId, int userId, string approvalComments ) : void
trans IDbTransaction
itemId int
itemVersionId int
approvalStatusId int
userId int
approvalComments string
Résultat void