User Tools

Site Tools


develop:functionb

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
develop:functionb [2014/02/25 18:02]
arnoldvl [B/C]
develop:functionb [2015/05/08 20:04] (current)
arnoldvl [An Index of PHPlist Functions and Class Methods]
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/​functiona|Back]]| ​ [[http://​resources.phplist.com/​develop/​functionndx|Up to Index]] ​ |  [[http://​resources.phplist.com/​develop/​functiond|Next]]|
 +====B/C====
 +===backtrace()===
 +<​code>​commonlib/​lib/​errorlib.php,​ line 58</​code>​
 +  * Arguments:
 +  * Return value:
 +  * Comments:
 +===build_message()===
 +<​code>​class.phplistmailer.php,​ line 197</​code>​
 +  * Arguments:
 +  * Return value:
 +  * Comments:
 +===button($link,​$linktext,​$title = ''​)===
 +<​code>​commonlib/​lib/​interfacelib.php,​ line 1064</​code>​
 +  * Arguments:
 +    -$link
 +    -$linktext
 +    -$title
 +  * Return value:
 +  * Comments:
 +===buttonGroup($topbutton = ''​)===
 +<​code>​commonlib/​lib/​interfacelib.php,​ line 1118</​code>​
 +  * Arguments:
 +    -$topbutton
 +  * Return value:
 +  * Comments:
 +===campaignStarted($messagedata = array())===
 +<​code>​defaultplugin.php,​ line 615</​code>​
 +  * 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:
 +    -$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)===
 +<​code>​defaultplugin.php,​ line 374</​code>​
 +  *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:
 +    -$messagedata:​ An array of message data filled by the function //​loadMessageData()//​
 +    -$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)===
 +<​code>​commonlib/​lib/​userlib.php,​ line 748</​code>​
 +  * Arguments:
 +    -$ccno
 +  * Return value:
 +  * Comments:
 +===changeDropDowns()===
 +<​code>​commonlib/​pages/​usermgt.php,​ line 280</​code>​
 +  * Arguments:
 +  * Return value:
 +  * Comments:
 +===checkAccess($page)===
 +<​code>​connect.php,​ line 282</​code>​
 +  * Explanation:​ This function checks to see whether a Phplist file is allowed to be served as a web page.
 +  * Arguments:
 +    -$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)===
 +<​code>​commonlib/​lib/​userlib.php,​ line 764</​code>​
 +  * Arguments:
 +    -$ccno
 +  * Return value:
 +  * Comments:
 +===checkForm()===
 +<​code>​send_core.php,​ line 570</​code>​
 +  * Arguments:
 +  * Return value:
 +  * Comments:
 +===checkI18NDir($rootdir)===
 +<​code>​checki18n.php,​ line 28</​code>​
 +  * Arguments:
 +    -$rootdir
 +  * Return value:
 +  * Comments:
 +===CheckImgExt($filename)===
 +<​code>​fckphplist.php,​ line 138</​code>​
 +  * Arguments:
 +    -$filename
 +  * Return value:
 +  * Comments:
 +===checkLock($processid)===
 +<​code>​lib.php,​ line 781</​code>​
 +  * Arguments:
 +    -$processid
 +  * Return value:
 +  * Comments:
 +===cl_output($message)===
 +<​code>​connect.php,​ line 1635</​code>​
 +  * Arguments:
 +    -$message
 +  * Return value:
 +  * Comments:
 +===cl_progress($message)===
 +<​code>​connect.php,​ line 1643</​code>​
 +  * Arguments:
 +    -$message
 +  * Return value:
 +  * Comments:
 +===clean ($value)===
 +<​code>​connect.php,​ line 406</​code>​
 +  * Arguments:
 +    -$value
 +  * Return value:
 +  * Comments:
 +===clean2 ($value)===
 +<​code>​lib.php,​ line 477</​code>​
 +  * Arguments:
 +    -$value
 +  * Return value:
 +  * Comments:
 +===cleanArray($array)===
 +<​code>​connect.php,​ line 1617</​code>​
 +  * Arguments:
 +    -$array
 +  * Return value:
 +  * Comments:
 +===cleanAttributeName($name)===
 +<​code>​connect.php,​ line 1738</​code>​
 +  * Arguments:
 +    -$name
 +  * Return value:
 +  * Comments:
 +===cleanCommaList($sList)===
 +<​code>​connect.php,​ line 1748</​code>​
 +  * Arguments:
 +    -$sList
 +  * Return value:
 +  * Comments:
 +===cleanEmail ($value)===
 +<​code>​lib.php,​ line 488</​code>​
 +  * Arguments:
 +    -$value
 +  * Return value:
 +  * Comments:
 +===cleanUrl($url,​$disallowed_params = array('​PHPSESSID'​))===
 +<​code>​lib.php,​ line 1143</​code>​
 +  * Arguments:
 +    -$url
 +    -$disallowed_params
 +  * 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($to_name = "",​ $to_addr, $from_name, $from_addr, $subject = '',​ $headers = '',​$envelope = ''​)===
 +<​code>​class.phplistmailer.php,​ line 227</​code>​
 +  * Arguments:
 +    -$to_name
 +    -$to_addr
 +    -$from_name
 +    -$from_addr
 +    -$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:
 +
 +|[[http://​resources.phplist.com/​develop/​functiona|Back]]| ​   [[http://​resources.phplist.com/​develop/​functionndx|Up to Index]] ​ |  [[http://​resources.phplist.com/​develop/​functiond|Next]]|
develop/functionb.txt · Last modified: 2015/05/08 20:04 by arnoldvl

Resources
Contact Us

e: info@phplist.com

Boring Bit

phpList is a registered limited company

UK Company No. 07582966

VAT Registration 122 0788 37

© phpList 2016