Revision as of 02:38, 5 February 2008 (view source) Nefuh (Talk | contribs) (Create the document, add the Global Functions)		Revision as of 03:13, 5 February 2008 (view source) Nefuh (Talk | contribs) (Adding $roster->db->, edit some linebreaks) Newer edit →
Line 16:		Line 16:
	==border==		==border==
−	Parameters: $style, $mode, $header_txt, $width	+	Parameters: $style, $mode, $header_txt, $width<br/>
−	Starts or ends fancy bodering containers	+	Starts or ends fancy bodering containers<br/>
	*@param string $style What bordering style to use		*@param string $style What bordering style to use
	*@param string $mode ( start | end )		*@param string $mode ( start | end )
Line 26:		Line 26:
	==setTooltip==		==setTooltip==
−	Parameters: $var, $content	+	Parameters: $var, $content<br/>
−	Makes a tootip and places it into the tooltip array	+	Makes a tootip and places it into the tooltip array<br/>
	*@param string $var		*@param string $var
	*@param string $content		*@param string $content
Line 33:		Line 33:
	==getAllTooltips==		==getAllTooltips==
−	Gathers all tootips and places them into javascript variables	+	Parameters: none<br/>
		+	Gathers all tootips and places them into javascript variables<br/>
	*@param array $tooltipArray		*@param array $tooltipArray
	*@return string Tooltips placed in javascript variables		*@return string Tooltips placed in javascript variables
Line 39:		Line 40:
	==sql_highlight==		==sql_highlight==
−	Parameters: $sql	+	Parameters: $sql<br/>
−	Highlight certain keywords in a SQL query	+	Highlight certain keywords in a SQL query<br/>
	*@param string $sql Query string		*@param string $sql Query string
	*@return string Highlighted string		*@return string Highlighted string
Line 46:		Line 47:
	==die_quietly==		==die_quietly==
−	Parameters: $text, $title, $file, $line, $sql	+	Parameters: $text, $title, $file, $line, $sql<br/>
−	Clean replacement for die(), outputs a message with debugging info if needed and ends output	+	Clean replacement for die(), outputs a message with debugging info if needed and ends output<br/>
	*@param string $text Text to display on error page		*@param string $text Text to display on error page
	*@param string $title Title to place on web page (default Message)		*@param string $title Title to place on web page (default Message)
Line 56:		Line 57:
	==roster_die==		==roster_die==
−	Parameters: $message, $title, $style	+	Parameters: $message, $title, $style<br/>
−	Draw a message box with the specified border color, then die cleanly	+	Draw a message box with the specified border color, then die cleanly<br/>
	*@param string $message | The message to display inside the box		*@param string $message | The message to display inside the box
	*@param string $title | The box title (default Message )		*@param string $title | The box title (default Message )
Line 64:		Line 65:
	==ajax_die==		==ajax_die==
−	Parameters: $text, $title, $file, $line, $sql	+	Parameters: $text, $title, $file, $line, $sql<br/>
−	Print a roster-ajax XML error message	+	Print a roster-ajax XML error message<br/>
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==backtrace==		==backtrace==
−	Print a debug backtrace. This works in PHP4.3.x+, there is an integrated function for this starting PHP5 but I prefer always having the same layout.	+	Parameters: none<br/>
		+	Print a debug backtrace. This works in PHP4.3.x+, there is an integrated function for this starting PHP5 but I prefer always having the same layout.<br/>
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==stripAllHtml==		==stripAllHtml==
−	Parameters: $string	+	Parameters: $string<br/>
−	This will remove HTML tags, javascript sections and white space. It will also convert some common HTML entities to their text equivalent	+	This will remove HTML tags, javascript sections and white space. It will also convert some common HTML entities to their text equivalent<br/>
	*@param string $file		*@param string $file
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==check_if_image==		==check_if_image==
−	Parameters: $filename	+	Parameters: $filename<br/>
−	This will check if the given Filename is an image	+	This will check if the given Filename is an image<br/>
	*@param imagefile $file		*@param imagefile $file
	*@return mixed The extentsion if the filetype is an image, false if it is not		*@return mixed The extentsion if the filetype is an image, false if it is not
Line 86:		Line 88:
	==colorTooltip==		==colorTooltip==
−	Parameters: $tooltip, $caption_color, $locale, $inline_caption	+	Parameters: $tooltip, $caption_color, $locale, $inline_caption<br/>
−	Tooltip colorizer function with string cleaning. Use only with makeOverlib	+	Tooltip colorizer function with string cleaning. Use only with [[#makeOverlib]]<br/>
	*@param string $tooltip | Tooltip as a string (delimited by "\n" character)		*@param string $tooltip | Tooltip as a string (delimited by "\n" character)
	*@param string $caption_color | (optional) Color for the caption		*@param string $caption_color | (optional) Color for the caption
Line 99:		Line 101:
	==cleanTooltip==		==cleanTooltip==
−	Parameters: $tooltip, $caption_color, $inline_caption	+	Parameters: $tooltip, $caption_color, $inline_caption<br/>
−	Cleans up the tooltip and parses an inline_caption if needed. Use only with [[#makeOverlib]]	+	Cleans up the tooltip and parses an inline_caption if needed. Use only with [[#makeOverlib]]<br/>
	*@param string $tooltip | Tooltip as a string (delimited by "\n" character)		*@param string $tooltip | Tooltip as a string (delimited by "\n" character)
	*@param string $caption_color | (optional) Color for the caption		*@param string $caption_color | (optional) Color for the caption
Line 110:		Line 112:
	==makeOverlib==		==makeOverlib==
−	Parameters: $tooltip, $caption, $caption_color, $mode, $locale, $extra_parameters	+	Parameters: $tooltip, $caption, $caption_color, $mode, $locale, $extra_parameters<br/>
−	Easy all in one function to make overlib tooltips. Creates a string for insertion into any html tag that has "onmouseover" and "onmouseout" events	+	Easy all in one function to make overlib tooltips. Creates a string for insertion into any html tag that has "onmouseover" and "onmouseout" events<br/>
	*@param string $tooltip | Tooltip as a string (delimited by "\n" character)		*@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 | (optional) Text to set as a true OverLib caption
Line 127:		Line 129:
	==messagebox==		==messagebox==
−	Parameters: $message, $title, $style, $width	+	Parameters: $message, $title, $style, $width<br/>
−	Draw a message box with the specified border color.	+	Draw a message box with the specified border color.<br/>
	*@param string $message | The message to display inside the box		*@param string $message | The message to display inside the box
	*@param string $title | The box title (default message)		*@param string $title | The box title (default message)
Line 137:		Line 139:
	==scrollbox==		==scrollbox==
−	Parameters: $message, $title, $style, $width, $height	+	Parameters: $message, $title, $style, $width, $height<br/>
−	Draw a 300x550px scrolling messagebox with the specified border color.	+	Draw a 300x550px scrolling messagebox with the specified border color.<br/>
	*@param string $message | The message to display inside the box		*@param string $message | The message to display inside the box
	*@param string $title | The box title (default message)		*@param string $title | The box title (default message)
Line 148:		Line 150:
	==messageboxtoggle==		==messageboxtoggle==
−	Parameters: $message, $title, $style, $open, $width	+	Parameters: $message, $title, $style, $open, $width<br/>
−	Draw a message box with the specified border color.	+	Draw a message box with the specified border color.<br/>
	*@param string $message | The message to display inside the box		*@param string $message | The message to display inside the box
	*@param string $title | The box title		*@param string $title | The box title
Line 159:		Line 161:
	==scrollboxtoggle==		==scrollboxtoggle==
−	Parameters: $message, $title, $style, $open, $width, $height	+	Parameters: $message, $title, $style, $open, $width, $height<br/>
−	Draw a 300x550px scrolling messagebox with the specified border color.	+	Draw a 300x550px scrolling messagebox with the specified border color.<br/>
	*@param string $messages | The message to display inside the box		*@param string $messages | The message to display inside the box
	*@param string $title | The box title (default message)		*@param string $title | The box title (default message)
Line 170:		Line 172:
	==escape_array==		==escape_array==
−	Parameters: $array	+	Parameters: $array<br/>
−	Recursively escape $array	+	Recursively escape $array<br/>
	*@param array $array | The array to escape		*@param array $array | The array to escape
	*@return array | The same array, escaped		*@return array | The same array, escaped
Line 177:		Line 179:
	==stripslash_array==		==stripslash_array==
−	Parameters: $array	+	Parameters: $array<br/>
−	Recursively stripslash $array	+	Recursively stripslash $array<br/>
	*@param array $array | The array to escape		*@param array $array | The array to escape
	*@return array | The same array, escaped		*@return array | The same array, escaped
Line 184:		Line 186:
	==readbleDate==		==readbleDate==
−	Parameters: $datetime, $offset	+	Parameters: $datetime, $offset<br/>
−	Converts a datetime field into a readable date	+	Converts a datetime field into a readable date<br/>
	*@param string $datetime | datetime field data in DB		*@param string $datetime | datetime field data in DB
	*@param string $offset | Offset in hours to calcuate time returned		*@param string $offset | Offset in hours to calcuate time returned
Line 192:		Line 194:
	==get_file_ext==		==get_file_ext==
−	Parameters: $filename	+	Parameters: $filename<br/>
−	Gets a file's extention passed as a string	+	Gets a file's extention passed as a string<br/>
	*@param string $filename		*@param string $filename
	*@return string		*@return string
Line 199:		Line 201:
	==seconds_to_time==		==seconds_to_time==
−	Parameters: $seconds	+	Parameters: $seconds<br/>
−	Converts seconds to a string delimited by time values. Will show w,d,h,m,s	+	Converts seconds to a string delimited by time values. Will show w,d,h,m,s<br/>
	*@param string $seconds		*@param string $seconds
	*@return string		*@return string
Line 206:		Line 208:
	==getaddon==		==getaddon==
−	Parameters: $addonname	+	Parameters: $addonname<br/>
−	Sets up addon data for use in the addon framework	+	Sets up addon data for use in the addon framework<br/>
	*@param string $addonname | The name of the addon		*@param string $addonname | The name of the addon
	*@return array $addon  | The addon's database record		*@return array $addon  | The addon's database record
Line 214:		Line 216:
	==active_addon==		==active_addon==
−	Parameters: $name	+	Parameters: $name<br/>
−	Check to see if an addon is active or not	+	Check to see if an addon is active or not<br/>
	*@param string $name | Addon basename		*@param string $name | Addon basename
	*@return bool		*@return bool
Line 221:		Line 223:
	==urlgrabber==		==urlgrabber==
−	Parameters: $url, $timeout, $user_agent, $loopcount	+	Parameters: $url, $timeout, $user_agent, $loopcount<br/>
−	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	+	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<br/>
	*@param string $url | URL to retrieve		*@param string $url | URL to retrieve
	*@param int $timeout | Timeout for curl, socket connection timeout for fsock (default 5)		*@param int $timeout | Timeout for curl, socket connection timeout for fsock (default 5)
Line 231:		Line 233:
	==request_uri==		==request_uri==
−	Stupid function to create an REQUEST_URI for IIS 5 servers	+	Parameters: none<br/>
		+	Stupid function to create an REQUEST_URI for IIS 5 servers<br/>
	*@return string		*@return string
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==file_writer==		==file_writer==
−	Parameters: $filename, &$content, $mode	+	Parameters: $filename, &$content, $mode<br/>
−	Attempts to write a file to the file system	+	Attempts to write a file to the file system<br/>
	*@param string $filename | Name of the file		*@param string $filename | Name of the file
	*@param string $content | Content of the file		*@param string $content | Content of the file
Line 245:		Line 248:
	==php_as_nobody==		==php_as_nobody==
−	Parameters: $file	+	Parameters: $file<br/>
−	No Description	+	No Description<br/>
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==_aprint==		==_aprint==
−	Parameters: $arr, $tab	+	Parameters: $arr, $tab<br/>
−	Debugging function dumps arrays/object formatted. Do Not call this, call [[#aprint|aprint()]]	+	Debugging function dumps arrays/object formatted. Do Not call this, call [[#aprint|aprint()]]<br/>
	*@param array $arr		*@param array $arr
	*@param int $tab | (default 1)		*@param int $tab | (default 1)
Line 258:		Line 261:
	==aprint==		==aprint==
−	Parameters: $arr, $prefix, $return	+	Parameters: $arr, $prefix, $return<br/>
−	Debugging function dumps arrays/object formatted	+	Debugging function dumps arrays/object formatted<br/>
	*@param array $arr		*@param array $arr
	*@param string $prefix		*@param string $prefix
Line 266:		Line 269:
	==socketColorEn==		==socketColorEn==
−	Parameters: $socket_color, $locale	+	Parameters: $socket_color, $locale<br/>
−	Helper function that returns the localized gem color in english	+	Helper function that returns the localized gem color in english<br/>
	*@param string $socket_color		*@param string $socket_color
	*@return string $color		*@return string $color
Line 273:		Line 276:
	==format_microtime==		==format_microtime==
−	Parameters: none	+	Parameters: none<br/>
−	No Description	+	No Description<br/>
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]
	==array_overlay==		==array_overlay==
−	Parameters: $skel, $arr	+	Parameters: $skel, $arr<br/>
−	A better array_merge()	+	A better array_merge()<br/>
	*@param array $skel		*@param array $skel
	*@param array $arr		*@param array $arr
Line 286:		Line 289:
	==updateCheck==		==updateCheck==
−	Parameters: $addon	+	Parameters: $addon<br/>
−	Checks an addon download id on the wowroster.net rss feed. And informs if there is an update.	+	Checks an addon download id on the wowroster.net rss feed. And informs if there is an update.<br/>
	*@param string $name | name of the download		*@param string $name | name of the download
	*@param string $url | url		*@param string $url | url
Line 293:		Line 296:
	==dummy==		==dummy==
−	Parameters: none	+	Parameters: none<br/>
−	Dummy function. For when you need a callback that doesn't do anything.	+	Dummy function. For when you need a callback that doesn't do anything.<br/>
		+	<br/>[[#Global functions|Top]]
		+
		+	=roster->db->=
		+	The following functions can be used to operate on database
		+
		+	==error==
		+	Parameters: none<br/>
		+	Get last SQL error<br/>
		+	*@return string last SQL error
		+	<br/>[[#Global functions|Top]]
		+
		+	==errno==
		+	Parameters:none<br/>
		+	Get last SQL errno<br/>
		+	*@return string last SQL errno
		+	<br/>[[#Global functions|Top]]
		+
		+	==query==
		+	Parameters: $query<br/>
		+	Basic query function<br/>
		+	*@param $query Query string
		+	*@return mixed Query ID / Error string / Bool
		+	<br/>[[#Global functions|Top]]
		+
		+	==query_first==
		+	Parameters: $query<br />
		+	Return the first record (single column) in a query result<br/>
		+	*@param $query Query string
		+	<br/>[[#Global functions|Top]]
		+
		+	==build_query==
		+	Parameters: $query, $array<br/>
		+	Build query<br/>
		+	*@param $query
		+	*@param $array Array of field => value pairs (default false)
		+	*@return $query | Returns the builded query
		+	<br/>[[#Global functions|Top]]
		+
		+	==fetch==
		+	Parameters: $query_id, $result_type<br/>
		+	Fetch one record<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@param $result_type | SQL_ASSOC, SQL_NUM, or SQL_BOTH (default SQL_BOTH)
		+	*@return mixed Record / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==fetch_all==
		+	Parameters: $query_id, $result_type<br/>
		+	Fetch all records<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@param $result_type | SQL_ASSOC, SQL_NUM, or SQL_BOTH
		+	*@return mixed Record Set / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==result==
		+	Parameters: $query_id, $row, $field<br/>
		+	Get result data<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@param $row | The row number from the result that's being retrieved. Row numbers start at 0
		+	*@param $field | The name or offset of the field being retrieved
		+	*@return mixed Record / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==num_rows==
		+	Parameters: $query_id<br/>
		+	Find the number of returned rows<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@return mixed Number of rows / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==affected_rows==
		+	Parameters: $query_id<br/>
		+	Finds out the number of rows affected by a query<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@return mixed Affected Rows / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==insert_id==
		+	Parameters: none<br/>
		+	Find the ID of the row that was just inserted<br/>
		+	*@return mixed Last ID / false
		+	<br/>[[#Global functions|Top]]
		+
		+	==free_result==
		+	Parameters: $query_id<br/>
		+	Free result data<br/>
		+	*@param $query_id | Query ID (default 0)
		+	*@return bool
		+	<br/>[[#Global functions|Top]]
		+
		+	==escape==
		+	Parameters: $string<br/>
		+	Remove quote escape<br/>
		+	*@param $string
		+	*@return string
		+	<br/>[[#Global functions|Top]]
		+
		+	==error_die==
		+	Parameters: $setting<br/>
		+	Set the error_die var<br/>
		+	@param $setting<br/>
		+	<br/>[[#Global functions|Top]]
		+
		+	==table==
		+	Parameters: $table, $addon<br/>
		+	Expand base table name to a full table name<br/>
		+	*@param string $table | the base table name
		+	*@param string $addon | the name of the addon, empty for a base roster table
		+	*@return string | tablename as fit for MySQL queries
	<br/>[[#Global functions|Top]]		<br/>[[#Global functions|Top]]

---

Revision as of 03:13, 5 February 2008

Contents 1 Main Page 2 Global functions 2.1 border 2.2 setTooltip 2.3 getAllTooltips 2.4 sql_highlight 2.5 die_quietly 2.6 roster_die 2.7 ajax_die 2.8 backtrace 2.9 stripAllHtml 2.10 check_if_image 2.11 colorTooltip 2.12 cleanTooltip 2.13 makeOverlib 2.14 messagebox 2.15 scrollbox 2.16 messageboxtoggle 2.17 scrollboxtoggle 2.18 escape_array 2.19 stripslash_array 2.20 readbleDate 2.21 get_file_ext 2.22 seconds_to_time 2.23 getaddon 2.24 active_addon 2.25 urlgrabber 2.26 request_uri 2.27 file_writer 2.28 php_as_nobody 2.29 _aprint 2.30 aprint 2.31 socketColorEn 2.32 format_microtime 2.33 array_overlay 2.34 updateCheck 2.35 dummy 3 roster->db-> 3.1 error 3.2 errno 3.3 query 3.4 query_first 3.5 build_query 3.6 fetch 3.7 fetch_all 3.8 result 3.9 num_rows 3.10 affected_rows 3.11 insert_id 3.12 free_result 3.13 escape 3.14 error_die 3.15 table

Function Overview
Overview over all functions in the Roster that can be used by Addon Developers.

---

Latest changes

• Nefuh | 05.02.2008 03:07 | Created document

---

Global functions

These function are located in functions.lib.php

border

Parameters: $style, $mode, $header_txt, $width
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 (default null)
• @param string $width Set a fixed width for the box
• @return string

Top

setTooltip

Parameters: $var, $content
Makes a tootip and places it into the tooltip array

• @param string $var
• @param string $content

Top

getAllTooltips

Parameters: none
Gathers all tootips and places them into javascript variables

• @param array $tooltipArray
• @return string Tooltips placed in javascript variables

Top

sql_highlight

Parameters: $sql
Highlight certain keywords in a SQL query

• @param string $sql Query string
• @return string Highlighted string

Top

die_quietly

Parameters: $text, $title, $file, $line, $sql
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 (default Message)
• @param string $file Filename to display
• @param string $line Line in file to display
• @param string $sql Any SQL text to display

Top

roster_die

Parameters: $message, $title, $style
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)

Top

ajax_die

Parameters: $text, $title, $file, $line, $sql
Print a roster-ajax XML error message

Top

backtrace

Parameters: none
Print a debug backtrace. This works in PHP4.3.x+, there is an integrated function for this starting PHP5 but I prefer always having the same layout.

Top

stripAllHtml

Parameters: $string
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

Top

check_if_image

Parameters: $filename
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

Top

colorTooltip

Parameters: $tooltip, $caption_color, $locale, $inline_caption
Tooltip colorizer function with string cleaning. Use only with #makeOverlib

• @param string $tooltip | Tooltip as a string (delimited by "\n" character)
• @param string $caption_color | (optional) Color for the caption
• Default is 'ffffff' - white
• @param string $locale | (optional) Locale so color parser can work correctly
• Default is $roster->config['locale']
• @param bool $inline_caption | (optional) (default 1)
• Default is true
• @return string | Formatted tooltip

Top

cleanTooltip

Parameters: $tooltip, $caption_color, $inline_caption
Cleans up the tooltip and parses an inline_caption if needed. Use only with #makeOverlib

• @param string $tooltip | Tooltip as a string (delimited by "\n" character)
• @param string $caption_color | (optional) Color for the caption
• Default is 'ffffff' - white
• @param bool $inline_caption | (optional) (default 1)
• Default is true
• @return string | Formatted tooltip

Top

makeOverlib

Parameters: $tooltip, $caption, $caption_color, $mode, $locale, $extra_parameters
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)
• Default 0 (colorize)
• @param string $locale | Locale so color parser can work correctly
• Only needed when $colorize is true
• Default is $roster->config['locale']
• @param string $extra_parameters | (optional) Extra OverLib parameters you wish to pass
• @param string $item_id
• @return unknown

Top

messagebox

Parameters: $message, $title, $style, $width
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 (default message)
• @param string $style | The border style (default sgray)
• @param string $width | Set a fixed width
• @return string $html | The HTML for the messagebox

Top

scrollbox

Parameters: $message, $title, $style, $width, $height
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 (default message)
• @param string $style | The border style (default sgray)
• @param string $width | Initial width with unit (default 550px)
• @param string $height | Initial height with unit (default 300px)
• @return string $html | The HTML for the messagebox

Top

messageboxtoggle

Parameters: $message, $title, $style, $open, $width
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 (default sgray)
• @param boolean $open | True if initially open (default false)
• @param string $width | Initial width with unit (default 550px)
• @return string $html | The HTML for the messagebox

Top

scrollboxtoggle

Parameters: $message, $title, $style, $open, $width, $height
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 (default message)
• @param string $style | The border style (default sgray)
• @param string $width | Initial width with unit (default 550px)
• @param string $height | Initial height with unit (default 300px)
• @return string $html | The HTML for the messagebox

Top

escape_array

Parameters: $array
Recursively escape $array

• @param array $array | The array to escape
• @return array | The same array, escaped

Top

stripslash_array

Parameters: $array
Recursively stripslash $array

• @param array $array | The array to escape
• @return array | The same array, escaped

Top

readbleDate

Parameters: $datetime, $offset
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

Top

get_file_ext

Parameters: $filename
Gets a file's extention passed as a string

• @param string $filename
• @return string

Top

seconds_to_time

Parameters: $seconds
Converts seconds to a string delimited by time values. Will show w,d,h,m,s

• @param string $seconds
• @return string

Top

getaddon

Parameters: $addonname
Sets up addon data for use in the addon framework

• @param string $addonname | The name of the addon
• @return array $addon | The addon's database record
• @global array $addon_conf | The addon's config data is added to this global array.

Top

active_addon

Parameters: $name
Check to see if an addon is active or not

• @param string $name | Addon basename
• @return bool

Top

urlgrabber

Parameters: $url, $timeout, $user_agent, $loopcount
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, socket connection timeout for fsock (default 5)
• @param string $user_agent | Useragent to use for connection (default false)
• @param int $loopcount | (default 0)
• @return mixed | False on error, contents on success

Top

request_uri

Parameters: none
Stupid function to create an REQUEST_URI for IIS 5 servers

• @return string

Top

file_writer

Parameters: $filename, &$content, $mode
Attempts to write a file to the file system

• @param string $filename | Name of the file
• @param string $content | Content of the file
• @param string $mode | (default wb)
• @return bool

Top

php_as_nobody

Parameters: $file
No Description

Top

_aprint

Parameters: $arr, $tab
Debugging function dumps arrays/object formatted. Do Not call this, call aprint()

• @param array $arr
• @param int $tab | (default 1)
• @return string

Top

aprint

Parameters: $arr, $prefix, $return
Debugging function dumps arrays/object formatted

• @param array $arr
• @param string $prefix
• @return string | (default false)

Top

socketColorEn

Parameters: $socket_color, $locale
Helper function that returns the localized gem color in english

• @param string $socket_color
• @return string $color

Top

format_microtime

Parameters: none
No Description

Top

array_overlay

Parameters: $skel, $arr
A better array_merge()

• @param array $skel
• @param array $arr
• @return array

Top

updateCheck

Parameters: $addon
Checks an addon download id on the wowroster.net rss feed. And informs if there is an update.

• @param string $name | name of the download
• @param string $url | url

Top

dummy

Parameters: none
Dummy function. For when you need a callback that doesn't do anything.

Top

roster->db->

The following functions can be used to operate on database

error

Parameters: none
Get last SQL error

• @return string last SQL error

Top

errno

Parameters:none
Get last SQL errno

• @return string last SQL errno

Top

query

Parameters: $query
Basic query function

• @param $query Query string
• @return mixed Query ID / Error string / Bool

Top

query_first

Parameters: $query
Return the first record (single column) in a query result

• @param $query Query string

Top

build_query

Parameters: $query, $array
Build query

• @param $query
• @param $array Array of field => value pairs (default false)
• @return $query | Returns the builded query

Top

fetch

Parameters: $query_id, $result_type
Fetch one record

• @param $query_id | Query ID (default 0)
• @param $result_type | SQL_ASSOC, SQL_NUM, or SQL_BOTH (default SQL_BOTH)
• @return mixed Record / false

Top

fetch_all

Parameters: $query_id, $result_type
Fetch all records

• @param $query_id | Query ID (default 0)
• @param $result_type | SQL_ASSOC, SQL_NUM, or SQL_BOTH
• @return mixed Record Set / false

Top

result

Parameters: $query_id, $row, $field
Get result data

• @param $query_id | Query ID (default 0)
• @param $row | The row number from the result that's being retrieved. Row numbers start at 0
• @param $field | The name or offset of the field being retrieved
• @return mixed Record / false

Top

num_rows

Parameters: $query_id
Find the number of returned rows

• @param $query_id | Query ID (default 0)
• @return mixed Number of rows / false

Top

affected_rows

Parameters: $query_id
Finds out the number of rows affected by a query

• @param $query_id | Query ID (default 0)
• @return mixed Affected Rows / false

Top

insert_id

Parameters: none
Find the ID of the row that was just inserted

• @return mixed Last ID / false

Top

free_result

Parameters: $query_id
Free result data

• @param $query_id | Query ID (default 0)
• @return bool

Top

escape

Parameters: $string
Remove quote escape

• @param $string
• @return string

Top

error_die

Parameters: $setting
Set the error_die var
@param $setting

Top

table

Parameters: $table, $addon
Expand base table name to a full table name

• @param string $table | the base table name
• @param string $addon | the name of the addon, empty for a base roster table
• @return string | tablename as fit for MySQL queries

Top