From WoWRosterWiKi

(Difference between revisions)

Jump to: navigation, search

Latest revision as of 04:09, 23 May 2012

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.

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

makelink

Parameters: $url, $full
Function to create links in Roster. ALL LINKS SHOULD PASS THROUGH THIS FUNCTION. Hopefully this function will be the magic that makes porting Roster easier (Ninja looted from DragonFly, thanks you guys!).

@param string $url | (Example: 'util-news-comment&id='.$news_id)
@param bool $full | (default false)
@return string

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

close_db

Top

$roster->auth

Login and authorization

Top

getAuthorized

Parameters: $access
Check if $access is allowed

@$access | guild / office / admin
@return

Top

getMessage

Parameters: none
Return the latest message from class

Top

getLoginForm

Parameters: $level
Check if login is allowed and return login form, else return message

@$level | The RosterLogin level (1 = guild, 2 = office, 3 = admin)
@return | If login allowed login form else message

Top

getMenuLoginForm

Parameters: none
Check if login allowed return login form, else message

Top

@@ Line 1: / Line 1: @@
 __NOEDITSECTION__
-{{Disclaimer}}
+{{Disclaimer|NoLang}}
 {{MainMenu|Roster}}
 '''Functions Overview'''<br>
 Overview over all functions in the Roster that can be used by Addon Developers.<br>
-----
-Latest changes
+See also the new [[Roster:API|Roster API]] for additional information.
-*Nefuh | 05.02.2008 03:07 | Created document
-*Nefuh | 07.02.2008 23:52 | Added section [[#$roster->auth|$roster->auth]]
-----
 <br />
 __TOC__
@@ Line 418: / Line 415: @@
 <br>[[#Global functions|Top]]
-=$roster->auth=
+==close_db==
-Login and authorization<br>
 <br>[[#Global functions|Top]]
-==RosterLogin==
-Parameters: $script_filename<br>
-Constructor for Roster Login class<br>
-Accepts an action for the form<br>
-And an array of additional fields<br>
-*@param $script_filename
-*@return RosterLogin
-<br>[[#Global functions|Top]]
-==checkPass==
+=$roster->auth=
-Parameters: $pass<br>
+Login and authorization<br>
-Check $pass if password match and could be verified.<br>
-*@$pass | Password to verify
-*@return | Nothing
 <br>[[#Global functions|Top]]
@@ Line 460: / Line 445: @@
 Parameters: none<br>
 Check if login allowed return login form, else message<br>
-<br>[[#Global functions|Top]]
-==setAction==
-Parameters: $action<br>
-Generate action value for forms<br>
-*@$action | Action value for forms (without URL)
-*@return | Action value processed by makelink (with URL)
-<br>[[#Global functions|Top]]
-==rosterAccess==
-Parameters: $values<br>
-Generate input field for settings access level<br>
-*@$values['name'] | Name of the config_value
-*@return | Returns a <select name=“config_$value['name']“></select> Field with all possible access levels
 <br>[[#Global functions|Top]]

Roster:FunctionsOverview