Skip to content

Commit

Permalink
Doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@eldy
eldy committed Sep 2, 2011
1 parent cd91c7f commit 3ff04be
Showing 1 changed file with 60 additions and 79 deletions.
139 changes: 60 additions & 79 deletions htdocs/lib/functions.lib.php
View file
Expand Up @@ -2572,70 +2572,78 @@ function print_liste_field_titre($name, $file="", $field="", $begin="", $morepar

/**
* Get title line of an array
*
* @param name Label of field
* @param thead For thead format
* @param file Url used when we click on sort picto
* @param field Field to use for new sorting
* @param begin ("" by defaut)
* @param moreparam Add more parameters on sort url links ("" by default)
* @param moreattrib Add more attributes on th ("" by defaut)
* @param td Options of attribute td ("" by defaut)
* @param sortfield Current field used to sort
* @param sortorder Current sort order
*/
function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="")
function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $td="", $sortfield="", $sortorder="")
{
global $conf;
//print "$name, $file, $field, $begin, $options, $moreattrib, $sortfield, $sortorder<br>\n";
//print "$name, $file, $field, $begin, $options, $td, $sortfield, $sortorder<br>\n";

$out='';
// If field is used as sort criteria we use a specific class
// Example if (sortfield,field)=("nom","xxx.nom") or (sortfield,field)=("nom","nom")
if ($field && ($sortfield == $field || $sortfield == preg_replace("/^[^\.]+\./","",$field)))

if ($thead)
{
$out.= '<th class="liste_titre_sel" '. $moreattrib.'>';
$out.= '<th>'.$name.'</th>';
}
else
{
$out.= '<th class="liste_titre" '. $moreattrib.'>';
}
$out.=$name;

if (empty($thead) && $field) // If this is a sort field
{
$options=preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i','',$moreparam);
$options=preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i','',$options);
$options=preg_replace('/&+/i','&',$options);
if (! preg_match('/^&/',$options)) $options='&'.$options;

//print "&nbsp;";
$out.= '<img width="2" src="'.DOL_URL_ROOT.'/theme/common/transparent.png" alt="">';
if (! $sortorder)
{
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
else
{
if ($field != $sortfield)
{
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
else {
$sortorder=strtoupper($sortorder);
if ($sortorder == 'DESC' ) {
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
}
if ($sortorder == 'ASC' ) {
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
}
}
// Le champ de tri est mis en evidence.
// Exemple si (sortfield,field)=("nom","xxx.nom") ou (sortfield,field)=("nom","nom")
if ($field && ($sortfield == $field || $sortfield == preg_replace("/^[^\.]+\./","",$field)))
{
$out.= '<td class="liste_titre_sel" '. $td.'>';
}
else
{
$out.= '<td class="liste_titre" '. $td.'>';
}
$out.= $name;

// If this is a sort field
if ($field)
{
$options=preg_replace('/sortfield=([a-zA-Z0-9,\s\.]+)/i','',$moreparam);
$options=preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i','',$options);
$options=preg_replace('/&+/i','&',$options);
if (! preg_match('/^&/',$options)) $options='&'.$options;

//print "&nbsp;";
$out.= '<img width="2" src="'.DOL_URL_ROOT.'/theme/common/transparent.png" alt="">';
if (! $sortorder)
{
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
else
{
if ($field != $sortfield)
{
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
else {
$sortorder=strtoupper($sortorder);
if ($sortorder == 'DESC' ) {
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",0).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",1).'</a>';
}
if ($sortorder == 'ASC' ) {
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=asc&begin='.$begin.$options.'">'.img_down("A-Z",1).'</a>';
$out.= '<a href="'.$file.'?sortfield='.$field.'&sortorder=desc&begin='.$begin.$options.'">'.img_up("Z-A",0).'</a>';
}
}
}
}
$out.= "</td>";
}
$out.='</th>';

return $out;
}
Expand Down Expand Up @@ -2664,7 +2672,6 @@ function print_fiche_titre($titre, $mesg='', $picto='title.png', $pictoisfullpat

/**
* Load a title with picto
*
* @param titre Title to show
* @param mesg Added message to show on right
* @param picto Icon to use before title (should be a 32x32 transparent png file)
Expand Down Expand Up @@ -2697,7 +2704,6 @@ function load_fiche_titre($titre, $mesg='', $picto='title.png', $pictoisfullpath

/**
* Print a title with navigation controls for pagination
*
* @param titre Title to show (required)
* @param page Numero of page (required)
* @param file Url of page (required)
Expand Down Expand Up @@ -2807,7 +2813,6 @@ function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $so

/**
* Fonction servant a afficher les fleches de navigation dans les pages de listes
*
* @param page Numero of page
* @param file Lien
* @param options Autres parametres d'url a propager dans les liens ("" par defaut)
Expand All @@ -2832,7 +2837,6 @@ function print_fleche_navigation($page,$file,$options='',$nextpage,$betweenarrow
/**
* Fonction qui retourne un taux de tva formate pour visualisation
* Utilisee dans les pdf et les pages html
*
* @param rate Rate value to format (19.6 19,6 19.6% 19,6%,...)
* @param addpercent Add a percent % sign in output
* @param info_bits Miscellanous information on vat
Expand Down Expand Up @@ -2861,7 +2865,6 @@ function vatrate($rate,$addpercent=false,$info_bits=0)
/**
* Fonction qui formate un montant pour visualisation
* Fonction utilisee dans les pdf et les pages html
*
* @param amount Montant a formater
* @param html Type de formatage, html ou pas (par defaut)
* @param outlangs Objet langs pour formatage text
Expand Down Expand Up @@ -2934,8 +2937,7 @@ function price($amount, $html=0, $outlangs='', $trunc=1, $rounding=-1, $forcerou
/**
* Function that return a number with universal decimal format (decimal separator is '.') from
* an amount typed by a user.
* Function to use on each input amount before any numeric test or database insert
*
* Function to use on each input amount before any numeric test or database insert.
* @param amount Amount to convert/clean
* @param rounding ''=No rounding
* 'MU'=Round to Max unit price (MAIN_MAX_DECIMALS_UNIT)
Expand Down Expand Up @@ -3020,7 +3022,6 @@ function price2num($amount,$rounding='',$alreadysqlnb=0)

/**
* Return localtaxe rate for a particular tva
*
* @param tva Vat taxe
* @param local Local taxe to search and return
* @param societe_acheteuse Object of buying third party
Expand Down Expand Up @@ -3059,8 +3060,7 @@ function get_localtax($tva, $local, $societe_acheteuse="")

/**
* Return vat rate of a product in a particular selling country or default country
* vat if product is unknown
*
* vat if product is unknown.
* @param idprod Id of product or 0 if not a predefined product
* @param countrycode Country code (FR, US, IT, ...)
* @return int <0 if KO, Vat rate if OK
Expand Down Expand Up @@ -3119,7 +3119,6 @@ function get_product_vat_for_country($idprod, $countrycode)

/**
* Return localtax rate of a product in a particular selling country
*
* @param idprod Id of product
* @package local 1 for localtax1, 2 for localtax 2
* @param countrycode Country code (FR, US, IT, ...)
Expand Down Expand Up @@ -3277,7 +3276,6 @@ function get_default_localtax($societe_vendeuse, $societe_acheteuse, $local, $id

/**
* Return yes or no in current language
*
* @param yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
* @param case 1=Yes/No, 0=yes/no
* @param color 0=texte only, 1=Text is formated with a color font style ('ok' or 'error'), 2=Text is formated with 'ok' color.
Expand Down Expand Up @@ -3306,7 +3304,6 @@ function yn($yesno, $case=1, $color=0)
* Return a path to have a directory according to an id
* Examples: '001' with level 3->"0/0/1/", '015' with level 3->"0/1/5/"
* Examples: 'ABC-1' with level 3 ->"0/0/1/", '015' with level 1->"5/"
*
* @param $num Id to develop
* @param $level Level of development (1, 2 or 3 level)
* @param $alpha Use alpha ref
Expand All @@ -3333,7 +3330,6 @@ function create_exdir($dir)

/**
* Creation of a directory (recursive)
*
* @param $dir Directory to create
* @return int < 0 if KO, 0 = already exists, > 0 if OK
*/
Expand Down Expand Up @@ -3395,7 +3391,6 @@ function dol_mkdir($dir)

/**
* Return picto saying a field is required
*
* @return string Chaine avec picto obligatoire
*/
function picto_required()
Expand All @@ -3406,7 +3401,6 @@ function picto_required()

/**
* Clean a string from all HTML tags and entities
*
* @param StringHtml String to clean
* @param removelinefeed Replace also all lines feeds by a space
* @return string String cleaned
Expand All @@ -3431,8 +3425,7 @@ function dol_string_nohtmltag($StringHtml,$removelinefeed=1)


/**
* Replace CRLF in string with a HTML BR tag
*
* Replace CRLF in string with a HTML BR tag.
* @param stringtoencode String to encode
* @param nl2brmode 0=Adding br before \n, 1=Replacing \n by br
* @param forxml false=Use <br>, true=Use <br />
Expand Down Expand Up @@ -3462,8 +3455,7 @@ function dol_nl2br($stringtoencode,$nl2brmode=0,$forxml=false)
* - writeHTMLCell -> param must be encoded into HTML.
* - MultiCell -> param must not be encoded into HTML.
* Because writeHTMLCell convert also \n into <br>, if function
* is used to build PDF, nl2brmode must be 1
*
* is used to build PDF, nl2brmode must be 1.
* @param stringtoencode String to encode
* @param nl2brmode 0=Adding br before \n, 1=Replacing \n by br (for use with FPDF writeHTMLCell function for example)
* @param pagecodefrom Pagecode stringtoencode is encoded
Expand All @@ -3490,7 +3482,6 @@ function dol_htmlentitiesbr($stringtoencode,$nl2brmode=0,$pagecodefrom='UTF-8')

/**
* This function is called to decode a HTML string (it decodes entities and br tags)
*
* @param stringtodecode String to decode
* @param pagecodeto Page code for result
*/
Expand All @@ -3506,7 +3497,6 @@ function dol_htmlentitiesbr_decode($stringtodecode,$pagecodeto='UTF-8')

/**
* This function remove all ending \n and br at end
*
* @param stringtodecode String to decode
*/
function dol_htmlcleanlastbr($stringtodecode)
Expand All @@ -3517,7 +3507,6 @@ function dol_htmlcleanlastbr($stringtodecode)

/**
* This function is called to decode a string with HTML entities (it decodes entities tags)
*
* @param stringhtml stringhtml
* @param pagecodeto Encoding of input string
* @return string decodestring
Expand All @@ -3530,7 +3519,6 @@ function dol_entity_decode($stringhtml,$pagecodeto='UTF-8')

/**
* Replace html_entity_decode functions to manage errors
*
* @param a
* @param b
* @param c
Expand All @@ -3545,7 +3533,6 @@ function dol_html_entity_decode($a,$b,$c)

/**
* Replace htmlentities functions to manage errors
*
* @param a
* @param b
* @param c
Expand All @@ -3562,8 +3549,7 @@ function dol_htmlentities($a,$b,$c)
/**
* Check if a string is a correct iso string
* If not, it will we considered not HTML encoded even if it is by FPDF.
* Example, if string contains euro symbol that has ascii code 128
*
* Example, if string contains euro symbol that has ascii code 128.
* @param s String to check
* @return int 0 if bad iso, 1 if good iso
*/
Expand All @@ -3584,7 +3570,6 @@ function dol_string_is_good_iso($s)

/**
* Return nb of lines of a clear text
*
* @param s String to check
* @param maxchar Not yet used
* @return int Number of lines
Expand All @@ -3601,7 +3586,6 @@ function dol_nboflines($s,$maxchar=0)

/**
* Return nb of lines of a formated text with \n and <br>
*
* @param text Text
* @param maxlinesize Largeur de ligne en caracteres (ou 0 si pas de limite - defaut)
* @param charset Give the charset used to encode the $text variable in memory.
Expand Down Expand Up @@ -3638,7 +3622,6 @@ function dol_nboflines_bis($text,$maxlinesize=0,$charset='UTF-8')

/**
* Same function than microtime in PHP 5 but compatible with PHP4
*
* @return float Time (millisecondes) with microsecondes in decimal part
*/
function dol_microtime_float()
Expand All @@ -3649,7 +3632,6 @@ function dol_microtime_float()

/**
* Return if a text is a html content
*
* @param msg Content to check
* @param option 0=Full detection, 1=Fast check
* @return boolean true/false
Expand Down Expand Up @@ -4112,8 +4094,7 @@ function verifCond($strRights)

/**
* Replace eval function to add more security.
* This function is called by verifCond()
*
* This function is called by verifCond().
* @param string $s
*/
function dol_eval($s)
Expand Down

0 comments on commit 3ff04be

Please sign in to comment.