Points

Points is a Craft CMS plugin that allows you create a points / scoring / credits system and assign these to a user.

Points are assigned to a user by firstly creating an 'Event' (E.g. Signed Up to Newsletter = 20pts) and then assigning this event to a particular user when they have performed that action.

Features

• Assign points to a particular user
• Control Panel to manage events
• Control Panel to manage point entries
• Generate a 'Points Total' per user
• Craft 2.5 compatible

Install

• Add the points directory into your craft/plugins directory.
• Navigate to Settings -> Plugins and click the "Install" button.

Usage

Before you can assign points to a user, you firstly need to create an 'Event'. An event is essentially an action the user has completed, e.g. Logged In, Signed Up to Newsletter, Bought a Product etc.

To do this, navigate to Points -> Events in the sidebar after installing and click 'Add Event' in the top right. Give the event a name and decide how many points the user receives once this event is triggered.

If you want to allow this event to be triggered multiple times rather than once, switch the Multiple option on. If this is turned off then the event can only be assigned to a user once.

To then assign points to a user you can do this via the CMS Points -> Entries or using a Twig tag (See below)

Templating

Add Entry

To add Points (Entry) to a user you only really need to specify an events eventHandle.

{{ craft.points.addEntry(
	{ 
		eventHandle: 'SignedUpToNewsletter'
	}
) }}

This will assign the points from the SignedUpToNewsletter event to the current logged in user. If you want to add points to a user that is not currently logged in, just specify the userId parameter.

{{ craft.points.addEntry(
	{ 
		userId: 5
		eventHandle: 'SignedUpToNewsletter'
	}
) }}

You can assign the userId dynamically by creating a variable and passing it to the add method. The below example takes the user from the segment 1 of the URL.

{% set user = craft.user.username(craft.request.getSegment(1)).first() %}

{{ craft.points.addEntry(
	{ 
		userId: user.id
		eventHandle: 'SignedUpToNewsletter'
	}
) }}

Remove Entry

You can also remove points from a user in the same way as adding points. Optionally adding in the userId parameter. It's important to remember that if you have selected 'Multiple' on the event, that removing points only removes 1 instance, not all.

{{ craft.points.removeEntry(
	{ 
		eventHandle: 'SignedUpToNewsletter'
	}
) }}

Sum Entries

To get a sum amount of points a user has (E.g. 30pts), use the .sumEntries option.

{{ craft.points.sumEntries() }}

To get the Sum Entries for a specific user you just need to specify the user ID.

{{ craft.points.sumEntries(5) }}

Total Entries

To get the total amount of entries a user has (E.g. 3 Entries), use the .totalEntries option.

{{ craft.points.totalEntries() }}

To get the Total Entries for a specific user you just need to specify the user ID.

{{ craft.points.totalEntries(5) }}

Add Event

If you want to make more events dynamic then you can create Events on the fly. ALL of the attributes are required.

{{ craft.points.addEvent(
	{
		event: 'Viewed ' ~ entry.title,
		eventHandle: 'viewed' ~ entry.title|camel,
		points: '20',
		multiple: false
	}
) }}

Widget

Points also comes with a widget to see the latest points assigned to users directly on the dashboard.

Roadmap

• Leaderboard
• More Widgets - Leaderboard Widget, Events Widget
• Delay - Set a delay multiple points can be assigned to a user
• Hook to create events after entries are created

Credits

• Diamond by Edward Boatman from the Noun Project (https://thenounproject.com/edward/)