Differences

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

--- develop:functionh [2014/01/05 19:02] – [An Index of PHPlist Functions and Class Methods] arnoldvl
+++ develop:functionh [2015/05/08 19:06] (current) – [An Index of PHPlist Functions and Class Methods] arnoldvl
@@ 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/functionf|Back]]|   [[http://resources.phplist.com/develop/functionndx|Up to Index]]   |   [[http://resources.phplist.com/develop/functionm|Next]]|
+====H, I, J, K, L====
+===header()===
+<code>commonlib/lib/interfacelib.php, line 1336</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===HelloWorld($params)===
+<code>defaultplugin.php, line 356</code>
+  * Arguments:
+    -$params
+  * Return value:
+  * Comments:
+===Help($topic, $text = '?')===
+<code>connect.php, line 1275</code>
+  * Arguments:
+    -$topic
+    -$text
+  * Return value:
+  * Comments:
+===hide()===
+<code>commonlib/lib/interfacelib.php, line 1178</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===hideadminbar()===
+<code>commonlib/lib/interfacelib.php, line 761</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===HTML2Text($text)===
+<code>commonlib/lib/maillib.php, line 12</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===i18nLanguageDir()===
+<code>defaultplugin.php, line 175</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===image_exists($templateid,$filename)===
+<code>class.phplistmailer.php, line 479</code>
+  * Arguments:
+    -$templateid
+    -$filename
+  * Return value:
+  * Comments:
+===importContent()===
+<code>defaultplugin.php, line 744</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===importReport($report)===
+<code>defaultplugin.php, line 591</code>
+  * Arguments:
+    -$report
+  * Return value:
+  * Comments:
+===includeStyles($text)===
+<code>lib.php, line 863</code>
+  * Arguments:
+    -$text
+  * Return value:
+  * Comments:
+===index()===
+<code>commonlib/lib/interfacelib.php, line 355</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===Info($msg)===
+<code>commonlib/lib/errorlib.php, line 171</code>
+  * Arguments:
+    -$msg
+  * Return value:
+  * Comments:
+===Info($msg,$noClose = false)===
+<code>connect.php, line 474</code>
+  * Arguments:
+    -$msg
+    -$noClose
+  * Return value:
+  * Comments:
+===initFSTranslations($language = '')===
+<code>languages.php, line 462</code>
+  * Arguments:
+    -$language
+  * Return value:
+  * Comments:
+===initialise()===
+<code>defaultplugin.php, line 145</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===initialiseUserSession()===
+<code>commonlib/lib/userlib.php, line 12</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===interval($seconds = 0)===
+<code>connect.php, line 1883</code>
+  * Arguments:
+    -$seconds
+  * Return value:
+  * Comments:
+===is_email($email)===
+<code>commonlib/lib/userlib.php, line 494</code>
+  * Arguments:
+    -$email
+  * Return value:
+  * Comments:
+===isBlackListed($email = "",$immediate = true)===
+<code>commonlib/lib/userlib.php, line 344</code>
+  * Arguments:
+    -$email
+    -$immediate
+  * Return value:
+  * Comments:
+===isBlackListedID($userid = 0)===
+<code>commonlib/lib/userlib.php, line 361</code>
+  * Arguments:
+    -$userid
+  * Return value:
+  * Comments:
+===isGuestAccount()===
+<code>commonlib/lib/userlib.php, line 922</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===isSuperUser()===
+<code>accesscheck.php, line 26</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===isValidRedirect($url)===
+<code>lib.php, line 909</code>
+  * Arguments:
+    -$url
+  * Return value:
+  * Comments:
+===join_clean($sep,$array)===
+<code>connect.php, line 417</code>
+  * Arguments:
+    -$sep
+    -$array
+  * Return value:
+  * Comments:
+===keepLock($processid)===
+<code>lib.php, line 775</code>
+  * Arguments:
+    -$processid
+  * Return value:
+  * Comments:
+===langChange()===
+<code>installer/home.php, line 24</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===lanSort($a,$b)===
+<code>languages.php, line 60</code>
+  * Arguments:
+    -$a
+    -$b
+  * Return value:
+  * Comments:
+===linkencode($p_url)===
+<code>sendemaillib.php, line 1037</code>
+  * Arguments:
+    -$p_url
+  * Return value:
+  * Comments:
+===ListAllAttributes()===
+<code>subscribelib2.php, line 1263</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===listArray($array,$indent = 0)===
+<code>commonlib/lib/errorlib.php, line 37</code>
+  * Arguments:
+    -$array
+    -$indent
+  * Return value:
+  * Comments:
+===ListAttributes($attributes,$attributedata,$htmlchoice = 0,$userid = 0,$emaildoubleentry='no' )===
+<code>subscribelib2.php, line 734</code>
+  * Arguments:
+    -$attributes
+    -$attributedata
+    -$htmlchoice
+    -$userid
+    -$emaildoubleentry
+  * Return value:
+  * Comments:
+===ListAttributes2011($attributes,$attributedata,$htmlchoice = 0,$userid = 0,$emaildoubleentry='no' )===
+<code>subscribelib2.php, line 1016</code>
+  * Arguments:
+    -$attributes
+    -$attributedata
+    -$htmlchoice
+    -$userid
+    -$emaildoubleentry
+  * Return value:
+  * Comments:
+===ListAvailableLists($userid = 0,$lists_to_show = "")===
+<code>subscribelib2.php, line 667</code>
+  * Arguments:
+    -$userid
+    -$lists_to_show
+  * Return value:
+  * Comments:
+===listCategories()===
+<code>lib.php, line 1493</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===listingElement($element)===
+<code>commonlib/lib/interfacelib.php, line 489</code>
+  * Arguments:
+    -$element
+  * Return value:
+  * Comments:
+===listingEnd()===
+<code>commonlib/lib/interfacelib.php, line 576</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===listingHeader()===
+<code>commonlib/lib/interfacelib.php, line 457</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===listingStart($class="")===
+<code>commonlib/lib/interfacelib.php, line 453</code>
+  * Arguments:
+    -$class
+  * Return value:
+  * Comments:
+===listName($id)===
+<code>lib.php, line 42</code>
+  * **Explanation:** Returns the name of a list from the database, given the ID of the list.
+  * **Arguments:**
+    -$id: The numerical ID of the list in the database
+  * **Return value:** The list name as a string
+  * **Comments:**
+===ListofLists($current,$fieldname,$subselect)===
+<code>connect.php, line 1102</code>
+  * Arguments:
+    -$current
+    -$fieldname
+    -$subselect
+  * Return value:
+  * Comments:
+===listOwner($listid = 0)===
+<code>lib.php, line 612</code>
+  * Arguments:
+    -$listid
+  * Return value:
+  * Comments:
+===listPlaceHolders()===
+<code>connect.php, line 1725</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+===listSelectHTML ($current,$fieldname,$subselect,$alltab = '')===
+<code>connect.php, line 1165</code>
+  * Arguments:
+    -$current
+    -$fieldname
+    -$subselect
+    -$alltab
+  * Return value:
+  * Comments:
+===listStyle($style)===
+<code>commonlib/lib/interfacelib.php, line 847</code>
+  * Arguments:
+    -$style
+  * Return value:
+  * Comments:
+===listUsedInSubscribePage($listid = 0)===
+<code>lib.php, line 618</code>
+  * Arguments:
+    -$listid
+  * Return value:
+  * Comments:
+===loadBounceRules($all = 0)===
+<code>lib.php, line 1283</code>
+  * Arguments:
+    -$all
+  * Return value:
+  * Comments:
+===loadCCvalidationFile($ccrangefile)===
+<code>commonlib/lib/userlib.php, line 720</code>
+  * Arguments:
+    -$ccrangefile
+  * Return value:
+  * Comments:
+===loadMessageData($msgid)===
+<code>lib.php, line 82</code>
+  * **Explanation:** loads all of the data of the next message to be processed in the queue.
+  * **Arguments:**
+    -$msgid: The numerical id of the message in the data base.
+  * **Return value:** the array of data. For a list of the elements of this array see lines 104 to 132 in //lib.php//
+  * **Comments:**
+===loadUser($loginname = "")===
+<code>commonlib/lib/userlib.php, line 808</code>
+  * Arguments:
+    -$loginname
+  * Return value:
+  * Comments:
+===LogError($error)===
+<code>commonlib/lib/errorlib.php, line 175</code>
+  * Arguments:
+    -$error
+  * Return value:
+  * Comments:
+===logEvent($msg = '')===
+<code>defaultplugin.php, line 655</code>
+  * Arguments:
+    -$msg
+  * Return value:
+  * Comments:
+===logEvent($msg)===
+<code>lib.php, line 650</code>
+  * Arguments:
+    -$msg
+  * Return value:
+  * Comments:
+===logout()===
+<code>defaultplugin.php, line 665</code>
+  * Arguments:
+  * Return value:
+  * Comments:
+|[[http://resources.phplist.com/develop/functionf|Back]]|   [[http://resources.phplist.com/develop/functionndx|Up to Index]]  |    [[http://resources.phplist.com/develop/functionm|Next]]|

Tools

menus and quick search

quick search

site status

location indicator

Page Tools

meta data for this page

Differences