Data Access

When adding custom code to system templates such as the Fundraising page or Fundraiser dashboards you are able to access specific data.

This guide below explains exactly what data you can get access to, on which templates.

Fundraising Page

Templates: profile.php & profile_diy.php

The following data is accessible on the above templates.

$SetupDetails=array()

Provides access to the core platform settings.

$MemberDetails=array()

Provides access to the fundraiser's details

$EventDetails=array()

Provides access to the event the fundraiser is in

$CharityDetails=array()

if the site is in multi-charity mode, this provides access to the related charity details

$CategoryDetails=array()

For DIY only, gain access to the DIY category information

$ActiveEvents=int()

Returns the number of active events this person has

$Rank=int()

Returns fundraising ranking as a number

$TeamDetails=array()

If applicable, provides access to the team the fundraiser is in

$members=array()

if applicable, returns an array of all team members

$donations=array()

Returns an array of all donations made to this fundraiser for the specific event

$blogs=array()

Returns an array of fundraiser blogs that have been added against the specific event

$DonationsTotal=float()

Returns the amount this fundraiser has raised within the specific event

$DonationsOverall=float()

Returns the amount this fundraiser has raised across all events

$EventDonationsTotal=float()

DIY only, provides a total amount raised of the entire event

$GiftAidTotal=float()

Returns the amount raised via Gift Aid (uk only)

$Galleries=array()

Returns an arrary of gallery images that have been added by the fundraiser for the specific event

$TotalDistance=float()

Returns the total distance in miles or kms this fundraiser has logged either manually or via a connected app

$TotalDuration=float()

Returns the total duration in seconds this fundraiser has logged either manually or via a connected app

$TotalSteps=float()

Returns the total steps this fundraiser has logged either manually or via a connected app

$TotalDistanceProgress=float()

Returns a number relating to the distance achieved in relation to the fundraisers distance goal

$TotalDurationProgress=float()

Returns a number relating to the duration achieved in relation to the fundraisers duration goal

$TotalStepsProgress=float()

Returns a number relating to the steps achieved in relation to the fundraisers step goal

$Steps=array()

Returns an array of interactions for this fundraiser relating to the specific event e.g. shared-page

$CustomFields=array()

Returns an array of all custom fields for this fundraiser relating to the specific event

$badges=array()

Returns an array of gamification badges that have been added against the specific event

Team Fundraising Page

Templates: profile_team.php

The following data is accessible on the above template.

$SetupDetails=array()

Provides access to the core platform settings.

$TeamDetails=array()

Provides access to the team record

$CaptainDetails=array()

Provides access to the team captain

$EventDetails=array()

Provides access to the event the team is in

$CharityDetails=array()

if the site is in multi-charity mode, this provides access to the related charity details

$CategoryDetails=array()

For DIY only, gain access to the DIY category information

$CustomFields=array()

Returns an array of all custom fields for this team relating to the specific event

$Rank=int()

Returns team ranking as a number

$DonationsTotal=float()

Returns the amount this team has raised within the specific event

$DonationsTotalLocal=float()

Returns the amount this team has raised within the specific event in the events local currency if mult-currency

$GiftAidTotal=float()

Returns the gift aid amount this team has raised within the specific event

$members=array()

if applicable, returns an array of all team members

$donations=array()

Returns an array of all donations made to this team for the specific event

$blogs=array()

Returns an array of team blogs that have been added against the specific event

$TotalDistance=float()

Returns the total distance in miles or kms this team has logged either manually or via a connected app

$TotalDuration=float()

Returns the total duration in seconds this team has logged either manually or via a connected app

$TotalSteps=float()

Returns the total steps this team has logged either manually or via a connected app

$badges=array()

Returns an array of gamification badges that have been added against the specific event

Organisation Fundraising Page

Templates: profile_org.php

The following data is accessible on the above template.

$SetupDetails=array()

Provides access to the core platform settings.

$OrgDetails=array()

Provides access to the team record

$CaptainDetails=array()

Provides access to the team captain

$EventDetails=array()

Provides access to the event the team is in

$CharityDetails=array()

if the site is in multi-charity mode, this provides access to the related charity details

$CategoryDetails=array()

For DIY only, gain access to the DIY category information

$CustomFields=array()

Returns an array of all custom fields for this organisation relating to the specific event

$Rank=int()

Returns team ranking as a number

$DonationsTotal=float()

Returns the amount this organisation has raised within the specific event

$DonationsTotalLocal=float()

Returns the amount this organisation has raised within the specific event in the events local currency if mult-currency

$GiftAidTotal=float()

Returns the gift aid amount this organisation has raised within the specific event

$members=array()

if applicable, returns an array of all organisation members

$teams=array()

if applicable, returns an array of all organisation teams

$donations=array()

Returns an array of all donations made to this team for the specific event

$blogs=array()

Returns an array of team blogs that have been added against the specific event

$TotalDistance=float()

Returns the total distance in miles or kms this organisation has logged either manually or via a connected app

$TotalDuration=float()

Returns the total duration in seconds this organisation has logged either manually or via a connected app

$TotalSteps=float()

Returns the total steps this organisation has logged either manually or via a connected app

Individual Dashboard

Templates: login_dashboard.php

The following data is accessible on the above template.

$SetupDetails=array()

Provides access to the core platform settings.

$MemberDetails=array()

Provides access to the fundraiser's details

$ActiveEventDetails=array()

Provides access to the event the fundraiser is in

$CharityDetails=array()

if the site is in multi-charity mode, this provides access to the related charity details

$CategoryDetails=array()

For DIY only, gain access to the DIY category information

$TeamDetails=array()

If applicable, provides access to the team the fundraiser is in

$OrgDetails=array()

If applicable, provides access to the organisation the fundraiser is in

$Rank=int()

Returns fundraising ranking as a number

$DonationsTotal=float()

Returns the amount this fundraiser has raised within the specific event

$DonationsOverall=float()

Returns the amount this fundraiser has raised across all events

$TotalDistance=float()

Returns the total distance in miles or kms this fundraiser has logged either manually or via a connected app

$TotalDuration=float()

Returns the total duration in seconds this fundraiser has logged either manually or via a connected app

$TotalSteps=float()

Returns the total steps this fundraiser has logged either manually or via a connected app

$TotalDistanceProgress=float()

Returns a number relating to the distance achieved in relation to the fundraisers distance goal

$TotalDurationProgress=float()

Returns a number relating to the duration achieved in relation to the fundraisers duration goal

$TotalStepsProgress=float()

Returns a number relating to the steps achieved in relation to the fundraisers step goal

$Steps=array()

Returns an array of interactions for this fundraiser relating to the specific event e.g. shared-page

$CustomFields=array()

Returns an array of all custom fields for this fundraiser relating to the specific event

$donations=array()

Returns an array the 8 most recent donations made to this fundraiser for the specific event