Integrating Your Component - Revision history

Patricia Schmidt at 05:24, 9 March 2013

2013-03-09T05:24:35Z

Patricia Schmidt at 19:18, 7 March 2013

2013-03-07T19:18:46Z

Patricia Schmidt: /* Use and Extend JomSocial User Object, cUser */

2013-03-07T19:18:08Z

‎Use and Extend JomSocial User Object, cUser

Patricia Schmidt at 18:09, 7 March 2013

2013-03-07T18:09:30Z

Sinisakrisan: /* Use JomSocial Avatar */

2013-01-18T17:59:38Z

‎Use JomSocial Avatar

Sinisakrisan at 15:50, 17 January 2013

2013-01-17T15:50:20Z

Sinisakrisan at 15:48, 17 January 2013

2013-01-17T15:48:41Z

Sinisakrisan: /* Getting a user's friend count */

2013-01-17T15:48:08Z

‎Getting a user's friend count

Sinisakrisan: /* Getting a user's friend count */

2013-01-17T15:39:32Z

‎Getting a user's friend count

Sinisakrisan at 15:38, 17 January 2013

2013-01-17T15:38:45Z

@@ Line 1: / Line 1: @@
 Third-party developers can easily integrate JomSocial features into their components. Among other things, Third-party components can:
- Support JomSocial built-in personal messaging system.
+# Support JomSocial built-in personal messaging system.
- Use JomSocial avatars.
+# Use JomSocial avatars.
- Use and extend JomSocial user object, CUser.
+# Use and extend JomSocial user object, CUser.
- Include user actions in JomSocial activity stream and reward users with points.
+# Include user actions in JomSocial activity stream and reward users with points.
- Extend JomSocial via new plugins.
+# Extend JomSocial via new plugins.
 ===Support JomSocial Built-In Personal Messaging System===
 To support private messaging within your component, you can use this snippet:
 <syntaxhighlight lang="php">

@@ Line 2: / Line 2: @@
   Support JomSocial built-in personal messaging system.
   Use JomSocial avatars.
-  Use and extend JomSocial user object, cUser.
+  Use and extend JomSocial user object, CUser.
   Include user actions in JomSocial activity stream and reward users with points.
   Extend JomSocial via new plugins.

@@ Line 29: / Line 29: @@
 <br />
-===Use and Extend JomSocial User Object, cUser===
+===Use and Extend JomSocial User Object, CUser===
-JomSocial has its own [[JomSocial User Object|user object]] that can be extended further. Here are few examples how can you use it inside your component.
+JomSocial has its own [[JomSocial User Object|user object]] that can be extended further. The following are few examples how can you use it inside your component.
-====Getting a user's friend count====
+====Getting a User's Friend Count====
-To retrieve a specific user's friend count, similar like how you would request a CUser object, and call the method getFriendCount.
+Retrieving a specific user's friend count is similar to how you would request a CUser object, by calling the getFriendCount method.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 41: / Line 41: @@
 </syntaxhighlight>
 <br />
-====Getting a User's status====
+====Getting a User's Status====
-To retrieve the status that is set by the user, load up the CUser object and call the method getStatus.
+To retrieve the status that is set by the user, load the CUser object and call the method, getStatus.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 52: / Line 52: @@
 <br />
 ====Getting  a User's Display Name====
-Since JomSocial allows displaying name by either username or real name, you should use the getDisplayName method from the CUser object.
+Since JomSocial allows displaying the name with either the username or the real name, use the getDisplayName method from the CUser object.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 61: / Line 61: @@
 </syntaxhighlight>
 <br />
-====Getting a User's online status====
+====Getting a User's Online Status====
-To get the online status of the current user, you should use the isOnline method from the CUser object.
+To get the online status of the current user, use the isOnline method from the CUser object.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 74: / Line 74: @@
 </syntaxhighlight>
 <br />
-====Getting a User's view count====
+====Getting a User's View Count====
-To get a user's view count, you should use the method getViewCount from the CUser object.
+To get a user's view count, use the method, getViewCount, from the CUser object.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 84: / Line 84: @@
 </syntaxhighlight>
 <br />
-====Link to a User's personal profile Page====
+====Link to a User's Personal Profile Page====
-By using our own library, CRoute, which is a replacement for JRoute, link to any part of JomSocial will have the correct Itemid and will help avoid any duplicate link.
+By using our own library, CRoute, which is a replacement for JRoute, the link to any part of JomSocial will have the correct Itemid and will help avoid any duplicate links.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';

@@ Line 1: / Line 1: @@
-rd party component can easily integrate JomSocial features into their component. Among other things, 3rd party other component can
+Third-party developers can easily integrate JomSocial features into their components. Among other things, Third-party components can:
-  Support JomSocial build-in personal messaging system
+  Support JomSocial built-in personal messaging system.
-  Use JomSocial avatar
+  Use JomSocial avatars.
-  Use and extend JomSocial user object, CUser
+  Use and extend JomSocial user object, cUser.
-  Include user action to JomSocial activity stream, and reward user with points
+  Include user actions in JomSocial activity stream and reward users with points.
-  Extends JomSocial via new plugin
+  Extend JomSocial via new plugins.
-===Support JomSocial build-in personal messaging system===
+===Support JomSocial Built-In Personal Messaging System===
-To support private messaging within your component, you can use this snippet.
+To support private messaging within your component, you can use this snippet:
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 18: / Line 18: @@
 <br />
-===Use JomSocial Avatar===
+===Use JomSocial Avatars===
-To get path to JS avatar, you can simply request a CUser object and call a simple getThumbAvatar function to retrieve the avatar url.
+To acquire a path to a '''JomSocial Avatar''', you can simply request a cUser object and call a simple getThumbAvatar function to retrieve the avatar url.
 <syntaxhighlight lang="php">
 include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
@@ Line 29: / Line 29: @@
 <br />
-===Use and extend JomSocial user object, CUser===
+===Use and Extend JomSocial User Object, cUser===
-JomSocial have its own [[JomSocial User Object|user object]] that can be extended further.
+JomSocial has its own [[JomSocial User Object|user object]] that can be extended further. Here are few examples how can you use it inside your component.
 Here are few examples how can you use it inside your component
 ====Getting a user's friend count====
 To retrieve a specific user's friend count, similar like how you would request a CUser object, and call the method getFriendCount.

@@ Line 25: / Line 25: @@
 $user = CFactory::getUser($userid);
 $avatarUrl = $user->getThumbAvatar();
-echo '<img src="/.%20$avatarUrl%20.%20" mce_src="http://www.jomsocial.com/. $avatarUrl .">';
+echo '<img src="'.$avatarUrl.'">';
 </syntaxhighlight>
 <br />
 ===Use and extend JomSocial user object, CUser===
 JomSocial have its own [[JomSocial User Object|user object]] that can be extended further.

@@ Line 38: / Line 38: @@
 $count = $user->getFriendCount();
 echo 'Total friends: ' .$count;
 </syntaxhighlight>

@@ Line 33: / Line 33: @@
 To retrieve a specific user's friend count, similar like how you would request a CUser object, and call the method getFriendCount.
 <syntaxhighlight lang="php">
-$jspath = JPATH_ROOT . DS . 'components' . DS . 'com_community';
+include_once JPATH_ROOT.'/components/com_community/libraries/core.php';
-include_once($jspath. DS . 'libraries' . DS . 'core.php');
 // Get CUser object
 $user  = CFactory::getUser( $userid );