AddonSDK

Revision as of 05:04, 11 January 2008 (view source) Zanix (Talk | contribs) ← Older edit		Revision as of 04:13, 6 February 2008 (view source) Zanix (Talk | contribs) Newer edit →
Line 4:		Line 4:
	==WoWRoster v2.0.0b AddOn Development==		==WoWRoster v2.0.0b AddOn Development==
−	Updated: 10:41, 7 January 2008 (PST)	+	Updated: 22:13, 5 February 2008 (CST)
	This document is being revised as 2.0 goes through development<br>		This document is being revised as 2.0 goes through development<br>
Line 10:		Line 10:
	==Changes==		==Changes==
		+	* [[User:Zanix|Zanix]] 22:13, 5 February 2008 (CST)
		+	** Updated some examples, and some of the wording in a few places
		+	** Roster Auth changes
		+
	* [[User:Zanix|Zanix]] 21:04, 10 January 2008 (PST)		* [[User:Zanix|Zanix]] 21:04, 10 January 2008 (PST)
	** Roster login changes		** Roster login changes
Line 137:		Line 141:
	* Create AddOns with SQL Debug Output, Debug Mode, and SQL Window enabled in [[Roster:CP|RosterCP]]		* Create AddOns with SQL Debug Output, Debug Mode, and SQL Window enabled in [[Roster:CP|RosterCP]]
	** Even though php notices and warnings are suppressed when these are off, it is good practice to enable these options when coding AddOns		** Even though php notices and warnings are suppressed when these are off, it is good practice to enable these options when coding AddOns
−	* No funky text (BOM characters displaying above the menu for example)	+	* No funky text (such as BOM characters)
	*: (ie: strange characters appearing on top of the roster's menu)		*: (ie: strange characters appearing on top of the roster's menu)
	* Valid XHTML 1.0 Transitional - http://validator.w3.org		* Valid XHTML 1.0 Transitional - http://validator.w3.org
−	* Proper use of the DB layer - <span style="color:maroon;">$roster->db</span>	+	* Proper use of the DB layer - [[FunctionsOverview#.24roster-.3Edb|$roster->db]]
	* Roster main files are not edited		* Roster main files are not edited
	* Roster main database tables are not edited, unless you provide a clean way to revert the data in your uninstall		* Roster main database tables are not edited, unless you provide a clean way to revert the data in your uninstall
Line 175:		Line 179:
	==Changes Since 1.7.3==		==Changes Since 1.7.3==
−	* All AddOns need to be installed using an install definition file inc/install.def.php.	+	* All AddOns need to be installed using an install definition file [[#Creating_the_Installer|inc/install.def.php]].
	* During install, database tables, graphical configuration, menu buttons, and update hooks can be registered with the main framework.		* During install, database tables, graphical configuration, menu buttons, and update hooks can be registered with the main framework.
	* menu.php file is no longer required.		* menu.php file is no longer required.
Line 199:		Line 203:
	* You do not know the basename at design time.		* You do not know the basename at design time.
	** Please use the $addon['basename'] variable for this at all times.		** Please use the $addon['basename'] variable for this at all times.
−	* On lua updates, the addon's inc/update_hook.php is included once.	+	* On lua updates, the addon's [[#AddOn_Update_Hook|inc/update_hook.php]] is included once.
	** Details for the new update hook structure is below		** Details for the new update hook structure is below
	* Menu buttons are created in the database using installer functions		* Menu buttons are created in the database using installer functions
Line 221:		Line 225:
	# Do not have to connect to Roster's database		# Do not have to connect to Roster's database
	# Do not have to include your inc/conf.php		# Do not have to include your inc/conf.php
−	# AddOn files: inc/conf.php, style.css, inc/update_hook.php, and locale files are OPTIONAL!	+	# AddOn files: inc/conf.php, [[#CSS_Styles|style.css]], [[#AddOn_Update_Hook|inc/update_hook.php]], and locale files are OPTIONAL!
	#: Even additional locale files are optional, enUS.php is the default locale, and is required if you have locale files		#: Even additional locale files are optional, enUS.php is the default locale, and is required if you have locale files
Line 228:		Line 232:
	===What it does===		===What it does===
	# Includes all Roster config variables for you to use (<span style="color:maroon;">$roster</span>->config)		# Includes all Roster config variables for you to use (<span style="color:maroon;">$roster</span>->config)
−	# Includes all Roster SQL functions for your use (<span style="color:maroon;">$roster</span>->db)	+	# Includes all Roster SQL functions for your use ([[FunctionsOverview#.24roster-.3Edb|$roster->db]])
	# Includes all Roster and AddOn language variables for you (<span style="color:maroon;">$roster</span>->locale->wordings, <span style="color:maroon;">$roster</span>->locale->act)		# Includes all Roster and AddOn language variables for you (<span style="color:maroon;">$roster</span>->locale->wordings, <span style="color:maroon;">$roster</span>->locale->act)
	# Includes all Roster css styles		# Includes all Roster css styles
Line 346:		Line 350:
	====inc Folder====		====inc Folder====
−	This folder houses special files not meant for direct access by the AddOn Framework<br>	+	This folder houses special files not meant for direct access by the AddOn Framework
−	These files are conf.php, install.def.php, search.inc, and update_hook.php<br>	+
		+	* conf.php - This is included before any other addon file, any initialization can be done here
		+	* [[#Creating_the_Installer|install.def.php]] - The AddOn's install/upgrade/uninstall definition file
		+	* [[#Creating_the_Search_Class|search.inc.php]] - Search plug-in for the Roster search page
		+	* [[#AddOn_Update_Hook|update_hook.php]] - Update Hook file
		+
	You can also use this folder for lib, library, and/or functions files		You can also use this folder for lib, library, and/or functions files
Line 395:		Line 404:
	====Other Files====		====Other Files====
−	* inc/conf.php - This is included before any other addon file, any initialization can be done here
	* index.php - The main file for the util scope		* index.php - The main file for the util scope
−	* [[#Creating_the_Installer|inc/install.def.php]] - The AddOn's install/upgrade/uninstall definition file
	* [[#CSS_Styles|style.css]] - A custom css style for the AddOn		* [[#CSS_Styles|style.css]] - A custom css style for the AddOn
−	* [[#AddOn_Update_Hook|inc/update_hook.php]] - Update Hook file
Line 652:		Line 658:
	var $version = '2.0.0.0';		var $version = '2.0.0.0';
		+	var $wrnet_id = 0;
	var $fullname = 'some_addon';		var $fullname = 'some_addon';
Line 812:		Line 819:
	You can find more examples in the addons/ folder in roster		You can find more examples in the addons/ folder in roster
	<php><?php		<php><?php
		+	/**
		+	* WoWRoster.net WoWRoster
		+	*
		+	* LICENSE: Licensed under the Creative Commons
		+	*          "Attribution-NonCommercial-ShareAlike 2.5" license
		+	*
		+	* @copyright  2002-2007 WoWRoster.net
		+	* @license    http://creativecommons.org/licenses/by-nc-sa/2.5  Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
		+	* @version    SVN: $Id: search.inc.php 1518 2007-12-10 20:18:04Z Zanix $
		+	* @link      http://www.wowroster.net
		+	* @package    News
		+	* @subpackage Search
		+	*/
		+
		+	if( !defined('IN_ROSTER') )
		+	{
		+	exit('Detected invalid access to this file!');
		+	}
	class news_search		class news_search
Line 818:		Line 843:
	var $result = array();		var $result = array();
	var $result_count = 0;		var $result_count = 0;
		+	var $start_search;
		+	var $stop_search;
		+	var $time_search;
	var $link_next;		var $link_next;
	var $link_prev;		var $link_prev;
−	var $data = array(); // Addon data	+	var $open_table;
−		+	var $close_table;
		+	var $data = array();   // Addon data
	function search( $search , $url_search , $limit=10 , $page=0 )		function search( $search , $url_search , $limit=10 , $page=0 )
Line 830:		Line 859:
	$q = "SELECT `news`.`news_id`, `news`.`author`, `news`.`title`, `news`.`content`, `news`.`html`, "		$q = "SELECT `news`.`news_id`, `news`.`author`, `news`.`title`, `news`.`content`, `news`.`html`, "
−	. "DATE_FORMAT(  DATE_ADD(`news`.`date`, INTERVAL "	+	. "DATE_FORMAT(  DATE_ADD(`news`.`date`, INTERVAL " . $roster->config['localtimeoffset'] . " HOUR ), '" . $roster->locale->act['timeformat'] . "' ) AS 'date_format', "
−	. $roster->config['localtimeoffset'] . " HOUR ), '" . $roster->locale->act['timeformat'] . "' ) AS 'date_format', "	+	. "COUNT(`comments`.`comment_id`) comm_count "
−	. "COUNT(`comments`.`comment_id`) comm_count "	+	. "FROM `" . $roster->db->table('news','news') . "` news "
−	. "FROM `" . $roster->db->table('news','news') . "` news "	+	. "LEFT JOIN `" . $roster->db->table('comments','news') . "` comments USING (`news_id`) "
−	. "LEFT JOIN `" . $roster->db->table('comments','news') . "` comments USING (`news_id`) "	+	. "WHERE `news`.`news_id` LIKE '%$search%' "
−	. "WHERE `news`.`news_id` LIKE '%$search%' "	+	. "OR `news`.`author` LIKE '%$search%' "
−	. "OR `news`.`author` LIKE '%$search%' "	+	. "OR `news`.`date` LIKE '%$search%' "
−	. "OR `news`.`date` LIKE '%$search%' "	+	. "OR `news`.`title` LIKE '%$search%' "
−	. "OR `news`.`title` LIKE '%$search%' "	+	. "OR `news`.`content` LIKE '%$search%' "
−	. "OR `news`.`content` LIKE '%$search%' "	+	. "GROUP BY `news`.`news_id` "
−	. "GROUP BY `news`.`news_id` "	+	. ( $limit > 0 ? " LIMIT $first," . ($limit+1) : '' ) . ';';
−	. "LIMIT $first," . ($limit+1) .";";	+
		+	//calculating the search time
		+	$this->start_search = format_microtime();
	$result = $roster->db->query($q);		$result = $roster->db->query($q);
		+
		+	$this->stop_search = format_microtime();
		+	$this->time_search = round($this->stop_search - $this->start_search,3);
		+
	$nrows = $roster->db->num_rows($result);		$nrows = $roster->db->num_rows($result);
−	$x = ($limit > $nrows) ? $nrows : $limit;	+	$x = ($limit > $nrows) ? $nrows : ($limit > 0 ? $limit : $nrows);
	if( $nrows > 0 )		if( $nrows > 0 )
	{		{
Line 880:		Line 915:
	$item['short_text'] = implode(' ',$array);		$item['short_text'] = implode(' ',$array);
−	$item['footer'] = ($comments == 0?'No':$comments) . ' comment' . ($comments == 1?'':'s');	+	$item['footer'] = ($comments == 0 ? 'No' : $comments) . ' comment' . ($comments == 1 ? '' : 's');
	$this->add_result($item);		$this->add_result($item);
Line 890:		Line 925:
	if( $page > 0 )		if( $page > 0 )
	{		{
−	$this->link_prev = '<a href="' . makelink('search&amp;page=' . ($page-1) . '&amp;search=' . $url_search . '&amp;s_addon='	+	$this->link_prev = '<a href="' . makelink('search&amp;page=' . ($page-1) . '&amp;search=' . $url_search . '&amp;s_addon=' . $this->data['basename']) . '"><strong>' . $roster->locale->act['search_previous_matches'] . $this->data['fullname'] . '</strong></a>';
−	. $this->data['basename']) . '"><strong>' . $roster->locale->act['search_previous_matches'] . $this->data['basename'] . '</strong></a>';	+
	}		}
	if( $nrows > $limit )		if( $nrows > $limit )
	{		{
−	$this->link_next = '<a href="' . makelink('search&amp;page=' . ($page+1) . '&amp;search=' . $url_search . '&amp;s_addon='	+	$this->link_next = '<a href="' . makelink('search&amp;page=' . ($page+1) . '&amp;search=' . $url_search . '&amp;s_addon=' . $this->data['basename']) . '"><strong> ' . $roster->locale->act['search_next_matches'] . $this->data['fullname'] . '</strong></a>';
−	. $this->data['basename']) . '"><strong> ' . $roster->locale->act['search_next_matches'] . $this->data['basename'] . '</strong></a>';	+
	}		}
	}		}
Line 904:		Line 937:
	$this->result[$this->result_count++] = $resultarray;		$this->result[$this->result_count++] = $resultarray;
	}		}
−	}	+	}</php>
−	</php>	+
Line 937:		Line 969:
	* makelink		* makelink
−	*: Passes this through Roster's makelink() function to generate a correct link to another page in Roster.	+	*: Passes this through Roster's [[FunctionsOverview#makelink|makelink()]] function to generate a correct link to another page in Roster.
	*: <span style="color:maroon;">$installer</span>->add_config("120,'config_name','link_value','makelink','menu'")		*: <span style="color:maroon;">$installer</span>->add_config("120,'config_name','link_value','makelink','menu'")
	* makenewlink		* makenewlink
−	*: Same as makelink, except it opens a new browser window.	+	*: Same as [[FunctionsOverview#makelink|makelink()]], except it opens a new browser window.
	*: <span style="color:maroon;">$installer</span>->add_config("180,'config_name','link_value','makenewlink','menu'")		*: <span style="color:maroon;">$installer</span>->add_config("180,'config_name','link_value','makenewlink','menu'")
Line 1,057:		Line 1,089:
	===Example File===		===Example File===
−	Example from the PvPLog Roster AddOn<br>	+	Example from the MembersList Roster AddOn<br>
−	addons/pvplog/locale/deDE.php	+	addons/memberslist/locale/deDE.php
	<php><?php		<php><?php
	/**		/**
Line 1,068:		Line 1,100:
	* @copyright  2002-2007 WoWRoster.net		* @copyright  2002-2007 WoWRoster.net
	* @license    http://creativecommons.org/licenses/by-nc-sa/2.5  Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"		* @license    http://creativecommons.org/licenses/by-nc-sa/2.5  Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
−	* @version    SVN: $Id: deDE.php 899 2007-05-06 10:16:36Z Zanix $	+	* @version    SVN: $Id: deDE.php 1523 2007-12-13 12:24:31Z pleegwat $
	* @link      http://www.wowroster.net		* @link      http://www.wowroster.net
		+	* @package    MembersList
		+	* @subpackage Locale
	*/		*/
−	$lang['bglog']='BG &Uuml;bersicht';	+	// -[ deDE Localization ]-
−	$lang['pvplog']='PvP &Uuml;bersicht';	+
−	$lang['duellog']='Duell &Uuml;bersicht';	+	// Installer names
−	$lang['duelsummary']='Duell Summary';	+	$lang['memberslist']           = 'Mitgliederliste';
		+	$lang['memberslist_desc']      = 'Eine sortier- und filterbare Mitgliederliste';
		+
		+	// Button names
		+	$lang['memberslist_Members'] = 'Mitglieder|Zeigt die Gildenmitgliederliste mit Spielernotizen, Zuletzt online, usw... an';
		+	$lang['memberslist_Stats'] = 'Grundwerte|Zeigt die Grundwerte jedes Gildenmitglieds wie Intelligenz, Ausdauer, usw... an';
		+	$lang['memberslist_Honor'] = 'Ehre|Zeigt die PvP-Informationen jedes Gildenmitglieds an';
		+	$lang['memberslist_Log'] = 'Mitglieder Log|Zeigt das upload log für neue und entfernte Mitglieder an';
		+	$lang['memberslist_Realm'] = 'Mitglieder|Zeigt die Mitgliederliste für alle Gilden auf allen Servern an';
		+	$lang['memberslist_RealmGuild'] = 'Gilden|Zeigt eine Liste für alle Gilden auf allen Realms an';
		+
		+	// Interface wordings
		+	$lang['memberssortfilter'] = 'Sortierreihenfolge und Filterung';
		+	$lang['memberssort'] = 'Sortierung';
		+	$lang['memberscolshow'] = 'Zeige/Verstecke Spalten';
		+	$lang['membersfilter'] = 'Zeilenfilter';
		+
		+	$lang['openall']                = 'Öffne alle';
		+	$lang['closeall']              = 'Schließe alle';
		+	$lang['ungroupalts']            = 'Twinkgruppen auflösen';
		+	$lang['openalts']              = 'Gruppiere Twinks (Open)';
		+	$lang['closealts']              = 'Gruppiere Twinks (Closed)';
		+	$lang['clientsort']            = 'Clientsortierung';
		+	$lang['serversort']            = 'Serversortierung';
		+
		+	// Column headers
		+	$lang['onote']                  = 'Offizier Notiz';
		+
		+	$lang['honorpoints']            = 'Ehrenpunkte';
		+	$lang['arenapoints']            = 'Arenapunkte';
		+
		+	$lang['main_name']              = 'Hauptcharaktername';
		+	$lang['alt_type']              = 'Alt type';
		+
		+	$lang['xp_to_go']              = '%1$s XP until level %2$s';
		+
		+	$lang['skill_level'] = 'Skill level';
		+
		+	// Last Online words
		+	$lang['online_at_update']      = 'Online bei Update';
		+	$lang['second']                = 'vor %s Sekunde';
		+	$lang['seconds']                = 'vor %s Sekunden';
		+	$lang['minute']                = 'vor %s Minute';
		+	$lang['minutes']                = 'vor %s Minuten';
		+	$lang['hour']                  = 'vor %s Stunde';
		+	$lang['hours']                  = 'vor %s Stunden';
		+	$lang['day']                    = 'vor %s Tag';
		+	$lang['days']                  = 'vor %s Tagen';
		+	$lang['week']                  = 'vor %s Woche';
		+	$lang['weeks']                  = 'vor %s Wochen';
		+	$lang['month']                  = 'vor %s Monat';
		+	$lang['months']                = 'vor %s Monaten';
		+	$lang['year']                  = 'vor %s Jahr';
		+	$lang['years']                  = 'vor %s Jahren';
		+
		+	$lang['armor_tooltip'] = 'Verringert den erlittenen körperlichen Schaden um %1$s%%';
		+
		+	$lang['motd']                  = 'MOTD';
		+	$lang['accounts']              = 'Accounts';
		+
		+	// Configuration
		+	$lang['memberslist_config'] = 'Gehe zur Mitgliederliste-Konfiguration';
		+	$lang['memberslist_config_page']= 'Mitgliederliste-Konfiguration';
		+	$lang['documentation'] = 'Dokumentation';
		+	$lang['uninstall'] = 'Uninstall';
		+
		+	// Page names
		+	$lang['admin']['display']      = 'Anzeige|Konfiguriert die Anzeigeoptionen für die Mitgliederliste.';
		+	$lang['admin']['members']      = 'Mitgliederliste|Konfiguriert die Sichtbarkeit der Mitgliederliste-Spalten.';
		+	$lang['admin']['stats']        = 'Werteliste|Konfiguriert die Sichtbarkeit der Grundwerte-Spalten.';
		+	$lang['admin']['honor']        = 'Ehrenliste|Konfiguriert die Sichtbarkeit der Ehrenliste-Spalten.';
		+	$lang['admin']['log']          = 'Mitglieder Log|Konfiguriert die Sichtbarkeit der Mitglieder Log-Spalten.';
		+	$lang['admin']['build']        = 'Hauptchar/Twink Beziehungen|Konfiguriert wie Hauptchars/Twinks erkannt werden.';
		+	$lang['admin']['ml_wiki']      = 'Dokumentation|Mitgliederliste Dokumentation auf WoWRoster wiki.';
		+	$lang['admin']['updMainAlt']    = 'Aktualisiere Beziehungen|Aktualisiert die Main/Alt Beziehungen der Daten, die bereits in der DB gespeichert sind.';
		+	$lang['admin']['page_size'] = 'Seitengröße|Konfiguriert die Anzahl der Zeilen Pro Seite oder 0 für keinen Seitenumbruch';
−	$lang['totalwins']='Gewinne total';	+	// Settings names on display page
−	$lang['totallosses']='Verluste total';	+	$lang['admin']['openfilter'] = 'Öffne Filterbereich|Gib an, ob der Filterbereich standardmäßig geöffnet oder geschlossen sein sill.';
−	$lang['totaloverall']='Gesamt';	+	$lang['admin']['nojs']          = 'Listentyp|Gib an, ob du eine serverseitige Sortierung oder eine clientseitige Sortierung+Filterung haben möchtest.';
−	$lang['win_average']='Durchschnittliche Level Differenz (Gewinne)';	+	$lang['admin']['def_sort'] = 'Standard Sortierung|Gib die standard Sortiermethode an.';
−	$lang['loss_average']='Durchschnittliche Level Differenz  (Verluste)';	+	$lang['admin']['member_tooltip']= 'Mitglieder Tooltip|Schalte den Inf-Tooltip über den Mitgliedernamen an oder aus.';
		+	$lang['admin']['group_alts']    = 'Gruppiere Twinks|Gruppiere Twinks unterhalb ihrer Hauptcharaktere anstelle sie seperat zu sortieren.';
		+	$lang['admin']['icon_size']    = 'Icon Größe|Setze die Größe der Klasse/Ehre/Beruf Icons.';
		+	$lang['admin']['spec_icon'] = 'Talent Icon|Schalte das Talent Icon an oder aus.';
		+	$lang['admin']['class_icon']    = 'Klassen Icon|Kontrolliert die Klass/Talent Icon Anzeige.<br />Full - Anzeige von Talent und Klassen Icon<br />On - Nur Anzeige des Klasse Icons<br />Off- Keine Icons';
		+	$lang['admin']['class_text']    = 'Klassentext|Kontrolliert die Klassentectanzeige.<br />Color - Farbiger Klassentext<br />On - Anzeige des Klassentextes<br />Off - Kein Klassentext';
		+	$lang['admin']['talent_text']  = 'Talenttext|Zeigt die Talentspezialisierung anstalle des Klassennamens.';
		+	$lang['admin']['level_bar']    = 'Level Balken|Anzeige von Levelbalken anstelle von einfachen Zahlen.';
		+	$lang['admin']['honor_icon']    = 'Ehre Icon|Anzeige des Ehrenrang Icons.';
		+	$lang['admin']['compress_note'] = 'Kompakte Notiz|Zeige Gildennotiz als Tooltip anstelle innerhalb der Spalte.';
−	// These need to be EXACTLY what PvPLog stores them as	+	// Settings on Members page
−	$lang['alterac_valley']='Alteractal';	+	$lang['admin']['member_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Mitgliederseite';
−	$lang['arathi_basin']='Arathibecken';	+	$lang['admin']['member_motd'] = 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Mitgliederseite';
−	$lang['warsong_gulch']='Kriegshymnenschlucht';	+	$lang['admin']['member_hslist'] = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Mitgliederseite';
		+	$lang['admin']['member_pvplist']= 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Mitgliederseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
		+	$lang['admin']['member_class']  = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Mitgliederseite';
		+	$lang['admin']['member_level']  = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Mitgliederseite';
		+	$lang['admin']['member_gtitle'] = 'Gildenrang|Setze die Sichtbarkeit der Gildenrangspalte auf der Mitgliederseite';
		+	$lang['admin']['member_hrank']  = 'Ehrenrang|Setze die Sichtbarkeit der letzter Ehrenrangspalte auf der Mitgliederseite';
		+	$lang['admin']['member_prof']  = 'Beruf|Setze die Sichtbarkeit der Berufspalte auf der Mitgliederseite';
		+	$lang['admin']['member_hearth'] = 'Ruhestein|Setze die Sichtbarkeit der Ruhesteinspalte auf der Mitgliederseite';
		+	$lang['admin']['member_zone']  = 'Zone|Setze die Sichtbarkeit der Letztes Gebiet-Spalte auf der Mitgliederseite';
		+	$lang['admin']['member_online'] = 'Zuletzt Online|Setze die Sichtbarkeit der Zuletzt Online-Spalte auf der Mitgliederseite';
		+	$lang['admin']['member_update'] = 'Zuletzt aktualisiert|Setze die Sichtbarkeit der Zuletzt aktualisiert-Spalte auf der Mitgliederseite';
		+	$lang['admin']['member_note']  = 'Notiz|Setze die Sichtbarkeit der Notizspalte auf der Mitgliederseite';
		+	$lang['admin']['member_onote'] = 'Offizernotiz|Setze die Sichtbarkeit der Offiziernotizspalte auf der Mitgliederseite';
−	$lang['world_pvp']='Welt-PvP';	+	// Settings on Stats page
−	$lang['versus_guilds']='Gegengilden';	+	$lang['admin']['stats_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Wertelisteseite';
−	$lang['versus_players']='Gegenspieler';	+	$lang['admin']['stats_motd'] = 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Wertelisteseite';
−	$lang['bestsub']='Beste Subzone';	+	$lang['admin']['stats_hslist']  = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Wertelisteseite';
−	$lang['worstsub']='Schlechteste Subzone';	+	$lang['admin']['stats_pvplist'] = 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Wertelisteseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
−	$lang['killedmost']='Am meisten get&ouml;tet';	+	$lang['admin']['stats_class']  = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Wertelisteseite';
−	$lang['killedmostby']='Am meisten get&ouml;tet durch';	+	$lang['admin']['stats_level']  = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Wertelisteseite';
−	$lang['gkilledmost']='Am meisten get&ouml;tete Spieler der Gilde';	+	$lang['admin']['stats_str']    = 'Stärke|Setze die Sichtbarkeit der Stärkepalte auf der Wertelisteseite';
−	$lang['gkilledmostby']='Am meister get&ouml;tet durch Spieler der Gilde';	+	$lang['admin']['stats_agi']    = 'Beweglichkeit|Setze die Sichtbarkeit der Beweglichkeitspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_sta']     = 'Willenskraft|Setze die Sichtbarkeit der Willenskraftspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_int']    = 'Intelligenz|Setze die Sichtbarkeit der Intelligenzspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_spi']    = 'Willenskraft|Setze die Sichtbarkeit der Willenskraftspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_sum']    = 'Gesamt|Setze die Sichtbarkeit der Gesamtspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_health']  = 'Gesundheit|Setze die Sichtbarkeit der Gesundheitspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_mana']    = 'Mana|Setze die Sichtbarkeit der Manaspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_armor']  = 'Rüstung|Setze die Sichtbarkeit der Rüstungspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_dodge']  = 'Ausweichen|Setze die Sichtbarkeit der Ausweichenspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_parry']  = 'Parrieren|Setze die Sichtbarkeit der Parierenspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_block']  = 'Blocken|Setze die Sichtbarkeit der Blockenspalte auf der Wertelisteseite';
		+	$lang['admin']['stats_crit']    = 'Krit|Setze die Sichtbarkeit der Kritspalte auf der Wertelisteseite';
−	$lang['wins']='Gewinne';	+	// Settings on Honor page
−	$lang['losses']='Verluste';	+	$lang['admin']['honor_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Ehrenstatistikseite';
−	$lang['overall']='Gesamt';	+	$lang['admin']['honor_motd'] = 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Ehrenstatistikseite';
−	$lang['best_zone']='Beste Zone';	+	$lang['admin']['honor_hslist']  = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Ehrenstatistikseite';
−	$lang['worst_zone']='Schlechteste Zone';	+	$lang['admin']['honor_pvplist'] = 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Ehrenstatistikseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
−	$lang['most_killed']='Meisten get&ouml;tet';	+	$lang['admin']['honor_class']   = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Ehrenstatistikseite';
−	$lang['most_killed_by']='Meisten get&ouml;tet durch';	+	$lang['admin']['honor_level']  = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Ehrenstatistikseite';
−	$lang['leveldiff']='LevelDiff';	+	$lang['admin']['honor_thk']    = 'Heute HK|Setze die Sichtbarkeit der Heute HK-Spalte auf der Ehrenstatistikseite';
−	$lang['bg']='Schlachtfeld';	+	$lang['admin']['honor_tcp']    = 'Heute CP|Setze die Sichtbarkeit der Heute CP-Spalte auf der Ehrenstatistikseite';
−	$lang['kills']='Kills';	+	$lang['admin']['honor_yhk']    = 'Gestern HK|Setze die Sichtbarkeit der Gestern HK-Spalte auf der Ehrenstatistikseite';
		+	$lang['admin']['honor_ycp']     = 'Gestern CP|Setze die Sichtbarkeit der Gestern CP-Spalte auf der Ehrenstatistikseite';
		+	$lang['admin']['honor_lifehk']  = 'Gesamte HK|Setze die Sichtbarkeit der Gesamt HK-Spalte auf der Ehrenstatistikseite';
		+	$lang['admin']['honor_hrank']  = 'Höchster Rang|Setze die Sichtbarkeit der Höchster Rang-Spalte auf der Ehrenstatistikseite';
		+	$lang['admin']['honor_hp']      = 'Ehrenpunkte|Setze die Sichtbarkeit der Ehrenpunktespalte auf der Ehrenstatistikseite';
		+	$lang['admin']['honor_ap']     = 'Arenapunkte|Setze die Sichtbarkeit der Arenapunktespalte auf der Ehrenstatistikseite';
−	// guildpvp strings	+	// Settings on Members page
−	$lang['guildwins'] = 'Wins by Guild';	+	$lang['admin']['log_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Mitglieder Log Seite';
−	$lang['guildlosses'] = 'Losses by Guild';	+	$lang['admin']['log_motd'] = 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Mitglieder Log Seite';
−	$lang['enemywins'] = 'Wins by Enemy';	+	$lang['admin']['log_hslist'] = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Mitglieder Log Seite';
−	$lang['enemylosses'] = 'Losses by Enemy';	+	$lang['admin']['log_pvplist'] = 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Mitglieder Log Seite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
−	$lang['purgewins'] = 'Guild Member Kills';	+	$lang['admin']['log_class'] = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Mitglieder Log Seite';
−	$lang['purgelosses'] = 'Guild Member Deaths';	+	$lang['admin']['log_level'] = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Mitglieder Log Seite';
−	$lang['purgeavewins'] = 'Best Win/Level-Diff Average';	+	$lang['admin']['log_gtitle'] = 'Gildenrang|Setze die Sichtbarkeit der Gildenrangspalte auf der Mitglieder Log Seite';
−	$lang['purgeavelosses'] = 'Best Loss/Level-Diff Average';	+	$lang['admin']['log_type'] = 'Typ|Setze die Sichtbarkeit der Typspalte auf der Mitglieder Log Seite';
−	$lang['pvpratio'] = 'Solo Win/Loss Ratios';	+	$lang['admin']['log_date'] = 'Zuletzt Online|Setze die Sichtbarkeit der Zuletzt Online-Spalte auf der Mitglieder Log Seite';
−	$lang['playerinfo'] = 'Player Info';	+	$lang['admin']['log_note'] = 'Notiz|Setze die Sichtbarkeit der Notizspalte auf der Mitglieder Log Seite';
−	$lang['kill_lost_hist']='Kill/Loss history for %1$s (%2$s %3$s) of %4$s';	+	$lang['admin']['log_onote'] = 'Offizernotiz|Setze die Sichtbarkeit der Offiziernotizspalte auf der Mitglieder Log Seite';
−	$lang['kill_lost_hist_guild'] = 'Kill/Loss history for Guild &quot;%1$s&quot;';	+
−	$lang['solo_win_loss'] = 'Solo Win/Loss Ratios (Level differences -7 to +7 counted)';	+
−	$lang['guildinfo'] = 'Guild Info';	+
−	$lang['admin']['pvpconfig'] = "PvPLog Config|Configure PvPLog main options";	+	// Settings names on build page
−	$lang['admin']['minPvPLogver'] = "Min PvPLog version|Minimum PvPLog Version zum Upload";	+	$lang['admin']['use_global']   = 'Use global settings|Use global settings rather than these local ones for this guild.';
−	</php>	+	$lang['admin']['getmain_regex'] = 'Regex|Dieses Feld spezifiziert die Benutzung des Regex. <br /> Folge dem wiki-Link für Details.';
		+	$lang['admin']['getmain_field'] = 'Anwenden auf Feld|Dieses Feld spezifiziert auf welches Mitgliederfeld Regex angewendet werden soll. <br />Folge dem wiki-Link für Details.';
		+	$lang['admin']['getmain_match'] = 'Benutze Treffernr.|Dieses Feld spezifiziert welcher Rückgabewert von Regex verwendet wird. <br /> Folge dem wiki-Link für Details.';
		+	$lang['admin']['getmain_main']  = 'Hauptchar-Identifizierung|Wenn Regex diesen Wert findet, so wird dieser Chars als Hauptcharakter angenommen.';
		+	$lang['admin']['defmain']      = 'Kein Ergebnis|Setze wie die Charaktere definiert weden sollen, bei denen Regex nichts zurückgibt.';
		+	$lang['admin']['invmain']      = 'Ungültiges Ergebnis|Setze wie die Charaktere definiert weden sollen, <br />wenn Regex ein Ergebnis ausgibt, dass kein Gildenmitglied oder kein Hauptcharakter ist.';
		+	$lang['admin']['altofalt']      = 'Twink des Twinks|Gib an, was zu tun ist, wenn der Charakter ein hauptcharakterloser Twink ist.';
		+	$lang['admin']['update_type']  = 'Aktualisierungstyp|Gib an, an welchem Auslöser die Hauptchar/Twink Beziehungen aktualisiert werden sollen.';</php>
Line 1,200:		Line 1,350:
	What happens here is that we are making and setting template variables.<br>		What happens here is that we are making and setting template variables.<br>
	Notice how the variables in available to the template are much simpler than the php variables<br>		Notice how the variables in available to the template are much simpler than the php variables<br>
−	'L_POSTEDBY' as opposed to $roster->locale->act['posted_by']	+	'L_POSTEDBY' as opposed to <span style="color:maroon;">$roster</span>->locale->act['posted_by']
Line 1,516:		Line 1,666:
	All variables are available whether during update hooks or in the framework		All variables are available whether during update hooks or in the framework
−	* <span style="color:maroon;">$roster</span>->db	+	* [[FunctionsOverview#.24roster-.3Edb|$roster->db]]
	** Database layer for roster		** Database layer for roster
	* <span style="color:maroon;">$roster</span>->locale->wordings		* <span style="color:maroon;">$roster</span>->locale->wordings
Line 1,595:		Line 1,745:
	** URL path to the Addon's images/ folder, this is not the full url path		** URL path to the Addon's images/ folder, this is not the full url path
	* <span style="color:maroon;">$addon</span>['css_file']		* <span style="color:maroon;">$addon</span>['css_file']
−	** Full path to the Addon's style.css file	+	** Full path to the Addon's [[#CSS_Styles|style.css]] file
	* <span style="color:maroon;">$addon</span>['css_url']		* <span style="color:maroon;">$addon</span>['css_url']
	** URL path to the Addon's css file, this is not the full url path		** URL path to the Addon's css file, this is not the full url path
Line 1,605:		Line 1,755:
	** Full path to the Addon's admin directory		** Full path to the Addon's admin directory
	* <span style="color:maroon;">$addon</span>['trigger_file']		* <span style="color:maroon;">$addon</span>['trigger_file']
−	** Full path to the Addon's inc/update_hook.php file	+	** Full path to the Addon's [[#AddOn_Update_Hook|inc/update_hook.php]] file
	* <span style="color:maroon;">$addon</span>['ajax_file']		* <span style="color:maroon;">$addon</span>['ajax_file']
	** Full path to the Addon's ajax.php		** Full path to the Addon's ajax.php
Line 1,648:		Line 1,798:
	This is a list of functions that are available for your Addons		This is a list of functions that are available for your Addons
−	<php>/**	+	View [[FunctionsOverview]] for details on available Roster functions
−	* Starts or ends fancy bodering containers	+
−	*	+
−	* @param string $style What bordering style to use	+
−	* @param string $mode ( start | end )	+
−	* @param string $header_text Place text in a styled header	+
−	* @param string $hwidth Set a fixed width for the box	+
−	* @return string	+
−	*/	+
−	function border( $style , $mode , $header_text=null , $width='' )</php>	+
−		+
−	<php>/**	+
−	* Highlight certain keywords in a SQL query	+
−	*	+
−	* @param string $sql Query string	+
−	* @return string Highlighted string	+
−	*/	+
−	function sql_highlight( $sql )</php>	+
−		+
−	<php>/**	+
−	* Clean replacement for die(), outputs a message with debugging info if needed and ends output	+
−	*	+
−	* @param string $text Text to display on error page	+
−	* @param string $title Title to place on web page	+
−	* @param string $file Filename to display	+
−	* @param string $line Line in file to display	+
−	* @param string $sql Any SQL text to display	+
−	*/	+
−	function die_quietly( $text='', $title='', $file='', $line='', $sql='' )</php>	+
−		+
−	<php>/**	+
−	* Draw a message box with the specified border color, then die cleanly	+
−	*	+
−	* @param string $message | The message to display inside the box	+
−	* @param string $title | The box title (default = 'Message')	+
−	* @param string $style | The border style (default = sred)	+
−	*/	+
−	function roster_die( $message , $title = 'Message' , $style = 'sred' )</php>	+
−		+
−	<php>/**	+
−	* This will remove HTML tags, javascript sections and white space	+
−	* It will also convert some common HTML entities to their text equivalent	+
−	*	+
−	* @param string $file	+
−	*/	+
−	function stripAllHtml($string)</php>	+
−		+
−	<php>/**	+
−	* This will check if the given Filename is an image	+
−	*	+
−	* @param imagefile $file	+
−	* @return mixed The extentsion if the filetype is an image, false if it is not	+
−	*/	+
−	function check_if_image( $imagefilename )</php>	+
−		+
−	<php>/**	+
−	* Recursively escape $array	+
−	*	+
−	* @param array $array The array to escape	+
−	* @return array The same array, escaped	+
−	*/	+
−	function escape_array( $array )</php>	+
−		+
−	<php>/**	+
−	* Recursively stripslash $array	+
−	*	+
−	* @param array $array	+
−	* The array to escape	+
−	* @return array	+
−	* The same array, escaped	+
−	*/	+
−	function stripslash_array( $array )</php>	+
−		+
−	<php>/**	+
−	* Converts a datetime field into a readable date	+
−	*	+
−	* @param string $datetime datetime field data in DB	+
−	* @param string $offset Offset in hours to calcuate time returned	+
−	* @return string formatted date string	+
−	*/	+
−	function readbleDate( $datetime , $offset=null )</php>	+
−		+
−	<php>/**	+
−	* Gets a file's extention passed as a string	+
−	*	+
−	* @param string $filename	+
−	* @return string	+
−	*/	+
−	function get_file_ext( $filename )</php>	+
−		+
−	<php>/**	+
−	* Converts seconds to a string delimited by time values	+
−	* Will show d,h,m,s	+
−	*	+
−	* @param string $seconds	+
−	* @return string	+
−	*/	+
−	function seconds_to_time( $seconds )</php>	+
−		+
−	<php>/**	+
−	* Check to see if an addon is active or not	+
−	*	+
−	* @param string $name | Addon basename	+
−	* @return bool	+
−	*/	+
−	function active_addon( $name )</php>	+
−		+
−	<php>/**	+
−	* Handles retrieving the contents of a URL trying multiple methods	+
−	* Current methods are curl, file_get_contents, fsockopen and will try each in that order	+
−	*	+
−	* @param string $url | URL to retrieve	+
−	* @param int $timeout | Timeout for curl	+
−	* @param  string $user_agent | Useragent to use for connection	+
−	* @return mixed | False on error, contents on success	+
−	*/	+
−	function urlgrabber( $url , $timeout = 5 , $user_agent=false )</php>	+
−		+
−	<php>/**	+
−	* Debugging function dumps arrays/object formatted	+
−	*	+
−	* @param array $arr	+
−	* @param int $tab	+
−	* @return string	+
−	*/	+
−	function aprint( $arr , $prefix='' )</php>	+
−		+
−	<php>/**	+
−	* Helper function that returns the localized gem color in english	+
−	*	+
−	* @param string $socket_color	+
−	* @return string $color	+
−	*/	+
−	function socketColorEn( $socket_color, $locale )</php>	+
−		+
−	<php>/**	+
−	* Attempts to write a file to the file system	+
−	*	+
−	* @param string $filename	+
−	* @param string $content	+
−	* @param string $mode	+
−	* @return bool	+
−	*/	+
−	function file_writer( $filename , &$content , $mode='wb' )</php>	+
	===Roster Authorization===		===Roster Authorization===
−	Like those nifty log-in boxes in Roster CP?<br>	+	Like those nifty log-in boxes in RosterCP?<br>
	Now you can easily add one to your addon!		Now you can easily add one to your addon!
	This checks if the user has admin access		This checks if the user has admin access
	<php>// ----[ Check log-in ]-------------------------------------		<php>// ----[ Check log-in ]-------------------------------------
−	$roster_login = new RosterLogin();
−
	// Disallow viewing of the page		// Disallow viewing of the page
−	if( $roster_login->getAuthorized(3) )	+	if( !$roster->auth->getAuthorized($required_level) )
	{		{
−	include_once (ROSTER_BASE . 'roster_header.tpl');
−	$roster_menu = new RosterMenu;
−	print $roster_menu->makeMenu('main');
−
	print		print
	'<span class="title_text">Some Title</span><br />'.		'<span class="title_text">Some Title</span><br />'.
−	$roster_login->getMessage().	+	$roster->auth->getLoginForm();
−	$roster_login->getLoginForm();	+
−	include_once (ROSTER_BASE . 'roster_footer.tpl');	+	return; //Kicks out of the AddOn and back to the Roster framework
−	exit();	+
−	}	+
−	else	+
−	{	+
−	// continue with addon processing	+
	}		}
	// ----[ End Check log-in ]---------------------------------</php>		// ----[ End Check log-in ]---------------------------------</php>
−	* <span style="color:maroon;">$roster_login</span> - Roster Login class	+	* <span style="color:maroon;">$roster</span>->auth - Roster Auth class
−	* <span style="color:maroon;">$roster_login</span>->getAuthorized() - (bool) Returns access granted or denied	+	* <span style="color:maroon;">$roster</span>->auth->getAuthorized() - (bool) Returns access granted or denied
−	** 1 - Guild Memeber Access	+	* <span style="color:maroon;">$roster</span>->auth->getMessage() - (string) Message sent from Roster Login, such as "Logged Out" or "Wrong Password"
−	** 2 - Officer Access	+	* <span style="color:maroon;">$roster</span>->auth->getLoginForm() - (string) The Roster Log-in form
−	** 3 - Roster Admin Access	+
−	* <span style="color:maroon;">$roster_login</span>->getMessage() - (string) Message sent from Roster Login, such as "Logged In", "Logged Out", or "Wrong Password"	+	Also note that there is a log in box in the menu.
−	* <span style="color:maroon;">$roster_login</span>->getLoginForm() - (string) The Roster Log-in form	+
Line 1,835:		Line 1,829:
	===Addon Credits===		===Addon Credits===
	Link = http://[www.someurl.net]/roster/?p=credits (SEO: http://[www.someurl.net]/roster/credits.html)<br>		Link = http://[www.someurl.net]/roster/?p=credits (SEO: http://[www.someurl.net]/roster/credits.html)<br>
−	To get credits on the main credit page, set the $credits array in the AddOn's inc/install.def.php file	+	To get credits on the main credit page, set the $credits array in the AddOn's [[#Creating_the_Installer|inc/install.def.php]] file
	<php>var $credits = array(		<php>var $credits = array(
	array( "name"=> "Author Name",		array( "name"=> "Author Name",
Line 1,841:		Line 1,835:
	);</php>		);</php>
	Replace the following		Replace the following
−	*"Addon Name" with your addon's name	+	* "Addon Name" with your addon's name
−	*"Author Name" with your (The addon's author) name	+	* "Author Name" with your (The addon's author) name
−	*"Extra Info" with a short description or additional info	+	* "Extra Info" with a short description or additional info
	(Use <nowiki><br></nowiki> for line breaks)		(Use <nowiki><br></nowiki> for line breaks)

---

Revision as of 04:13, 6 February 2008

Contents 1 Main Page 2 WoWRoster v2.0.0b AddOn Development 3 Changes 4 Info and Download 5 Certified WoWRoster AddOn 5.1 Requirements for Approval 6 Basics of an AddOn 7 Changes Since 1.7.3 8 AddOn Framework 8.1 Features 8.2 What it does 8.3 AddOn Directory Structure 8.3.1 admin Folder 8.3.2 char Folder 8.3.3 guild Folder 8.3.4 inc Folder 8.3.5 locale Folder 8.3.6 realm Folder 8.3.7 The util Scope 8.3.8 Other Files 8.4 Required Files 8.5 Linking to AddOns 9 Creating the Installer 9.1 Properties 9.2 AddOn Install Class Methods 9.3 Queries 9.4 RosterCP API Entries 9.5 Creating/Editing Menu Entries 9.6 Other Installer Methods 9.7 Example File 10 Creating the Search Class 10.1 Properties 10.2 Example File 11 Roster Config API 11.1 Menu Bar Items 11.1.1 Usage 11.2 Options Blocks 11.3 Options 11.4 AddOn Config Function File 12 Locale Files 12.1 Using Locale Strings 12.2 Example File 13 CSS Styles 14 Template Parser 14.1 Getting Started 14.2 The PHP Side 14.3 The Template Side 15 AddOn Update Hook 15.1 Properties 15.2 Methods 15.3 Additional LUA Files During Update 15.4 Example Update Hook File 16 Variables and Functions for AddOns 16.1 Variables 16.2 Variable Calls 16.3 Functions 16.4 Roster Authorization 16.5 Addon Credits 16.6 Tooltips 16.7 Message Boxes

WoWRoster v2.0.0b AddOn Development

Updated: 22:13, 5 February 2008 (CST)

This document is being revised as 2.0 goes through development
Keep checking back for changes and additions

Changes

• Zanix 22:13, 5 February 2008 (CST)
  • Updated some examples, and some of the wording in a few places
  • Roster Auth changes

• Zanix 21:04, 10 January 2008 (PST)
  • Roster login changes

• Gaxme 10:41 7 January 2008 (PST)
  • The $installer->remove_config($id) function exists, now listed here

• Gaxme 17:37, 3 January 2008 (PST)
  • Added note regarding additional lua files for upload (lower case)

• Zanix 10:40, 27 November 2007 (PST)
  • install.def.php changes
  • Addon install class must be named basenameInstall, where 'basename' is the base name of the addon

• Zanix 18:28, 25 November 2007 (PST)
  • Changes to how $roster->output['show_menu'] works
  • Added info on adding additional lua files for upload
    • This isn't new but I am finally adding info about it

• Zanix 15:05, 5 November 2007 (PST)
  • Some small changes, spelling, grammar, etc...
  • Added $wrnet_id to the installer properties
  • Separated Other Files from Util Scope files description

• Zanix 18:56, 27 October 2007 (PDT)
  • Install::add_menu_pane() and Install::remove_menu_pane() changed
    • Addon basename is no longer prefixed to the panel name
  • Removed $section parameter in Install::add_menu_button()
  • Clarified $roster->output['show_menu'] to include changes to the custom menu panels

• Zanix 15:07, 25 October 2007 (PDT)
  • 2 new installer menu functions
  • Install::add_menu_pane()
  • Install::remove_menu_pane()
    • Details on these new functions can be found under "8.5 Creating/Editing Menu Entries"
  • Install::add_menu_button() has an additional parameter $section
    • This allows you to add a menu button to a custom made menu pane
  • Install::create_table() now adds the table name to the drop list
    • This means that when the addon has an error on installation, these tables will also be dropped

• Zanix 09:55, 2 October 2007 (PDT)
  • Updated templating to allow template files to be in addons/addonname/templates/
  • Added xmlparse.class.php to list of new files in Roster
  • Removed mention of required variable $icon for update hook class, it should not be there
  • Fixed some small, grammatical errors

• Zanix 18:46, 27 September 2007 (PDT)
  • Clarified when addon update hooks are fired
  • Moved the Variable Calls section to its proper location

• Zanix 20:33, 25 September 2007 (PDT)
  • Install::add_table() should be Install::create_table()

• Zanix 09:34, 25 September 2007 (PDT)
  • Added 2 new addon installer functions

    Install::add_table() , Install::drop_table()

    Install::add_table() is required for adding new tables to the roster db as it automatically sets the correct charset

    Install::drop_table() is not required, just useful

  • Updated the example installer file to be more 'complete'

• Nightfighter 09:16, 2 September 2007 (PDT)
  • Added the display type and a some usage description.

• Zanix 19:13, 25 August 2007 (PDT)
  • Changed instances of ROSTER_INSTALLED to IN_ROSTER

    Please use IN_ROSTER for direct file access protection

  • Addon data variables 'fullname' and 'description' can be locale keys now

    Please use locale keys as it enables the ability to localize this data

  • Added some more addon installer info

    Now contains all the installer methods available

  • Updated urlgrabber(), added file_writer()

• Zanix 19:53, 12 August 2007 (PDT)
  • Updated icons, you can now specify an image in the addon's images directory

• Zanix 13:34, 12 August 2007 (PDT)
  • Added information about the new template parser

• Anaxent 12:16, 12 August 2007 (PDT)
  • More info on search class

• Anaxent 22:25, 25 July 2007 (PDT)
  • Added beginnings of search class for Addons

• Zanix 20:59, 25 July 2007 (PDT)
  • Guildless Scope removed
  • New addon variables - $addon['url'], $addon['url_full'], $addon['url_path'], $addon['image_full'], $addon['image_path']
  • Clarified $roster->data variable
  • Updated messagebox(), border(), readbleDate()
  • New functions stripslash_array(), aprint(), socketColorEn()
  • Added beginnings of search class for Addons

• Zanix 01:07, 1 July 2007 (PDT)
  • Paths to install.def.php, conf.php, and update_hook.php have been changed
  • Also changed the importance of the inc/ folder

Info and Download

You can view the open source project at http://www.wowroster.net

For corrections and/or suggestions - http://www.wowroster.net

Thanks to: http://www.wowroster.com
And Everyone involved in the project.

Download the Roster AddOnSDK

Certified WoWRoster AddOn

AddOns that conform to our Coding Standards and the basic outline described within this document, will be given a "AddOn Framework Standards Compliant" stamp of approval.

Requirements for Approval

• Unique locale variables
  • Use Roster base locale strings whenever possible
  • Don't overwrite existing locale strings

    Roster has some protection against this, but AddOns can still overwrite other AddOns' strings

• Create AddOns with SQL Debug Output, Debug Mode, and SQL Window enabled in RosterCP
  • Even though php notices and warnings are suppressed when these are off, it is good practice to enable these options when coding AddOns
• No funky text (such as BOM characters)

  (ie: strange characters appearing on top of the roster's menu)

• Valid XHTML 1.0 Transitional - http://validator.w3.org
• Proper use of the DB layer - $roster->db
• Roster main files are not edited
• Roster main database tables are not edited, unless you provide a clean way to revert the data in your uninstall

Basics of an AddOn

The following are required to run the WoWRoster back-end and to be able to run any AddOns
>Roster Requirements<

The AddOn system is designed so that you can mod the roster base without having to change the base code as it could change a lot between versions.
Hopefully with this system we will be closer to having a drop-in module system without having to mod a lot of the base files each time.

We will be constantly refining the system as we go along.
So with each new version of Roster, some AddOns may break (not work in the new WoWRoster)

Changes Since 1.7.3

• All AddOns need to be installed using an install definition file inc/install.def.php.
• During install, database tables, graphical configuration, menu buttons, and update hooks can be registered with the main framework.
• menu.php file is no longer required.
• conf.php is still used because there may be more to initialize than just settings.
  • conf.php has been moved to addonname/inc/conf.php
• Several variables, most notably $addonDir, have changed names.
• localization.php is no longer used.
  • Locale files are now placed in the addonname/locale/ folder and are named for the locale they define
• Configuration from database is automatically added. Addons are initialized in this order:
  • Addon registration record
  • Other constants (locations of addon files and the addon base dir)
  • Database configuration, if it exists
  • Localization files
    • The addon framework uses the $roster->mulitlanguages array to automatically add the default Roster locales
  • inc/conf.php file
• The addon is called differently now.
  • Details are below.
• Additional lua files for upload can be specified in the update_hook file of each addon
  • Add lua file names in the $files array in the update hook class
  • The Roster updater automatically parses any uploaded lua files
    • The file names given to the $files array must be lower case
    • The data is available in the $update->uploadData['luafilename'] array
• You do not know the basename at design time.
  • Please use the $addon['basename'] variable for this at all times.
• On lua updates, the addon's inc/update_hook.php is included once.
  • Details for the new update hook structure is below
• Menu buttons are created in the database using installer functions
• New libraries available:
  • lib/install.lib.php: AddOn install/upgrade/uninstall class
  • lib/config.lib.php: AddOn config class
  • lib/roster.php: Roster global class
    • This holds all of roster's config, locale strings, error control, some output variables, and the db layer
  • lib/minixml.lib.php: A XML parser and maker
  • lib/xmlparse.class.php: A lightweight XML reader, for parsing large XML files
  • lib/template.php
    • Template parser based on DragonFly

AddOn Framework

Features

1. Uses output buffering, which means all the output is stored in a variable that is sent to the browser
2. Do not have to include Roster's conf.php
3. Do not have to include/declare $roster object
4. Do not have to connect to Roster's database
5. Do not have to include your inc/conf.php
6. AddOn files: inc/conf.php, style.css, inc/update_hook.php, and locale files are OPTIONAL!

   Even additional locale files are optional, enUS.php is the default locale, and is required if you have locale files

What it does

1. Includes all Roster config variables for you to use ($roster->config)
2. Includes all Roster SQL functions for your use ($roster->db)
3. Includes all Roster and AddOn language variables for you ($roster->locale->wordings, $roster->locale->act)
4. Includes all Roster css styles
5. The Roster header, footer, and menu are included to your files.

   These can be disabled if needed, more below...

Best of all, this is transparent to you!

AddOn Directory Structure

Here is an example of an AddOn's directory structure

roster/
|_ addons/
   |_ addonname/
      |_ admin/
      |  |_ index.php
      |  |_ other.php
      |
      |_ char/
      |  |_ index.php
      |  |_ other.php
      |
      |_ guild/
      |  |_ index.php
      |  |_ other.php
      |
      |_ inc/
      |  |_ conf.php
      |  |_ functions.php
      |  |_ install.def.php
      |  |_ search.inc
      |  |_ update_hook.php
      |
      |_ locale/
      |  |_ deDE.php
      |  |_ enUS.php
      |  |_ esES.php
      |  |_ frFR.php
      |
      |_ realm/
      |  |_ index.php
      |  |_ other.php
      |
      |_ index.php
      |_ somefile.php
      |_ style.css
      |_ util.php

admin Folder

The admin folder houses files for the Roster CP
Normally you'll never need files here because the Config API can handle most configuration needs

If you do need a custom config interface, this is where you make it

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=rostercp-addon-addonname-file
• SEO Link - http://[www.someurl.net]/roster/trunk/rostercp/addon/addonname/file.html

This will normally grab your AddOn's config data from the 'roster_addon_config' table in the database and display the options using the Config API

If you need your own file, you need only to place index.php in addons/addonname/admin/

You can also have the best of both worlds
For example, the Members List and Character Info AddOns use both the Config API and custom files

• Members List uses addons/memberslist/admin/update.php to process data for alt relations

  Normal Link - http://[www.someurl.net]/roster/trunk/?p=rostercp-addon-memberslist-update

  SEO Link - http://[www.someurl.net]/roster/trunk/rostercp/addon/memberslist/update.html

• Character Info uses addons/info/admin/display.php to control data display for each character

  Normal Link - http://[www.someurl.net]/roster/trunk/?p=rostercp-addon-info-display

  SEO Link - http://[www.someurl.net]/roster/trunk/rostercp/addon/info/display.html

char Folder

Files for use in the Character scope
Data for the requested character is passed to the AddOn
If member= is not specified or if this member does not exist, an error message will display

member= can be either the member id number, or name@rc-realm text

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=char-addonname&member=##
• Normal Link - http://[www.someurl.net]/roster/trunk/?p=char-addonname&member=name@rc-realm
• SEO Link - http://[www.someurl.net]/roster/trunk/char/addonname/member=##.html
• SEO Link - http://[www.someurl.net]/roster/trunk/char/addonname/member=name@rc-realm.html

Accessing other files in the char scope is easy
addons/addonname/addonname/char/file.php is accessed like this:

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=char-addonname-file&member=##
• SEO Link - http://[www.someurl.net]/roster/trunk/char/addonname/file/member=##.html

guild Folder

Files for use in the Guild scope
Data for the requested guild is passed to the AddOn
If guild= is not specified, the default guild/realm name set in Roster CP will show
If the guild does not exist or if there is no data for this guild, an error message will display

guild= can be either the guild id number, or name@rc-realm text

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=guild-addonname&guild=##
• Normal Link - http://[www.someurl.net]/roster/trunk/?p=guild-addonname&guild=name@rc-realm
• SEO Link - http://[www.someurl.net]/roster/trunk/guild/addonname/guild=##.html
• SEO Link - http://[www.someurl.net]/roster/trunk/guild/addonname/guild=name@rc-realm.html

Accessing other files in the guild scope is easy
addons/addonname/guild/file.php is accessed like this:

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=guild-addonname-file&guild=##
• SEO Link - http://[www.someurl.net]/roster/trunk/guild/addonname/file/guild=##.html

inc Folder

This folder houses special files not meant for direct access by the AddOn Framework

• conf.php - This is included before any other addon file, any initialization can be done here
• install.def.php - The AddOn's install/upgrade/uninstall definition file
• search.inc.php - Search plug-in for the Roster search page
• update_hook.php - Update Hook file

You can also use this folder for lib, library, and/or functions files

Place any files here that you do not or should not be accessed directly by the AddOn Framework

locale Folder

Where locale translation files go
See below for more info Locale Files

realm Folder

Files for use in the Realm scope
Data for the requested realm is passed to the AddOn
If realm= is not specified, the default realm name set in Roster CP will show
If the realm does not exist or if there is no data for this realm, an error message will display

realm= can be text

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=guild-addonname&realm=rc-name
• SEO Link - http://[www.someurl.net]/roster/trunk/guild/addonname/realm=rc-name.html

Accessing other files in the realm scope is easy
addons/addonname/realm/file.php is accessed like this:

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=realm-addonname-file&realm=rc-name
• SEO Link - http://[www.someurl.net]/roster/trunk/realm/addonname/file/realm=rc-name.html

The util Scope

Files not in these folders are considered under the util scope
This scope is not restricted if there is no guild or character information and can be accessed before data is in the database

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=util-addonname
• Normal Link - http://[www.someurl.net]/roster/trunk/?p=util-addonname
• SEO Link - http://[www.someurl.net]/roster/trunk/util/addonname.html
• SEO Link - http://[www.someurl.net]/roster/trunk/util/addonname.html

Accessing other files in the util scope is easy
addons/addonname/file.php is accessed like this:

• Normal Link - http://[www.someurl.net]/roster/trunk/?p=util-addonname-file
• SEO Link - http://[www.someurl.net]/roster/trunk/util/addonname/file.html

Other Files

• index.php - The main file for the util scope
• style.css - A custom css style for the AddOn

Required Files

There are a few files that you must have

• addons/addoname/inc/install.def.php (AddOn install/upgrade/uninstall file)

Linking to AddOns

You can link to any file in the root AddOn folder

The url to access each page is simple

• Normal Link - http://[www.someurl.net]/roster/?p=scope-addonname-file
• SEO Link - http://[www.someurl.net]/roster/scope/addonname/file.html

The values explained

• scope - One of five values; realm, guild, char, util

  Realm (realm) - Page that uses realm information (realm=name is appended to the url)

  Guild (guild) - Page that uses guild information (guild=id# or guild=name@server is appended to the url)

  Character (char) - Page that uses character information (member=id# or member=name@server must be appended to the url)

  Utility (util) - Page that doesn't use either, or could use either, most of the Roster pages are utility pages (rostercp, update, credits, search)

• addonname - The name of the AddOn you are accessing
• file - The file you are accessing

Creating the Installer

This installer requires a similar install file definition as DragonFly CMS, with some important exceptions:

• SQL entries are the same as as passing it to mysql_query() using $installer->add_query($sqlstring)
• No rollback data per query. Instead, call $installer->add_backup($table_name) for each table you want restored in case of an upgrade/uninstall failure.

  Any backup tables you create are automatically deleted in rollback.

• Different required variables to be set.

You should create a file called inc/install.def.php with in it a class that is named identical to your AddOn's install directory name, plus Install.

The folder name will be referred to as your AddOn's basename.

Properties

• var $active

  Boolean, set to true to activate this AddOn after installing, set to false if it has to be configured first.

• var $version

  String, the current version of your AddOn.

  Needs to be compatible with php's version_compare().

  Should be incremented on every update. So you know what version someone is running.

• var $icon

  String, an icon to display for your AddOn in the AddOn management page in RosterCP

  Valid icons are from the Interface ImagePack or images in addons/ADDONNAME/images/

  To use an Interface icon, specify the image without the extension 'ability_cheapshot'

  To use and image in your AddOns images/ folder, specify the image with the extension 'icon.png'

  DO NOT use a full path to the image, just the filename.

• var $fullname

  String, the full name of the AddOn for display.

  This can either be literal or reference a locale key.

• var $description

  String, a sort description of your AddOn.

  This can either be literal or reference a locale key.

• var $wrnet_id

  int, the download ID for this addon on WoWRoster.net

  This is used for update checking via wowroster.net for your addon

  When your addon is updated in the downloads section, Roster will notify everyone that has your addon installed that a new version is available

  For example SigGen is downloaded at http://www.wowroster.net/Downloads/details/id=20.html

  20 is SigGen's ID and would be entered here

  Roster checks the local addon version to the version field for this addon on wowroster.net

• var $credits

  Credits information.

$credits = array(
	array(	"name"=>	"Name",
		"info"=>	"Some Info"),
	array(	"name"=>	"Another Name",
		"info"=>	"More Info"),
);

AddOn Install Class Methods

• install()

  Here you can add all queries for a fresh install.

  No parameters.

  Return true on success, false on failure.

• upgrade($oldversion)

  Here you can add all queries for an upgrade.

  $oldversion, the version you are upgrading from.

  Return true on success, false on failure.

• uninstall()

  Here you should add all queries for an uninstall.

  No parameters.

  Return true on success, false on failure

Queries

Queries are added to the install using the $installer methods.

• $installer->create_table($tablename,$tabledata);

  Add a table to the Roster database

  This is the preferred method for adding a table to the Roster database as it adds the correct charset for you

  This also adds the table to the drop list for rollback, which is important when an install fails

• $installer->drop_table($tablename);

  Drop a table from the Roster database

  This isn't required for dropping a table, but it sure is handy

• $installer->add_query($sqlstring);

  Any valid SQL query

• $installer->add_backup($table)

  Makes a temporary copy of a table and its contents that is put back in case of a rollback

• $installer->add_drop($table)

  Have a table be dropped on rollback

RosterCP API Entries

These entries can be used to build a config page through Roster's config page API

• $installer->add_config($sqlstring);

  Add config sql to `roster_addon_config` table

  Format is "'id','config_name','config_value','form_type','config_type'"

• $installer->update_config($id, $sqlstring);

  Modify an existing config value

  $id is the id of the config value

  $sqlstring is what would be inside "UPDATE `roster_addon_config` SET $sqlstring WHERE `config_id` = '$id';"

• $installer->remove_config($id);

  Remove an existing config value

  $id is the id of the config value

• $installer->remove_all_config();

  Removes all the config data for the addon

Creating/Editing Menu Entries

There are 5 functions for creating, changing, and editing menu entries.
Note the menu button titles should be unique per AddOn.
Using your basename in the key will work fine.

• $installer->add_menu_pane($name)

  Adds a menu pane to insert menu entries into

  Try to keep this unique to your addon, try using your addon name as part of the name

  To label the Panel, add a locale key 'menupanel_PANELNAME'

  When adding buttons to a custom pane, Roster ignores the scope and basename parameters of the buttons

  Make sure the url is correct when placing buttons in a custom panel

• $installer->remove_menu_pane($name)

  Removes a menu pane

  you cannot remove a roster made pane ('util','realm','guild','char')

• $installer->add_menu_button($title, $scope, $url, $icon)

  Adds a menu button. Parameters:

  $title

  The localization key for the menu button's title.

  $scope

  The scope of the link ('util','realm','guild','char')

  $url

  The url parameters this button should call the AddOn with

  $icon

  An icon to display in the button

  Valid icons are from the Interface ImagePack or images in addons/ADDONNAME/images/

  To use an Interface icon, specify the image without the extension 'ability_cheapshot'

  To use and image in your AddOns images/ folder, specify the image with the extension 'icon.png'

  DO NOT use a full path to the image, just the filename.

• $installer->update_menu_button($title, $scope, $url, $icon)

  Changes menu button. Parameters:

  $title

  The localization key for the menu button's title.

  $scope

  The scope of the link ('util','realm','guild','char')

  $url

  The url parameters this button should call the AddOn with

  $icon

  An icon to display in the button

  Valid icons are from the Interface ImagePack or images in addons/ADDONNAME/images/

  To use an Interface icon, specify the image without the extension 'ability_cheapshot'

  To use and image in your AddOns images/ folder, specify the image with the extension 'icon.png'

  DO NOT use a full path to the image, just the filename.

• $installer->remove_menu_button($title)

  Removes a menu button. Parameters:

  $title

  The localization key for the menu button's title.

• $installer->remove_all_menu_button()

  Removes all the menu buttons for the addon.

Other Installer Methods

• $installer->table($table, $backup=false)

  Returns a full table name from base table name for the current addon and config profile.

  If the roster table prefix is 'roster_', and the addon is named 'news', and the table name is 'category'

  • The table name returned would be 'roster_addons_news_category'

• $installer->seterrors($string)

  Set an error message to be displayed.

• $installer->setmessages($string)

  Set a message to be displayed.

Example File

Here is an example of an AddOn install file
This shows most of the methods that can be used in an installer

You can find more examples in the addons/ folder in roster

<?php
/**
 * WoWRoster.net WoWRoster
 *
 * LICENSE: Licensed under the Creative Commons
 *          "Attribution-NonCommercial-ShareAlike 2.5" license
 *
 * @copyright  2002-2007 WoWRoster.net
 * @license    http://creativecommons.org/licenses/by-nc-sa/2.5   Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
 * @version    SVN: $Id: install.def.php 897 2007-05-06 00:35:11Z Zanix $
 * @link       http://www.wowroster.net
 * @package    SomeAddon
 * @subpackage Installer
*/
 
if ( !defined('IN_ROSTER') )
{
    exit('Detected invalid access to this file!');
}
 
/**
 * Installer SomeAddon
 *
 * @package    InstanceKeys
 * @subpackage Installer
 */
class SomeAddonInstall
{
	var $active = true;
	var $icon = 'inv_misc_key_06';
 
	var $version = '2.0.0.0';
	var $wrnet_id = 0;
 
	var $fullname = 'some_addon';
	var $description = 'some_addon_desc';
	var $credits = array(
	array(	"name"=>	"WoWRoster Dev Team",
			"info"=>	"Original Author")
	);
 
 
	/**
	 * Install Function
	 *
	 * @return bool
	 */
	function install()
	{
		global $installer;
 
		// Master and menu entries
		$installer->add_config("'1','startpage','keys_conf','display','master'");
		$installer->add_config("'110','some_addon_conf',NULL,'blockframe','menu'");
 
		$installer->add_config("'1010','colorcmp','#00ff00','color','some_addon_conf'");
		$installer->add_config("'1020','colorcur','#ffd700','color','some_addon_conf'");
		$installer->add_config("'1030','colorno','#ff0000','color','some_addon_conf'");
 
		$installer->add_menu_button('some_addon','guild','','spell_holy_prayerofspirit');
		$installer->add_menu_button('some_addon','guild','log','inv_misc_symbolofkings_01');
 
		$installer->create_table($installer->table('some_table'),"
			`member_id` int(11)    unsigned NOT NULL default '0',
			`row_id`   int(11)    unsigned NOT NULL default '0',
			`type`  tinyint(3) unsigned NOT NULL default '0',
			PRIMARY KEY (`member_id`)");
 
		return true;
	}
 
	/**
	 * Upgrade Function
	 *
	 * @param string $oldversion
	 * @return bool
	 */
	function upgrade($oldversion)
	{
		global installer;
 
		if( version_compare('2.0.0.0', $oldversion,'>') == true )
		{
			// Upgrade versions lower than 2.0.0.0
		}
 
		if( version_compare('2.0.6.4', $oldversion,'>') == true )
		{
			// Upgrade versions lower than 2.0.6.4
		}
 
		if( version_compare('3.0.0.0', $oldversion,'>') == true )
		{
			// Upgrade versions lower than 3.0.0.0
		}
 
		return true;
	}
 
	/**
	 * Un-Install Function
	 *
	 * @return bool
	 */
	function uninstall()
	{
		global $installer;
 
		$installer->remove_all_config();
 
		$installer->drop_table($installer->table('some_table'));
 
		$installer->remove_all_menu_button();
		return true;
	}
}

Creating the Search Class

Properties

• var $options

  Used to to add advanced options to the search page

• var $result

  Search array

• var $result_count

  Counter for results display

• var $link_next

  Used to create a url to the next page of results

• var $link_prev

  Used to create a url to the previous page of results

• var $data

  An array that holds all of the addons data

• var $page

  Counter for page number

• var $limit

  Counter for the number of results that can be displayed per page

• var $sql_query

  -

• var $the_query

  -

• var $url_query

  Urlencoded query

• var $item['results_header']

  When this variable is used it will add a header above each result with in that addon search

• var $item['html']

  When used this variable allows you to display your own formated html code which over rides any predefined search display

• var $item['author']

  Used to display the author of a post/update/upload

• var $item['date']
• . var that will print the date

• var $item['url']

  Variable used to create a makelink() to the results addons home page

• var $result['title']

  Displays the title of the addon

• var $result['short_text']

  Used to give a short description of the result

• var $result['more_text']

  Used to create a secondary link per result

• var $result['footer']

  If desired allows each addon result to have a custom footer

• var $result['results_footer']

  Used to create a footer for the addon results overall footer

Example File

Here is an example of an AddOn search.inc file
From the "News" AddOn which creates the search class and adds the addon into
Rosters Search Engine

You can find more examples in the addons/ folder in roster

<?php
/**
 * WoWRoster.net WoWRoster
 *
 * LICENSE: Licensed under the Creative Commons
 *          "Attribution-NonCommercial-ShareAlike 2.5" license
 *
 * @copyright  2002-2007 WoWRoster.net
 * @license    http://creativecommons.org/licenses/by-nc-sa/2.5   Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
 * @version    SVN: $Id: search.inc.php 1518 2007-12-10 20:18:04Z Zanix $
 * @link       http://www.wowroster.net
 * @package    News
 * @subpackage Search
*/
 
if( !defined('IN_ROSTER') )
{
    exit('Detected invalid access to this file!');
}
 
class news_search
{
	var $options;
	var $result = array();
	var $result_count = 0;
	var $start_search;
	var $stop_search;
	var $time_search;
	var $link_next;
	var $link_prev;
	var $open_table;
	var $close_table;
	var $data = array();    // Addon data
 
	function search( $search , $url_search , $limit=10 , $page=0 )
	{
		global $roster;
 
		$first = $page*$limit;
 
		$q = "SELECT `news`.`news_id`, `news`.`author`, `news`.`title`, `news`.`content`, `news`.`html`, "
		   . "DATE_FORMAT(  DATE_ADD(`news`.`date`, INTERVAL " . $roster->config['localtimeoffset'] . " HOUR ), '" . $roster->locale->act['timeformat'] . "' ) AS 'date_format', "
		   . "COUNT(`comments`.`comment_id`) comm_count "
		   . "FROM `" . $roster->db->table('news','news') . "` news "
		   . "LEFT JOIN `" . $roster->db->table('comments','news') . "` comments USING (`news_id`) "
		   . "WHERE `news`.`news_id` LIKE '%$search%' "
		   . "OR `news`.`author` LIKE '%$search%' "
		   . "OR `news`.`date` LIKE '%$search%' "
		   . "OR `news`.`title` LIKE '%$search%' "
		   . "OR `news`.`content` LIKE '%$search%' "
		   . "GROUP BY `news`.`news_id` "
		   . ( $limit > 0 ? " LIMIT $first," . ($limit+1) : '' ) . ';';
 
		//calculating the search time
		$this->start_search = format_microtime();
 
		$result = $roster->db->query($q);
 
		$this->stop_search = format_microtime();
		$this->time_search = round($this->stop_search - $this->start_search,3);
 
		$nrows = $roster->db->num_rows($result);
 
		$x = ($limit > $nrows) ? $nrows : ($limit > 0 ? $limit : $nrows);
		if( $nrows > 0 )
		{
			while( $x > 0 )
			{
				list($news_id, $author, $title, $content, $html, $date, $comments) = $roster->db->fetch($result);
 
				$item['author'] = $author;
				$item['date'] = $date;
				$item['title'] = $title;
				$item['url'] = makelink('util-news-comment&amp;id=' . $news_id);
 
				if( $html == '1' && $this->data['config']['news_html'] >= 0 )
				{
					$content = $content;
				}
				else
				{
					$content = htmlentities($content);
				}
				$content = nl2br($content);
 
				$array = explode(' ',$content,101);
				if( isset($array[100]) )
				{
					unset($array[100]);
					$item['more_text'] = true;
				}
				else
				{
					$item['more_text'] = false;
				}
				$item['short_text'] = implode(' ',$array);
 
				$item['footer'] = ($comments == 0 ? 'No' : $comments) . ' comment' . ($comments == 1 ? '' : 's');
 
				$this->add_result($item);
				unset($item);
				$x--;
			}
		}
 
		if( $page > 0 )
		{
			$this->link_prev = '<a href="' . makelink('search&amp;page=' . ($page-1) . '&amp;search=' . $url_search . '&amp;s_addon=' . $this->data['basename']) . '"><strong>' . $roster->locale->act['search_previous_matches'] . $this->data['fullname'] . '</strong></a>';
		}
		if( $nrows > $limit )
		{
			$this->link_next = '<a href="' . makelink('search&amp;page=' . ($page+1) . '&amp;search=' . $url_search . '&amp;s_addon=' . $this->data['basename']) . '"><strong> ' . $roster->locale->act['search_next_matches'] . $this->data['fullname'] . '</strong></a>';
		}
	}
 
	function add_result( $resultarray )
	{
		$this->result[$this->result_count++] = $resultarray;
	}
}

Roster Config API

This is the current functionality of the Roster Config API.
There are two classes of form types:

• Option blocks for layout
• Actual options

Items of the page, pageframe, and pagehide class contain option blocks.
Items of the blockframe or blockhide class contain options.

Menu Bar Items

• display:

  Sets the first page that will be displayed when you first select the addon for configuration.

  $installer->add_config("'1','startpage','config_name','display','master'")

• page, pageframe, pagehide, blockframe, blockhide:

  A page of options that gets selected with javascript

  $installer->add_config("'110','config_name',NULL,'blockframe','menu'")

  $installer->add_config("'150', 'config_name2', NULL, 'page{1', 'menu'")

• link

  An external link to be opened in the same window

  $installer->add_config("120,'config_name','link_value','link','menu'")

• newlink

  An external link to be opened in a new window

  $installer->add_config("170,'config_name','http://www.someurl.com','newlink','menu'")

• makelink

  Passes this through Roster's makelink() function to generate a correct link to another page in Roster.

  $installer->add_config("120,'config_name','link_value','makelink','menu'")

• makenewlink

  Same as makelink(), except it opens a new browser window.

  $installer->add_config("180,'config_name','link_value','makenewlink','menu'")

Usage

In most cases the config_name is a reference to an entry in your locale file. Each entry you make needs to have a unique config name. The entry in the locale file needs to contain at least the prompt text, but can also contain hover help text by seperating them with a vertical bar '|'.

Options Blocks

• page{n

  n columns of options blocks

  $installer->add_config("'4001', 'menu_conf_wide', NULL, 'page{2', 'menu_conf'")

• pageframe{n

  n columns of options blocks in a border

  $installer->add_config("'4025', 'menu_conf_left', NULL, 'pageframe{3', 'menu_conf'")

• pagehide{n

  n columns of options blocks in a border, with a show/hide option

  $installer->add_config("'4020', 'menu_conf_hidden', NULL, 'pagehide{1', 'menu_conf'")

• blockframe

  A list of options in a border

  $installer->add_config("'4000, 'menu_conf_top', NULL, 'blockframe', 'menu_conf'")

• blockhide

  A list of options in a border, with a show/hide option

  $installer->add_config("'4050, 'menu_conf_bottom', NULL, 'blockhide', 'menu_conf'")

• function{name

  Calls the function called name with no parameters to produce the HTML for the page.

  If this is a tab (directly linked from the switch menu on the left side) it is put outside the main form so you can put forms in it.

  $installer->add_config("'4470', 'menu_conf_right', NULL, 'function{newForm', 'menu_conf_top'")

Options

• text{n|m

  A text box m characters wide, maximum of n characters input

  $installer->add_config("'1110','page_size','0','text{4|30','menu_conf_top'")

• radio{op1^val1|op2^val2|op3^val3...

  A list of radio buttons with labels op1, op2, op3,...

  Which produce values val1, val2, val3,...

  Labels are literal, not localization keys.

  $installer->add_config("'1010','nojs','0','radio{Server^1|Client^0','menu_conf_top'")

• select{op1^val1|op2^val2|op3^val3...

  A dropdown box with options op1, op2, op3,...

  Which produce values val1, val2, val3,...

  Labels are literal, not localization keys.

  $installer->add_config("'1020','def_sort','Note','select{Public Note^Note|Officer Note^OfficerNote','menu_conf_top'")

• function{name

  Calls the function called name with the option record as parameter to produce the HTML for the option.

  $installer->add_config("'4270', 'left_text', 'VERANDA.TTF', 'function{fontFiles', 'menu_conf_top'")

• display

  Displays the option's setting.

  $installer->add_config("'3, 'help_text', 'This is to help', 'display', 'menu_conf_top'")

• color

  Enables the use of the color picker javascript to pick a color from a pallet

  $installer->add_config("'4230', 'menu_left_barcolor', '#3e0000', 'color', 'menu_conf_top'")

AddOn Config Function File

addons/addonname/admin/config.func.php

• Both function types call functions that can be defined in a file called 'config.func.php' in your AddOn's admin/ directory.

  If this file has a function named topBox(), the html returned by this function will be put above the options in the middle column.

Locale Files

These are used in translating any text in your AddOn if you want to support multi-langages.
As you can see in the example below, we have a file for deDE which is the German language, enUS which is the English language, frFR for French, and esES for Spanish.

Roster currently supports deDE, enUS, frFR, and esES, these are taken out of character profiler based on what region of WOW they are using.

The folder structure for locale files is as follows:

roster/
|_ addons/
   |_ addonname/
      |_ locale/
         |_ deDE.php
         |_ enUS.php
         |_ esES.php
         |_ frFR.php

When using locale files, it is absolutely necessary to ALWAYS have enUS.php
The AddOn Framework will default to this file if a locale is not found for a specific locale

Example:

• You make an AddOn and only create it in English (enUS.php only, no other locale files)
• Someone downloads your AddOn for a deDE Roster
• The AddOn Framework automatically inserts the enUS locale strings into the deDE locale
• This way, you only need to have enUS.php
• Later, if other locales are translated, they can be placed into the locale folder and Roster will detect them based on the locales set in localization/languages.php

Using Locale Strings

When using these them in your script you can use something similar to this

$header_title = $roster->locale->wordings['locale_key']['some_key'];

or

$header_title = $roster->locale->act['some_key'];

The first example is to get a specific locale value
The second is a reference to the current locale set in Roster

Remember that Roster's locale files are already added, so you only have to add the stuff that is custom to your AddOn.

So if you need to check to make sure we have don't already have a translation, you can open the files in the "localization/" directory to see the default words that you don't have to duplicate.

Duplication may cause errors in the main Roster code, if you duplicate a main Roster locale variable, you will incur the wrath of the WoWRoster.net Dev Team

Example File

Example from the MembersList Roster AddOn
addons/memberslist/locale/deDE.php

<?php
/**
 * WoWRoster.net WoWRoster
 *
 * LICENSE: Licensed under the Creative Commons
 *          "Attribution-NonCommercial-ShareAlike 2.5" license
 *
 * @copyright  2002-2007 WoWRoster.net
 * @license    http://creativecommons.org/licenses/by-nc-sa/2.5   Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
 * @version    SVN: $Id: deDE.php 1523 2007-12-13 12:24:31Z pleegwat $
 * @link       http://www.wowroster.net
 * @package    MembersList
 * @subpackage Locale
*/
 
// -[ deDE Localization ]-
 
// Installer names
$lang['memberslist']            = 'Mitgliederliste';
$lang['memberslist_desc']       = 'Eine sortier- und filterbare Mitgliederliste';
 
// Button names
$lang['memberslist_Members']	= 'Mitglieder|Zeigt die Gildenmitgliederliste mit Spielernotizen, Zuletzt online, usw... an';
$lang['memberslist_Stats']		= 'Grundwerte|Zeigt die Grundwerte jedes Gildenmitglieds wie Intelligenz, Ausdauer, usw... an';
$lang['memberslist_Honor']		= 'Ehre|Zeigt die PvP-Informationen jedes Gildenmitglieds an';
$lang['memberslist_Log']		= 'Mitglieder Log|Zeigt das upload log für neue und entfernte Mitglieder an';
$lang['memberslist_Realm']		= 'Mitglieder|Zeigt die Mitgliederliste für alle Gilden auf allen Servern an';
$lang['memberslist_RealmGuild']	= 'Gilden|Zeigt eine Liste für alle Gilden auf allen Realms an';
 
// Interface wordings
$lang['memberssortfilter']		= 'Sortierreihenfolge und Filterung';
$lang['memberssort']			= 'Sortierung';
$lang['memberscolshow']			= 'Zeige/Verstecke Spalten';
$lang['membersfilter']			= 'Zeilenfilter';
 
$lang['openall']                = 'Öffne alle';
$lang['closeall']               = 'Schließe alle';
$lang['ungroupalts']            = 'Twinkgruppen auflösen';
$lang['openalts']               = 'Gruppiere Twinks (Open)';
$lang['closealts']              = 'Gruppiere Twinks (Closed)';
$lang['clientsort']             = 'Clientsortierung';
$lang['serversort']             = 'Serversortierung';
 
// Column headers
$lang['onote']                  = 'Offizier Notiz';
 
$lang['honorpoints']            = 'Ehrenpunkte';
$lang['arenapoints']            = 'Arenapunkte';
 
$lang['main_name']              = 'Hauptcharaktername';
$lang['alt_type']               = 'Alt type';
 
$lang['xp_to_go']               = '%1$s XP until level %2$s';
 
$lang['skill_level']		= 'Skill level';
 
// Last Online words
$lang['online_at_update']       = 'Online bei Update';
$lang['second']                 = 'vor %s Sekunde';
$lang['seconds']                = 'vor %s Sekunden';
$lang['minute']                 = 'vor %s Minute';
$lang['minutes']                = 'vor %s Minuten';
$lang['hour']                   = 'vor %s Stunde';
$lang['hours']                  = 'vor %s Stunden';
$lang['day']                    = 'vor %s Tag';
$lang['days']                   = 'vor %s Tagen';
$lang['week']                   = 'vor %s Woche';
$lang['weeks']                  = 'vor %s Wochen';
$lang['month']                  = 'vor %s Monat';
$lang['months']                 = 'vor %s Monaten';
$lang['year']                   = 'vor %s Jahr';
$lang['years']                  = 'vor %s Jahren';
 
$lang['armor_tooltip']			= 'Verringert den erlittenen körperlichen Schaden um %1$s%%';
 
$lang['motd']                   = 'MOTD';
$lang['accounts']               = 'Accounts';
 
// Configuration
$lang['memberslist_config']		= 'Gehe zur Mitgliederliste-Konfiguration';
$lang['memberslist_config_page']= 'Mitgliederliste-Konfiguration';
$lang['documentation']			= 'Dokumentation';
$lang['uninstall']				= 'Uninstall';
 
// Page names
$lang['admin']['display']       = 'Anzeige|Konfiguriert die Anzeigeoptionen für die Mitgliederliste.';
$lang['admin']['members']       = 'Mitgliederliste|Konfiguriert die Sichtbarkeit der Mitgliederliste-Spalten.';
$lang['admin']['stats']         = 'Werteliste|Konfiguriert die Sichtbarkeit der Grundwerte-Spalten.';
$lang['admin']['honor']         = 'Ehrenliste|Konfiguriert die Sichtbarkeit der Ehrenliste-Spalten.';
$lang['admin']['log']           = 'Mitglieder Log|Konfiguriert die Sichtbarkeit der Mitglieder Log-Spalten.';
$lang['admin']['build']         = 'Hauptchar/Twink Beziehungen|Konfiguriert wie Hauptchars/Twinks erkannt werden.';
$lang['admin']['ml_wiki']       = 'Dokumentation|Mitgliederliste Dokumentation auf WoWRoster wiki.';
$lang['admin']['updMainAlt']    = 'Aktualisiere Beziehungen|Aktualisiert die Main/Alt Beziehungen der Daten, die bereits in der DB gespeichert sind.';
$lang['admin']['page_size']		= 'Seitengröße|Konfiguriert die Anzahl der Zeilen Pro Seite oder 0 für keinen Seitenumbruch';
 
// Settings names on display page
$lang['admin']['openfilter']	= 'Öffne Filterbereich|Gib an, ob der Filterbereich standardmäßig geöffnet oder geschlossen sein sill.';
$lang['admin']['nojs']          = 'Listentyp|Gib an, ob du eine serverseitige Sortierung oder eine clientseitige Sortierung+Filterung haben möchtest.';
$lang['admin']['def_sort']		= 'Standard Sortierung|Gib die standard Sortiermethode an.';
$lang['admin']['member_tooltip']= 'Mitglieder Tooltip|Schalte den Inf-Tooltip über den Mitgliedernamen an oder aus.';
$lang['admin']['group_alts']    = 'Gruppiere Twinks|Gruppiere Twinks unterhalb ihrer Hauptcharaktere anstelle sie seperat zu sortieren.';
$lang['admin']['icon_size']     = 'Icon Größe|Setze die Größe der Klasse/Ehre/Beruf Icons.';
$lang['admin']['spec_icon']		= 'Talent Icon|Schalte das Talent Icon an oder aus.';
$lang['admin']['class_icon']    = 'Klassen Icon|Kontrolliert die Klass/Talent Icon Anzeige.<br />Full - Anzeige von Talent und Klassen Icon<br />On - Nur Anzeige des Klasse Icons<br />Off- Keine Icons';
$lang['admin']['class_text']    = 'Klassentext|Kontrolliert die Klassentectanzeige.<br />Color - Farbiger Klassentext<br />On - Anzeige des Klassentextes<br />Off - Kein Klassentext';
$lang['admin']['talent_text']   = 'Talenttext|Zeigt die Talentspezialisierung anstalle des Klassennamens.';
$lang['admin']['level_bar']     = 'Level Balken|Anzeige von Levelbalken anstelle von einfachen Zahlen.';
$lang['admin']['honor_icon']    = 'Ehre Icon|Anzeige des Ehrenrang Icons.';
$lang['admin']['compress_note'] = 'Kompakte Notiz|Zeige Gildennotiz als Tooltip anstelle innerhalb der Spalte.';
 
// Settings on Members page
$lang['admin']['member_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Mitgliederseite';
$lang['admin']['member_motd']	= 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Mitgliederseite';
$lang['admin']['member_hslist']	= 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Mitgliederseite';
$lang['admin']['member_pvplist']= 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Mitgliederseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
$lang['admin']['member_class']  = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Mitgliederseite';
$lang['admin']['member_level']  = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Mitgliederseite';
$lang['admin']['member_gtitle'] = 'Gildenrang|Setze die Sichtbarkeit der Gildenrangspalte auf der Mitgliederseite';
$lang['admin']['member_hrank']  = 'Ehrenrang|Setze die Sichtbarkeit der letzter Ehrenrangspalte auf der Mitgliederseite';
$lang['admin']['member_prof']   = 'Beruf|Setze die Sichtbarkeit der Berufspalte auf der Mitgliederseite';
$lang['admin']['member_hearth'] = 'Ruhestein|Setze die Sichtbarkeit der Ruhesteinspalte auf der Mitgliederseite';
$lang['admin']['member_zone']   = 'Zone|Setze die Sichtbarkeit der Letztes Gebiet-Spalte auf der Mitgliederseite';
$lang['admin']['member_online'] = 'Zuletzt Online|Setze die Sichtbarkeit der Zuletzt Online-Spalte auf der Mitgliederseite';
$lang['admin']['member_update'] = 'Zuletzt aktualisiert|Setze die Sichtbarkeit der Zuletzt aktualisiert-Spalte auf der Mitgliederseite';
$lang['admin']['member_note']   = 'Notiz|Setze die Sichtbarkeit der Notizspalte auf der Mitgliederseite';
$lang['admin']['member_onote']  = 'Offizernotiz|Setze die Sichtbarkeit der Offiziernotizspalte auf der Mitgliederseite';
 
// Settings on Stats page
$lang['admin']['stats_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Wertelisteseite';
$lang['admin']['stats_motd']	= 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Wertelisteseite';
$lang['admin']['stats_hslist']  = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Wertelisteseite';
$lang['admin']['stats_pvplist']	= 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Wertelisteseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
$lang['admin']['stats_class']   = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Wertelisteseite';
$lang['admin']['stats_level']   = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Wertelisteseite';
$lang['admin']['stats_str']     = 'Stärke|Setze die Sichtbarkeit der Stärkepalte auf der Wertelisteseite';
$lang['admin']['stats_agi']     = 'Beweglichkeit|Setze die Sichtbarkeit der Beweglichkeitspalte auf der Wertelisteseite';
$lang['admin']['stats_sta']     = 'Willenskraft|Setze die Sichtbarkeit der Willenskraftspalte auf der Wertelisteseite';
$lang['admin']['stats_int']     = 'Intelligenz|Setze die Sichtbarkeit der Intelligenzspalte auf der Wertelisteseite';
$lang['admin']['stats_spi']     = 'Willenskraft|Setze die Sichtbarkeit der Willenskraftspalte auf der Wertelisteseite';
$lang['admin']['stats_sum']     = 'Gesamt|Setze die Sichtbarkeit der Gesamtspalte auf der Wertelisteseite';
$lang['admin']['stats_health']  = 'Gesundheit|Setze die Sichtbarkeit der Gesundheitspalte auf der Wertelisteseite';
$lang['admin']['stats_mana']    = 'Mana|Setze die Sichtbarkeit der Manaspalte auf der Wertelisteseite';
$lang['admin']['stats_armor']   = 'Rüstung|Setze die Sichtbarkeit der Rüstungspalte auf der Wertelisteseite';
$lang['admin']['stats_dodge']   = 'Ausweichen|Setze die Sichtbarkeit der Ausweichenspalte auf der Wertelisteseite';
$lang['admin']['stats_parry']   = 'Parrieren|Setze die Sichtbarkeit der Parierenspalte auf der Wertelisteseite';
$lang['admin']['stats_block']   = 'Blocken|Setze die Sichtbarkeit der Blockenspalte auf der Wertelisteseite';
$lang['admin']['stats_crit']    = 'Krit|Setze die Sichtbarkeit der Kritspalte auf der Wertelisteseite';
 
// Settings on Honor page
$lang['admin']['honor_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Ehrenstatistikseite';
$lang['admin']['honor_motd']	= 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Ehrenstatistikseite';
$lang['admin']['honor_hslist']  = 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Ehrenstatistikseite';
$lang['admin']['honor_pvplist']	= 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Ehrenstatistikseite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
$lang['admin']['honor_class']   = 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Ehrenstatistikseite';
$lang['admin']['honor_level']   = 'Level|Setze die Sichtbarkeit der Levelspalte auf der Ehrenstatistikseite';
$lang['admin']['honor_thk']     = 'Heute HK|Setze die Sichtbarkeit der Heute HK-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_tcp']     = 'Heute CP|Setze die Sichtbarkeit der Heute CP-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_yhk']     = 'Gestern HK|Setze die Sichtbarkeit der Gestern HK-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_ycp']     = 'Gestern CP|Setze die Sichtbarkeit der Gestern CP-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_lifehk']  = 'Gesamte HK|Setze die Sichtbarkeit der Gesamt HK-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_hrank']   = 'Höchster Rang|Setze die Sichtbarkeit der Höchster Rang-Spalte auf der Ehrenstatistikseite';
$lang['admin']['honor_hp']      = 'Ehrenpunkte|Setze die Sichtbarkeit der Ehrenpunktespalte auf der Ehrenstatistikseite';
$lang['admin']['honor_ap']      = 'Arenapunkte|Setze die Sichtbarkeit der Arenapunktespalte auf der Ehrenstatistikseite';
 
// Settings on Members page
$lang['admin']['log_update_inst'] = 'Aktualisierungsanleitung|Kontrolliert die Anzeige der Aktualisierungsanleitung auf der Mitglieder Log Seite';
$lang['admin']['log_motd']		= 'Gilden MOTD|Zeige Gilden "Nachtricht des Tages" oben auf der Mitglieder Log Seite';
$lang['admin']['log_hslist']	= 'Ehrensystem Werte|Kontrolliert die Anzeige der Ehrenpunkteliste auf der Mitglieder Log Seite';
$lang['admin']['log_pvplist']	= 'PvP-Logger Werte|Kontrolliert die Anzeige der PvP-Log Werte auf der Mitglieder Log Seite<br />Wenn du das Hochladen des PvPLog deaktiviert hast, macht es keinen Sinn diese Anzeige zu aktivieren';
$lang['admin']['log_class']		= 'Klasse|Setze die Sichtbarkeit der Klassespalte auf der Mitglieder Log Seite';
$lang['admin']['log_level']		= 'Level|Setze die Sichtbarkeit der Levelspalte auf der Mitglieder Log Seite';
$lang['admin']['log_gtitle']	= 'Gildenrang|Setze die Sichtbarkeit der Gildenrangspalte auf der Mitglieder Log Seite';
$lang['admin']['log_type']		= 'Typ|Setze die Sichtbarkeit der Typspalte auf der Mitglieder Log Seite';
$lang['admin']['log_date']		= 'Zuletzt Online|Setze die Sichtbarkeit der Zuletzt Online-Spalte auf der Mitglieder Log Seite';
$lang['admin']['log_note']		= 'Notiz|Setze die Sichtbarkeit der Notizspalte auf der Mitglieder Log Seite';
$lang['admin']['log_onote']		= 'Offizernotiz|Setze die Sichtbarkeit der Offiziernotizspalte auf der Mitglieder Log Seite';
 
// Settings names on build page
$lang['admin']['use_global']    = 'Use global settings|Use global settings rather than these local ones for this guild.';
$lang['admin']['getmain_regex'] = 'Regex|Dieses Feld spezifiziert die Benutzung des Regex. <br /> Folge dem wiki-Link für Details.';
$lang['admin']['getmain_field'] = 'Anwenden auf Feld|Dieses Feld spezifiziert auf welches Mitgliederfeld Regex angewendet werden soll. <br />Folge dem wiki-Link für Details.';
$lang['admin']['getmain_match'] = 'Benutze Treffernr.|Dieses Feld spezifiziert welcher Rückgabewert von Regex verwendet wird. <br /> Folge dem wiki-Link für Details.';
$lang['admin']['getmain_main']  = 'Hauptchar-Identifizierung|Wenn Regex diesen Wert findet, so wird dieser Chars als Hauptcharakter angenommen.';
$lang['admin']['defmain']       = 'Kein Ergebnis|Setze wie die Charaktere definiert weden sollen, bei denen Regex nichts zurückgibt.';
$lang['admin']['invmain']       = 'Ungültiges Ergebnis|Setze wie die Charaktere definiert weden sollen, <br />wenn Regex ein Ergebnis ausgibt, dass kein Gildenmitglied oder kein Hauptcharakter ist.';
$lang['admin']['altofalt']      = 'Twink des Twinks|Gib an, was zu tun ist, wenn der Charakter ein hauptcharakterloser Twink ist.';
$lang['admin']['update_type']   = 'Aktualisierungstyp|Gib an, an welchem Auslöser die Hauptchar/Twink Beziehungen aktualisiert werden sollen.';

CSS Styles

CSS style from the MembersList AddOn
addons/memberslist/style.css

/**
 * WoWRoster.net WoWRoster
 *
 * LICENSE: Licensed under the Creative Commons
 *          "Attribution-NonCommercial-ShareAlike 2.5" license
 *
 * @copyright  2002-2007 WoWRoster.net
 * @license    http://creativecommons.org/licenses/by-nc-sa/2.5   Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
 * @version    SVN: $Id: style.css 942 2007-05-20 04:50:02Z Zanix $
 * @link       http://www.wowroster.net
 * @package    MembersList
*/
 
.membersRowColor1 {
	background-color:#1F1E1D;
}
 
.membersRowColor2 {
	background-color:#2E2D2B;
}
 
.membersRowAltColor1 {
	background-color:#1F1E3D;
}
 
.membersRowAltColor2 {
	background-color:#2E2D4B;
}

I assume you know what css is...

Template Parser

Available to AddOns is the template parser which enables making the layout of your AddOn easier and easier to edit.
Roster automatically includes the template parser on initialization.

The templates have {CONTAINERS} for the information from php. This {INFO} is replaced by the output of the php code.
This means you have full control of where these containers are displayed or whether they are at all.

Currently the only AddOn in the Roster core that uses templates is "News".
All examples below are from the "News" AddOn.

Getting Started

Create a folder in roster/templates/default/ with your AddOn's basename
Or create a templates/ folder in your addon folder
This folder will hold all the templates for your AddOn

The PHP Side

In your php files, we will be calling the $roster->tpl object to insert data into your template

// Assign template vars
$roster->tpl->assign_vars(array(
	'L_POSTEDBY' => $roster->locale->act['posted_by'],
	'L_EDIT'     => $roster->locale->act['edit'],
	'L_ADD_NEWS' => $roster->locale->act['add_news'],
 
	'U_ADD_NEWS'  => makelink('util-news-add'),
	'S_ADD_NEWS' => true,
	)
);

or

$roster->tpl->assign_var('VAR_NAME','value');

What happens here is that we are making and setting template variables.
Notice how the variables in available to the template are much simpler than the php variables
'L_POSTEDBY' as opposed to $roster->locale->act['posted_by']

This all all fine and good for variables, but what if you want a repeating section?
This is quite easy actually.

Here we will be reading from the database and creating a template block variable

while( $news = $roster->db->fetch($result) )
{
	$roster->tpl->assign_block_vars('news_row', array(
		'TITLE'         => $news['title'],
		'ID'            => $news['news_id'],
		'CONTENT'       => $news['content'],
		'COMMENT_COUNT' => $news['comm_count'],
		'AUTHOR'        => $news['author'],
		'DATE'          => $news['date_format'],
 
		'U_BORDER_S' => border('sorange','start',$news['title'],'60%'),
		'U_BORDER_E' => border('sorange','end'),
		'U_COMMENT'  => makelink('util-news-comment&id=' . $news['news_id']),
		'U_EDIT'     => makelink('util-news-edit&id=' . $news['news_id']),
 
		'L_COMMENT' => ($news['comm_count'] != 1 ?
			sprintf($roster->locale->act['n_comments'],$news['comm_count']) :
			sprintf($roster->locale->act['n_comment'],$news['comm_count'])),
		)
	);
}

This is very useful for tables with repeating rows.

Now we want to select the template we want to display.

$roster->tpl->set_filenames(array('body' => $addon['basename'] . '/news.html'));
$roster->tpl->display('body');

What happens here is we are assigning a 'handle' to a template file
Then we use that handle to display and output the template

You can assign multiple templates, then display them

$roster->tpl->set_filenames(array(
	'newshead' => $addon['basename'] . '/news_head.html',
	'body' => $addon['basename'] . '/news.html',
	'newsfooter' => $addon['basename'] . '/news_head.html'
	)
);
$roster->tpl->display('newshead');
$roster->tpl->display('body');
$roster->tpl->display('newsfooter ');

Or in the template file, you can include a template file

<!-- INCLUDE news/news_head.html -->

(This is an html comment that the parser picks up, then includes this template)

The Template Side

Now we are ready to make the template
This example is from the "News" AddOn

roster/templates/default/news/news.html
or
roster/addons/news/templates/news.html

<!-- INCLUDE news/news_head.html -->

<!-- BEGIN news_row -->

{news_row.U_BORDER_S}

{news_row.CONTENT}
<hr />
<div style="text-align:left;">
	<span style="float:right;">
	<a href="{news_row.U_COMMENT}">{news_row.L_COMMENT}</a> | <a href="{news_row.U_EDIT}">{L_EDIT}</a></span>
	{L_POSTEDBY}: {news_row.AUTHOR} - {news_row.DATE}
</div>

{news_row.U_BORDER_E}
<br />
<!-- END news_row -->

<!-- IF S_ADD_NEWS --><!-- INCLUDE news/news_foot.html --><!-- ENDIF -->

See how all the variables are here, but wrapped in braces? { }
These are the variables you assigned in the php file

Notice the 'BEGIN news_row'?
This is the beginning of our repeating section

	$roster->tpl->assign_block_vars('news_row', array(
		'TITLE'         => $news['title'],
		'ID'            => $news['news_id'],

The variables 'TITLE' and 'ID' are available in this loop by appending the loop name 'news_row' and a period to the variable

	<a href="{news_row.U_COMMENT}">{news_row.L_COMMENT}</a> | <a href="{news_row.U_EDIT}">{L_EDIT}</a></span>

We will try to add more about templates, if anyone finds a good resource for phpbb, eqdkp, or DF templates, let us know...

AddOn Update Hook

The update hook is a file that ties into the lua upload process
You can specify any additional lua files you may you need

There are a few hook modes that an AddOn can make use of

• update
  • This mode does not hook into the CharacterProfiler upload process and is a good way to parse and process data from lua files other than CharacterProfiler
• char_pre
  • This mode is fired once per realm before any character is processed
• char
  • This mode fires for every character that is processed
• char_post
  • This mode is fired once per realm after every character is processed
• guild_pre
  • This mode is fired for each guild processed before any guild members are processed
• guild
  • This mode is fired for each guild member processed
• guild_post
  • This mode is fired for each guild processed after guild members are processed

Properties

The following variables are required in the update hook class

• var $messages

  String, any messages or output.

• var $data

  Array, Addon data object, recieved in constructor.

  This holds the addon's data from the database

• var $files

  array, An array of additional lua files that your addon needs.

  If you are using CharacterProfiler for data, there is no need to list it here.

Methods

• addonUpdate()

  The constructor for the update hook

  This is the only required method in an update hook class

  The addons data is passed to this function, you should set the passed data to an internal property variable

	function addonUpdate($data)
	{
		$this->data = $data;
	}

The following methods are reserved for update hooks
Descriptions for these methods are above and are not required

These function fairly simmilar

• update()
• char_pre($characters)
  • $characters - Array: All characters and their data in CharacterProfiler.lua
• char($char, $memberid)
  • $char - Array: Character data array for the current processed character
  • $memberid - Int: Member id from members table
• char_post($characters)
  • $characters - Array: All characters and their data in CharacterProfiler.lua
• guild_pre($guild)
  • $guild - Array: All guilds and their data in CharacterProfiler.lua
• guild($char, $memberid)
  • $char - Array: Member data array for the current processed member
  • $memberid - Int: Member id from members table
• guild_post($guild)
  • $guild - Array: All guilds and their data in CharacterProfiler.lua

You can add other methods or properties as you wish, but be warned that Roster may implement more update hook methods in future versions

Additional LUA Files During Update

The update class in Roster allows an addon to add more lua files for upload during the update process.

In your addon update hook class, add a member variable called $files.
This is an array of lua files you would like to add to the update process.

Specify the filename, without the .lua extension, in the update hook class constructor.

	function addonnameUpdate( $data )
	{
		$this->data = $data;
		$this->files[] = 'luafilename';
		$this->files[] = 'anotherluafilename';
	}

The uploaded lua data is available in Update::uploadData

$update->uploadData['luafilename']
$update->uploadData['anotherluafilename']

Example Update Hook File

This is an example update hook file
Look at memberslist and pvplog (example of additional lua file upload and processing) for more complex examples

<?php
/**
 * WoWRoster.net WoWRoster
 *
 * LICENSE: Licensed under the Creative Commons
 *          "Attribution-NonCommercial-ShareAlike 2.5" license
 *
 * @copyright  2002-2007 WoWRoster.net
 * @license    http://creativecommons.org/licenses/by-nc-sa/2.5   Creative Commons "Attribution-NonCommercial-ShareAlike 2.5"
 * @version    SVN: $Id: update_hook.php 899 2007-05-06 10:16:36Z Zanix $
 * @link       http://www.wowroster.net
 * @package    AddOnName
*/
 
if ( !defined('IN_ROSTER') )
{
    exit('Detected invalid access to this file!');
}
 
/**
 * Addon Update class
 * This MUST be the same name as the addon basename
 */
class addonUpdate
{
	var $messages = '';	// Update messages
	var $data = array();	// Addon config data automatically pulled from the addon_config table
	var $files = array();
 
 
	/**
	 * Class instantiation
	 * The name of this function MUST be the same name as the class name
	 *
	 * @param array $data	| Addon data
	 * @return recipe
	 */
	function addonUpdate($data)
	{
		$this->data = $data;
	}
 
	/**
	 * Resets addon messages
	 */
	function reset_messages()
	{
		$this->messages = '';
	}
 
 
	function update()
	{
		global $roster;
 
		$this->messages .= "<span class=\"green\">This is a non CP hook</span><br />\n";
 
		return true;
	}
 
	function guild_pre( $data )
	{
		global $roster;
 
		$this->messages .= "<span class=\"green\">This is a guild_pre hook</span><br />\n";
 
		return true;
	}
 
	function guild( $data , $memberid )
	{
		global $roster;
 
		$this->messages .= "<span class=\"yellow\">This is a guild hook</span><br />\n";
 
		return true;
	}
 
	function guild_post( $data )
	{
		global $roster;
 
		$this->messages .= "<span class=\"red\">This is a guild_post hook</span><br />\n";
 
		return true;
	}
 
	function char_pre( $data )
	{
		global $roster;
 
		$this->messages .= "<span class=\"green\">This is a char_pre hook</span><br />\n";
 
		return true;
 
	}
 
	function char( $data , $memberid )
	{
		global $roster;
 
		$this->messages .= "<span class=\"yellow\">This is a char hook</span><br />\n";
 
		return true;
	}
 
	function char_post( $data )
	{
		global $roster;
 
		$this->messages .= "<span class=\"red\">This is a char_post hook</span><br />\n";
 
		return true;
	}
}

Variables and Functions for AddOns

There are many variables, functions, and classes available for Addons to use

Variables

This is a list of variables that are available for your Addons

All variables are available whether during update hooks or in the framework

• $roster->db
  • Database layer for roster
• $roster->locale->wordings
  • Every locale array
• $roster->locale->act
  • The current global locale string array
• $roster->config
  • The roster configuration array
• $roster->pages
  • Array of current pages accessed
• $roster->data
  • Current scope data

  This contains data about the current scope

  • Realm - Only contains the Realm Name and Region Code
  • Guild - Contains all the data about a guild, Region Code, Realm Name, motd, update time, number of members, etc...
  • Character - Contains all the data about the character from the players table
• DIR_SEP
  • OS specific directory separator
• ROSTER_BASE
  • Full path to roster directory including DIR_SEP at the end
• ROSTER_LIB
  • Full path to roster lib directory including DIR_SEP at the end
• ROSTER_ADDONS
  • Full path to roster addons directory including DIR_SEP at the end
• ROSTER_ADMIN
  • Full path to roster admin directory including DIR_SEP at the end
• ROSTER_AJAX
  • Full path to rosters ajax directory including DIR_SEP at the end
• ROSTER_LOCALE
  • Full path to roster localization directory including DIR_SEP at the end
• ROSTER_VERSION
  • Current Version of Roster
• ROSTER_URL
  • Full valid URL to roster's root directory
• ROSTER_PATH
  • URL path to roster's root directory
• IN_ROSTER
  • Constant saying that you are in the Roster framework
• ROSTER_MAXCHARLEVEL

  Maximum level that a character in WoW can achieve

• ROSTER_MAXSKILLLEVEL

  Maximum skill level that a character in WoW can achieve

• $roster->db->prefix
  • Database table prefix
• $roster->db->table($tablename, $addon=)
  • Returns a table name including the database prefix
    • This will return 'databaseprefix_tablename'
  • When $addon is passed, use the basename of the addon
    • This will return 'databaseprefix_addon_basename_tablename'
• $addon['addon_id']
  • Addon database id
• $addon['basename']
  • Addon folder name
• $addon['version']
  • Addon version
• $addon['active']
  • 0 - if the Addon is disabled : 1 - if the Addon is enabled
  • Use addon_active('basename') to check if an addon is enabled
• $addon['fullname']
  • Addon's full name for display
• $addon['description']
  • Short description of the addon
• $addon['credits']
  • Serialized array of credits
• $addon['icon']
  • Addon's display icon
• $addon['dir']
  • Full path to the Addon's folder
• $addon['url']
  • URL path from the Roster base folder to the Addon's folder, this is not the full url path
• $addon['url_full']
  • URL to the Addon's folder, this is a full qualified url
• $addon['url_path']
  • URL path to the Addon's folder, this is not the full url path
• $addon['image_full']
  • URL to the Addon's images/ folder, this is a full qualified url
• $addon['image_path']
  • URL path to the Addon's images/ folder, this is not the full url path
• $addon['css_file']
  • Full path to the Addon's style.css file
• $addon['css_url']
  • URL path to the Addon's css file, this is not the full url path
• $addon['conf_file']
  • Full path to the Addon's inc/conf.php file
• $addon['locale_dir']
  • Full path to the Addon's locale directory
• $addon['admin_dir']
  • Full path to the Addon's admin directory
• $addon['trigger_file']
  • Full path to the Addon's inc/update_hook.php file
• $addon['ajax_file']
  • Full path to the Addon's ajax.php
• $addon['config']
  • Addon's configuration array

Variable Calls

These are added to index.php for some additional support

If you add these to your addon, you can turn off the header, footer and menu on the page, these are always enabled by default.

$roster->output['show_header'] = false;  // Disable the roster header
$roster->output['show_menu'] = false;    // Disable roster menu
$roster->output['show_footer'] = false;  // Disable roster footer 

$roster->output['show_menu'] accepts a string or an array of button panel names to display
When building an addon, you can build your own button listing that only displays on your addon pages
Pass a string for only one set of buttons, or pass an array for multiple sets of buttons

$roster->output['show_menu'] = array('util' => 1);  // Display only the util button panel, default opened
$roster->output['show_menu'] = array('util' => 1,'char' => 0);  // Display only the util and char button panels: util default opened, char default closed
$roster->output['show_menu']['custom'] = 1;  // Display the default panels and the custom button panel, default opened 

$roster->output['html_head'] = 'string';

Accepts any string needing to be in the html header for your addon, such as javascript inclusion
roster_header.tpl will pick this variable up and place its contents in the header

$roster->output['body_attr'] = 'string';

Accepts any string needing to be in the <body> tag in roster_header.tpl

$roster->output['body_onload'] = 'string';

Accepts any string needing to be in <body onload=""> in roster_header.tpl

Any output needed, just print or echo it
Roster uses php's output buffering to capture all print or echo commands
Then it echos the output where needed

Functions

This is a list of functions that are available for your Addons

View FunctionsOverview for details on available Roster functions

Roster Authorization

Like those nifty log-in boxes in RosterCP?
Now you can easily add one to your addon!

This checks if the user has admin access

// ----[ Check log-in ]-------------------------------------
// Disallow viewing of the page
if( !$roster->auth->getAuthorized($required_level) )
{
	print
	'<span class="title_text">Some Title</span><br />'.
	$roster->auth->getLoginForm();
 
	return; //Kicks out of the AddOn and back to the Roster framework
}
// ----[ End Check log-in ]--------------------------------- 

• $roster->auth - Roster Auth class
• $roster->auth->getAuthorized() - (bool) Returns access granted or denied
• $roster->auth->getMessage() - (string) Message sent from Roster Login, such as "Logged Out" or "Wrong Password"
• $roster->auth->getLoginForm() - (string) The Roster Log-in form

Also note that there is a log in box in the menu.

Addon Credits

Link = http://[www.someurl.net]/roster/?p=credits (SEO: http://[www.someurl.net]/roster/credits.html)
To get credits on the main credit page, set the $credits array in the AddOn's inc/install.def.php file

var $credits = array(
	array(	"name"=>	"Author Name",
		"info"=>	"Extra Info"),
);

Replace the following

• "Addon Name" with your addon's name
• "Author Name" with your (The addon's author) name
• "Extra Info" with a short description or additional info

(Use <br> for line breaks)

You can add multiple arrays inside the main one to add more credits
(Try not to add too many, we don't wanna clutter the credits page now do we?)

Tooltips

/**
 * Makes a tootip and places it into the tooltip array
 *
 * @param string $var
 * @param string $content
 */
function setTooltip( $var , $content )

Creates a js variable for use with overlib
Instead of outputting text in the html, you can create a js variable that holds this instead

/**
 * Easy all in one function to make overlib tooltips
 * Creates a string for insertion into any html tag that has "onmouseover" and "onmouseout" events
 *
 * @param string $tooltip | Tooltip as a string (delimited by "\n" character)
 * @param string $caption | (optional) Text to set as a true OverLib caption
 * @param string $caption_color | (optional) Color for the caption
 * Default is 'ffffff' - white
 * @param bool $mode| (optional) Options 0=colorize,1=clean,2=pass through
 * Default 0 (colorize)
 * @param string $locale | Locale so color parser can work correctly
 * Only needed when $colorize is true
 * Default is $roster_conf['roster_lang']
 * @param string $extra_parameters | (optional) Extra OverLib parameters you wish to pass
 * @return unknown
 */
function makeOverlib( $tooltip , $caption='' , $caption_color='' , $mode=0 , $locale='' , $extra_parameters='' )

Returns this string for use in any html tag that supports onmouseover and onmouseout events

onmouseover="return overlib(overlib_'.$num_of_tips.$caption.$extra_parameters.');" onmouseout="return nd();"

For more info about makeOverlib() and its supporting functions, look at functions.lib.php

Message Boxes

Functions to draw message boxes

/**
 * Draw a message box with the specified border color.
 *
 * @param string $message | The message to display inside the box
 * @param string $title | The box title
 * @param string $style | The border style
 * @param string $width | Set a fixed width
 * @return string $html | The HTML for the messagebox
 */
function messagebox( $message , $title='Message' , $style='sgray' , $width='' )

/**
 * Draw a 300x550px scrolling messagebox with the specified border color.
 *
 * @param string $message | The message to display inside the box
 * @param string $title | The box title
 * @param string $style | The border style
 * @param string $width | Initial width with unit
 * @param string $height | Initial height with unit
 * @return string $html | The HTML for the messagebox
 */
function scrollbox($message, $title = 'Message', $style = 'sgray', $width = '550px', $height = '300px')

/**
 * Draw a message box with the specified border color.
 *
 * @param string $message | The message to display inside the box
 * @param string $title | The box title
 * @param string $style | The border style
 * @param boolean $open | True if initially open
 * @param string $width | Initial width with unit
 * @return string $html | The HTML for the messagebox
 */
function messageboxtoggle($message, $title = 'Message', $style = 'sgray', $open = false, $width = '550px')

/**
 * Draw a 300x550px scrolling messagebox with the specified border color.
 *
 * @param string $messages | The message to display inside the box
 * @param string $title | The box title
 * @param string $style | The border style
 * @param string $width | Initial width with unit
 * @param string $height | Initial height with unit
 * @return string $html | The HTML for the messagebox
 */
function scrollboxtoggle($message, $title = 'Message', $style = 'sgray', $open = false, $width = '550px', $height = '300px')