Profile Enhancements - Customizable Roster (Member List)

Customizable Roster (Member List)
[How to] get a working Guild/Clan Roster

Note: This modification is now discontinued - this means that while it will remain available for download and use, support will no longer be provided as the thread is no longer monitored. Please see the 3.7 release of this modification for future updates here.

Introduction:

This Mod started off as a [How to] template modification. I have since added in permission control and an installer. Those that install this Mod will need to make adjustments to two templates and one phrase depending on what you want displayed. I'll include instructions for each step as well as optional changes you can make at your decretion.

Click the following link for a Guild Roster preview: http://vanguard.sacredhaven.org/forums/showroster.php

You'll notice that I use the "Extra Profile Fields Page" by Wired1. It isn't needed for the Roster, but I think it makes the field updates look nicer for the users.


Installation:

Step 0: If you are upgrading from a previous version, save a copy of your old showroster.php and rename your showroster templates (I recommend giving them an underscore prefix; Example: _SHOWROSTER).

Step 1: Download the attached showrosterXXX.zip file.

Step 2: Upload the files to their correct directories.

Upload the showroster.php to the /forum/ directory.
Upload the bitfield_showroster.xml to the /forum/includes/xml/ directory.
Upload the spacer.gif to the /forum/images directory if you plan to use avatars.

Step 3: Admincp > Plugin & Products > Manage Products > Add/Import Product

Import the product-showroster.xml file.

Step 4: Admincp > Languages & Phrases > Phrase Manager > Phrase Type: ShowRoster > showroster_title --> Edit

Change this to whatever you want as the title of your roster.

Step 5: Admincp > User Profile Fields > Add New/Update User Profile Field

Add all the Profile Fields you plan to use and keep track of their number(s) (i.e. field6, field7, etc.).

Step 6: Admincp > Styles & Templates > Expand > ShowRoster Templates > showroster_header

This template contains the headers for each of your columns. Add/Edit/Remove columns to your preference. Be sure to update the colspan to the number of columns you have.

Step 7: Admincp > Styles & Templates > Expand > ShowRoster Templates > showroster_userbits

This template gets the data from each of the fields you want to have viewed on your roster. Add/Edit/Remove columns and/or the nowrap="nowrap" to your preference. Be sure to update each of the field#'s to match the fields from Step 5.

Step 8: Admincp > Usergroups > Usergroup Manager > Edit Usergroup

• Set "Access - Should this usergroup have access to the Showroster page?" to Yes for whatever groups you want to have permissions to access the showroster page.
• Set "Viewable - Should this usergroup be viewable on the Showroster page?" to Yes for the groups you want to have appear on the showroster page.

All instructions are included in the instructions.txt and optional.txt.

Enjoy!!!


Versions:

v1.1.3 - April 22, 2007

• Added 'Who's Online' plugin to the installer (Thanks m002.p).
• Made an update to the optional.txt file for changing the default sort.

v1.1.2 - April 20, 2007

• Added sorting to the roster. This is optional and will work without adding the sorting features.

v1.1.1 - April 19, 2007

• Small update. Just added total member count.

v1.1 - April 5, 2007 (Mod Revamp)

• Revamped everything. There is now an installer to do most of the work for you.
• The installer adds two new fields to your usergroup table. This allows you to set permissions for the showroster rather than using the showgroups permissions.
• Removed a few options from the optional.txt file since they are now a part of the mod.

v1.03 - April 2, 2007

• Added some code back to the showroster.php so join date, last activity, and usernames HTML markups could be used.
• Changed $user[username] to $user[musername] in the showroster_userbits template. This will allow HTML markups to the usernames again.
• Added instructions on how to change which usergroups appear on the Roster.
• Added optional.txt to the zip for optional changes.

v1.01 - March 27, 2007

• Changed a few variable names.
• Changed template names.
• Removed a lot of unneeded code from the showroster.php.
• Added the ability to include user avatars.
• Added a counter to keep track of how many users in each usergroup.

v1.01 - March 9, 2007

• Removed a lot of unneeded code from the SHOWROSTER template.
• Fixed a couple code problems.

v1.0 - March 6, 2007 (Initial Release)

[grecostimpy]

Originally Posted by Sarcoth

Let me know how that works.

PERFECT! Thank you so much!

Only problem is it still crashes (white screens) when I try to include all usergroups.

Hmmmm....we'll get it figured out!

[Sarcoth]

Originally Posted by grecostimpy

PERFECT! Thank you so much!

Only problem is it still crashes (white screens) when I try to include all usergroups.

Hmmmm....we'll get it figured out!

Try upgrading to the new version. Maybe we'll get lucky and that will have fixed the problem. I removed a bunch of code and maybe part of it was causing the white screen on your forums. I wish I could generate the same problem as you for testing.

[Sarcoth]

Pay close attention to the following changes if you do upgrade to the new version. I would recommend just going through all the steps again and copying the updated templates.

Templates were renamed:

• SHOWROSTER stayed the same.
• showroster_usergroup was renamed to showroster_header
• showroster_usergroupbit was renamed to showroster_userbits

Variables in templates were renamed:

• In SHOWROSTER: $usergroups was renamed to $rosterheader
• In showroster_header: $usergroupbits was renamed to $rosterbits

Sorry for any confusion but I'm trying to fork away from the showgroups page.

[grecostimpy]

Originally Posted by Sarcoth

Templates were renamed:

• SHOWROSTER stayed the same.
• showroster_usergroup was renamed to showroster_header
• showroster_usergroupbit was renamed to showroster_userbits

FYI: In the instructions you have it renamed to showroster_rosterbits. Mine was not working until I realized the difference.

Unfortunately, still getting the white screen of death on large usergroups....my main registered users group (which is the one it fails on) only has around 1,800 users. Any ideas?

[grecostimpy]

...also...(sorry for so many requests)

Since the php file changed, could you show what edits I would need to make to only show users who have filled out custom profile field 5 again (I tried myself, but could not make it work)

[Sarcoth]

Originally Posted by grecostimpy

FYI: In the instructions you have it renamed to showroster_rosterbits. Mine was not working until I realized the difference.

Unfortunately, still getting the white screen of death on large usergroups....my main registered users group (which is the one it fails on) only has around 1,800 users. Any ideas?

Ahhh, thanks for pointing that out. I apologize for the typo.

1,800 users. Really not sure why it would be failing. I'll see if I can come up with a way to page it out for you, but that is probably a bit above my knowledge right now. I'll see if I can figure it out.

Originally Posted by grecostimpy

...also...(sorry for so many requests)

Since the php file changed, could you show what edits I would need to make to only show users who have filled out custom profile field 5 again (I tried myself, but could not make it work)

NP. I'm actually enjoying this.

Find:

		foreach ($users AS $user) {
			exec_switch_bg();
			$usercount++;
			$avatarurl=fetch_avatar_url($user[userid]); 
			if (!$avatarurl) {
				$avatarurl = 'images/spacer.gif';
			} else {
				$avatarurl = $vbulletin->options['bburl'] . '/' . $avatarurl[0];
			}
			$avatarimage='<img src="'.$avatarurl.'" border="0">';  //Use $avatarimage in userbits to display avatars
			eval('$rosterbits .= "' . fetch_template('showroster_userbits') . '";');
		}

Change to:

		foreach ($users AS $user) {
			if ($user['field5'] != '') {
				exec_switch_bg();
				$usercount++;
				$avatarurl=fetch_avatar_url($user[userid]); 
				if (!$avatarurl) {
					$avatarurl = 'images/spacer.gif';
				} else {
					$avatarurl = $vbulletin->options['bburl'] . '/' . $avatarurl[0];
				}
				$avatarimage='<img src="'.$avatarurl.'" border="0">';  //Use $avatarimage in userbits to display avatars
				eval('$rosterbits .= "' . fetch_template('showroster_userbits') . '";');
			}
		}

[grecostimpy]

Thanks Sarcoth....

As for the large usergroups...

I'm wondering if something similar can be done as what was with the Timeslip database. It created custom profile fields for all users and then only showed users who had them filled out. Not sure how they got around the white screens, but perhaps someone can chime in?

Again...thanks for all of your help. You truly are a great supporter of your product!

[ssslippy]

ok what code should I replace to pick the usergroups manually, is this possible. Would be much easier for me as I need to have multiple rosters.

[ssslippy]

Originally Posted by Sarcoth

Ahhh, thanks for pointing that out. I apologize for the typo.

1,800 users. Really not sure why it would be failing. I'll see if I can come up with a way to page it out for you, but that is probably a bit above my knowledge right now. I'll see if I can figure it out.



NP. I'm actually enjoying this.

Find:

		foreach ($users AS $user) {
			exec_switch_bg();
			$usercount++;
			$avatarurl=fetch_avatar_url($user[userid]); 
			if (!$avatarurl) {
				$avatarurl = 'images/spacer.gif';
			} else {
				$avatarurl = $vbulletin->options['bburl'] . '/' . $avatarurl[0];
			}
			$avatarimage='<img src="'.$avatarurl.'" border="0">';  //Use $avatarimage in userbits to display avatars
			eval('$rosterbits .= "' . fetch_template('test_showroster_userbits') . '";');
		}

Change to:

		foreach ($users AS $user) {
			if ($user['field5'] != '') {
				exec_switch_bg();
				$usercount++;
				$avatarurl=fetch_avatar_url($user[userid]); 
				if (!$avatarurl) {
					$avatarurl = 'images/spacer.gif';
				} else {
					$avatarurl = $vbulletin->options['bburl'] . '/' . $avatarurl[0];
				}
				$avatarimage='<img src="'.$avatarurl.'" border="0">';  //Use $avatarimage in userbits to display avatars
				eval('$rosterbits .= "' . fetch_template('test_showroster_userbits') . '";');
			}
		}

Slight error in this code, you have 'test_showroster_userbits' and it should be 'showroster_userbits'

[Sarcoth]

Originally Posted by ssslippy

ok what code should I replace to pick the usergroups manually, is this possible. Would be much easier for me as I need to have multiple rosters.

That's my primary project for this hack right now. I'll let you know once I have it working.

Originally Posted by ssslippy

Slight error in this code, you have 'test_showroster_userbits' and it should be 'showroster_userbits'

Thanks for pointing that out. I use a test_ page for making changes. I forgot to drop the prefix before posting the code.