develop:functionp

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.

Back

Up to Index

pad_right($str,$len)

lib.php, line 1560

Arguments:
1. $str: An input string
2. $len: An integer
Return value: The padded string.
Comments: If $str is longer than $len, $str is padded with spaces on the left to form a string of length $len, essentially moving $str rightwards in the output string. If the input string is longer than $len, only the rightmost characters of the input are taken. In either case, the length of the output string is $len.

PageAttributes($data)

connect.php, line 1375

Arguments:
1. $data
Return value:
Comments:

pageCategory($page)

connect.php, line 686

Arguments:
1. $page
Return value:
Comments:

PageData($id)

connect.php, line 1317

Arguments:
1. $id
Return value:
Comments:

pageInfo($id = '')

commonlib/lib/interfacelib.php, line 966

Arguments:
1. $id
Return value:
Comments:

PageLink2($name,$desc="",$url="",$no_plugin = false,$title = '')

connect.php, line 953

Arguments:
1. $name
2. $desc
3. $url
4. $noplugin
  -$title
  * Return value:
  * Comments:
  ===PageLinkActionButton($name,$desc=“”,$url=“”,$extraclass = ,$title = )===
  <code>connect.php, line 1059</code>
  * Arguments:
  -$name
  -$desc
  -$url
  -$extraclass
  -$title
  * Return value:
  * Comments:
  ===PageLinkAjax ($name,$desc=“”,$url=“”,$extraclass = )=== <code>connect.php, line 1033</code> * Arguments: -$name -$desc -$url -$extraclass * Return value: * Comments: ===PageLinkButton($name,$desc =, $url = ,$extraclass = ,$title = )=== <code>connect.php, line 1055</code> * Arguments: -$name -$desc -$url -$extraclass -$title * Return value: * Comments: ===PageLinkClass($name,$desc=“”,$url=“”,$class =,$title = )=== <code>connect.php, line 1043</code> * Arguments: -$name -$desc -$url -$class -$title * Return value: * Comments: ===PageLinkDialog ($name,$desc=“”,$url=“”,$extraclass =)===
  <code>connect.php, line 1013</code>
  * Arguments:
  -$name
  -$desc
  -$url
  -$extraclass
  * Return value:
  * Comments:
  ===PageLinkDialogOnly ($name,$desc=“”,$url=“”,$extraclass = '')===
  <code>connect.php, line 1023</code>
  * Arguments:
  -$name
  -$desc
  -$url
  -$extraclass
  * Return value:
  * Comments:
  ===pageTitle($page)===
  <code>languages.php, line 312</code>
  * Arguments:
  -$page
  * Return value:
  * Comments:
  ===pageTitleHover($page)===
  <code>languages.php, line 345</code>
  * Arguments:
  -$page
  * Return value:
  * Comments:
  ===PageURL2($name,$desc = “”,$url=“”,$noplugin = false)===

connect.php, line 1084

Arguments:
1. $name
2. $desc
3. $url
4. $noplugin
  * Return value:
  * Comments:
  ===Paging($baseurl,$start,$total,$numpp = 10,$label = “”)===

connect.php, line 1815

Arguments:
1. $baseurl
  -$start
  -$total
  -$numpp
  -$label
  * Return value:
  * Comments:
  ===PagingNext($baseurl,$start,$total,$numpp,$label = “”)===

connect.php, line 1843

Arguments:
1. $baseurl
  -$start
  -$total
  -$numpp
  -$label
  * Return value:
  * Comments:
  ===PagingPrevious($baseurl,$start,$total,$numpp,$label = “”)===

connect.php, line 1852

Arguments:
1. $baseurl
  -$start
  -$total
  -$numpp
  -$label
  * Return value:
  * Comments:
  ===parseCline()===
  <code>index.php, line 584</code>
  * Explanation: parses the arguments passed to the Phplist script index.php when it is run from the command line
  * Arguments: None. The function picks up its input from $GLOBALS['argv']
  * Return value: An associative array of argument values with the argument names as the keys.
  * Comments: Used only in initializing Phplist. The return value is stored in the $cline array. See line 27 of index.php.
  ===parseDate($strdate, $format = 'Y-m-d')===
  <code>lib.php, line 1405</code>
  * Arguments:
  -$strdate
  -$format
  * Return value:
  * Comments:
  ===parseDate($strdate,$format = 'Y-m-d')===
  <code>commonlib/pages/usermgt.php, line 19</code>
  * Arguments:
  -$strdate
  -$format
  * Return value:
  * Comments:
  ===parseDelimitedData($value)===
  <code>connect.php, line 1483</code>
  * Arguments:
  -$value
  * Return value:
  * Comments:
  ===parseFinalMessage($sendformat, $htmlmessage, $textmessage, & $mail,$messageid)===
  <code>defaultplugin.php, line 504</code>
  * Arguments:
  -$sendformat
  -$htmlmessage
  -$textmessage
  -$mail
  -$messageid
  * Return value:
  * Comments:
  ===parseMessage($content,$template,$adminid = 0)===
  <code>lib.php, line 600</code>
  * Arguments:
  -$content
  -$template
  -$adminid
  * Return value:
  * Comments:
  ===parseOutgoingHTMLMessage($messageid, $content, $destination, $userdata = null)===
  <code>defaultplugin.php, line 434</code>
  * Arguments:
  -$messageid
  -$content
  -$destination
  -$userdata
  * Return value:
  * Comments:
  ===parseOutgoingTextMessage($messageid, $content, $destination, $userdata = null)===
  <code>defaultplugin.php, line 422</code>
  * Arguments:
  -$messageid
  -$content
  -$destination
  -$userdata
  * Return value:
  * Comments:
  ===parsePlaceHolders($content,$array = array())===
  <code>sendemaillib.php, line 1186</code>
  * Explanation: This is the function that replaces standard placeholders by the value of the attribute specified in upper case between square brackets.
  * Arguments:
  -$content: A text string. This function is used to process text or HTML content of a message.
  -$array: An array in the form $key ⇒ $value. The key is the name of an attribute; $value is the value associated with the current subscriber and/or message.
  * Return value: The that was input but with placeholders replaced by values.
  * Comments: If the attribute inside the square brackets is not one of the keys in $array, the placeholder is left untouched.
  ===parsePlaceHolders($templ, $data)===
  <code>importlib.php, line 19</code>
  * Arguments:
  -$templ
  -$data
  * Return value:
  * Comments:
  ===parsePo($translationUpdate)===
  <code>languages.php, line 622</code>
  * Arguments:
  -$translationUpdate
  * Return value:
  * Comments:
  ===parseQueryString($str)===
  <code>lib.php, line 1128</code>
  * Arguments:
  -$str
  * Return value:
  * Comments:
  ===parseRSSTemplate($template,$data)===
  <code>rsslib.php, line 4</code>
  * Arguments:
  -$template
  -$data
  * Return value:
  * Comments:
  ===parseText($text)===
  <code>sendemaillib.php, line 1218</code>
  * Arguments:
  -$text
  * Return value:
  * Comments:
  ===parseThankyou($pageid= 0, $userid= 0, $text= “”)===
  <code>defaultplugin.php, line 291</code>
  * Arguments:
  -$pageid
  -$userid
  -$text
  * Return value:
  * Comments:
  ===phpcfgsize2bytes($val)===
  <code>connect.php, line 1260</code>
  * Arguments:
  -$val
  * Return value:
  * Comments:
  ===phplistI18N()===

languages.php, line 175

Arguments:
Return value:
Comments:

phplist_shutdown ()

connect.php, line 1651

Arguments:
Return value:
Comments:

PHPlistMailer($messageid,$email,$inBlast = true,$exceptions = false)

class.phplistmailer.php, line 40

Arguments:
1. $messageid
2. $email
3. $inBlast
4. $exceptions
Return value:
Comments:

phplistplugin()

defaultplugin.php, line 87

Arguments:
Return value:
Comments:

phplistTest()

defaulttest.php, line 9

Arguments:
Return value:
Comments:

plainText($text)

commonlib/lib/interfacelib.php, line 425

Arguments:
1. $text
Return value:
Comments:

pluginsCall($method)

pluginlib.php, line 163

Arguments:
1. $method
Return value:
Comments:

precacheMessage($messageid,$forwardContent = 0)

sendemaillib.php, line 1292

Arguments:
1. $messageid
2. $forwardContent
Return value:
Comments:

prepareOutput()

readtestmail.php, line 37

Arguments:
Return value:
Comments:

previewTemplate($id,$adminid = 0,$text = "", $footer = "")

lib.php, line 527

Arguments:
1. $id
2. $adminid
3. $text
4. $footer
Return value:
Comments:

previous()

commonlib/lib/interfacelib.php, line 874

Arguments:
Return value:
Comments:

previousLink()

commonlib/lib/interfacelib.php, line 867

Arguments:
Return value:
Comments:

prevNextNav()

commonlib/lib/interfacelib.php, line 892

Arguments:
Return value:
Comments:

printarray($array)

connect.php, line 1766

Arguments:
1. $array
Return value:
Comments:

printobject($object)

connect.php, line 1754

Arguments:
1. $object
Return value:
Comments:

===printTree($tree,$root,$delim)

import3.php, line 66

Arguments:
1. $tree
2. $root
3. $delim
Return value:
Comments:

processBounceData($bounceid,$msgid,$userid)

processbounces.php, line 202

Arguments:
1. $bounceid
2. $msgid
3. $userid
Return value:
Comments:

processbounces_shutdown()

processbounces.php, line 46

Arguments:
Return value:
Comments:

processDBerror($errorid)

defaultplugin.php, line 582

Arguments:
1. $errorid
Return value:
Comments:

processEditList($id)

defaultplugin.php, line 706

Arguments:
1. $id
Return value:
Comments:

ProcessError ($message)

actions/processqueue.php, line 305

Arguments:
1. $message
Return value:
Comments:

ProcessError($message)

readtestmail.php, line 62

Arguments:
1. $message
Return value:
Comments:

processError($msg)

defaultplugin.php, line 597

Arguments:
1. $msg
Return value:
Comments:

processImapBounce ($link,$num,$header)

processbounces.php, line 170

Arguments:
1. $link
2. $num
3. $header
Return value:
Comments:

processImapFolder($server,$user,$password,$folder,$fieldlist = array())

import3.php, line 136

Arguments:
1. $server
2. $user
3. $password
4. $folder
5. $fieldlist
Return value:
Comments:

processMbox ($file)

processbounces.php, line 330

Arguments:
1. $file
Return value:
Comments:

processMessages($link,$max = 3000)

processbounces.php, line 345

Arguments:
1. $link
2. $max
Return value:
Comments:

processPop ($server,$user,$password)

processbounces.php, line 310

Arguments:
1. $server
2. $user
3. $password
Return value:
Comments:

processQueueStart()

defaultplugin.php, line 605

Explanation: A method of the default plugin that you can override with a plugin. It is called at the beginning of processQueue, after the process was locked.
Arguments: None
Return value: None

processSendFailed($messageid, $userdata, $isTest = false)

defaultplugin.php, line 541

Arguments:
1. $messageid
2. $userdata
3. $isTest
Return value:
Comments:

processSendStats($sent = 0,$invalid = 0,$failed_sent = 0,$unconfirmed = 0,$counters = array())

defaultplugin.php, line 557

Arguments:
1. $sent
2. $invalid
3. $failedsent
  -$unconfirmed
  -$counters
  * Return value:
  * Comments:
  ===processSendSuccess($messageid, $userdata, $isTest = false)===
  <code>defaultplugin.php, line 528</code>
  * Arguments:
  -$messageid
  -$userdata
  -$isTest
  * Return value:
  * Comments:
  ===processSpamComplaint($email,$date)===
  <code>defaultplugin.php, line 713</code>
  * Arguments:
  -$email
  -$date
  * Return value:
  * Comments:
  ===processSubscribePageEdit($subscribePageID)===
  <code>defaultplugin.php, line 736</code>
  * Arguments:
  -$subscribePageID
  * Return value:
  * Comments:
  ===processSuccesFailure($messageid, $sendformat, $userdata, $success= true)===
  <code>defaultplugin.php, line 508</code>
  * Arguments:
  -$messageid
  -$sendformat
  -$userdata
  -$success
  * Return value:
  * Comments:
  ===processTestEmailsshutdown()===

readtestmail.php, line 68

Arguments:
Return value:
Comments:

Back

Up to Index