develop:functionf

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

Fatal_error($msg)

commonlib/lib/errorlib.php, line 10

Arguments:
1. $msg
Return value:
Comments:

Fatal_Error($msg,$documentationURL = '')

connect.php, line 428

Arguments:
1. $msg
2. $documentationURL
Return value:
Comments:

fetchEmailsFromHeader($header,$folder,$fieldlist = array())

import3.php, line 104

Arguments:
1. $header
2. $folder
3. $fieldlist
Return value:
Comments:

fetchInfoContent($include)

commonlib/lib/interfacelib.php, line 980

Arguments:
1. $include
Return value:
Comments:

fetchStyles($text)

lib.php, line 887

Arguments:
1. $text
Return value:
Comments:

fetchUrl($url,$userdata = array())

lib.php, line 961

Arguments:
1. $url
2. $userdata
Return value:
Comments:

fetchUrlCurl($url,$request_parameters)

lib.php, line 1049

Arguments:
1. $url
2. $request_parameters
Return value:
Comments:

fetchUrlPear($url,$request_parameters)

lib.php, line 1069

Arguments:
1. $url
2. $request_parameters
Return value:
Comments:

FileNotFound($msg = '')

connect.php, line 1426

Arguments:
1. $msg
Return value:
Comments:

filesystem_image_exists($filename)

class.phplistmailer.php, line 415

Arguments:
1. $filename
Return value:
Comments:

FileUploadError($errno)

commonlib/lib/errorlib.php, line 20

Arguments:
1. $errno
Return value:
Comments:

fill($prefix,$listid)

stresstest.php, line 30

Arguments:
1. $prefix
2. $listid
Return value:
Comments:

find_html_images($templateid)

class.phplistmailer.php, line 295

Arguments:
1. $templateid
Return value:
Comments:

findEmailForUser($link, $mailToFind, $max= 3000)

readtestmail.php, line 217

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

findMessageId($text)

processbounces.php, line 87

Arguments:
1. $text
Return value:
Comments:

findMime($filename)

connect.php, line 1434

Arguments:
1. $filename
Return value:
Comments:

findUserID($text)

processbounces.php, line 103

Arguments:
1. $text
Return value:
Comments:

finish ($flag,$message)

processbounces.php, line 29

Arguments:
1. $flag
2. $message
Return value:
Comments:

finish ($flag,$message,$script_stage)

actions/processqueue.php, line 282

Arguments:
1. $flag
2. $message
3. $script_stage
Return value:
Comments:

finish($flag, $message)

readtestmail.php, line 47

Arguments:
1. $flag
2. $message
Return value:
Comments:

fixEmail($email)

reconcileusers.php, line 52

Arguments:
1. $email
Return value:
Comments:

flushBrowser()

lib.php, line 1341

Arguments:
Return value:
Comments:

flushbuffer()

convertstats.php, line 30

Arguments:
Return value:
Comments:

flushClickTrackCache()

lib.php, line 1349

Arguments:
Return value:
Comments:

commonlib/lib/interfacelib.php, line 1367

Arguments:
Return value:
Comments:

formatBytes ($value)

lib.php, line 1380

Arguments:
1. $value
Return value:
Comments:

formatDate ($date,$short = 0)

connect.php, line 1410

Arguments:
1. $date
2. $short
Return value:
Comments:

formatDateTime ($datetime,$short = 0)

connect.php, line 1629

Arguments:
1. $datetime
2. $short
Return value:
Comments:

formatText($text)

languages.php, line 363

Arguments:
1. $text
Return value:
Comments:

formatTime($time,$short = 0)

connect.php, line 1613

Arguments:
1. $time
2. $short
Return value:
Comments:

formStart($additional="")

connect.php, line 245

Arguments:
1. $additional
Return value:
Comments:

get($text)

languages.php, line 530

Arguments:
1. $text
Return value:
Comments:

get_filesystem_image($filename)

class.phplistmailer.php, line 442

Arguments:
1. $filename
Return value:
Comments:

get_template_image($templateid,$filename)

class.phplistmailer.php, line 490

Arguments:
1. $templateid
2. $filename
Return value:
Comments:

getAttributeIDbyName ($sName)

commonlib/lib/userlib.php, line 120

Arguments:
1. $sName
Return value:
Comments:

getAttributeNamebyID ($iAttribute)

commonlib/lib/userlib.php, line 153

Arguments:
1. $iAttribute
Return value:
Comments:

getBestVersion($emails)

import3.php, line 191

Arguments:
1. $emails
Return value:
Comments:

getConfig($name)

defaultplugin.php, line 209

Arguments:
1. $name
Return value:
Comments:

getDate($value = "")

date.php, line 75

Arguments:
1. $value
Return value:
Comments:

getEveryoneGroupID()

commonlib/lib/userlib.php, line 18

Arguments:
Return value:
Comments:

getFileI18Ntags($file)

checki18n.php, line 10

Arguments:
1. $file
Return value:
Comments:

getImapFolders($server,$user,$password)

import3.php, line 168

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

getMessageAttachment($messageid, $content)

defaultplugin.php, line 438

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

getNewAttributeTablename($name)

commonlib/lib/userlib.php, line 900

Arguments:
1. $name
Return value:
Comments:

getNiceBackTrace( $bTrace = false )

lib.php, line 1531

Arguments:
1. $bTrace
Return value:
Comments:

getPageCache($url,$lastmodified = 0)

lib.php, line 791

Arguments:
1. $url
2. $lastmodified
Return value:
Comments:

getPageCacheLastModified($url)

lib.php, line 796

Arguments:
1. $url
Return value:
Comments:

getPageLock($force = 0)

lib.php, line 682

Arguments:
1. $force
Return value:
Comments:

getPluginBasedir()

languages.php, line 448

Arguments:
Return value:
Comments:

getSelectedLists($fieldname)

connect.php, line 1199

Arguments:
1. $fieldname
Return value:
Comments:

getTemplateImages($content)

template.php, line 24

Arguments:
1. $content
Return value:
Comments:

getTemplateLinks($content)

template.php, line 52

Arguments:
1. $content
Return value:
Comments:

gettext($text)

languages.php, line 248

Arguments:
1. $text
Return value:
Comments:

getTime($value = "")

date.php, line 90

Arguments:
1. $value
Return value:
Comments:

getTopSmtpServer($domain)

lib.php, line 258

Arguments:
1. $domain
Return value:
Comments:

getTranslation($text,$page,$basedir)

languages.php, line 483

Arguments:
1. $text
2. $page
3. $basedir
Return value:
Comments:

getTranslationUpdates()

languages.php, line 572

Arguments:
Return value:
Comments:

getUniqid($table = "")

commonlib/lib/userlib.php, line 28

Arguments:
1. $table
Return value:
Comments:

getUserAttributeValues($email = '', $id = 0, $bIndexWithShortnames = false)

commonlib/lib/userlib.php, line 218

Explanation: Get the values of the user attributes for a user by his email address or by his id in the database.
Arguments:
1. $email: The email for the user of interest.
2. $id: The numerical database ID for the user of interest.
3. $bIndexWithShortnames: Set this parameter to true if you want the attributes to keyed by a string concatenated from the word 'attribute' and the ID of the attribute name in the database. The default is that the array returned is keyed by the attribute name.
Return value: An associative array (key ⇒ attribute value)
Comments: You can identify the user by the email address OR by the user's ID. It is not necessary to specify both of these values is the arguments of this function.

getUserConfig($item, $userid = 0)

defaultconfig.php, line 755

Arguments:
1. $item
2. $userid
Return value:
Comments:

getVersion()

defaultplugin.php, line 115

Arguments:
Return value:
Comments:

giveAlternative($table,$delete,$attributeid)

editattributes.php, line 88

Arguments:
1. $table
2. $delete
3. $attributeid
Return value:
Comments:

groupName($id)

user.php, line 62

Arguments:
1. $id
Return value:
Comments: