Wavyzz/dolibarr
2
0
Fork 1
mirror of https://github.com/Dolibarr/dolibarr.git synced 2025-12-05 17:18:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur
2011-09-12 17:43:31 +00:00
parent d7b943ec0f
commit ac7b8484de
9 changed files with 139 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
htdocs/adherents/class/adherent.class.php
View File

@@ -143,7 +143,7 @@ class Adherent extends CommonObject
* @param addr_bcc email bcc
* @param deliveryreceipt demande accuse reception
* @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
* @param errors_to erros to
* @param errorsto erros to
* @return int <0 if KO, >0 if OK
*/
function send_an_email($text, $subject, $filename_list=array(), $mimetype_list=array(), $mimefilename_list=array(), $addr_cc="", $addr_bcc="", $deliveryreceipt=0, $msgishtml=-1, $errors_to='')
@@ -1454,7 +1454,6 @@ class Adherent extends CommonObject
/**
* Fonction qui dit si cet utilisateur est un redacteur existant dans spip
*
* @return int 1=existe, 0=n'existe pas, -1=erreur
*/
function is_in_spip()
@@ -1477,19 +1476,20 @@ class Adherent extends CommonObject
{
if ($mydb->num_rows($result))
{
// nous avons au moins une reponse
# nous avons au moins une reponse
$mydb->close($result);
return 1;
}
else
{
// nous n'avons pas de reponse => n'existe pas
# nous n'avons pas de reponse => n'existe pas
$mydb->close($result);
return 0;
}
}
else
{
# error
$this->error=$mydb->error();
return -1;
}
@@ -1502,7 +1502,6 @@ class Adherent extends CommonObject
/**
* Subscribe an email to all mailing-lists
*
* @param listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK
*/
@@ -1583,7 +1582,6 @@ class Adherent extends CommonObject
/**
* Unsubscribe an email from all mailing-lists
* Used when a user is resiliated
*
* @param listes To force mailing-list (string separated with ,)
* @return int <=0 if KO, >0 if OK
*/
@@ -1656,7 +1654,6 @@ class Adherent extends CommonObject
/**
* Return full name (civility+' '+name+' '+lastname)
*
* @param langs Language object for translation of civility
* @param option 0=No option, 1=Add civility
* @param nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname
@@ -1694,7 +1691,6 @@ class Adherent extends CommonObject
/**
* Return label of a civility of a contact
*
* @param nohtmlentities 0=Encode with htmlentities for HTML output, 1=No htmlentities for memory translation
* @return string Name translated of civility
*/
@@ -1710,7 +1706,6 @@ class Adherent extends CommonObject
/**
* Renvoie nom clicable (avec eventuellement le picto)
*
* @param withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @param maxlen length max libelle
* @param option Page lien
@@ -1745,7 +1740,6 @@ class Adherent extends CommonObject
/**
* Return full address of member
*
* @param withcountry 1=Add country into address string
* @param sep Separator to use to build string
* @return string Full address string
@@ -1771,7 +1765,6 @@ class Adherent extends CommonObject
/**
* Retourne le libelle du statut d'un adherent (brouillon, valide, resilie)
*
* @param mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
* @return string Libelle
*/
@@ -1782,7 +1775,6 @@ class Adherent extends CommonObject
/**
* Renvoi le libelle d'un statut donne
*
* @param statut Id statut
* @param need_subscription 1 si type adherent avec cotisation, 0 sinon
* @param date_end_subscription Date fin adhesion
@@ -1864,7 +1856,6 @@ class Adherent extends CommonObject
/**
* Charge indicateurs this->nb de tableau de bord
*
* @return int <0 si ko, >0 si ok
*/
function load_state_board()
@@ -1898,7 +1889,6 @@ class Adherent extends CommonObject
/**
* Load indicators for dashboard (this->nbtodo and this->nbtodolate)
*
* @param user Objet user
* @return int <0 if KO, >0 if OK
*/
@@ -1989,7 +1979,6 @@ class Adherent extends CommonObject
/**
* Retourne chaine DN complete dans l'annuaire LDAP pour l'objet
*
* @param info Info string loaded by _load_ldap_info
* @param mode 0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
* 1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb)
@@ -2009,7 +1998,6 @@ class Adherent extends CommonObject
/**
* Initialise tableau info (tableau des attributs LDAP)
*
* @return array Tableau info des attributs
*/
function _load_ldap_info()
@@ -2056,8 +2044,7 @@ class Adherent extends CommonObject
/**
* Charge les informations d'ordre info dans l'objet adherent
*
* @param int $id Id of member to load
* @param id Id du membre a charger
*/
function info($id)
{

63
htdocs/comm/propal/class/propal.class.php
View File

@@ -431,6 +431,7 @@ class Propal extends CommonObject
/**
* Update a proposal line
*
* @param rowid Id de la ligne
* @param pu Prix unitaire (HT ou TTC selon price_base_type)
* @param qty Quantity
@@ -443,7 +444,8 @@ class Propal extends CommonObject
* @param info_bits Miscellanous informations
* @param special_code Set special code ('' = we don't change it)
* @param fk_parent_line Id of line parent
* @return int 0 en cas de succes
* @param skip_update_total Skip update total
* @return int 0 if OK, <0 if KO
*/
function updateline($rowid, $pu, $qty, $remise_percent=0, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0)
{
@@ -543,9 +545,10 @@ class Propal extends CommonObject
/**
* \brief Supprime une ligne de detail
* \param idligne Id de la ligne detail a supprimer
* \return int >0 si ok, <0 si ko
* Supprime une ligne de detail
*
* @param int $lineid Id of line to delete
* @return int >0 if OK, <0 if KO
*/
function deleteline($lineid)
{
@@ -577,7 +580,9 @@ class Propal extends CommonObject
/**
* Create commercial proposal into database
* this->ref can be set or empty. If empty, we will use "(PROVid)"
* @param user User that create
*
* @param User $user User that create
* @param int $notrigger Disable trigger
* @return int <0 if KO, >=0 if OK
*/
function create($user='', $notrigger=0)
@@ -1288,10 +1293,11 @@ class Propal extends CommonObject
}
/**
* \brief Set delivery
* \param user Objet utilisateur qui modifie
* \param delivery delai de livraison
* \return int <0 si ko, >0 si ok
* Set delivery
*
* @param User $user Objet utilisateur qui modifie
* @param int $id Availability id
* @return int <0 if KO, >0 if OK
*/
function set_availability($user, $id)
{
@@ -1316,10 +1322,11 @@ class Propal extends CommonObject
}
/**
* \brief Set source of demand
* \param user Objet utilisateur qui modifie
* \param demand_reason source of demand
* \return int <0 si ko, >0 si ok
* Set source of demand
*
* @param User $user Objet utilisateur qui modifie
* @param int $id Input reason id
* @return int <0 if KO, >0 if OK
*/
function set_demand_reason($user, $id)
{
@@ -1344,10 +1351,11 @@ class Propal extends CommonObject
}
/**
* \brief Positionne numero reference client
* \param user Utilisateur qui modifie
* \param ref_client Reference client
* \return int <0 si ko, >0 si ok
* Positionne numero reference client
*
* @param user Utilisateur qui modifie
* @param ref_client Reference client
* @return int <0 si ko, >0 si ok
*/
function set_ref_client($user, $ref_client)
{
@@ -1802,9 +1810,10 @@ class Propal extends CommonObject
/**
* \brief Change les conditions de reglement de la facture
* \param cond_reglement_id Id de la nouvelle condition de reglement
* \return int >0 si ok, <0 si ko
* Change les conditions de reglement de la facture
*
* @param cond_reglement_id Id de la nouvelle condition de reglement
* @return int >0 if OK, <0 if KO
*/
function cond_reglement($cond_reglement_id)
{
@@ -1836,9 +1845,10 @@ class Propal extends CommonObject
/**
* \brief Change le mode de reglement
* \param mode_reglement Id du nouveau mode
* \return int >0 si ok, <0 si ko
* Change le mode de reglement
*
* @param mode_reglement_id Id du nouveau mode
* @return int >0 if OK, <0 if KO
*/
function mode_reglement($mode_reglement_id)
{
@@ -1869,9 +1879,10 @@ class Propal extends CommonObject
}
/**
* \brief Change le delai de livraison
* \param availability_id Id du nouveau delai de livraison
* \return int >0 si ok, <0 si ko
* Change le delai de livraison
*
* @param availability_id Id du nouveau delai de livraison
* @return int >0 if OK, <0 if KO
*/
function availability($availability_id)
{

42
htdocs/core/class/smtps.class.php
View File

@@ -261,19 +261,14 @@ class SMTPs
}
// =============================================================
function setDebug( $_vDebug = false )
{
$this->_debug = $_vDebug;
}
// ** Class methods
/**
* build RECIPIENT List, all addresses who will recieve this message
*
* @param void
* @return void
*/
function buildRCPTlist()
@@ -285,7 +280,6 @@ class SMTPs
/**
* Attempt a connection to mail server
*
* @param void
* @return mixed $_retVal Boolean indicating success or failure on connection
*/
function _server_connect()
@@ -343,7 +337,6 @@ class SMTPs
/**
* Attempt mail server authentication for a secure connection
*
* @param void
* @return mixed $_retVal Boolean indicating success or failure of authentication
*/
function _server_authenticate()
@@ -544,7 +537,6 @@ class SMTPs
* - 'pipe [1] - use UNIX path to EXE
* - 'phpmail [2] - use the PHP built-in mail function
*
* @param void
* @return int $_strHost Host Name or IP of the Mail Server to use
*/
function getTransportType()
@@ -586,7 +578,6 @@ class SMTPs
* Retrieves the Host Name or IP of the Mail Server to use
* This is used only with 'socket' based mail transmission
*
* @param void
* @return string $_strHost Host Name or IP of the Mail Server to use
*/
function getHost()
@@ -613,7 +604,6 @@ class SMTPs
* Retrieves the Port Number of the Mail Server to use
* This is used only with 'socket' based mail transmission
*
* @param void
* @return string $_smtpsPort Port Number of the Mail Server to use
*/
function getPort()
@@ -635,7 +625,6 @@ class SMTPs
/**
* Retrieves the User Name for authentication on Mail Server
*
* @param void
* @return string _smtpsID User Name for authentication on Mail Server
*/
function getID()
@@ -657,7 +646,6 @@ class SMTPs
/**
* Retrieves the User Password for authentication on Mail Server
*
* @param void
* @return string $_smtpsPW User Password for authentication on Mail Server
*/
function getPW()
@@ -681,7 +669,6 @@ class SMTPs
/**
* Retrieves the Character set used for current message
*
* @param void
* @return string $_smtpsCharSet Character set used for current message
*/
function getCharSet()
@@ -713,7 +700,6 @@ class SMTPs
/**
* Retrieves the Content-Transfer-Encoding
*
* @param void
* @return string $_smtpsTransEncode Content-Transfer-Encoding
*/
function getTransEncode()
@@ -746,9 +732,7 @@ class SMTPs
/**
* Retrieves the Content-Transfer-Encoding
*
* @param void
* @return string $_smtpsTransEncode Content-Transfer-Encoding
*
*/
function getTransEncodeType()
{
@@ -761,7 +745,7 @@ class SMTPs
/**
* FROM Address from which mail will be sent
*
* @param string $_msgFrom Address from which mail will be sent
* @param string $_strFrom Address from which mail will be sent
* @return void
*/
function setFrom($_strFrom)
@@ -773,8 +757,8 @@ class SMTPs
/**
* Retrieves the Address from which mail will be sent
*
* @param boolean $_strip To "strip" 'Real name' from address
* @return string $_msgFrom Address from which mail will be sent
* @param boolean $_part To "strip" 'Real name' from address
* @return string Address from which mail will be sent
*/
function getFrom($_part = true)
{
@@ -870,7 +854,6 @@ class SMTPs
* - $_aryEmail[host] = "domain.tld"
* - $_aryEmail[user] = "userName"
*
* @param void
* @return array $_aryEmail An array of the various parts of an email address
*/
function _strip_email($_strAddr)
@@ -913,7 +896,6 @@ class SMTPs
* This is a "build as you go" method. Each time this method is called
* the underlaying array is destroyed and reconstructed.
*
* @param void
* @return array $_RCPT_list Returns an array of bares addresses
*/
function get_RCPT_list()
@@ -1005,7 +987,6 @@ class SMTPs
/**
* Retrieves the TO Address[es] inwhich to send mail to
*
* @param void
* @return string $_msgRecipients TO Address[es] inwhich to send mail to
*/
function getTo()
@@ -1028,7 +1009,6 @@ class SMTPs
/**
* Retrieves the CC Address[es] inwhich to send mail to
*
* @param void
* @return string $_msgRecipients CC Address[es] inwhich to send mail to
*/
function getCC()
@@ -1051,7 +1031,6 @@ class SMTPs
/**
* Retrieves the BCC Address[es] inwhich to send mail to
*
* @param void
* @return string $_msgRecipients BCC Address[es] inwhich to send mail to
*/
function getBCC()
@@ -1074,7 +1053,6 @@ class SMTPs
/**
* Retrieves the Message Subject
*
* @param void
* @return string $_msgSubject Message Subject
*/
function getSubject()
@@ -1085,7 +1063,6 @@ class SMTPs
/**
* Constructes and returns message header
*
* @param void
* @return string Complete message header
*/
function getHeader()
@@ -1163,8 +1140,7 @@ class SMTPs
/**
* Retrieves the Message Content
*
* @param void
* @return string $_msgContent Message Content
* @return string Message Content
*/
function getBodyContent()
{
@@ -1438,7 +1414,6 @@ class SMTPs
/**
* Gets flag which determines whether to calculate message MD5 checksum.
*
* @param void
* @return string $_value Message Priority
*/
function getMD5flag()
@@ -1463,7 +1438,6 @@ class SMTPs
/**
* Retrieves the Message X-Header Content
*
* @param void
* @return string $_msgContent Message X-Header Content
*/
function getXheader()
@@ -1474,7 +1448,6 @@ class SMTPs
/**
* Generates Random string for MIME message Boundary
*
* @param void
* @return void
*/
function _setBoundary()
@@ -1485,7 +1458,6 @@ class SMTPs
/**
* Retrieves the MIME message Boundary
*
* @param void
* @return string $_smtpsBoundary MIME message Boundary
*/
function _getBoundary()
@@ -1557,7 +1529,6 @@ class SMTPs
/**
* Returns errors codes and messages for Class
*
* @param void
* @return string $_errMsg Error Message
*/
function getErrors()
@@ -1573,10 +1544,9 @@ class SMTPs
}
// =============================================================
} // end of Class
}
// =============================================================
// =============================================================
// ** CSV Version Control Info

40
htdocs/lib/pdf.lib.php
View File

@@ -198,6 +198,7 @@ function pdf_format_address($outputlangs,$object)
/**
* Return a string with full address formated
*
* @param outputlangs Output langs object
* @param sourcecompany Source company object
* @param targetcompany Target company object
@@ -296,9 +297,10 @@ function pdf_build_address($outputlangs,$sourcecompany,$targetcompany='',$target
/**
* Show header of page for PDF generation
* @param pdf Object PDF
* @param outputlang Object lang for output
* @param page_height
*
* @param PDF $pdf Object PDF
* @param Translate $outputlang Object lang for output
* @param int $page_height Height of page
*/
function pdf_pagehead(&$pdf,$outputlangs,$page_height)
{
@@ -314,10 +316,11 @@ function pdf_pagehead(&$pdf,$outputlangs,$page_height)
/**
* Add a draft watermark on PDF files
*
* @param pdf Object PDF
* @param outputlangs Object lang
* @param height Height of PDF
* @param width Width of PDF
* @param h Height of PDF
* @param w Width of PDF
* @param unit Unit of height (mmn, pt, ...)
* @param text Text to show
*/
@@ -492,8 +495,9 @@ function pdf_bank(&$pdf,$outputlangs,$curx,$cury,$account,$onlynumber=0)
/**
* Show footer of page for PDF generation
*
* @param pdf The PDF factory
* @param outputlang Object lang for output
* @param outputlangs Object lang for output
* @param paramfreetext Constant name of free text
* @param fromcompany Object company
* @param marge_basse Margin bottom
@@ -688,17 +692,19 @@ function pdf_pagefoot(&$pdf,$outputlangs,$paramfreetext,$fromcompany,$marge_bass
/**
* Output line description into PDF
* @param pdf PDF object
* @param object Object
* @param i Current line number
* @param outputlang Object lang for output
* @param w
* @param h
* @param posx
* @param posy
* @param hideref Hide reference
* @param hidedesc Hide description
* @param issupplierline Is it a line for a supplier object ?
*
* @param PDF $pdf PDF object
* @param Object $object Object
* @param int $i Current line number
* @param Translate $outputlangs Object lang for output
* @param int $w Width
* @param int $h Height
* @param int $posx Pos x
* @param int $posy Pos y
* @param int $hideref Hide reference
* @param int $hidedesc Hide description
* @param int $issupplierline Is it a line for a supplier object ?
* @param HookManager $hookmanager Instance of HookManager
*/
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0,$hookmanager=false)
{

21
htdocs/main.inc.php
View File

@@ -85,6 +85,7 @@ function test_sql_and_script_inject($val, $get)
if ($get) $sql_inj += preg_match('/"/i', $val); // We refused " in GET parameters value
return $sql_inj;
}
/**
* Security: Return true if OK, false otherwise
*
@@ -784,17 +785,17 @@ if (! function_exists("llxHeader"))
{
/**
* Show HTML header HTML + BODY + Top menu + left menu + DIV
* @param head Add optionnal head lines
* @param title Title of web page
* @param help_url Url links to help page
*
* @param string $head Optionnal head lines
* @param string $title HTML title
* @param string $help_url Url links to help page
* Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage
* For other external page: http://server/url
* @param target Target to use in menu links
* @param disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax)
* @param disablehead Do not output head section
* @param arrayofjs Array of js files to add in header
* @param arrayofcss Array of css files to add in header
* @param morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)
* @param int $disablejs More content into html header
* @param int $disablehead More content into html header
* @param array $arrayofjs Array of complementary js files
* @param array $arrayofcss Array of complementary css files
* @param string $morequerystring Query string to add to the link "print" to get same parameters (use only if autodetect fails)
*/
function llxHeader($head = '', $title='', $help_url='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='')
{
@@ -829,7 +830,7 @@ function top_httphead()
* @param int $disablehead More content into html header
* @param array $arrayofjs Array of complementary js files
* @param array $arrayofcss Array of complementary css files
* @return none
* @return void
*/
function top_htmlhead($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='')
{

11
htdocs/product/canvas/product/actions_card_product.class.php
View File

@@ -72,17 +72,6 @@ class ActionsCardProduct extends Product
return $langs->trans("Products");
}
/**
* \brief Lecture des donnees dans la base
* \param id Product id
*/
function fetch($id='', $ref='', $action='')
{
$result = parent::fetch($id);
return $result;
}
/**
* Assign custom values for canvas (for example into this->tpl to be used by templates)
*

11
htdocs/product/canvas/service/actions_card_service.class.php
View File

@@ -72,17 +72,6 @@ class ActionsCardService extends Product
return $langs->trans("Products");
}
/**
* \brief Lecture des donnees dans la base
* \param id Product id
*/
function fetch($id='', $ref='', $action='')
{
$result = parent::fetch($id);
return $result;
}
/**
* Assign custom values for canvas (for example into this->tpl to be used by templates)
*

5
htdocs/societe/canvas/default/actions_card_default.class.php
View File

@@ -69,7 +69,8 @@ class ActionsCardDefault extends ActionsCardCommon
/**
* Execute actions
* @param Id of object (may be empty for creation)
*
* @param int $socid Id of object (may be empty for creation)
*/
function doActions($socid)
{
@@ -81,7 +82,7 @@ class ActionsCardDefault extends ActionsCardCommon
/**
* Assign custom values for canvas (for example into this->tpl to be used by templates)
*
* @param action Type of action
* @param string $action Type of action
*/
function assign_values($action='')
{

5
htdocs/societe/canvas/individual/actions_card_individual.class.php
View File

@@ -69,7 +69,8 @@ class ActionsCardIndividual extends ActionsCardCommon
/**
* Execute actions
* @param Id of object (may be empty for creation)
*
* @param int $socid Id of object (may be empty for creation)
*/
function doActions($socid)
{
@@ -81,7 +82,7 @@ class ActionsCardIndividual extends ActionsCardCommon
/**
* Assign custom values for canvas (for example into this->tpl to be used by templates)
*
* @param action Type of action
* @param string $action Type of action
*/
function assign_values($action='')
{