Docs For Class modPlugin

## Class modPlugin

Description

modPlugin Extend your OsDate capabilities

modPlugin is an API alowing you to extend OsDate's capabilities without modifing OsDate itself. Plugins can be written in packages that can be distributed, uploaded and installed from a single zip file.
Tables to be used exclusively for the plugin should be named in the format DB_PREFIX_PluginName_tableName. (DB_PREFIX is the table prefix given in configs/config.php. PluginName is the name of the plugin and tableName is the name of the table.) e.g. osdate_speedDater_speeddater.
Plugin File Structure
pluginTemplate - Plugin Directory. Must be named the same as the plugin.
pluginTemplate/language - Language directory. Containts language definitions.
pluginTemplate/language/lang_spanish
pluginTemplate/language/lang_spanish/lang_main.php - Spanish language definitions.
pluginTemplate/language/lang_german
pluginTemplate/language/lang_german/lang_main.php - German language definitions.
pluginTemplate/language/lang_english
pluginTemplate/language/lang_english/lang_main.php - English language definitions.
pluginTemplate/language/lang_portuguese
pluginTemplate/language/lang_portuguese/lang_main.php - Portuguese language definitions.
pluginTemplate/language/lang_greek
pluginTemplate/language/lang_greek/lang_main.php - Greek language definitions.
pluginTemplate/language/lang_turkish
pluginTemplate/language/lang_turkish/lang_main.php - Turkish language definitions.
pluginTemplate/language/lang_romanian
pluginTemplate/language/lang_romanian/lang_main.php - Romanian language definitions.
pluginTemplate/language/lang_russian
pluginTemplate/language/lang_russian/lang_main.php - Russian language definitions.
pluginTemplate/language/lang_dutch
pluginTemplate/language/lang_dutch/lang_main.php - Dutch language definitions.
pluginTemplate/language/lang_french
pluginTemplate/language/lang_french/lang_main.php - French language definitions.
pluginTemplate/images - Plugin specific images.
pluginTemplate/sql
pluginTemplate/sql/install.sql - Table creation SQL.
pluginTemplate/includes
pluginTemplate/includes/default_config.php - Default configuration values.
pluginTemplate/templates - Plugin templage directory.
pluginTemplate/templates/default
pluginTemplate/templates/default/helloworld.tpl - User template.
pluginTemplate/templates/default/admin
pluginTemplate/templates/default/admin/helloworld.tpl - Admin template
pluginTemplate/libs - Classes related to plugin.
pluginTemplate/libs/pluginTemplate.php - Main plugin class. Must be named the same as the plugin.
Displaying Content
There are four methods to display content on the OsDate site, displayPluginPage, displayPluginContent, displayLeftCol and displayMain. These methods return HTML to be displayed. The modPlugin logic handles the actual display of the HTML.
displayPluginPage
displayPluginPage is used when you need a new page on the osdate site. HTML returned by displayPluginPage is displayed in the main content area of OsDate. When you set the $user_menu_text variable to the text to appear on the menu, and set user_menu_appear to true, a link to your page will appear on the user menu. You can also access the page directly using the link plugin.php?plugin=pluginTemplate (assuming your plugin naem is pluginTemplate).
displayPluginContent
displayPluginContent is used when you need a new page with only your content. For example if you need a popup window that displays a simple message. The HTML returned by displayPluginContent is displayed on the new page. You can also access the page directly using the link pluginraw.php?plugin=pluginTemplate (assuming your plugin naem is pluginTemplate).
displayLeftCol
displayLeftCol will display your content in the left column of OsDate. The HTML returned by displayLeftCol is displayed.
displayMain
displayMain will display your content in the main content area of OsDate below the existing main content. The HTML returned by displayMain is displayed.
Getting Started
To get started on your first plugin, make a directory inside the plugins directory the name of your new plugin (ex. mkdir plugins/myNewPlugin). Then copy all the files in the plugins/pluginTemplate directory to your new directory (ex. cp -r plugins/pluginTemplate/. plugins/myNewPlugin/). Now rename pluginTemplate.php to the name of your plugin (ex. mv pluginTemplate.php myNewPlugin.php. Lastly, open myNewPlugin.php and rename all instances of pluginTemplate to myNewPlugin.
Now that you have all the files you need, start writing your code using the methods and documentation listed below.

- version: 1.0
- author: Down Home Consutling (www.DownHomeConsulting.com)

Located in /modPlugin.php (line 83)

Variable Summary
mixed $lang
Method Summary
void modPlugin ()
void clrErrorMessage ()
string displayLeftCol ()
string displayMain ()
string displayPluginAdminPage ()
string displayPluginContent ()
string displayPluginPage ()
array getAdminMenuEntry ()
array getErrorMessage ()
string getImagesDir ()
string getIncludeDir ()
string getLanguageDir ()
string getLibsDir ()
string getPluginDir ()
string getSqlDir ()
string getTemplatesDir ()
array getUserMenuEntry ()
bool modAddEvent (array $param)
bool modAddProfileRating (array $param)
array modAddRec (string $table, array $data)
array modAvailablePermissions (array $param)
string modCheckStatus (array $param)
bool modClrBan (array $param)
array modDeleteRows (string $table, array $search)
array modEditRec (string $table, array $data, array $keys)
array modGetAdmin (array $param)
array modGetAffiliateStats ()
array modGetAlbum (array $param)
array modGetAll (string $table, array $search)
array modGetAllAlbums ([array $param = false])
array modGetAllFeatured ()
array modGetAllLanguages ()
array modGetAllPictures (array $param)
array modGetAllUsers (array $param)
array modGetArticles ()
array modGetBanners ()
int modGetBannerStats (array $param)
array modGetBlogInfo (array $param)
array modGetBlogPost (array $param)
array modGetCalendars ()
array modGetErrorMessage ()
array modGetEvents (array $param)
array|string modGetLang ([string|void $key1 = false], [string|void $key2 = false])
string modGetLoadedLanguage ()
array modGetLoggedInAdmin ()
array modGetLoggedInUser ()
array modGetMembershipPriviledges (array $param)
array modGetNews ()
array modGetPaymentMods ()
string modGetPicture (array $param)
array modGetPlugin (array $param)
array modGetPolls ()
array modGetPollStats (array $param)
array modGetProfile (array $param)
array modGetProfileRatings (array $param)
array modGetRow (string $table, array $search)
string|int modGetSetting (array $param)
string modGetSkinName ()
array modGetTransaction (array $param)
array modGetUser (array $param)
array modGetUserTransactions (array $param)
bool modHasPermission (array $param)
bool modIsBanned (array $param)
bool modIsFeatured (array $param)
bool modIsLoggedIn (array $param)
bool modIsZipLoaded (array $param)
bool modLogout (array $param)
bool modMakeFeatured (array $param)
bool modRemoveAlbum (array $param)
bool modRemoveBlogComment (array $param)
bool modRemoveBlogPost (array $param)
bool modRemovePicture (array $param)
bool modSendMail (array $param)
bool modSendMessage (array $param)
bool modSendWink (array $param)
bool modSetBan (array $param)
void modSetLoadedLanguage (array $param)
bool modSetNews (array $param)
string modSiteUrl ()
string modSmartyAssign (mixed $variable, mixed $value, string $filename)
string modSmartyFetch (string $filename)
Variables
mixed $lang = array() (line 96)

Holds the language phrases for the active language in an associative array

- access: public

Methods
Constructor modPlugin (line 126)

Constructor, called by modOsDate to initialize plugin class. There should never be a need to call this directly.

- access: public

void modPlugin ()
clrErrorMessage (line 1833)

Clears all error messages

- access: public

void clrErrorMessage ()
displayLeftCol (line 1968)

Returns the content that will appear in the left column of a page. Override this method in yor class if you have content that needs displayed in the left column.

- return: - html that will be displayed
- access: public

string displayLeftCol ()
displayMain (line 1978)

Returns the content that will appear in the main content area of the page. This content will appear after the existing main content. Override this method in yor class if you have content that needs displayed in after the existing main content.

- return: - html that will be displayed
- access: public

string displayMain ()
displayPluginAdminPage (line 2003)

Returns the content to display a custom admin page. Override this method in your class if you need a new page for your plugin.

- return: - html that will be displayed
- access: public

string displayPluginAdminPage ()
displayPluginContent (line 2019)

WARNING: USER IS NOT VALIDATED HERE. BE CAREFUL
Returns all the html for a page. Override this method in your class if you need a page with only your content. Often used in downloads

- return: - html that will be displayed
- access: public

string displayPluginContent ()
displayPluginPage (line 1988)

Returns the content to display a custom user page. Override this method in your class if you need a new page for your plugin.

- return: - html that will be displayed
- access: public

string displayPluginPage ()
getAdminMenuEntry (line 1949)

Returns the admin menu entry for a plugin.

- access: public

array getAdminMenuEntry ()
getErrorMessage (line 1823)

Returns all error messages

- return: - associative array of messages
- access: public

array getErrorMessage ()
getImagesDir (line 1898)

Returns the images directory for this plugin

- access: public

string getImagesDir ()
getIncludeDir (line 1888)

Returns the includes directory for this plugin

- access: public

string getIncludeDir ()
getLanguageDir (line 1908)

Returns the language directory for this plugin

- access: public

string getLanguageDir ()
getLibsDir (line 1920)

Returns the libs directory for this plugin

- access: public

string getLibsDir ()
getPluginDir (line 1878)

Returns the main directory for this plugin

- access: public

string getPluginDir ()
getSqlDir (line 2030)

Returns the sql directory for this plugin

- access: public

string getSqlDir ()
getTemplatesDir (line 2040)

Returns the sql directory for this plugin

- access: public

string getTemplatesDir ()
getUserMenuEntry (line 1930)

Returns the user menu entry for a plugin.

- access: public

array getUserMenuEntry ()
modAddEvent (line 899)

add an event to calendar X, event details specified in parameter

- return: True on success. False on failure.
- access: public

bool modAddEvent (array $param)

- array $param: an associative array with the following keys:
  - userid - user id
  - event
  - description
  - recurring - 1 or 0
  - recuroption - (0 = none, 1 = days, 2 = weeks, 3 = months, 4 = years)
  - calendarid
  - enabled - Y or N
  - timezone
  - datetime_from
  - datetime_to
  - private_to

modAddProfileRating (line 1252)

adds a profile rating for user X

- return: True on success. False on failure.
- access: public

bool modAddProfileRating (array $param)

- array $param: an associative array with the following keys:
  - userid - id of user
  - ratingid (optional)

modAddRec (line 2201)

Adds a record from the provided table with the provided data. The table must belong to the plugin or this will return false.

- access: public

array modAddRec (string $table, array $data)

- string $table: the name of the table to retrieve
- array $data: keys are field names and the value is the value to match (ex. to add field first_name with 'bob' of 5 use $data['first_name'] = 'bob').

modAvailablePermissions (line 242)

return a list of permissions available to a particular user

- access: public

array modAvailablePermissions (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user to logout

modCheckStatus (line 624)

returns the registration status of a particular user

- access: public

string modCheckStatus (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user

modClrBan (line 538)

clear a ban of user X for user Y

- return: True on success. False on failure.
- access: public

bool modClrBan (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user to remove ban
  - type - type of ban to remove, B for ban, H for hotlist, F for buddy

modDeleteRows (line 2115)

Deletes record(s) from the provided table using the search. The table must belong to the plugin or this will return false.

- access: public

array modDeleteRows (string $table, array $search)

- string $table: the name of the table
- array $search: keys are field names and the value is the value to match (ex. to find id of 5 use $search['id'] = 5)

modEditRec (line 2174)

Edits a record from the provided table with the provided data. The table must belong to the plugin or this will return false.

- access: public

array modEditRec (string $table, array $data, array $keys)

- string $table: the name of the table to retrieve
- array $data: keys are field names and the value is the value to update (ex. to update field first_name with 'bob' of 5 use $data['first_name'] = 'bob').
- array $keys: the record to update. (ex. to update id 5, include $key['id'] = 5).

modGetAdmin (line 308)

Gets a admin's record

- access: public

array modGetAdmin (array $param)

- array $param: an associative array with the following keys:
  - adminid - id of the admin's record to get

modGetAffiliateStats (line 1100)

gets an array of all affiliate statistics for affiliate X

- access: public

array modGetAffiliateStats ()
modGetAlbum (line 771)

Returns the picture album that match the provided keys.

- access: public

array modGetAlbum (array $param)

- array $param: an associative array with the following keys:
  - id - id of the album
  - username - username of the album owner
  - name - name of the album

modGetAll (line 2145)

Gets all records from the provided table using the search. The table must belong to the plugin or this will return false.

- return: - multidimensional array. The first level the index. Second level a associtive array of the records fields and values.
- access: public

array modGetAll (string $table, array $search)

- string $table: the name of the table to retrieve
- array $search: keys are field names and the value is the value to match (ex. to find id of 5 use $search['id'] = 5)

modGetAllAlbums (line 750)

returns all available picture albums or if params are provide, returns all the albums that match those keys.

- access: public

array modGetAllAlbums ([array $param = false])

- array $param: an associative array with the following keys:
  - username - username of the album owner
  - name - name of the album

modGetAllFeatured (line 1008)

Returns all featured user profiles

- return: user ids of featured users
- access: public

array modGetAllFeatured ()
modGetAllLanguages (line 924)

returns all configured languages

- access: public

array modGetAllLanguages ()
modGetAllPictures (line 669)

returns all available pictures for a user / album

- return:
  Example:
  Array
  (
  [0] => Array
  (
  [id] => 37
  [userid] => 104
  [picno] => 1
  [ins_time] => 1154301578
  [active] => Y
  [picext] => jpg
  [tnext] => jpg
  [album_id] => 0
  )
  [1] => Array
  (
  [id] => 38
  [userid] => 104
  [picno] => 2
  [ins_time] => 1154301599
  [active] => Y
  [picext] => jpg
  [tnext] => jpg
  [album_id] => 0
  )
  )
- access: public

array modGetAllPictures (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user
  - album_id - id of the album
  - active - Y or N

modGetAllUsers (line 442)

Gets all user's records matching provided parameters

- access: public

array modGetAllUsers (array $param)

- array $param: an associative array with any of the following keys:
  - sort - field to sort by and direction (ex. "username ASC" or "username DESC"
  - limit - max number of records to return
  - id
  - active,
  - username
  - lastvisit
  - regdate
  - level
  - timezone
  - allow_viewonline
  - rank
  - email
  - country
  - actkey
  - firstname
  - lastname
  - gender
  - lookgender
  - lookagestart
  - lookageend
  - address_line1
  - address_line2
  - state_province
  - county
  - city
  - zip
  - birth_date
  - lookcountry
  - lookstate_province
  - lookcounty
  - lookcity
  - lookzip
  - lookradius
  - radiustype
  - picture
  - status
  - levelend

modGetArticles (line 1282)

get all current articles

- access: public

array modGetArticles ()
modGetBanners (line 1066)

gets a list of all current banners

- access: public

array modGetBanners ()
modGetBannerStats (line 1081)

gets the click statistics for banner X

- return: number of clicks
- access: public

int modGetBannerStats (array $param)

- array $param: an associative array with the following keys:
  - bannerid - id of banner

modGetBlogInfo (line 1551)

get details on a specific blog

- return: id, userid, adminid, name, description, members_comment, buddies_comment, members_vote, gui_editor, max_comments, bad_words, title_template, story_template
- access: public

array modGetBlogInfo (array $param)

- array $param: an associative array with any of the following keys:
  - id - id of blog
  - userid - id of user owning blog (if a user blog)
  - adminid - id of admin owning blog (if a admin blog)
  - name
  - description
  - members_comment
  - buddies_comment
  - members_vote
  - gui_editor
  - max_comments
  - bad_words
  - title_template
  - story_template

modGetBlogPost (line 1523)

get details on a specific blog post

- return: id, userid, adminid, date_posted, title, story, views
- access: public

array modGetBlogPost (array $param)

- array $param: an associative array with any of the following keys:
  - id - id of blog post
  - userid - id of user
  - adminid - id of admin
  - date_posted
  - title
  - story
  - views

modGetCalendars (line 853)

returns a list of all available calendars

- access: public

array modGetCalendars ()
modGetErrorMessage (line 145)

Returns the current error messages

- access: public

array modGetErrorMessage ()
modGetEvents (line 871)

returns a list of all available events for calendar X

- access: public

array modGetEvents (array $param)

- array $param: an associative array with the following keys:
  - calendarid - id of calendar

modGetLang (line 1855)

Returns the language phrase or the entire language array from class's language definitions.

- access: public

array|string modGetLang ([string|void $key1 = false], [string|void $key2 = false])

- string|void $key1: If blank, returns the whole array. If a string, returns that phrase
- string|void $key2: If a string, returns the second dimension of phrase

modGetLoadedLanguage (line 945)

returns the currently loaded language

- access: public

string modGetLoadedLanguage ()
modGetLoggedInAdmin (line 1447)

get data for the currently logged in admin

- access: public

array modGetLoggedInAdmin ()
modGetLoggedInUser (line 1436)

get data for the currently logged in user

- return:
  Example:
  Array
  (
  [id] => 104
  [active] => 1
  [username] => testuser
  [password] => 179ad45c6ce2cb97cf1029e212046e81
  [lastvisit] => 1154266346
  [regdate] => 1152972184
  [level] => 1 (role id)
  [timezone] => -10.00
  [allow_viewonline] => 1
  [rank] => 1
  [email] => dlhinkley@localhost.localdomain
  [country] => US
  [actkey] => bf45e84c32babfdcb9bce75381b7c8e5
  [firstname] => Test
  [lastname] => USer
  [gender] => M
  [lookgender] => F
  [lookagestart] => 16
  [lookageend] => 90
  [address_line1] =>
  [address_line2] =>
  [state_province] => AK
  [county] => sadff
  [city] => asdff
  [zip] => 12345
  [birth_date] => 1981-07-15
  [lookcountry] => US
  [lookstate_province] => AA
  [lookcounty] =>
  [lookcity] =>
  [lookzip] =>
  [lookradius] =>
  [radiustype] =>
  [picture] => 0
  [status] => Active
  [levelend] => 1185113123
  [countryname] => United States
  [statename] => Alaska
  [age] => 25
  )
- access: public

array modGetLoggedInUser ()
modGetMembershipPriviledges (line 1173)

gets the membership settings for any particular level

- return:
  Example:
  Array
  (
  [id] => 1
  [roleid] => 1
  [name] => Gold
  [chat] => 1
  [forum] => 1
  [blog] => 1
  [poll] => 1
  [includeinsearch] => 1
  [message] => 1
  [message_keep_cnt] => 0
  [message_keep_days] => 0
  [allowim] => 1
  [uploadpicture] => 1
  [uploadpicturecnt] => 20
  [allowalbum] => 1
  [event_mgt] => 1
  [seepictureprofile] => 1
  [favouritelist] => 1
  [sendwinks] => 1
  [extsearch] => 1
  [activedays] => 365
  [fullsignup] => 1
  [price] => 20.00
  [currency] => USD
  [enabled] => Y
  )
- access: public

array modGetMembershipPriviledges (array $param)

- array $param: an associative array with any of the following keys:
  - roleid - role id
  - name - (ex. Gold)

modGetNews (line 1298)

get all current news items

- access: public

array modGetNews ()
modGetPaymentMods (line 1458)

get information related to the currently-loaded payment modules

- access: public

array modGetPaymentMods ()
modGetPicture (line 694)

Given a picture id, returns the picture

- access: public

string modGetPicture (array $param)

- array $param: an associative array with the following keys:
  - id - id of the picture
  - type - type of picture ('main' or 'thumbnail')

modGetPlugin (line 1570)

get details on a plugin

- return: id, name, active
- access: public

array modGetPlugin (array $param)

- array $param: an associative array with any of the following keys:
  - id - id of plugin
  - name - name of plugin

modGetPolls (line 1191)

gets a list of current polls

- access: public

array modGetPolls ()
modGetPollStats (line 1211)

gets a list of poll statistics for poll X

- access: public

array modGetPollStats (array $param)

- array $param: an associative array with the following keys:
  - pollid - id of poll

modGetProfile (line 1635)

Returns a profile matching the search params.

- access: public

array modGetProfile (array $param)

- array $param: an associative array with the following keys:
  - rand - 1 to return a random profile
  - id - return the profile matching this id

modGetProfileRatings (line 1230)

gets a list of all profile ratings for user X

- access: public

array modGetProfileRatings (array $param)

- array $param: an associative array with the following keys:
  - userid - id of user

modGetRow (line 2087)

Gets a record from the provided table using the search. The table must belong to the plugin or this will return false.

- access: public

array modGetRow (string $table, array $search)

- string $table: the name of the table to retrieve
- array $search: keys are field names and the value is the value to match (ex. to find id of 5 use $search['id'] = 5)

modGetSetting (line 831)

returns the value of any particular global configuration setting

- access: public

string|int modGetSetting (array $param)

- array $param: an associative array with the following key:
  - setting - name of the setting

modGetSkinName (line 1843)

Returns the current template skin name

- access: public

string modGetSkinName ()
modGetTransaction (line 1498)

get payment transaction information for a particular transaction search by one or many paramaters

- access: public

array modGetTransaction (array $param)

- array $param: an associative array with the following keys:
  - invoice_no - invoice number
  - user_id - user id
  - txn_id - transaction id
  - txn_date - transaction date

modGetUser (line 371)

Gets a user's record

- return:
  Example:
  Array
  (
  [id] => 104
  [active] => 1
  [username] => testuser
  [password] => 179ad45c6ce2cb97cf1029e212046e81
  [lastvisit] => 1154266346
  [regdate] => 1152972184
  [level] => 1 (role id)
  [timezone] => -10.00
  [allow_viewonline] => 1
  [rank] => 1
  [email] => dlhinkley@localhost.localdomain
  [country] => US
  [actkey] => bf45e84c32babfdcb9bce75381b7c8e5
  [firstname] => Test
  [lastname] => USer
  [gender] => M
  [lookgender] => F
  [lookagestart] => 16
  [lookageend] => 90
  [address_line1] =>
  [address_line2] =>
  [state_province] => AK
  [county] => sadff
  [city] => asdff
  [zip] => 12345
  [birth_date] => 1981-07-15
  [lookcountry] => US
  [lookstate_province] => AA
  [lookcounty] =>
  [lookcity] =>
  [lookzip] =>
  [lookradius] =>
  [radiustype] =>
  [picture] => 0
  [status] => Active
  [levelend] => 1185113123
  [countryname] => United States
  [statename] => Alaska
  [age] => 25
  )
- access: public

array modGetUser (array $param)

- array $param: an associative array with the following key:
  - userid - user id of the users record to get

modGetUserTransactions (line 1475)

get all transactions for a particular user

- access: public

array modGetUserTransactions (array $param)

- array $param: an associative array with the following keys:
  - userid - id of user

modHasPermission (line 207)

check to see if the user has permission to access resource X

- return: True on success. False on failure.
- access: public

bool modHasPermission (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user to logout
  - resource - name of the resource one of ( chat, forum, blog, poll, includeinsearch, message, message_keep_days, allowim, uploadpicture, uploadpicturecnt, allowalbum, event_mgt, seepictureprofile, favouritelist, sendwinks, extsearch, fullsignup)

modIsBanned (line 577)

check to see if user X is banned for user Y

- return: true for banned false for not banned
- access: public

bool modIsBanned (array $param)

- array $param: an associative array with the following keys:
  - type - type of ban to check, B for ban, H for hotlist, F for buddy

modIsFeatured (line 979)

determines if a user's profile is featured

- return: True if featured. False if not featured.
- access: public

bool modIsFeatured (array $param)

- array $param: an associative array with the following keys:
  - userid - user id

modIsLoggedIn (line 157)

check to see if user with id is logged in

- return: True if logged in. False if not logged in.
- access: public

bool modIsLoggedIn (array $param)

- array $param: an associative array with the following keys:
  - userid - the user id of the user

modIsZipLoaded (line 1366)

determines if a zip code CSV file is loaded for a country

- return: True on success. False on failure.
- access: public

bool modIsZipLoaded (array $param)

- array $param: an associative array with the following keys:
  - countrycode - two letter country code

modLogout (line 178)

logout the current user

- return: True on success. False on failure.
- access: public

bool modLogout (array $param)

- array $param: an associative array with the following keys:
  - userid - the user id of the user to logout

modMakeFeatured (line 1041)

sets/unsets a user's profile as featured

- return: True on success. False on failure.
- access: public

bool modMakeFeatured (array $param)

- array $param: an associative array with the following keys:
  - userid
  - start_date - year-mo-day (ex 2006-07-15)
  - end_date - year-mo-day (ex 2006-07-15)
  - must_show - 1 or 0
  - req_exposures - required exposures

modRemoveAlbum (line 790)

remove album X from the user's albums

- return: True on success. False on failure.
- access: public

bool modRemoveAlbum (array $param)

- array $param: an associative array with the following keys:
  - album - name of album
  - userid - user id of user the album belongs

modRemoveBlogComment (line 1618)

remove a specific blog comment

- return: True on success. False on failure.
- access: public

bool modRemoveBlogComment (array $param)

- array $param: an associative array with the following keys:
  - id - id of comment
  - userid - id of user owning comment (if user blog)
  - adminid - id of admin owning comment (if admin blog)
  - blogid - id of blog the comment belongs to
  - datetime
  - comment

modRemoveBlogPost (line 1594)

remove a specific blog post

- return: True on success. False on failure.
- access: public

bool modRemoveBlogPost (array $param)

- array $param: an associative array with any of the following keys:
  - id - id of post
  - userid - id of user owning post (if user post)
  - adminid - id of admin owning post (if adming post)
  - date_posted
  - title
  - story
  - views

modRemovePicture (line 729)

Given a picture id, remove the picture from the users album

- return: True on success. False on failure.
- access: public

bool modRemovePicture (array $param)

- array $param: an associative array with the following keys:
  - id - id of the picture

modSendMail (line 1761)

send an email

- return: True on success. False on failure.
- access: public

bool modSendMail (array $param)

- array $param: an associative array with the following keys:
  - message - can be a templated message using user parameters in # (i.e. #firstname#, #country#))
  - rcvuserid - userid of member to receive message.
  - snduserid - userid of member to seend message (optional).
  - subject - message subject.

modSendMessage (line 1674)

send a message to a single user or group of users

- return: True on success. False on failure.
- access: public

bool modSendMessage (array $param)

- array $param: an associative array with the following keys:
  - message - can be a templated message using user parameters in # (i.e. #firstname#, #country#))
  - rcvuserid - userid of member to receive message.
  - snduserid - userid of member to send message.
  - subject - message subject.
  - notify - set to true to notify sender when read

modSendWink (line 273)

send a wink to a single user or group of users

- return: True on success. False on failure.
- access: public

bool modSendWink (array $param)

- array $param: an associative array with the following keys:
  - from_userid - the user id the wink is from
  - to_userid the user id the wink is for

modSetBan (line 484)

set a ban of user X for user Y

- return: True on success. False on failure.
- access: public

bool modSetBan (array $param)

- array $param: an associative array with the following keys:
  - userid - user id of the user to ban
  - ref_userid - the user id of the refering user
  - action - B for ban, H for hotlist, F for buddy

modSetLoadedLanguage (line 964)

sets the currently loaded language

- access: public

void modSetLoadedLanguage (array $param)

- array $param: an associative array with the following keys:
  - language - dutch ,french ,greek ,portuguese ,russian ,turkish ,english ,german ,romanian or spanish

modSetNews (line 1342)

sets the current news list (all at once).

data provided in a multidensional array of the format:
$news = array (

1. =>

array (
'date' => '1119770866',
'header' => 'Internet Dating More Successful than Thought',
'text' => 'Internet dating is proving a much more successful way to find long-term romance and friendship for thousands of people than was previously thought, new research shows.',
),

1. =>

array (
'date' => '1119770969',
'header' => 'New Dating Guide for Seniors',
'text' => 'Are you over age 65, single and thinking about entering the dating world?
',
),
2 =>
array (
'date' => '1237834800',
'header' => 'Women More Likely to Snoop Than Men',
'text' => 'In the new film, Little Black Book, Brittany Murphy\'s character engages in some high-tech snooping on her new boyfriend. ',
),
);

- return: True on success. False on failure.
- access: public

bool modSetNews (array $param)

- array $param: an associative array with the following keys:
  - date - Unix timestamp
  - header
  - text

modSiteUrl (line 1739)

returns the site home url

- return: the site home url
- access: public

string modSiteUrl ()
modSmartyAssign (line 2073)

Assigns a varible for use in smarty templates

- access: public

string modSmartyAssign (mixed $variable, mixed $value, string $filename)

- string $filename: the relative filename of the template file.

modSmartyFetch (line 2059)

Returns a parsed Smarty template from this plugins template directory

- access: public

string modSmartyFetch (string $filename)

- string $filename: the relative filename of the template file.

Documentation generated on Mon, 31 Jul 2006 10:26:07 -0600 by phpDocumentor 1.3.0RC3