Hello, I am Wiego. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you!

Table of contents

• Installation
• Getting started
• Programmatically adding badges to users
• Available permissions
• Available languages
• Extend backend views
• Available events
• Adding form fields
• Adding columns to lists
• Support

Installation

• To install from the Marketplace, click on the "Add to Project" button and then select the project you wish to add it to before updating the project in the backend of your website to pull in the plugin. To install from the backend, go to Settings -> Updates & Plugins -> Install Plugins and then search for Briddle.Badges.

Getting started

Please note that RainLab.User is required for this plugin.This plugin is FREE.

1. Download Briddle.Badges (This plugin requires RainLab.User so add this first). This plugin is FREE.
2. Go to Badges in the backend to add SVG badges.
3. Add Badges to users in the User plugin.

Example inline SVG code:

<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
     viewBox="0 0 512 512" style="enable-background:new 0 0 512 512;" xml:space="preserve">
<path style="fill:#FFAB15;" d="M421,512h-29.405L256,424.832L120.405,512H91V0h330V512z"/>
<polygon style="fill:#FF9400;" points="256,0 256,424.832 391.595,512 421,512 421,0 "/>
<polygon style="fill:#FFEA84;" points="256,138.937 274.541,176.505 316,182.529 286,211.772 293.082,253.063 256,233.568 
    218.918,253.063 226,211.772 196,182.529 237.459,176.505 "/>
<polygon style="fill:#FFDC40;" points="316,182.529 274.541,176.505 256,138.937 256,233.568 293.082,253.063 286,211.772 "/>
</svg>

Once the relationship is defined, you may access the user's badges using the badges dynamic property:

$user = User::find(1);

foreach ($user->badges as $badge) {
    //
}

Or (in Twig):

{% for reward in user.badges %}
    {{ reward.badge|raw }}
{% endfor %}

Programmatically adding badges to users

Please see: https://octobercms.com/docs/database/relations#inserting-related-models

Available permissions

As always you can set backend permissions for this plugin in Settings > Administrators > Badges

• briddle.badges

Available languages

This plugin can be translated in any language

This plugin supports the following languages out of the box:

• english

Extending functionality

Overwrite partials

You can overwrite the component partials to accommodate the design of your site by placing a copy in the partials folder of the CMS.

Please see: https://octobercms.com/docs/cms/components#customizing-default-markup

Extend backend views

Sometimes you may wish to allow a back-end view file or partial to be extended, such as a toolbar. You can add your own elements to the top of certain backend lists (e.g. to display stats) and the sidebar of certain backend forms (e.g. to display extra information).

The following view events are available to extend backe-end views:

https://octobercms.com/docs/plugin/extending#extending-with-events

Available events

Events allow you to be notified when a student submits an assignment or test or when a teacher grades a test etc.

The following events are available to extend the functionality of this plugin:

Please see: https://octobercms.com/docs/plugin/extending#extending-with-events

Adding form fields

You can extend this plugin with your own to add fields to any backend forms.

Please see: https://octobercms.com/docs/plugin/extending#extending-backend-form

Adding columns to lists

You can extend this plugin with your own to add columns to any backend lists.

Please see: https://octobercms.com/docs/plugin/extending#extending-backend-list

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

IMPORTANT NOTICE! All my activities on October CMS are suspended indefinitely after my second burn-out. I do not offer any support or updates