C# Class SobekCM.Library.ItemViewer.Viewers.Usage_Stats_ItemViewer_Prototyper

Usage statisticsitem viewer prototyper (for readership/viewers), which is used to create the link in the main menu, and to create the viewer itself if the user selects that option

Inheritance: iItemViewerPrototyper

显示文件 Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method	Description
Add_Menu_items ( BriefItemInfo CurrentItem, User_Object CurrentUser, Navigation_Object CurrentRequest, List MenuItems, bool IpRestricted ) : void	Gets the menu items related to this viewer that should be included on the main item (digital resource) menu
Create_Viewer ( BriefItemInfo CurrentItem, User_Object CurrentUser, Navigation_Object CurrentRequest, Custom_Tracer Tracer ) : iItemViewer	Creates and returns the an instance of the Usage_Stats_ItemViewer class for showing the usage statistics ( readership / visitors ) over time for a digital resource during execution of a single HTTP request. This method is called whenever a request requires the actual viewer to be created to render the HTML for the digital resource requested. The created viewer is then destroyed at the end of the request
Has_Access ( BriefItemInfo CurrentItem, User_Object CurrentUser, bool IpRestricted ) : bool	Flag indicates if the current user has access to this viewer for the item
Include_Viewer ( BriefItemInfo CurrentItem ) : bool	Indicates if the specified item matches the basic requirements for this viewer, or if this viewer should be ignored for this item
Override_On_Checkout ( BriefItemInfo CurrentItem ) : bool	Flag indicates if this viewer should be override on checkout
Usage_Stats_ItemViewer_Prototyper ( ) : System	Constructor for a new instance of the Usage_Stats_ItemViewer_Prototyper class

Method Details

Add_Menu_items() public method

Gets the menu items related to this viewer that should be included on the main item (digital resource) menu

public Add_Menu_items ( BriefItemInfo CurrentItem, User_Object CurrentUser, Navigation_Object CurrentRequest, List MenuItems, bool IpRestricted ) : void
CurrentItem	SobekCM.Core.BriefItem.BriefItemInfo	Digital resource object, which can be used to ensure if and how this viewer should appear /// in the main item (digital resource) menu
CurrentUser	SobekCM.Core.Users.User_Object	Current user, who may or may not be logged on
CurrentRequest	SobekCM.Core.Navigation.Navigation_Object	Information about the current request
MenuItems	List	List of menu items, to which this method may add one or more menu items
IpRestricted	bool	Flag indicates if this item is IP restricted AND if the current user is outside the ranges
return	void

Create_Viewer() public method

Creates and returns the an instance of the Usage_Stats_ItemViewer class for showing the usage statistics ( readership / visitors ) over time for a digital resource during execution of a single HTTP request.

This method is called whenever a request requires the actual viewer to be created to render the HTML for the digital resource requested. The created viewer is then destroyed at the end of the request

public Create_Viewer ( BriefItemInfo CurrentItem, User_Object CurrentUser, Navigation_Object CurrentRequest, Custom_Tracer Tracer ) : iItemViewer
CurrentItem	SobekCM.Core.BriefItem.BriefItemInfo	Digital resource object
CurrentUser	SobekCM.Core.Users.User_Object	Current user, who may or may not be logged on
CurrentRequest	SobekCM.Core.Navigation.Navigation_Object	Information about the current request
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	iItemViewer

Has_Access() public method

Flag indicates if the current user has access to this viewer for the item

public Has_Access ( BriefItemInfo CurrentItem, User_Object CurrentUser, bool IpRestricted ) : bool
CurrentItem	SobekCM.Core.BriefItem.BriefItemInfo	Digital resource to see if the current user has correct permissions to use this viewer
CurrentUser	SobekCM.Core.Users.User_Object	Current user, who may or may not be logged on
IpRestricted	bool	Flag indicates if this item is IP restricted AND if the current user is outside the ranges
return	bool

Include_Viewer() public method

Indicates if the specified item matches the basic requirements for this viewer, or if this viewer should be ignored for this item

public Include_Viewer ( BriefItemInfo CurrentItem ) : bool
CurrentItem	SobekCM.Core.BriefItem.BriefItemInfo	Digital resource to examine to see if this viewer really should be included
return	bool

Override_On_Checkout() public method

Flag indicates if this viewer should be override on checkout

public Override_On_Checkout ( BriefItemInfo CurrentItem ) : bool
CurrentItem	SobekCM.Core.BriefItem.BriefItemInfo	Digital resource to examine to see if this viewer should really be overriden
return	bool

Usage_Stats_ItemViewer_Prototyper() public method

Constructor for a new instance of the Usage_Stats_ItemViewer_Prototyper class

public Usage_Stats_ItemViewer_Prototyper ( ) : System
return	System