This shows you the differences between two versions of the page.
develop:functionc [2014/01/03 19:17] arnoldvl created |
develop:functionc [2014/01/03 19:17] (current) arnoldvl created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | | ||
+ | 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, | ||
+ | |||
+ | 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. | ||
+ | ====B/C==== | ||
+ | ===button($link, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$link | ||
+ | -$linktext | ||
+ | -$title | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===buttonGroup($topbutton = '' | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$topbutton | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===campaignStarted($messagedata = array())=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$messagedata | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===canSend ($messagedata, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$messagedata | ||
+ | -$subscriberdata | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===ccCompany($ccno)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$ccno | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===checkAccess($page)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$page | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===checkCCrange($ccno)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$ccno | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===checkI18NDir($rootdir)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$rootdir | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===CheckImgExt($filename)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$filename | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===checkLock($processid)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$processid | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cl_output($message)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$message | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cl_progress($message)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$message | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===clean ($value)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$value | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===clean2 ($value)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$value | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cleanArray($array)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$array | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cleanAttributeName($name)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$name | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cleanCommaList($sList)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$sList | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cleanEmail ($value)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$value | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cleanUrl($url, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$url | ||
+ | -$disallowed_params | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===clickTrackLinkId($messageid, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$messageid | ||
+ | -$userid | ||
+ | -$url | ||
+ | -$link | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===ClineError($msg)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$msg | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===clineUsage($line = "" | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$line | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===cmp($a, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$a | ||
+ | -$b | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===compatSend($to_name = "", | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$to_name | ||
+ | -$to_addr | ||
+ | -$from_name | ||
+ | -$from_addr | ||
+ | -$subject | ||
+ | -$headers | ||
+ | -$envelope | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===compressContent($content)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$content | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===confirmButton($confirmationtext, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$confirmationtext | ||
+ | -$link | ||
+ | -$linktext | ||
+ | -$title | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===constructSystemMail($message, | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$message | ||
+ | -$subject | ||
+ | * Return value: | ||
+ | * Comments: | ||
+ | ===createPDF($text)=== | ||
+ | < | ||
+ | * Arguments: | ||
+ | -$text | ||
+ | * Return value: | ||
+ | * Comments: | ||