Changeset 5c461ba in github for program/include/main.inc


Ignore:
Timestamp:
Sep 29, 2010 12:47:05 PM (3 years ago)
Author:
alecpl <alec@…>
Branches:
master, HEAD, courier-fix, dev-browser-capabilities, pdo, release-0.6, release-0.7, release-0.8
Children:
33da0b4
Parents:
c609784
Message:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • program/include/main.inc

    re999919 r5c461ba  
    152152 * Garbage collector for cache entries. 
    153153 * Remove all expired message cache records 
     154 * @return void 
    154155 */ 
    155156function rcmail_cache_gc() 
    … …  
    188189 * @param  string Suspected charset of the input string 
    189190 * @param  string Target charset to convert to; defaults to RCMAIL_CHARSET 
    190  * @return Converted string 
     191 * @return string Converted string 
    191192 */ 
    192193function rcube_charset_convert($str, $from, $to=NULL) 
    … …  
    323324 * but we need strict names for charset conversion (specially utf8 class) 
    324325 * 
    325  * @param  string  Input charset name 
    326  * @return The validated charset name 
     326 * @param  string Input charset name 
     327 * @return string The validated charset name 
    327328 */ 
    328329function rcube_parse_charset($input) 
    … …  
    428429 * 
    429430 * @param  string  Input string 
    430  * @return The converted string 
     431 * @return string  The converted string 
    431432 */ 
    432433function rcube_utf7_to_utf8($str) 
    … …  
    487488 * 
    488489 * @param  string  Input string 
    489  * @return The converted string 
     490 * @return string  The converted string 
    490491 */ 
    491492function rcube_utf16_to_utf8($str) 
    … …  
    518519 * @param  string  Replace mode for tags: show|replace|remove 
    519520 * @param  boolean Convert newlines 
    520  * @return The quoted string 
     521 * @return string  The quoted string 
    521522 */ 
    522523function rep_specialchars_output($str, $enctype='', $mode='', $newlines=TRUE) 
    … …  
    10881089 * 
    10891090 * @param mixed Debug message or data 
     1091 * @return void 
    10901092 */ 
    10911093function console() 
    … …  
    11221124 * @param $name name of log file 
    11231125 * @param line Line to append 
     1126 * @return void 
    11241127 */ 
    11251128function write_log($name, $line) 
    … …  
    11741177/** 
    11751178 * Write login data (name, ID, IP address) to the 'userlogins' log file. 
     1179 * 
     1180 * @return void 
    11761181 */ 
    11771182function rcmail_log_login() 
    … …  
    12021207/** 
    12031208 * @access private 
     1209 * @return mixed 
    12041210 */ 
    12051211function rcube_timer() 
    … …  
    12111217/** 
    12121218 * @access private 
     1219 * @return void 
    12131220 */ 
    12141221function rcube_print_time($timer, $label='Timer', $dest='console') 
    … …  
    12931300 * 
    12941301 * @param array Named parameters 
    1295  * @return object html_select HTML drop-down object 
     1302 * @return html_select HTML drop-down object 
    12961303 */ 
    12971304function rcmail_mailbox_select($p = array()) 
    … …  
    13201327 * Create a hierarchical array of the mailbox list 
    13211328 * @access private 
     1329 * @return void 
    13221330 */ 
    13231331function rcmail_build_folder_tree(&$arrFolders, $folder, $delm='/', $path='') 
    … …  
    13551363 * Return html for a structured list &lt;ul&gt; for the mailbox tree 
    13561364 * @access private 
     1365 * @return string 
    13571366 */ 
    13581367function rcmail_render_folder_tree_html(&$arrFolders, &$mbox_name, &$jslist, $attrib, $nestLevel=0) 
    … …  
    14531462 * Return html for a flat list <select> for the mailbox tree 
    14541463 * @access private 
     1464 * @return string 
    14551465 */ 
    14561466function rcmail_render_folder_tree_select(&$arrFolders, &$mbox_name, $maxlength, &$select, $realnames=false, $nestLevel=0) 
    … …  
    14861496 * Return internal name for the given folder if it matches the configured special folders 
    14871497 * @access private 
     1498 * @return string 
    14881499 */ 
    14891500function rcmail_folder_classname($folder_id) 
    … …  
    15231534 * 
    15241535 * @param string Editor mode 
     1536 * @return void 
    15251537 */ 
    15261538function rcube_html_editor($mode='') 
    … …  
    15531565 * @param integer HTTPS port number 
    15541566 * @param boolean Enables 'use_https' option checking 
     1567 * @return boolean 
    15551568 */ 
    15561569function rcube_https_check($port=null, $use_https=true) 
    … …  
    15711584 
    15721585 
    1573 // for backward compatibility 
     1586/** 
     1587 * For backward compatibility. 
     1588 * 
     1589 * @global rcmail $RCMAIL 
     1590 * @param string $var_name Variable name. 
     1591 * @return void 
     1592 */ 
    15741593function rcube_sess_unset($var_name=null) 
    15751594{ 
    … …  
    15801599 
    15811600 
    1582 // Replaces hostname variables 
     1601 
     1602/** 
     1603 * Replaces hostname variables 
     1604 * 
     1605 * @param string $name Hostname 
     1606 * @return string 
     1607 */ 
    15831608function rcube_parse_host($name) 
    15841609{ 
    … …  
    15991624/** 
    16001625 * E-mail address validation 
     1626 * 
     1627 * @param string $email Email address 
     1628 * @param boolean $dns_check True to check dns 
     1629 * @return boolean 
    16011630 */ 
    16021631function check_email($email, $dns_check=true) 
    … …  
    17241753 * 
    17251754 * @param array Named parameters 
     1755 * @return void 
    17261756 * @see raise_error() 
    17271757 */ 
Note: See TracChangeset for help on using the changeset viewer.