PaypalDonationExtension - Revision history

Trevorp: /* Details */

Trevorp — Tue, 10 Apr 2007 04:21:37 GMT

Details

←Older revision		Revision as of 04:21, 10 April 2007
Line 33:		Line 33:
	**Facilitates paypal donations, and recording of transactions		**Facilitates paypal donations, and recording of transactions
	**Provides an API to allow access to donation info		**Provides an API to allow access to donation info
-	*Donors	+	*[[PaypalDonationExtension-Donors\|Donors]]
	**Public list of donors		**Public list of donors
	**Private list of own contributions		**Private list of own contributions
-	*Finance	+	*[[PaypalDonationExtension-Finance\|Finance]]
	**Allows treasurer to enter financial details		**Allows treasurer to enter financial details
	**Retrieves data from donations and provides (monthly) reports on financial status		**Retrieves data from donations and provides (monthly) reports on financial status
	**Provides an API to allow information to be used for status indicators, other reporting engnes etc.		**Provides an API to allow information to be used for status indicators, other reporting engnes etc.
-	*Finance Reports	+	*[[PaypalDonationExtension-FinanceReports\|Finance Reports]]
	**Provides reports of financial details to the public		**Provides reports of financial details to the public
-	*Progress	+	*[[PaypalDonationExtension-Progress\|Progress]]
	**Adds a progress bar to each page showing how much of this months costs are met.		**Adds a progress bar to each page showing how much of this months costs are met.

Trevorp: /* Design */

Trevorp — Tue, 10 Apr 2007 04:20:17 GMT

Design

←Older revision		Revision as of 04:20, 10 April 2007
Line 18:		Line 18:

	The interaction between the Extension and plugins is shown:		The interaction between the Extension and plugins is shown:
-	+--------+ +--------+ +-----------------+	+	+--------+ +--------+ +-----------------+
-	\| PayPal \| \| Donors \| \| Finance Reports \|	+	\| PayPal \| \| Donors \| \| Finance Reports \|
-	+--------+ +--------+ +-----------------+	+	+--------+ +--------+ +-----------------+
-	\| / /	+	\| / /
	+------+ +--------+ +=====+ +---------+ +=====+ +----------+		+------+ +--------+ +=====+ +---------+ +=====+ +----------+
	\| Wiki \|---\| Donate \|----= API =---\| Finance \|---= API =---\| Progress \|		\| Wiki \|---\| Donate \|----= API =---\| Finance \|---= API =---\| Progress \|

Trevorp at 12:27, 9 April 2007

Trevorp — Mon, 09 Apr 2007 12:27:42 GMT

←Older revision		Revision as of 12:27, 9 April 2007
Line 130:		Line 130:
	{{:PaypalDonationExtension/History}}		{{:PaypalDonationExtension/History}}
	[[PaypalDonationExtension/History\|Full History]]		[[PaypalDonationExtension/History\|Full History]]
-	==Source Code==	+	==Download==
		+	*[[Media:Paypal.tar.gz]]

Trevorp: /* Installation */

Trevorp — Mon, 09 Apr 2007 12:27:15 GMT

Installation

←Older revision		Revision as of 12:27, 9 April 2007
Line 100:		Line 100:

	==Installation==		==Installation==
		+	Download the [[Media:Paypal.tar.gz\|source package]]
		+
	copy the four files into extensions/paypal/ (if you choose to change this path you will have to modify paypalCommon::$paypal[notify_url])		copy the four files into extensions/paypal/ (if you choose to change this path you will have to modify paypalCommon::$paypal[notify_url])

Trevorp: /* Installation */

Trevorp — Sun, 08 Apr 2007 23:23:28 GMT

Installation

←Older revision		Revision as of 23:23, 8 April 2007
Line 107:		Line 107:
	require("extensions/paypal/paypal.php");		require("extensions/paypal/paypal.php");

-	Modify common.php, setting the email address to make donations to, set the paypal URL to use (sandbox or HTTPS), as well as changing any other options desired.	+	Modify common.php, setting the email address to make donations to, set the paypal URL to use (sandbox or HTTPS production), as well as changing any other options desired.

	To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].		To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].

Trevorp: /* Installation */

Trevorp — Sun, 08 Apr 2007 23:23:12 GMT

Installation

←Older revision		Revision as of 23:23, 8 April 2007
Line 107:		Line 107:
	require("extensions/paypal/paypal.php");		require("extensions/paypal/paypal.php");

-	Modify common.php, setting the email address to make donations to, as well as changing any other options desired.	+	Modify common.php, setting the email address to make donations to, set the paypal URL to use (sandbox or HTTPS), as well as changing any other options desired.

	To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].		To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].
Line 116:		Line 116:
	*** [http://wiki.peacocktech.com/wiki/PaypalDonationExtension Paypal Donation Extension (version 0.0.1)], Adds a special page allowing users to donate money to the wiki., by [http://about.peacocktech.com/trevorp/ Trevor Ian Peacock]		*** [http://wiki.peacocktech.com/wiki/PaypalDonationExtension Paypal Donation Extension (version 0.0.1)], Adds a special page allowing users to donate money to the wiki., by [http://about.peacocktech.com/trevorp/ Trevor Ian Peacock]
	** Extension functions:		** Extension functions:
-	*** paypalSetup	+	*** paypalSetup

	==Releases==		==Releases==

Trevorp at 23:00, 8 April 2007

Trevorp — Sun, 08 Apr 2007 23:00:59 GMT

←Older revision		Revision as of 23:00, 8 April 2007
Line 2:		Line 2:

	==Details==		==Details==
-	*Version 0.0	+	*Version 0.1
-	*Date 5 Apr 2007	+	*Date 9 Apr 2007
	*Tested on MediaWiki 1.7.1, PHP 5.1.6 (apache2handler), MySQL 5.0.24a-Debian_9ubuntu0.1-log		*Tested on MediaWiki 1.7.1, PHP 5.1.6 (apache2handler), MySQL 5.0.24a-Debian_9ubuntu0.1-log

Trevorp at 22:58, 8 April 2007

Trevorp — Sun, 08 Apr 2007 22:58:02 GMT

←Older revision		Revision as of 22:58, 8 April 2007
Line 90:		Line 90:
	**:Returns an array of all donations made by the specified user.		**:Returns an array of all donations made by the specified user.
	**static function totalDuring($start, $end)		**static function totalDuring($start, $end)
-	**:Returns the total money recieved from donations between the dates specified.	+	**:Returns the total money received from donations between the dates specified.

	==Usage==		==Usage==

Trevorp at 22:57, 8 April 2007

Trevorp — Sun, 08 Apr 2007 22:57:34 GMT

←Older revision		Revision as of 22:57, 8 April 2007
Line 15:		Line 15:

	===Design===		===Design===
		+	This extension provides support for related extensions. It will automatically load these 'plugins', with no modification of LocalSettings.php required for each plugin.

-	+--------+ +------+	+	The interaction between the Extension and plugins is shown:
-	\| PayPal \| \| List \|	+	+--------+ +--------+ +-----------------+
-	+--------+ +------+	+	\| PayPal \| \| Donors \| \| Finance Reports \|
-	\| /	+	+--------+ +--------+ +-----------------+
-	+------+ +-----+ +=====+ +-----+ +=====+ +-----+	+	\| / /
-	\| Wiki \|---\| PPE \|----= API =---\| FRE \|---= API =---\| Ind \|	+	+------+ +--------+ +=====+ +---------+ +=====+ +----------+
-	+------+ +-----+ +=====+ +-----+ +=====+ +-----+	+	\| Wiki \|---\| Donate \|----= API =---\| Finance \|---= API =---\| Progress \|
-	\| \|	+	+------+ +--------+ +=====+ +---------+ +=====+ +----------+
-	+----------+ +----------+	+	\| \|
-	\| Database \| \| Database \|	+	+---------------------------------+
-	+----------+ +----------+	+	\| Database \|
		+	+---------------------------------+

-	*PPE Paypal Donation Extension	+	*Donate
	**Facilitates paypal donations, and recording of transactions		**Facilitates paypal donations, and recording of transactions
	**Provides an API to allow access to donation info		**Provides an API to allow access to donation info
-	*[[PaypalDonationExtension\|List]]	+	*Donors
	**Public list of donors		**Public list of donors
	**Private list of own contributions		**Private list of own contributions
-	*FRE Financial Reports Extension	+	*Finance
	**Allows treasurer to enter financial details		**Allows treasurer to enter financial details
	**Retrieves data from donations and provides (monthly) reports on financial status		**Retrieves data from donations and provides (monthly) reports on financial status
	**Provides an API to allow information to be used for status indicators, other reporting engnes etc.		**Provides an API to allow information to be used for status indicators, other reporting engnes etc.
-	*Ind Indicators/progress bars etc.	+	*Finance Reports
		+	**Provides reports of financial details to the public
		+	*Progress
		+	**Adds a progress bar to each page showing how much of this months costs are met.
		+
		+	====Files====
		+	*paypal.php
		+	*:Main file facilitating donations
		+	*common.php
		+	*:Common functions used by all plugins
		+	*ipn.php
		+	*:script for callback from paypal server
		+	*paypal-api.php
		+	*:Functions allowing access to donation data
		+

	====Database====		====Database====
Line 65:		Line 81:
	`country` text NOT NULL,		`country` text NOT NULL,
	PRIMARY KEY (`item_number`)		PRIMARY KEY (`item_number`)
-	) ENGINE=MyISAM AUTO_INCREMENT=20 DEFAULT CHARSET=latin1;</pre>	+	) ENGINE=MyISAM AUTO_INCREMENT=25 DEFAULT CHARSET=latin1;</pre>

	====API====		====API====
	*class paypal_api		*class paypal_api
-	**static function all_donations($number=10, $start=0)
-	**:
-	**static function myDonations($user)
-	**:
	**static function donations($number=10, $start=0)		**static function donations($number=10, $start=0)
-	**:	+	**:Retrieves an array of the most recent donations.
		+	**static function myDonations($user)
		+	**:Returns an array of all donations made by the specified user.
	**static function totalDuring($start, $end)		**static function totalDuring($start, $end)
-	**:	+	**:Returns the total money recieved from donations between the dates specified.

	==Usage==		==Usage==
Line 86:		Line 100:

	==Installation==		==Installation==
-	copy files into place	+	copy the four files into extensions/paypal/ (if you choose to change this path you will have to modify paypalCommon::$paypal[notify_url])
		+
		+	Use the sql code above to create a table in the wiki database.

	Insert the following line into the end of 'LocalSettings.php' (before the '?>')		Insert the following line into the end of 'LocalSettings.php' (before the '?>')
-	require("extensions/???.php");	+	require("extensions/paypal/paypal.php");
		+
		+	Modify common.php, setting the email address to make donations to, as well as changing any other options desired.

	To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].		To check to see if it is installed properly, visit your Version page, eg [[Special:Version]].

Trevorp: /* Features */

Trevorp — Sun, 08 Apr 2007 14:40:32 GMT

Features

←Older revision		Revision as of 14:40, 8 April 2007
Line 12:		Line 12:
	**[[PaypalDonationExtension-Finance]]		**[[PaypalDonationExtension-Finance]]
	**[[PaypalDonationExtension-FinanceReports]]		**[[PaypalDonationExtension-FinanceReports]]
		+	**[[PaypalDonationExtension-Progress]]

	===Design===		===Design===