FunctionsOverview

From WoWRosterWiKi
(Difference between revisions)
Jump to: navigation, search
(Create the document, add the Global Functions)
 
(Adding $roster->db->, edit some linebreaks)
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

WR.net

Important note: When you edit this page, you agree to release your contribution into the public domain.
If you do not want this or can not do this because of license restrictions, please do not edit.

Contents


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


Latest changes




Global functions

These function are located in functions.lib.php

border

Parameters: $style, $mode, $header_txt, $width
Starts or ends fancy bodering containers


Top

setTooltip

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


Top

getAllTooltips

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


Top

sql_highlight

Parameters: $sql
Highlight certain keywords in a SQL query


Top

die_quietly

Parameters: $text, $title, $file, $line, $sql
Clean replacement for die(), outputs a message with debugging info if needed and ends output


Top

roster_die

Parameters: $message, $title, $style
Draw a message box with the specified border color, then die cleanly


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


Top

check_if_image

Parameters: $filename
This will check if the given Filename is an image


Top

colorTooltip

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


Top

cleanTooltip

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


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


Top

messagebox

Parameters: $message, $title, $style, $width
Draw a message box with the specified border color.


Top

scrollbox

Parameters: $message, $title, $style, $width, $height
Draw a 300x550px scrolling messagebox with the specified border color.


Top

messageboxtoggle

Parameters: $message, $title, $style, $open, $width
Draw a message box with the specified border color.


Top

scrollboxtoggle

Parameters: $message, $title, $style, $open, $width, $height
Draw a 300x550px scrolling messagebox with the specified border color.


Top

escape_array

Parameters: $array
Recursively escape $array


Top

stripslash_array

Parameters: $array
Recursively stripslash $array


Top

readbleDate

Parameters: $datetime, $offset
Converts a datetime field into a readable date


Top

get_file_ext

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


Top

seconds_to_time

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


Top

getaddon

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


Top

active_addon

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


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


Top

request_uri

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


Top

file_writer

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


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()


Top

aprint

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


Top

socketColorEn

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


Top

format_microtime

Parameters: none
No Description

Top

array_overlay

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


Top

updateCheck

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


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


Top

errno

Parameters:none
Get last SQL errno


Top

query

Parameters: $query
Basic query function


Top

query_first

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


Top

build_query

Parameters: $query, $array
Build query


Top

fetch

Parameters: $query_id, $result_type
Fetch one record


Top

fetch_all

Parameters: $query_id, $result_type
Fetch all records


Top

result

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


Top

num_rows

Parameters: $query_id
Find the number of returned rows


Top

affected_rows

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


Top

insert_id

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


Top

free_result

Parameters: $query_id
Free result data


Top

escape

Parameters: $string
Remove quote escape


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


Top

Personal tools
Namespaces
Variants
Actions
WoWRoster
Navigation
Toolbox