diff --git a/htdocs/comm/action/class/actioncomm.class.php b/htdocs/comm/action/class/actioncomm.class.php index 24209a51fdcc34dba31b15e0324b099a3a3eda4b..2ed8ac14ba2ea9a484f2a51dc1eb6bee7ad9b51f 100644 --- a/htdocs/comm/action/class/actioncomm.class.php +++ b/htdocs/comm/action/class/actioncomm.class.php @@ -462,11 +462,12 @@ class ActionComm extends CommonObject } /** - * Load all objects with filters - * @param socid Filter by thirdparty - * @param fk_element Id of element action is linked to - * @param elementtype Type of element action is linked to - * @param filter Other filter + * Load all objects with filters + * + * @param int $socid Filter by thirdparty + * @param int $fk_element Id of element action is linked to + * @param string $elementtype Type of element action is linked to + * @param filter Other filter */ function getActions($socid=0, $fk_element=0, $elementtype='', $filter='') { @@ -511,8 +512,9 @@ class ActionComm extends CommonObject /** * Load indicators for dashboard (this->nbtodo and this->nbtodolate) - * @param user Objet user - * @return int <0 if KO, >0 if OK + * + * @param User $user Objet user + * @return int <0 if KO, >0 if OK */ function load_board($user) { @@ -603,9 +605,9 @@ class ActionComm extends CommonObject /** * Return label of status * - * @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto - * @param hidenastatus 1=Show nothing if status is "Not applicable" - * @return string String with status + * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto + * @param int $hidenastatus 1=Show nothing if status is "Not applicable" + * @return string String with status */ function getLibStatut($mode,$hidenastatus=0) { @@ -615,10 +617,10 @@ class ActionComm extends CommonObject /** * Return label of action status * - * @param percent Percent - * @param mode 0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Very short label+Picto - * @param hidenastatus 1=Show nothing if status is "Not applicable" - * @return string Label + * @param int $percent Percent + * @param int $mode 0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Very short label+Picto + * @param int $hidenastatus 1=Show nothing if status is "Not applicable" + * @return string Label */ function LibStatut($percent,$mode,$hidenastatus=0) { @@ -680,12 +682,12 @@ class ActionComm extends CommonObject * Renvoie nom clicable (avec eventuellement le picto) * Utilise $this->id, $this->code et $this->label * - * @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul - * @param maxlength Nombre de caracteres max dans libelle - * @param classname Force style class on a link - * @param option ''=Link to action,'birthday'=Link to contact - * @param overwritepicto 1=Overwrite picto - * @return string Chaine avec URL + * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul + * @param int $maxlength Nombre de caracteres max dans libelle + * @param string $classname Force style class on a link + * @param string $option ''=Link to action,'birthday'=Link to contact + * @param int $overwritepicto 1=Overwrite picto + * @return string Chaine avec URL */ function getNomUrl($withpicto=0,$maxlength=0,$classname='',$option='',$overwritepicto='') { @@ -726,12 +728,12 @@ class ActionComm extends CommonObject /** * Export events from database into a cal file. * - * @param format 'vcal', 'ical/ics', 'rss' - * @param type 'event' or 'journal' - * @param cachedelay Do not rebuild file if date older than cachedelay seconds - * @param filename Force filename - * @param filters Array of filters - * @return int <0 if error, nb of events in new file if ok + * @param string $format 'vcal', 'ical/ics', 'rss' + * @param string $type 'event' or 'journal' + * @param int $cachedelay Do not rebuild file if date older than cachedelay seconds + * @param string $filename Force filename + * @param filters Array of filters + * @return int <0 if error, nb of events in new file if ok */ function build_exportfile($format,$type,$cachedelay,$filename,$filters) { diff --git a/htdocs/comm/action/class/ical.class.php b/htdocs/comm/action/class/ical.class.php index 6bb6ae8f557fe125353cd48f424c15682699d471..c3a3c52be061178d24ebc926a86791972104de4a 100644 --- a/htdocs/comm/action/class/ical.class.php +++ b/htdocs/comm/action/class/ical.class.php @@ -1,7 +1,7 @@ <?php /* Copyright (C) 2006 Roman Ozana <ozana@omdesign.cz> * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es> - * Copyright (C) 2011 Laurent Destailleur <eldy@users.sourceforge.net> + * Copyright (C) 2012 Laurent Destailleur <eldy@users.sourceforge.net> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -41,13 +41,13 @@ class ical /** * Read text file, icalender text file * - * @param string $file - * @return string + * @param string $file File + * @return string */ function read_file($file) { $this->file = $file; - $file_text = join ("", file ($file)); //load file + $file_text = join("", file ($file)); //load file $file_text = preg_replace("/[\r\n]{1,} ([:;])/","\\1",$file_text); return $file_text; // return all text @@ -76,8 +76,8 @@ class ical /** * Translate Calendar * - * @param string $uri - * @return array + * @param string $uri Url + * @return array */ function parse($uri) { @@ -157,9 +157,9 @@ class ical /** * Add to $this->ical array one value and key. Type is VTODO, VEVENT, VFREEBUSY, VCALENDAR ... . * - * @param string $type - * @param string $key - * @param string $value + * @param string $type Type + * @param string $key Key + * @param string $value Value */ function add_to_array($type, $key, $value) { @@ -216,8 +216,8 @@ class ical /** * Parse text "XXXX:value text some with : " and return array($key = "XXXX", $value="value"); * - * @param string $text - * @return array + * @param string $text Text + * @return array */ function retun_key_value($text) { @@ -238,8 +238,8 @@ class ical /** * Parse RRULE return array * - * @param string $value - * @return array + * @param string $value string + * @return array */ function ical_rrule($value) { @@ -254,8 +254,8 @@ class ical /** * Return Unix time from ical date time fomrat (YYYYMMDD[T]HHMMSS[Z] or YYYYMMDD[T]HHMMSS) * - * @param unknown_type $ical_date - * @return timestamp + * @param string $ical_date String date + * @return timestamp */ function ical_date_to_unix($ical_date) { @@ -275,9 +275,9 @@ class ical /** * Return unix date from iCal date format * - * @param string $key - * @param string $value - * @return array + * @param string $key Key + * @param string $value Value + * @return array */ function ical_dt_date($key, $value) { @@ -321,9 +321,9 @@ class ical /** * Compare two unix timestamp * - * @param array $a - * @param array $b - * @return integer + * @param array $a Operand a + * @param array $b Operand b + * @return integer */ function ical_dtstart_compare($a, $b) { @@ -351,7 +351,7 @@ class ical } /** - * Return todo array (not sort todo array) + * Return to do array (not sort to do array) * * @return array */ diff --git a/htdocs/comm/action/fiche.php b/htdocs/comm/action/fiche.php index f33a72b91836adc77593de030acce7255dba02a6..4e74163622a6c18b9470d5eb57ef33c6a366b865 100644 --- a/htdocs/comm/action/fiche.php +++ b/htdocs/comm/action/fiche.php @@ -1,6 +1,6 @@ <?php /* Copyright (C) 2001-2005 Rodolphe Quiedeville <rodolphe@quiedeville.org> - * Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net> + * Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2005 Simon TOSSER <simon@kornog-computing.com> * Copyright (C) 2005-2011 Regis Houssin <regis@dolibarr.fr> * Copyright (C) 2010 Juanjo Menent <jmenent@2byte.es> @@ -427,8 +427,8 @@ if ($action == 'create') print '<input type="hidden" name="action" value="add_action">'; if (GETPOST("backtopage")) print '<input type="hidden" name="backtopage" value="'.(GETPOST("backtopage") != 1 ? GETPOST("backtopage") : $_SERVER["HTTP_REFERER"]).'">'; - if (GETPOST("actioncode") == 'AC_RDV') print_fiche_titre ($langs->trans("AddActionRendezVous")); - else print_fiche_titre ($langs->trans("AddAnAction")); + if (GETPOST("actioncode") == 'AC_RDV') print_fiche_titre($langs->trans("AddActionRendezVous")); + else print_fiche_titre($langs->trans("AddAnAction")); dol_htmloutput_mesg($mesg); @@ -986,8 +986,9 @@ llxFooter(); /** - * \brief Ajoute une ligne de tableau a 2 colonnes pour avoir l'option synchro calendrier - * \return int Retourne le nombre de lignes ajoutees + * Ajoute une ligne de tableau a 2 colonnes pour avoir l'option synchro calendrier + * + * @return int Retourne le nombre de lignes ajoutees */ function add_row_for_calendar_link() { diff --git a/htdocs/comm/action/index.php b/htdocs/comm/action/index.php index 3f3a63a29853186881d68175dc42d3622f7ab5b3..f61a49bbc90f65fa633c96cd6c1c4c41c1176af8 100644 --- a/htdocs/comm/action/index.php +++ b/htdocs/comm/action/index.php @@ -653,13 +653,13 @@ if (empty($action) || $action == 'show_month') // View by month { $style='cal_other_month'; echo ' <td class="'.$style.'" width="14%" valign="top" nowrap="nowrap">'; - show_day_events ($db, $max_day_in_prev_month + $tmpday, $prev_month, $prev_year, $month, $style, $eventarray, $conf->global->AGENDA_MAX_EVENTS_DAY_VIEW, $maxnbofchar, $newparam); + show_day_events($db, $max_day_in_prev_month + $tmpday, $prev_month, $prev_year, $month, $style, $eventarray, $conf->global->AGENDA_MAX_EVENTS_DAY_VIEW, $maxnbofchar, $newparam); echo " </td>\n"; } /* Show days of the current month */ elseif(($tmpday <= $max_day_in_month)) { - $curtime = dol_mktime (0, 0, 0, $month, $tmpday, $year); + $curtime = dol_mktime(0, 0, 0, $month, $tmpday, $year); $style='cal_current_month'; $today=0; @@ -714,7 +714,7 @@ elseif ($action == 'show_week') // View by week if(($tmpday <= $max_day_in_month)) { // Show days of the current week - $curtime = dol_mktime (0, 0, 0, $month, $tmpday, $year); + $curtime = dol_mktime(0, 0, 0, $month, $tmpday, $year); $style='cal_current_month'; $today=0; @@ -763,7 +763,7 @@ else // View by day echo " <tr>\n"; echo ' <td class="'.$style.'" width="14%" valign="top" nowrap="nowrap">'; $maxnbofchar=80; - show_day_events ($db, $day, $month, $year, $month, $style, $eventarray, 0, $maxnbofchar, $newparam, 1, 300); + show_day_events($db, $day, $month, $year, $month, $style, $eventarray, 0, $maxnbofchar, $newparam, 1, 300); echo "</td>\n"; echo " </tr>\n"; echo '</table>'; @@ -791,18 +791,19 @@ llxFooter(); /** * Show event of a particular day - * @param $db Database handler - * @param $day Day - * @param $month Month - * @param $year Year - * @param $monthshown Current month shown in calendar view - * @param $style Style to use for this day - * @param $eventarray Array of events - * @param $maxPrint Nb of actions to show each day on month view (0 means non limit) - * @param $maxnbofchar Nb of characters to show for event line - * @param $newparam Parameters on current URL - * @param $showinfo Add extended information (used by day view) - * @param $minheight Minimum height for each event. 60px by default. + * + * @param DoliDB $db Database handler + * @param int $day Day + * @param int $month Month + * @param int $year Year + * @param int $monthshown Current month shown in calendar view + * @param string $style Style to use for this day + * @param array $eventarray Array of events + * @param int $maxPrint Nb of actions to show each day on month view (0 means non limit) + * @param int $maxnbofchar Nb of characters to show for event line + * @param string $newparam Parameters on current URL + * @param int $showinfo Add extended information (used by day view) + * @param int $minheight Minimum height for each event. 60px by default. */ function show_day_events($db, $day, $month, $year, $monthshown, $style, &$eventarray, $maxPrint=0, $maxnbofchar=16, $newparam='', $showinfo=0, $minheight=60) { @@ -814,7 +815,7 @@ function show_day_events($db, $day, $month, $year, $monthshown, $style, &$eventa if ($_GET["maxprint"] == 'on') $maxPrint=0; // Force to remove limits print '<div id="dayevent_'.sprintf("%04d",$year).sprintf("%02d",$month).sprintf("%02d",$day).'" class="dayevent">'."\n"; - $curtime = dol_mktime (0, 0, 0, $month, $day, $year); + $curtime = dol_mktime(0, 0, 0, $month, $day, $year); print '<table class="nobordernopadding" width="100%">'; print '<tr style="background: #EEEEEE"><td align="left" nowrap="nowrap">'; print '<a href="'.DOL_URL_ROOT.'/comm/action/index.php?';