Extension:ContributionReporting

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
ContributionReporting

Release status:Extension status beta

ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description Displays statistics for contributions made to the Wikimedia Foundation.
Author(s)Template:Extension#username Trevor Parscaltalk
Latest versionTemplate:Extension#version SVN (2009-11-14)
MediaWikiTemplate:Extension#mediawiki 1.14alpha and higher
LicenseTemplate:Extension#license GPL v2
Download
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
LanguageGetMagicManual:Hooks/LanguageGetMagic

Translate the ContributionReporting extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

ContributionHistory[edit]

Special page providing complete contribution history.

ContributionTotal[edit]

Transcludable special page that provides a total amount contributed for a given fiscal year.

FundraiserStatistics[edit]

Special page that shows a bar chart, comparing daily takes of multiple fundraisers.

ContributionStatistics[edit]

Special page which builds reports for contributions to the WikiMedia Foundation. Data is relative to either a specific range of dates or the current fiscal year. This extension also depends on (and is part of) ContributionReporting. If ContributionStatistics is included manually, instead of automatically by ContributionReporting, the MediaWiki database will be used - which functionality is for testing only.

Usage[edit]

By appending /range/start_date:end_date to the end of the page url, such as Special:ContributionStatistics/range/2008-11-03:2009-07-01 you can generate statistics for a given range of dates. The end date is optional, and if not set the effective end date will become the end of the current fiscal year.

ContributionReporting defines a parser function, #contributiontotal. It accepts two parameters: fundraiser, which is the ID of a fundraiser; and fudgefactor, which is how much to adjust the total by. Here is an example:

{{#contributiontotal:fundraiser=2009|fudgefactor=1}}

Installation[edit]

This extension depends on access to a CiviCRM database, namely the public_reporting table. Without access to that table, this extension will not work.

  • Copy the ContributionReporting folder into your extensions directory.
  • Add the following line to the bottom of LocalSettings.php
 require_once ( "$IP/extensions/ContributionReporting/ContributionReporting.php" );

Configuration[edit]

The following parameters can be set by defining values for the following variables in your LocalSettings.php file.

Parameter Description Default Value
$egContributionStatisticsFiscalYearCutOff The first day of the fiscal year. July 1
$egContributionStatisticsViewDays Maximum number of days to show in the daily totals table. 7