Skip to content

ginkgostreet/org.chorusamerica.participantpricefieldreport

Repository files navigation

Participant Price Field Report

The Participant Price Field Report is a custom report that extends the functionality of the Participant Detail Report by including price field information in the display and export of the report. It also allows for some customization as to what type of custom fields are included as display options on the Columns tab of the report.

Screenshot

The extension is licensed under AGPL-3.0.

Requirements

  • PHP v5.4+
  • CiviCRM 4.7

Installation (Web UI)

This extension has not yet been published for installation via the web UI.

Installation (CLI, Zip)

Sysadmins and developers may download the .zip file for this extension and install it with the command-line tool cv.

cd <extension-dir>
cv dl org.chorusamerica.participantpricefieldreport@https://github.com/ginkgostreet/org.chorusamerica.participantpricefieldreport/archive/master.zip

Installation (CLI, Git)

Sysadmins and developers may clone the Git repo for this extension and install it with the command-line tool cv.

git clone https://github.com/ginkgostreet/org.chorusamerica.participantpricefieldreport.git
cv en participantpricefieldreport

Usage

Once installed, navigate to Reports >> Create New Report from Template, scroll down to the Event Report Templates section, and choose the Participant Listing (with Price Fields) report. By default, all event price sets are added as collapsible groups in the Columns tab of the report criteria. No price fields are included for display in the report by default, you will need to select a few price fields to get started.

Filtering Price Sets

When no price set filter has been defined, all event price sets are added as options for display in the report. If you have a lot of price sets but only need a few of them to be available on the report, a filter can be defined for that purpose. The filter would ideally be defined in your civicrm.settings.php file. There are three options...

Pattern match report title

You can provide a simple string that will be used with a MySQL LIKE comparison against the price set title. This example would match any price set with a title containing example in it.

define('PARTICIPANT_PRICE_FIELD_REPORT_FILTER', '%example%');

List of price set titles

If you have a specific list of price sets you would like to include, define the filter as a comma delimited string of the desired price set titles. Make sure that there are no spaces on either side of a comma.

define('PARTICIPANT_PRICE_FIELD_REPORT_FILTER', 'Price set #1,Price set #2,Price set #3');

List of price set IDs

If you know the internal IDs of the price sets you would like to include, define the filter as a comma delimited string of the desired price set IDs. Make sure that there are no spaces on either side of a comma.

define('PARTICIPANT_PRICE_FIELD_REPORT_FILTER', '12,34,56');

Custom fieldsets

The Columns tab will include fieldsets that extend Participant, Contact, Individual, and Event entities. If you would like to adjust which entities are included, define this setting as a comma delimited string of the desired entities. Make sure that there are no spaces on either side of a comma.

define('PARTICIPANT_PRICE_FIELD_REPORT_EXTENDS', 'Participant,Contact,Individual,Event');

Known Issues

There are no known issues with this report at this time.

About

CiviCRM Participant Detail and Price Field Report

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages