develop:functionb

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

backtrace()

commonlib/lib/errorlib.php, line 58

Arguments:
Return value:
Comments:

build_message()

class.phplistmailer.php, line 197

Arguments:
Return value:
Comments:

button($link,$linktext,$title = '')

commonlib/lib/interfacelib.php, line 1064

Arguments:
1. $link
2. $linktext
3. $title
Return value:
Comments:

buttonGroup($topbutton = '')

commonlib/lib/interfacelib.php, line 1118

Arguments:
1. $topbutton
Return value:
Comments:

campaignStarted($messagedata = array())

defaultplugin.php, line 615

Explanation: A method of the default plugin that you can override with a plugin. It is called when a message is pulled from the queue for sending out. A plugin can suppress the sending of this particular message by returning a string containing a reason for suppressing the sending of the message.
Arguments:
1. $messagedata: An array of message data filled by the function loadMessageData().
Return value: Null or an empty string allows the message to be sent. A string that is not empty suppresses the sending of the message and is taken to be the reason that the message is not sent.
Comments: This method gives a plugin the chance to look at the message before any queue processing is done.

canSend ($messagedata, $subscriberdata)

defaultplugin.php, line 374

Explanation: A method of the default plugin that you can override with a plugin. It is called before a message is sent out to a particular subscriber and can suppress sending of the message to that subscriber.
Arguments:
1. $messagedata: An array of message data filled by the function loadMessageData()
2. $subscriberdata; An array of data about a particular subscriber. See line 862 of actions/processqueue.php.
Return value: A boolean true if it's OK to send the message, false if it's not.

ccCompany($ccno)

commonlib/lib/userlib.php, line 748

Arguments:
1. $ccno
Return value:
Comments:

changeDropDowns()

commonlib/pages/usermgt.php, line 280

Arguments:
Return value:
Comments:

checkAccess($page)

connect.php, line 282

Explanation: This function checks to see whether a Phplist file is allowed to be served as a web page.
Arguments:
1. $page: A Phplist file name without the .php extension
Return value: 1 if the page is OK to be served, 0 otherwise.
Comments: If the file is called from the command line, this function will always return 1.

checkCCrange($ccno)

commonlib/lib/userlib.php, line 764

Arguments:
1. $ccno
Return value:
Comments:

checkForm()

send_core.php, line 570

Arguments:
Return value:
Comments:

checkI18NDir($rootdir)

checki18n.php, line 28

Arguments:
1. $rootdir
Return value:
Comments:

CheckImgExt($filename)

fckphplist.php, line 138

Arguments:
1. $filename
Return value:
Comments:

checkLock($processid)

lib.php, line 781

Arguments:
1. $processid
Return value:
Comments:

cl_output($message)

connect.php, line 1635

Arguments:
1. $message
Return value:
Comments:

cl_progress($message)

connect.php, line 1643

Arguments:
1. $message
Return value:
Comments:

clean ($value)

connect.php, line 406

Arguments:
1. $value
Return value:
Comments:

clean2 ($value)

lib.php, line 477

Arguments:
1. $value
Return value:
Comments:

cleanArray($array)

connect.php, line 1617

Arguments:
1. $array
Return value:
Comments:

cleanAttributeName($name)

connect.php, line 1738

Arguments:
1. $name
Return value:
Comments:

cleanCommaList($sList)

connect.php, line 1748

Arguments:
1. $sList
Return value:
Comments:

cleanEmail ($value)

lib.php, line 488

Arguments:
1. $value
Return value:
Comments:

cleanUrl($url,$disallowed_params = array('PHPSESSID'))

lib.php, line 1143

Arguments:
1. $url
2. $disallowedparams
  * Return value:
  * Comments:
  ===clearImport()===
  <code>importlib.php, line 31</code>
  * Arguments:
  * Return value:
  * Comments:
  ===clearPageCache ()===
  <code>lib.php, line 808</code>
  * Arguments:
  * Return value:
  * Comments:
  ===clickTrackLinkId($messageid,$userid,$url,$link)===
  <code>sendemaillib.php, line 1122</code>
  * Arguments:
  -$messageid
  -$userid
  -$url
  -$link
  * Return value:
  * Comments:
  ===ClineError($msg)===
  <code>connect.php, line 363</code>
  * Arguments:
  -$msg
  * Return value:
  * Comments:
  ===ClineSignature()===
  <code>connect.php, line 359</code>
  * Arguments:
  * Return value:
  * Comments:
  ===clineUsage($line = “”)===
  <code>connect.php, line 370</code>
  * Arguments:
  -$line
  * Return value:
  * Comments:
  ===closeadminbar()===
  <code>commonlib/lib/interfacelib.php, line 778</code>
  * Arguments:
  * Return value:
  * Comments:
  ===cmp($a,$b)===
  <code>commonlib/lib/interfacelib.php, line 359</code>
  * Arguments:
  -$a
  -$b
  * Return value:
  * Comments:
  ===collapse()===
  <code>commonlib/lib/interfacelib.php, line 372</code>
  * Arguments:
  * Return value:
  * Comments:
  ===compatSend($toname = “”, $toaddr, $fromname, $fromaddr, $subject = , $headers = ,$envelope = )=== <code>class.phplistmailer.php, line 227</code> * Arguments: -$toname -$toaddr -$fromname -$fromaddr -$subject -$headers -$envelope * Return value: * Comments: ===compressContent($content)=== <code>lib.php, line 823</code> * Arguments: -$content * Return value: * Comments: ===confirmButton($confirmationtext,$link,$linktext,$title =)===
  <code>commonlib/lib/interfacelib.php, line 1099</code>
  * Arguments:
  -$confirmationtext
  -$link
  -$linktext
  -$title
  * Return value:
  * Comments:
  ===connectLocal()===
  <code>import4.php, line 20</code>
  * Arguments:
  * Return value:
  * Comments:
  ===connectRemote()===
  <code>import4.php, line 28</code>
  * Arguments:
  * Return value:
  * Comments:
  ===constructSystemMail($message,$subject = '')===
  <code>lib.php, line 295</code>
  * Arguments:
  -$message
  -$subject
  * Return value:
  * Comments:
  ===contentDiv()===
  <code>commonlib/lib/interfacelib.php, line 1383</code>
  * Arguments:
  * Return value:
  * Comments:
  ===contextMenu()===
  <code>connect.php, line 726</code>
  * Arguments:
  * Return value:
  * Comments:
  ===CreateBody()===
  <code>class.phplistmailer.php, line 210</code>
  * Arguments:
  * Return value:
  * Comments:
  ===CreateHeader()===
  <code>class.phplistmailer.php, line 200</code>
  * Arguments:
  * Return value:
  * Comments:
  ===createPDF($text)===
  <code>sendemaillib.php, line 1009</code>
  * Arguments:
  -$text
  * Return value:
  * Comments:
  
  |Back| Up to Index | Next|