Differences

This shows you the differences between two versions of the page.

--- develop:functionr [2014/02/24 16:02] – [Q, R, S] arnoldvl
+++ develop:functionr [2015/05/08 19:07] (current) – [An Index of PHPlist Functions and Class Methods] arnoldvl
@@ Line 1: / Line 1: @@
+ =====An Index of PHPlist Functions and Class Methods=====
+The location of the definition of each function or method is listed by file name and line number. Each file is located relative to the admin directory in the phplist distribution, that is, relative to the subdirectory //public_html/lists/admin//.
+For each function or method, the arguments are listed and explained, as well as the return value if any. Some explanation of the function is planned to be given among the Comments. These pages are under construction. Most entries are incomplete. But every entry has the location for the definition of the function or method, so that you can look up the definition in file containing the source code.
+**The line numbers shown for each function listed correspond to version 3.05 of Phplist.** In most cases the locations of these functions have changed in later releases, Usually these functions involve only a small change in the line number, so that you can locate the function in the vicinity of the line number specified.
+|[[http://resources.phplist.com/develop/functionp|Back]]|  [[http://resources.phplist.com/develop/functionndx|Up to Index]]  |    [[http://resources.phplist.com/develop/functiont|Next]]|
+====Q, R, S====
+===quoteEnclosed($value,$col_delim = "\t",$row_delim = "\n")===
+<code>export.php, line 8</code>
+  * Arguments:
+    -$value
+    -$col_delim
+    -$row_delim
+  * Return value:
+  * Comments:
+===readentry($file)===
+<code>defaults.php, line 8</code>
+  * Arguments:
+    -$file
+  * Return value:
+  * Comments:
+===recentlyVisited()===
+<code>connect.php, line 836</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===Redirect($page)===
+<code>connect.php, line 1232</code>
+  * Arguments:
+    -$page
+  * Return value:
+  * Comments:
+===refreshTlds($force = 0)===
+<code>lib.php, line 1453</code>
+  * Arguments:
+    -$force
+  * Return value:
+  * Comments:
+===releaseLock($processid)===
+<code>lib.php, line 1122</code>
+  * Arguments:
+    -$processid
+  * Return value:
+  * Comments:
+===removeGetParam($remove)===
+<code>commonlib/lib/interfacelib.php, line 150</code>
+  * Arguments:
+    -$remove
+  * Return value:
+  * Comments:
+===removeJavascript($content)===
+<code>lib.php, line 813</code>
+  * Arguments:
+    -$content
+  * Return value:
+  * Comments:
+===removeXss($string)===
+<code>commonlib/lib/magic_quotes.php, line 21</code>
+  * Arguments:
+    -$string
+  * Return value:
+  * Comments:
+===renameColumn($oldname,$newname)===
+<code>commonlib/lib/interfacelib.php, line 142</code>
+  * Arguments:
+    -$oldname
+    -$newname
+  * Return value:
+  * Comments:
+===repeatMessage($msgid)===
+<code>connect.php, line 1493</code>
+  * Arguments:
+    -$msgid
+  * Return value:
+  * Comments:
+===replaceChars($text)===
+<code>commonlib/lib/maillib.php, line 77</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===requireAccessLevel($page,$level)===
+<code>accesscheck.php, line 21</code>
+  * Arguments:
+    -$page
+    -$level
+  * Return value:
+  * Comments:
+===resendConfirm($id)===
+<code>reconcileusers.php, line 28</code>
+  * Arguments:
+    -$id
+  * Return value:
+  * Comments:
+===resetMessageStatistics($messageid = 0)===
+<code>lib.php, line 1361</code>
+  * Arguments:
+    -$messageid
+  * Return value:
+  * Comments:
+===resourceLink($url)===
+<code>connect.php, line 454</code>
+  * Arguments:
+    -$url
+  * Return value:
+  * Comments:
+===reverse_htmlentities($mixed)===
+<code>lib.php, line 1273</code>
+  * Arguments:
+    -$mixed
+  * Return value:
+  * Comments:
+===rssUserHasContent($userid,$messageid,$frequency)===
+<code>rsslib.php, line 24</code>
+  * Arguments:
+    -$userid
+    -$messageid
+    -$frequency
+  * Return value:
+  * Comments:
+===runtest()===
+<code>defaulttest.php, line 21</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===s($text)===
+<code>languages.php, line 597</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===safeImageName($name)===
+<code>lib.php, line 465</code>
+  * Arguments:
+    -$name
+  * Return value:
+  * Comments:
+===sajax_esc($val)===
+<code>commonlib/lib/Sajax.php, line 178</code>
+  * Arguments:
+    -$val
+  * Return value:
+  * Comments:
+===sajax_export()===
+<code>commonlib/lib/Sajax.php, line 204</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_get_common_js()===
+<code>commonlib/lib/Sajax.php, line 80</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_get_javascript()===
+<code>commonlib/lib/Sajax.php, line 214</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_get_my_uri()===
+<code>commonlib/lib/Sajax.php, line 20</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_get_one_stub($func_name)===
+<code>commonlib/lib/Sajax.php, line 183</code>
+  * Arguments:
+    -$func_name
+  * Return value:
+  * Comments:
+===sajax_handle_client_request()===
+<code>commonlib/lib/Sajax.php, line 35</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_init()===
+<code>commonlib/lib/Sajax.php, line 17</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_init_object()===
+<code>commonlib/lib/Sajax.php, line 101</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_show_common_js()===
+<code>commonlib/lib/Sajax.php, line 173</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_show_javascript()===
+<code>commonlib/lib/Sajax.php, line 230</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sajax_show_one_stub($func_name)===
+<code>commonlib/lib/Sajax.php, line 200</code>
+  * Arguments:
+    -$func_name
+  * Return value:
+  * Comments:
+===savechanges()  }===
+<code>send_core.php, line 581</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===SaveConfig($item,$value,$editable=1,$ignore_errors = 0)===
+<code>connect.php, line 124</code>
+  * Arguments:
+    -$item
+    -$value
+    -$editable
+    -$ignore_errors
+  * Return value:
+  * Comments:
+===saveStates()===
+<code>commonlib/lib/interfacelib.php, line 1215</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===saveUser($loginname,$data)===
+<code>commonlib/lib/userlib.php, line 1097</code>
+  * Arguments:
+    -$loginname
+    -$data
+  * Return value:
+  * Comments:
+===saveUserAttribute($userid,$attid,$data)===
+<code>commonlib/lib/userlib.php, line 934</code>
+  * Arguments:
+    -$userid
+    -$attid
+    -$data
+  * Return value:
+  * Comments:
+===saveUserByID($userid,$data)===
+<code>commonlib/lib/userlib.php, line 1083</code>
+  * Arguments:
+    -$userid
+    -$data
+  * Return value:
+  * Comments:
+===saveUserData($username,$fields)===
+<code>commonlib/lib/userlib.php, line 1115</code>
+  * Arguments:
+    -$username
+    -$fields
+  * Return value:
+  * Comments:
+===secs2time($secs)===
+<code>connect.php, line 1691</code>
+  * Arguments:
+    -$secs
+  * Return value:
+  * Comments:
+===selectAll()===
+<code>checki18n.php, line 79</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===Send()===
+<code>class.phplistmailer.php, line 268</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sendAdminCopy($subject,$message,$lists = array())===
+<code>lib.php, line 431</code>
+  * Arguments:
+    -$subject
+    -$message
+    -$lists
+  * Return value:
+  * Comments:
+===sendAdminPasswordToken ($adminId)===
+<code>lib.php, line 226</code>
+  * Arguments:
+    -$adminId
+  * Return value:
+  * Comments:
+===sendEmail ($messageid,$email,$hash,$htmlpref = 0,$rssitems = array(),$forwardedby = array())===
+<code>sendemaillib.php, line 12</code>
+  * Arguments:
+    -$messageid
+    -$email
+    -$hash
+    -$htmlpref
+    -$rssitems
+    -$forwardedby
+  * Return value:
+  * Comments:
+===sendEmailTest ($messageid,$email)===
+<code>actions/processqueue.php, line 367</code>
+  * Arguments:
+    -$messageid
+    -$email
+  * Return value:
+  * Comments:
+===sendError ($subject,$to = '',$message = '')===
+<code>defaultplugin.php, line 575</code>
+  * Arguments:
+    -$subject
+    -$to
+    -$message
+  * Return value:
+  * Comments:
+===sendError($message,$to,$subject)===
+<code>connect.php, line 307</code>
+  * Arguments:
+    -$message
+    -$to
+    -$subject
+  * Return value:
+  * Comments:
+===sendError($msg, $email = "")===
+<code>commonlib/lib/errorlib.php, line 75</code>
+  * Arguments:
+    -$msg
+    -$email
+  * Return value:
+  * Comments:
+===sendFormats()===
+<code>defaultplugin.php, line 343</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===sendMail ($to,$subject,$message,$header = "",$parameters = "",$skipblacklistcheck = 0)===
+<code>lib.php, line 265</code>
+  * Arguments:
+    -$to
+    -$subject
+    -$message
+    -$header
+    -$parameters
+    -$skipblacklistcheck
+  * Return value:
+  * Comments:
+===sendMailDirect($destinationemail, $subject, $message)===
+<code>lib.php, line 397</code>
+  * Arguments:
+    -$destinationemail
+    -$subject
+    -$message
+  * Return value:
+  * Comments:
+===sendMailPhpMailer ($to,$subject,$message)===
+<code>lib.php, line 353</code>
+  * Arguments:
+    -$to
+    -$subject
+    -$message
+  * Return value:
+  * Comments:
+===sendMessageStats($msgid)===
+<code>connect.php, line 314</code>
+  * Arguments:
+    -$msgid
+  * Return value:
+  * Comments:
+===sendMessageTab($messageid= 0, $messagedata= array ())===
+<code>defaultplugin.php, line 318</code>
+  * Arguments:
+    -$messageid
+    -$messagedata
+  * Return value:
+  * Comments:
+===sendMessageTabSave($messageid= 0, $data= array ())===
+<code>defaultplugin.php, line 334</code>
+  * Arguments:
+    -$messageid
+    -$data
+  * Return value:
+  * Comments:
+===sendMessageTabTitle($messageid= 0)===
+<code>defaultplugin.php, line 327</code>
+  * Arguments:
+    -$messageid
+  * Return value:
+  * Comments:
+===sendReport ($subject,$message)===
+<code>defaultplugin.php, line 566</code>
+  * Arguments:
+    -$subject
+    -$message
+  * Return value:
+  * Comments:
+===sendReport($subject,$message)===
+<code>connect.php, line 297</code>
+  * Arguments:
+    -$subject
+    -$message
+  * Return value:
+  * Comments:
+===setClass($name,$class)===
+<code>commonlib/lib/interfacelib.php, line 113</code>
+  * Arguments:
+    -$name
+    -$class
+  * Return value:
+  * Comments:
+===setContent($content)===
+<code>commonlib/lib/interfacelib.php, line 972</code>
+  * Arguments:
+    -$content
+  * Return value:
+  * Comments:
+===setCurrent($name)===
+<code>commonlib/lib/interfacelib.php, line 863</code>
+  * Arguments:
+    -$name
+  * Return value:
+  * Comments:
+===setDate($date)===
+<code>date.php, line 65</code>
+  * Arguments:
+    -$date
+  * Return value:
+  * Comments:
+===setDateTime($datetime)===
+<code>date.php, line 58</code>
+  * Arguments:
+    -$datetime
+  * Return value:
+  * Comments:
+===setFinalDestinationEmail($messageid, $uservalues, $email)===
+<code>defaultplugin.php, line 468</code>
+  * Arguments:
+    -$messageid
+    -$uservalues
+    -$email
+  * Return value:
+  * Comments:
+===setId($id)===
+<code>commonlib/lib/interfacelib.php, line 851</code>
+  * Arguments:
+    -$id
+  * Return value:
+  * Comments:
+===setID($id)===
+<code>commonlib/lib/interfacelib.php, line 19</code>
+  * Arguments:
+    -$id
+  * Return value:
+  * Comments:
+===setListClass($class)===
+<code>commonlib/lib/interfacelib.php, line 859</code>
+  * Arguments:
+    -$class
+  * Return value:
+  * Comments:
+===setMessageData($msgid,$name,$value)===
+<code>lib.php, line 48</code>
+  * Arguments:
+    -$msgid
+    -$name
+    -$value
+  * Return value:
+  * Comments:
+===setPageCache($url,$lastmodified = 0,$content)===
+<code>lib.php, line 801</code>
+  * Arguments:
+    -$url
+    -$lastmodified
+    -$content
+  * Return value:
+  * Comments:
+===setTime($time)===
+<code>date.php, line 43</code>
+  * Arguments:
+    -$time
+  * Return value:
+  * Comments:
+===shadeIcon()===
+<code>commonlib/lib/interfacelib.php, line 1343</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===shaderJavascript()===
+<code>commonlib/lib/interfacelib.php, line 1186</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===shaderStart()===
+<code>commonlib/lib/interfacelib.php, line 1400</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===shortenTextDisplay($text,$max = 30)===
+<code>lib.php, line 1512</code>
+  * Arguments:
+    -$text
+    -$max
+  * Return value:
+  * Comments:
+===show()===
+<code>commonlib/lib/interfacelib.php, line 1182</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===showA()===
+<code>commonlib/lib/interfacelib.php, line 1070</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===showAend()===
+<code>commonlib/lib/interfacelib.php, line 1082</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===showInput($name,$fielddata,$value,$document_id = 0)===
+<code>date.php, line 100</code>
+  * Arguments:
+    -$name
+    -$fielddata
+    -$value
+    -$document_id
+  * Return value:
+  * Comments:
+===SidebarLink($name,$desc,$url="")===
+<code>connect.php, line 1069</code>
+  * Arguments:
+    -$name
+    -$desc
+    -$url
+  * Return value:
+  * Comments:
+===simplePaging($baseurl,$start,$total,$numpp,$itemname = '')===
+<code>connect.php, line 1784</code>
+  * Arguments:
+    -$baseurl
+    -$start
+    -$total
+    -$numpp
+    -$itemname
+  * Return value:
+  * Comments:
+===snbr($text)===
+<code>languages.php, line 615</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===snippetListsSelector ($optionAll = false)===
+<code>reconcileusers.php, line 396</code>
+  * Arguments:
+    -$optionAll
+  * Return value:
+  * Comments:
+===sortBy($colname,$direction = 'desc')===
+<code>commonlib/lib/interfacelib.php, line 125</code>
+  * Arguments:
+    -$colname
+    -$direction
+  * Return value:
+  * Comments:
+===sortbydate ($a, $b)===
+<code>import3.php, line 187</code>
+  * Arguments:
+    -$a
+    -$b
+  * Return value:
+  * Comments:
+===store($itemid,$fielddata,$value,$table)===
+<code>date.php, line 206</code>
+  * Arguments:
+    -$itemid
+    -$fielddata
+    -$value
+    -$table
+  * Return value:
+  * Comments:
+===strip_newlines( $str, $placeholder = '' )===
+<code>lib.php, line 1398</code>
+  * Arguments:
+    -$str
+    -$placeholder
+  * Return value:
+  * Comments:
+===stripComments($content)===
+<code>lib.php, line 818</code>
+  * Arguments:
+    -$content
+  * Return value:
+  * Comments:
+===stripStyles($text)===
+<code>lib.php, line 870</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===submitform()  document.sendmessageform.submit() }===
+<code>send_core.php, line 583</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===subscriberConfirmation($subscribepageID,$userdata = array())===
+<code>defaultplugin.php, line 301</code>
+  * Arguments:
+    -$subscribepageID
+    -$userdata
+  * Return value:
+  * Comments:
+===suppressGreenline()===
+<code>commonlib/lib/interfacelib.php, line 91</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===suppressHide()===
+<code>commonlib/lib/interfacelib.php, line 976</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===system_messageHeaders($useremail = "")===
+<code>lib.php, line 630</code>
+  * Arguments:
+    -$useremail
+  * Return value:
+  * Comments:
+|[[http://resources.phplist.com/develop/functionp|Back]]|   [[http://resources.phplist.com/develop/functionndx|Up to Index]]  |    [[http://resources.phplist.com/develop/functiont|Next]]|

Tools

menus and quick search

quick search

site status

location indicator

Page Tools

meta data for this page

Differences