Plugin Tutorials - Revision history

Patricia Schmidt: Undo revision 1870 by Patricia Schmidt (talk)

2013-03-12T02:31:22Z

Undo revision 1870 by Patricia Schmidt (talk)

Show changes

Patricia Schmidt: Reverted edits by Patricia Schmidt (talk) to last revision by Sinisakrisan

2013-03-12T02:02:48Z

Reverted edits by Patricia Schmidt (talk) to last revision by Sinisakrisan

Show changes

Patricia Schmidt: /* User Parameters */

2013-03-09T05:35:42Z

‎User Parameters

Patricia Schmidt: /* Community Plugin */

2013-03-09T05:34:50Z

‎Community Plugin

Patricia Schmidt: /* User Plugin */

2013-03-09T05:34:07Z

‎User Plugin

Patricia Schmidt: /* System Plugin */

2013-03-09T05:33:37Z

‎System Plugin

Patricia Schmidt: /* System Plugin */

2013-03-09T05:33:15Z

‎System Plugin

Patricia Schmidt: /* Tutorials */

2013-03-09T05:32:55Z

‎Tutorials

Patricia Schmidt: /* Overview */

2013-03-08T03:53:19Z

‎Overview

Patricia Schmidt: /* Sample Plugin */

2013-03-08T03:53:06Z

‎Sample Plugin

@@ Line 301: / Line 301: @@
 </syntaxhighlight>
 <br />
-user-specific parameter - load it by calling:
+'''User-Specific''' parameter - load it by calling:
 <syntaxhighlight lang="php">
 $this->loadUserParams();

@@ Line 184: / Line 184: @@
 ==Community Plugin==
 The Community, or Profile, plugin, also known as an application, is the most widely used type of plugin in JomSocial. When you create a '''Community plugin''', individual site members will be able to select your plugin to be displayed on their profile page. Your plugin will be able to pull information from the user profile page and will have access to user various parameters. Please note that in the XML file of the Community plugin, you must add some additional elements.
- '''isapplication''' - If set to true, the application can be selected by user from the front-end.
+# '''isapplication''' - If set to true, the application can be selected by user from the front-end.
- '''Field coreapp''' - Within the fields section, please add a field named '''coreapp'''. This allows the Admin to force this application to appear on all user profiles.
+# '''Field coreapp''' - Within the fields section, please add a field named '''coreapp'''. This allows the Admin to force this application to appear on all user profiles.
- '''Field position''' - Within the fields section, please add a field named '''position'''. This will allow Admin to select the default position if the plugin is set as a core.
+# '''Field position''' - Within the fields section, please add a field named '''position'''. This will allow Admin to select the default position if the plugin is set as a core.
 As with the system plugin, it will need a minimum of four (4) files for the community plugin to work; however, we recommend that you to create another folder named exactly the same as the plugin. In this folder, we will store the plugin favicon, thumbnail, and eventually the '''config.xml''' file which will be used for the Frontend configuration of plugin options, as explained later through these tutorials.<br/>
 As before, in your main PHP file, you will need to:
- Include JomSocial core file.
+# Include JomSocial core file.
- Declare a class with the format, plgCommunity[Plugin name]. Unlike the System and User plugins, this class should now extend CApplications class.
+# Declare a class with the format, plgCommunity[Plugin name]. Unlike the System and User plugins, this class should now extend CApplications class.
 ====example.php====

@@ Line 86: / Line 86: @@
 ==User Plugin==
 In this turtorial, we will create the user plugin that will utilize the Joomla [http://docs.joomla.org/Plugin/Events/User#onUserAfterSave onUserAfterSave] hook to make an action in the activity stream after a new user is created. As with the system plugin, you will need a minimum of four (4) files, and follow the same structure. As before, in your main php file you will need to:
- Include the JomSocial core file.
+# Include the JomSocial core file.
- Declare a class with plgUser[Plugin name] format. This class should extend the JPlugin class.
+# Declare a class with plgUser[Plugin name] format. This class should extend the JPlugin class.
 ====example.php====

@@ Line 17: / Line 17: @@
 System plugin allows you to perform various system-wide tasks. In this tutorial, we are going to create a custom system plugin that will be triggered after [http://docs.joomla.org/Plugin/Events/System#onAfterRoute onAfterRoute Joomla system event]. In your main PHP file, you will need to
- Include a JomSocial core file.
+# Include a JomSocial core file.
- Declare a class with plgSystem[Plugin name] format. This class should extend the JPlugin class.
+# Declare a class with plgSystem[Plugin name] format. This class should extend the JPlugin class.
 ====example.php====

@@ Line 14: / Line 14: @@
 # '''en-GB.plg_type_example.sys.ini''' - System Language File.
-==System Plugin==
+===System Plugin===
 System plugin allows you to perform various system-wide tasks. In this tutorial, we are going to create a custom system plugin that will be triggered after [http://docs.joomla.org/Plugin/Events/System#onAfterRoute onAfterRoute Joomla system event]. In your main PHP file, you will need to
   Include a JomSocial core file.

@@ Line 6: / Line 6: @@
 * '''Community Plugin'''
-==Tutorials==
+===Tutorials===
 If you already know how to [http://docs.joomla.org/Plugin_Development create Joomla Plugins] then creating a JomSocial plugin would be rather easy task. <br/>
 At very least, you will need the following four (4) files:
- '''example.php''' - Main Plugin File.
+# '''example.php''' - Main Plugin File.
- '''example.xml''' - Plugin XML File.
+# '''example.xml''' - Plugin XML File.
- '''en-GB.plg_type_example.ini''' - Main Language File.
+# '''en-GB.plg_type_example.ini''' - Main Language File.
- '''en-GB.plg_type_example.sys.ini''' - System Language File.
+# '''en-GB.plg_type_example.sys.ini''' - System Language File.
 ==System Plugin==

@@ Line 2: / Line 2: @@
 Plugins allow developers the ability to extend JomSocial and provide new functionality or feature that is not already available in the core or to use the features that are available and extend them even more. A JomSocial plugin is essentially a normal Joomla plugin that can be installed, uninstalled, and managed just like every other Joomla plugin. JomSocial provides plenty of [[API Events|system hooks]] or trigger points which your plugin will use to add new functionality.<br/>
 You can create any type of plugin, but the most common types are:
-* '''System plugin'''
+* '''System Plugin'''
 * '''User Plugin
 * '''Community Plugin'''

@@ Line 179: / Line 179: @@
 ===Sample Plugin===
-This plugin is freely available at [http://www.jomsocial.com/forum/extra-addons/2308-new-user-registration#12313 our forums]. Please note that you will need a valid subscription to see the forums and that the plugin code might differ.
+This plugin is freely available in [http://www.jomsocial.com/forum/extra-addons/2308-new-user-registration#12313 our forums]. Please note that you will need a valid subscription to see the forums and that the plugin code might differ.
 ==Community Plugin==