C# Class ScrewTurn.Wiki.Plugins.RatingManagerPlugin.RatingManager

A plugin for assigning a rating to pages.
Inheritance: IFormatterProviderV30
ファイルを表示 Open project: mono/ScrewTurnWiki

Public Methods

Method Description
Format ( string raw, ContextInformation context, FormattingPhase phase ) : string

Performs a Formatting phase.

Init ( IHostV30 host, string config ) : void

Initializes the Storage Provider.

PrepareTitle ( string title, ContextInformation context ) : string

Prepares the title of an item for display (always during phase 3).

RatingManager ( ) : System

Initializes a new instance of the RatingManager class.

Shutdown ( ) : void

Method invoked on shutdown.

This method might not be invoked in some cases.

Private Methods

Method Description
AddRating ( string fullPageName, int rate ) : void
ComputeRating ( ContextInformation context, StringBuilder buffer, string fullPageName ) : void

Gets the rating of the plugin from the backendpage and display it to the user.

DirectoryExists ( IFilesStorageProviderV30 filesStorageProvider, string directoryName ) : bool
FileExists ( IFilesStorageProviderV30 filesStorageProvider, string directory, string fileName ) : bool
FindAndRemoveFirstOccurrence ( StringBuilder buffer ) : Match>.KeyValuePair

Finds the and remove first occurrence.

GetCurrentAverage ( string fullPageName ) : float
GetDefaultFilesStorageProvider ( ) : IFilesStorageProviderV30
LogWarning ( string message ) : void

Logs the warning.

SearchPlugin ( string plugins, string currentPlugin ) : int

Searches the plugin.

Method Details

Format() public method

Performs a Formatting phase.
public Format ( string raw, ContextInformation context, FormattingPhase phase ) : string
raw string The raw content to Format.
context ScrewTurn.Wiki.PluginFramework.ContextInformation The Context information.
phase FormattingPhase The Phase.
return string

Init() public method

Initializes the Storage Provider.
If or are null. If is not valid or is incorrect.
public Init ( IHostV30 host, string config ) : void
host IHostV30 The Host of the Component.
config string The Configuration data, if any.
return void

PrepareTitle() public method

Prepares the title of an item for display (always during phase 3).
public PrepareTitle ( string title, ContextInformation context ) : string
title string The input title.
context ScrewTurn.Wiki.PluginFramework.ContextInformation The context information.
return string

RatingManager() public method

Initializes a new instance of the RatingManager class.
public RatingManager ( ) : System
return System

Shutdown() public method

Method invoked on shutdown.
This method might not be invoked in some cases.
public Shutdown ( ) : void
return void