User Points System - Revision history

Sinisakrisan: /* Calling the UserPoints API in Your Code */

2016-06-22T01:40:19Z

‎Calling the UserPoints API in Your Code

Sinisakrisan: /* Calling the UserPoints API in Your Code */

2016-06-22T01:38:44Z

‎Calling the UserPoints API in Your Code

Sinisakrisan at 01:38, 22 June 2016

2016-06-22T01:38:21Z

Sinisakrisan: /* Register Action Rules into Database */

2014-05-14T01:55:31Z

‎Register Action Rules into Database

Sinisakrisan at 11:04, 17 August 2013

2013-08-17T11:04:53Z

Patricia Schmidt: /* Register Action Rules into Database */

2013-03-09T05:27:57Z

‎Register Action Rules into Database

Patricia Schmidt: /* Register Action Rules into Database */

2013-03-09T05:26:50Z

‎Register Action Rules into Database

Patricia Schmidt: /* Register Action Rules into Database */

2013-03-07T19:43:34Z

‎Register Action Rules into Database

Patricia Schmidt: /* Register action rules into database */

2013-03-07T19:42:15Z

‎Register action rules into database

Patricia Schmidt: /* Register action rules into database */

2013-03-07T19:38:50Z

‎Register action rules into database

@@ Line 12: / Line 12: @@
 </syntaxhighlight>
 <br />
-The 'your.action.string' is the rule registered in db with how many points awarded to the current logged-in user. You will need to give a unique action string to your components such as 'com_name.profile.upload.avatar'. In some situations, where you want to give points to another user instead of the current logged-in user, you can call the API in the following manner:
+The '''your.action.string''' is the rule registered in database with how many points awarded to the current logged-in user. You will need to give a unique action string to your components such as 'com_name.profile.upload.avatar'. In some situations, where you want to give points to another user instead of the current logged-in user, you can call the API's in the following manner:
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 19: / Line 19: @@
 </syntaxhighlight>
 <br />
-By giving the UserId as the second parameter, the API will give points to the specified user.
+By giving the '''userId''' (62) as the second parameter, the API will give points to the specified user.
 ==Register Action Rules into Database==

@@ Line 14: / Line 14: @@
 The 'your.action.string' is the rule registered in db with how many points awarded to the current logged-in user. You will need to give a unique action string to your components such as 'com_name.profile.upload.avatar'. In some situations, where you want to give points to another user instead of the current logged-in user, you can call the API in the following manner:
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/userpoints.php';
 CuserPoints::assignPoint('your.action.string', 62);

@@ Line 4: / Line 4: @@
 The site Admin will have the ability to modify the exact number of points to be awarded for each action and can also completely disable it, if necessary.
-===Calling the UserPoints API in Your Code===
+==Calling the UserPoints API in Your Code==
 If you want to give points to a user, you will need to call the API by inserting the codes where you want them.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/userpoints.php';
 CuserPoints::assignPoint('your.action.string');
@@ Line 19: / Line 20: @@
 By giving the UserId as the second parameter, the API will give points to the specified user.
-===Register Action Rules into Database===
+==Register Action Rules into Database==
 To register all the action rules that used in your component / module / plugins, you will need to create an XML file for this. Create one XML file and name it ''''jomsocial_rule.xml''''. You MUST name your file exactly as shown or else the rule registration will fail.<br />
 You MUST include this file in your installer and put this file at the root level in your Frontend component folder. Your XML file should look like the below one :

@@ Line 23: / Line 23: @@
 You MUST include this file in your installer and put this file at the root level in your Frontend component folder. Your XML file should look like the below one :
 <syntaxhighlight lang="xml">
-<version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
-      <your component name>
+<!DOCTYPE jomsocial>
-	      <your action name>
+<jomsocial>
-	      <your description about the action>
+      <component>com_[Component Name]</component>
-	      <your unique action string.>
+     <rules>
-	      <whether to publish the rule or not. true or false>
+          <rule>
-	      <points given to this action.>
+				<name>[Rule Name]</name>
-	      <user access level. For registered user, use 1.>
+				<description>[Rule Description]</description>
 </syntaxhighlight>
 <br />
 For example,
 <syntaxhighlight lang="xml">
-<version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
-   <com_community>
+<!DOCTYPE jomsocial>
-     <Add Application>
+<jomsocial>
-	      <Give points when registered user add new application.>
+     <component>com_hikashop</component>
-	      <com_community.application.add>
+     <rules>
-	      <true>
+          <rule>
-	      <1>
+				<name>Blogger Review</name>
-	      <1>
+				<description>Give point when vote added.</description>
-         <Remove Application>
+				<action_string>hikashop.add.vote</action_string>
-	      <Deduct points when registered user remove application.>
+				<publish>true</publish>
-	      <com_community.application.remove>
+				<points>1</points>
-	      <true>
+				<access_level>0</access_level>
-	      <0>
+          </rule>
-	      <1>
+     </rules>
 </syntaxhighlight>
 <br />

← Older revision		Revision as of 11:04, 17 August 2013
Line 67:		Line 67:
	That's it. Now all your actions have been registered into db and your components should give points where you have placed your '''UserPoints API'''. You can always configure the action rule from the JomSocial Backend in the '''UserPoints''' page. The screen below shows where you can modify your rule's attributes.<br /><br/>		That's it. Now all your actions have been registered into db and your components should give points where you have placed your '''UserPoints API'''. You can always configure the action rule from the JomSocial Backend in the '''UserPoints''' page. The screen below shows where you can modify your rule's attributes.<br /><br/>
	::: [[File:rules3.jpg]]		::: [[File:rules3.jpg]]
		+
		+	==See Also==
		+	* [[Karma System]]
		+	* [[Disabling Individual Activity]]

@@ Line 65: / Line 65: @@
 ::: [[File:rules2.jpg]]
-That's it. Now all your actions have been registered into db and your components should give points where you have placed your UserPoints API. You can always configure the action rule from JomSocial Backend in the UserPoints page. The screen below shows where you can modify your rule's attributes.<br /><br/>
+That's it. Now all your actions have been registered into db and your components should give points where you have placed your '''UserPoints API'''. You can always configure the action rule from the JomSocial Backend in the '''UserPoints''' page. The screen below shows where you can modify your rule's attributes.<br /><br/>
 ::: [[File:rules3.jpg]]

@@ Line 52: / Line 52: @@
 <br />
 For the access_level, use these are the values:
-=> Public
+* 0 => Public
-=> Registered
+* 1 => Registered
-=> Special
+* 2 => Special
 Assuming you have included this 'jomsocial_rule.xml' into your installer.
@@ Line 60: / Line 60: @@
 Now, go to your Jomsocial Backend and you should see the icon 'UserPoints'. Go into UserPoints and you should see screen below with some default / existing action rule displayed.<br /><br/>
-[[File:rules1.jpg]]
+::: [[File:rules1.jpg]]
 Click '''Rule Scan''' to bring up the popup screen. '''Rule Scan''' will actually scan through all of the components folders to search for the file, 'jomsocial_rule.xml'. If there are new rules, the scanning will register them into db and you should see the screen below for what rules are registered. Click '''Refresh''' to continue.<br /><br/>
-[[File:rules2.jpg]]
+::: [[File:rules2.jpg]]
 That's it. Now all your actions have been registered into db and your components should give points where you have placed your UserPoints API. You can always configure the action rule from JomSocial Backend in the UserPoints page. The screen below shows where you can modify your rule's attributes.<br /><br/>
-[[File:rules3.jpg]]
+::: [[File:rules3.jpg]]