C# Класс ScrewTurn.Wiki.Plugins.PluginPack.DownloadCounter

Implements a formatter provider that counts download of files and attachments.
Наследование: IFormatterProviderV30
Показать файл Открыть проект

Открытые методы

Метод Описание
Format ( string raw, ContextInformation context, FormattingPhase phase ) : string

Performs a Formatting phase.

Init ( IHostV30 host, string config ) : void

Initializes the Storage Provider.

If the configuration string is not valid, the methoud should throw a InvalidConfigurationException.

PrepareTitle ( string title, ContextInformation context ) : string

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

Shutdown ( ) : void

Method invoked on shutdown.

This method might not be invoked in some cases.

Приватные методы

Метод Описание
BuildResult ( string pattern, int downloads, int daily, int weekly, int monthly ) : string

Builds the result.

CountAllDownloads ( XmlDocument doc ) : int

Counts all the downloads.

CountDownloads ( string fullFilePath, string providerName ) : int

Counts the downloads of a file.

CountDownloads ( string attachmentName, string pageName, string providerName ) : int

Counts the downloads of a file.

FindAndRemoveFirstOccurrence ( StringBuilder buffer ) : string>.KeyValuePair

Finds and removes the first occurrence of the XML markup.

GetProvider ( string provider ) : IFilesStorageProviderV30

Gets the specified provider or the default one.

GetRootAttributes ( XmlDocument doc, string &pattern, System.DateTime &startDate ) : void

Gets the root attributes.

LogWarning ( string message ) : void

Logs a warning.

ReplacePlaceholder ( StringBuilder buffer, string placeholder, string value ) : void

Replaces a placeholder with its value.

TryGetAttribute ( XmlNode node, string attribute ) : string

Tries to get the value of an attribute.

Описание методов

Format() публичный Метод

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.
Результат string

Init() публичный Метод

Initializes the Storage Provider.
If the configuration string is not valid, the methoud should throw a InvalidConfigurationException.
public Init ( IHostV30 host, string config ) : void
host IHostV30 The Host of the Component.
config string The Configuration data, if any.
Результат void

PrepareTitle() публичный Метод

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.
Результат string

Shutdown() публичный Метод

Method invoked on shutdown.
This method might not be invoked in some cases.
public Shutdown ( ) : void
Результат void