lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-07-04 09:36:29 +00:00
parent 8ca0718d5e
commit 0a7b70cf73
7 changed files with 399 additions and 378 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
htdocs/comm/action/class/actioncomm.class.php
View File

@ -23,7 +23,7 @@
* \file htdocs/comm/action/class/actioncomm.class.php * \file htdocs/comm/action/class/actioncomm.class.php
* \ingroup commercial * \ingroup commercial
* \brief File of class to manage agenda events (actions) * \brief File of class to manage agenda events (actions)
* \version $Id: actioncomm.class.php,v 1.41 2011/06/30 07:52:43 eldy Exp $ * \version $Id: actioncomm.class.php,v 1.42 2011/07/04 09:36:29 eldy Exp $
*/ */
require_once(DOL_DOCUMENT_ROOT.'/comm/action/class/cactioncomm.class.php'); require_once(DOL_DOCUMENT_ROOT.'/comm/action/class/cactioncomm.class.php');
require_once(DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php'); require_once(DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php');
@ -392,6 +392,8 @@ class ActionComm extends CommonObject
/** /**
* Load all objects with filters * Load all objects with filters
* @param socid Filter by thirdparty * @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 * @param filter Other filter
*/ */
function getActions($socid=0, $fk_element=0, $elementtype='', $filter='') function getActions($socid=0, $fk_element=0, $elementtype='', $filter='')
@ -603,7 +605,7 @@ class ActionComm extends CommonObject
* Utilise $this->id, $this->code et $this->label * 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 withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
* @param maxlength Nombre de caracteres max dans libelle * @param maxlength Nombre de caracteres max dans libelle
* @param class Force style class on a link * @param classname Force style class on a link
* @param option ''=Link to action,'birthday'=Link to contact * @param option ''=Link to action,'birthday'=Link to contact
* @return string Chaine avec URL * @return string Chaine avec URL
*/ */

105
htdocs/commande/class/commande.class.php
View File

@ -25,7 +25,7 @@
* \file htdocs/commande/class/commande.class.php * \file htdocs/commande/class/commande.class.php
* \ingroup commande * \ingroup commande
* \brief Fichier des classes de commandes * \brief Fichier des classes de commandes
* \version $Id: commande.class.php,v 1.116 2011/06/30 13:27:20 hregis Exp $ * \version $Id: commande.class.php,v 1.117 2011/07/04 09:36:29 eldy Exp $
*/ */
require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php"); require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php");
require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php"); require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php");
@ -570,9 +570,10 @@ class Commande extends CommonObject
/** /**
* Create order * Create order
* Note that this->ref can be set or empty. If empty, we will use "(PROV)"
* @param user Objet user that make creation * @param user Objet user that make creation
* @param notrigger Disable all triggers
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
* remarks this->ref can be set or empty. If empty, we will use "(PROV)"
*/ */
function create($user, $notrigger=0) function create($user, $notrigger=0)
{ {
@ -1126,9 +1127,9 @@ class Commande extends CommonObject
* $this->client doit etre charge * $this->client doit etre charge
* @param idproduct Id du produit a ajouter * @param idproduct Id du produit a ajouter
* @param qty Quantite * @param qty Quantite
* @param remise_percent Remise relative effectuee sur le produit
* @param date_start Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html) * @param date_start Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @param date_end End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html) * @param date_end End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @remise_percent remise_percent Remise relative effectuee sur le produit
* @return void * @return void
* TODO Remplacer les appels a cette fonction par generation objet Ligne * TODO Remplacer les appels a cette fonction par generation objet Ligne
* insere dans tableau $this->products * insere dans tableau $this->products
@ -1330,9 +1331,9 @@ class Commande extends CommonObject
/** /**
* \brief Ajout d'une ligne remise fixe dans la commande, en base * Ajout d'une ligne remise fixe dans la commande, en base
* \param idremise Id de la remise fixe * @param idremise Id de la remise fixe
* \return int >0 si ok, <0 si ko * @return int >0 si ok, <0 si ko
*/ */
function insert_discount($idremise) function insert_discount($idremise)
{ {
@ -1405,9 +1406,9 @@ class Commande extends CommonObject
/** /**
* \brief Reinitialize array lignes * Load array lines
* \param only_product Return only physical products * @param only_product Return only physical products
* \return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function fetch_lines($only_product=0) function fetch_lines($only_product=0)
{ {
@ -1588,10 +1589,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Renvoie un tableau avec les stocks restant par produit * Renvoie un tableau avec les stocks restant par produit
* \param filtre_statut Filtre sur statut * @param filtre_statut Filtre sur statut
* \return int 0 si OK, <0 si KO * @return int 0 si OK, <0 si KO
* \todo FONCTION NON FINIE A FINIR * TODO FONCTION NON FINIE A FINIR
*/ */
function stock_array($filtre_statut=-1) function stock_array($filtre_statut=-1)
{ {
@ -1625,9 +1626,9 @@ class Commande extends CommonObject
} }
/** /**
* \brief Supprime une ligne de la commande * Delete an order line
* \param idligne Id de la ligne a supprimer * @param lineid Id of line to delete
* \return int >0 si ok, 0 si rien a supprimer, <0 si ko * @return int >0 if OK, 0 if nothing to do, <0 if KO
*/ */
function deleteline($lineid) function deleteline($lineid)
{ {
@ -1700,10 +1701,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Applique une remise relative * Applique une remise relative
* \param user User qui positionne la remise * @param user User qui positionne la remise
* \param remise * @param remise
* \return int <0 si ko, >0 si ok * @return int <0 if KO, >0 if OK
*/ */
function set_remise($user, $remise) function set_remise($user, $remise)
{ {
@ -1733,10 +1734,10 @@ class Commande extends CommonObject
/** /**
* \brief Applique une remise absolue * Applique une remise absolue
* \param user User qui positionne la remise * @param user User qui positionne la remise
* \param remise * @param remise
* \return int <0 si ko, >0 si ok * @return int <0 if KO, >0 if OK
*/ */
function set_remise_absolue($user, $remise) function set_remise_absolue($user, $remise)
{ {
@ -1769,8 +1770,8 @@ class Commande extends CommonObject
/** /**
* Set the order date * Set the order date
* @param user Object user * @param user Object user making change
* @param date_livraison Date delivery * @param date Date
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function set_date($user, $date) function set_date($user, $date)
@ -1802,10 +1803,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Set the planned delivery date * Set the planned delivery date
* \param user Objet utilisateur qui modifie * @param user Objet utilisateur qui modifie
* \param date_livraison Date de livraison * @param date_livraison Date de livraison
* \return int <0 si ko, >0 si ok * @return int <0 si ko, >0 si ok
*/ */
function set_date_livraison($user, $date_livraison) function set_date_livraison($user, $date_livraison)
{ {
@ -1836,10 +1837,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Definit une adresse de livraison * Set address
* \param user Objet utilisateur qui modifie * @param user Object user making change
* \param adresse_livraison Adresse de livraison * @param fk_address Adress of delivery
* \return int <0 si ko, >0 si ok * @return int <0 ig KO, >0 if Ok
*/ */
function set_adresse_livraison($user, $fk_address) function set_adresse_livraison($user, $fk_address)
{ {
@ -1863,10 +1864,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Set delivery * Set availability
* \param user Objet utilisateur qui modifie * @param user Object user making change
* \param delivery delai de livraison * @param id If of availability delay
* \return int <0 si ko, >0 si ok * @return int <0 if KO, >0 if OK
*/ */
function set_availability($user, $id) function set_availability($user, $id)
{ {
@ -1891,10 +1892,10 @@ class Commande extends CommonObject
} }
/** /**
* \brief Set source of demand * Set source of demand
* \param user Objet utilisateur qui modifie * @param user Object user making change
* \param delivery delai de livraison * @param id Id of source
* \return int <0 si ko, >0 si ok * @return int <0 if KO, >0 if OK
*/ */
function set_demand_reason($user, $id) function set_demand_reason($user, $id)
{ {
@ -1963,9 +1964,9 @@ class Commande extends CommonObject
} }
/** /**
* \brief Change les conditions de reglement de la commande * Change les conditions de reglement de la commande
* \param cond_reglement_id Id de la nouvelle condition de reglement * @param cond_reglement_id Id de la nouvelle condition de reglement
* \return int >0 si ok, <0 si ko * @return int >0 if OK, <0 if KO
*/ */
function cond_reglement($cond_reglement_id) function cond_reglement($cond_reglement_id)
{ {
@ -2030,9 +2031,9 @@ class Commande extends CommonObject
} }
/** /**
* \brief Change le delai de livraison * Change le delai de livraison
* \param mode Id du nouveau mode * @param availability_id Id du nouveau mode
* \return int >0 si ok, <0 si ko * @return int >0 if OK, <0 if KO
*/ */
function availability($availability_id) function availability($availability_id)
{ {
@ -2280,9 +2281,9 @@ class Commande extends CommonObject
/** /**
* \brief Delete the customer order * Delete the customer order
* \user User object * @param user User object
* \return int <=0 if KO, >0 if OK * @return int <=0 if KO, >0 if OK
*/ */
function delete($user) function delete($user)
{ {
@ -2518,6 +2519,8 @@ class Commande extends CommonObject
* Return clicable link of object (with eventually picto) * Return clicable link of object (with eventually picto)
* @param withpicto Add picto into link * @param withpicto Add picto into link
* @param option Where point the link * @param option Where point the link
* @param max Max length to show
* @param short Use short labels
* @return string String with URL * @return string String with URL
*/ */
function getNomUrl($withpicto=0,$option=0,$max=0,$short=0) function getNomUrl($withpicto=0,$option=0,$max=0,$short=0)

12
htdocs/contact/class/contact.class.php
View File

@ -25,7 +25,7 @@
* \file htdocs/contact/class/contact.class.php * \file htdocs/contact/class/contact.class.php
* \ingroup societe * \ingroup societe
* \brief File of contacts class * \brief File of contacts class
* \version $Id$ * \version $Id: contact.class.php,v 1.30 2011/07/04 09:36:29 eldy Exp $
*/ */
require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php"); require_once(DOL_DOCUMENT_ROOT ."/core/class/commonobject.class.php");
@ -83,7 +83,6 @@ class Contact extends CommonObject
/** /**
* Constructor of class Contact * Constructor of class Contact
* @param DB Habler d'acces base * @param DB Habler d'acces base
* @param id Id contact
*/ */
function Contact($DB) function Contact($DB)
{ {
@ -583,7 +582,7 @@ class Contact extends CommonObject
} }
/* /**
* \brief Charge le nombre d'elements auquel est lie ce contact * \brief Charge le nombre d'elements auquel est lie ce contact
* ref_facturation * ref_facturation
* ref_contrat * ref_contrat
@ -626,9 +625,10 @@ class Contact extends CommonObject
} }
} }
/* /**
* \brief Efface le contact de la base * Efface le contact de la base
* \return int <0 si ko, >0 si ok * @param notrigger Disable all trigger
* @return int <0 if KO, >0 if OK
*/ */
function delete($notrigger=0) function delete($notrigger=0)
{ {

37
htdocs/core/class/commonobject.class.php
View File

@ -22,7 +22,7 @@
* \file htdocs/core/class/commonobject.class.php * \file htdocs/core/class/commonobject.class.php
* \ingroup core * \ingroup core
* \brief File of parent class of all other business classes (invoices, contracts, proposals, orders, ...) * \brief File of parent class of all other business classes (invoices, contracts, proposals, orders, ...)
* \version $Id: commonobject.class.php,v 1.143 2011/07/01 23:05:39 eldy Exp $ * \version $Id: commonobject.class.php,v 1.144 2011/07/04 09:36:29 eldy Exp $
*/ */
@ -78,11 +78,12 @@ class CommonObject
} }
/** /**
* \brief Add a link between element $this->element and a contact * Add a link between element $this->element and a contact
* \param fk_socpeople Id of contact to link * @param fk_socpeople Id of contact to link
* \param type_contact Type of contact (code or id) * @param type_contact Type of contact (code or id)
* \param source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user) * @param source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)
* \return int <0 if KO, >0 if OK * @param notrigger Disable all triggers
* @return int <0 if KO, >0 if OK
*/ */
function add_contact($fk_socpeople, $type_contact, $source='external',$notrigger=0) function add_contact($fk_socpeople, $type_contact, $source='external',$notrigger=0)
{ {
@ -168,11 +169,11 @@ class CommonObject
} }
/** /**
* \brief Update a link to contact line * Update a link to contact line
* \param rowid Id of line contact-element * @param rowid Id of line contact-element
* \param statut New status of link * @param statut New status of link
* \param type_contact_id Id of contact type * @param type_contact_id Id of contact type
* \return int <0 if KO, >= 0 if OK * @return int <0 if KO, >= 0 if OK
*/ */
function update_contact($rowid, $statut, $type_contact_id) function update_contact($rowid, $statut, $type_contact_id)
{ {
@ -194,9 +195,10 @@ class CommonObject
} }
/** /**
* \brief Delete a link to contact line * Delete a link to contact line
* \param rowid Id of link line to delete * @param rowid Id of contact link line to delete
* \return statur >0 si ok, <0 si ko * @param notrigger Disable all triggers
* @return int >0 if OK, <0 if KO
*/ */
function delete_contact($rowid,$notrigger=0) function delete_contact($rowid,$notrigger=0)
{ {
@ -1321,8 +1323,8 @@ class CommonObject
/** /**
* Set statut of an object * Set statut of an object
* @param statut Statut to set * @param statut Statut to set
* @param elementid Id of element to force (use this->id by default) * @param elementId Id of element to force (use this->id by default)
* @param elementtype Type of element to force (use ->this->element by default) * @param elementType Type of element to force (use ->this->element by default)
* @return int <0 if ko, >0 if ok * @return int <0 if ko, >0 if ok
*/ */
function setStatut($statut,$elementId='',$elementType='') function setStatut($statut,$elementId='',$elementType='')
@ -1664,6 +1666,8 @@ class CommonObject
* TODO Edit templates to use global variables and include them directly in controller call * TODO Edit templates to use global variables and include them directly in controller call
* But for the moment we don't know if it's possible as we keep a method available on overloaded objects. * But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
* @param $dateSelector 1=Show also date range input fields * @param $dateSelector 1=Show also date range input fields
* @param $seller Object thirdparty who sell
* @param $buyer Object thirdparty who buy
*/ */
function formAddPredefinedProduct($dateSelector,$seller,$buyer) function formAddPredefinedProduct($dateSelector,$seller,$buyer)
{ {
@ -1699,6 +1703,7 @@ class CommonObject
* TODO Move this into an output class file (htmlline.class.php) * TODO Move this into an output class file (htmlline.class.php)
* If lines are into a template, title must also be into a template * If lines are into a template, title must also be into a template
* But for the moment we don't know if it'st possible as we keep a method available on overloaded objects. * But for the moment we don't know if it'st possible as we keep a method available on overloaded objects.
* @param $action Action code
* @param $seller Object of seller third party * @param $seller Object of seller third party
* @param $buyer Object of buyer third party * @param $buyer Object of buyer third party
* @param $selected Object line selected * @param $selected Object line selected

46
htdocs/fourn/class/fournisseur.commande.class.php
View File

@ -25,7 +25,7 @@
* \file htdocs/fourn/class/fournisseur.commande.class.php * \file htdocs/fourn/class/fournisseur.commande.class.php
* \ingroup fournisseur,commande * \ingroup fournisseur,commande
* \brief File of class to manage suppliers orders * \brief File of class to manage suppliers orders
* \version $Id$ * \version $Id: fournisseur.commande.class.php,v 1.47 2011/07/04 09:36:29 eldy Exp $
*/ */
require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php"); require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php");
@ -618,6 +618,7 @@ class CommandeFournisseur extends Commande
/** /**
* Accept an order * Accept an order
* @param user Object user * @param user Object user
* @return int <0 if KO, >0 if OK
*/ */
function approve($user) function approve($user)
{ {
@ -739,9 +740,9 @@ class CommandeFournisseur extends Commande
} }
/** /**
* Cancel an approved order * Cancel an approved order.
* L'annulation se fait apres l'approbation
* @param user User making action * @param user User making action
* @remarks L'annulation se fait apres l'approbation
*/ */
function Cancel($user) function Cancel($user)
{ {
@ -800,6 +801,11 @@ class CommandeFournisseur extends Commande
/** /**
* Send a supplier order to supplier * Send a supplier order to supplier
* @param user User making change
* @param date Date
* @param methode Method
* @param comment Comment
* @return int <0 if KO, >0 if OK
*/ */
function commande($user, $date, $methode, $comment='') function commande($user, $date, $methode, $comment='')
{ {
@ -912,14 +918,14 @@ class CommandeFournisseur extends Commande
/** /**
* Add order line * Add order line
* @param desc Description * @param desc Description
* @param pu Unit price * @param pu_ht Unit price
* @param qty Quantity * @param qty Quantity
* @param txtva Taux tva * @param txtva Taux tva
* @param txlocaltax1 Localtax1 tax * @param txlocaltax1 Localtax1 tax
* @param txlocaltax2 Localtax2 tax * @param txlocaltax2 Localtax2 tax
* @param fk_product Id produit * @param fk_product Id produit
* @param fk_prod_fourn_price Id supplier price * @param fk_prod_fourn_price Id supplier price
* @param fournref Supplier reference * @param fourn_ref Supplier reference
* @param remise_percent Remise * @param remise_percent Remise
* @param price_base_type HT or TTC * @param price_base_type HT or TTC
* @param pu_ttc Unit price TTC * @param pu_ttc Unit price TTC
@ -1176,8 +1182,8 @@ class CommandeFournisseur extends Commande
} }
/** /**
* \brief Delete an order * Delete an order
* \return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function delete() function delete()
{ {
@ -1229,8 +1235,7 @@ class CommandeFournisseur extends Commande
} }
/** /**
* * Return list of order methods
*
*/ */
function get_methodes_commande() function get_methodes_commande()
{ {
@ -1295,8 +1300,8 @@ class CommandeFournisseur extends Commande
/** /**
* Change le mode de reglement * Change le mode de reglement
* @param mode Id du nouveau mode * @param mode_reglement_id Id du nouveau mode
* @return int >0 si ok, <0 si ko * @return int >0 if OK, <0 if KO
*/ */
function mode_reglement($mode_reglement_id) function mode_reglement($mode_reglement_id)
{ {
@ -1331,6 +1336,7 @@ class CommandeFournisseur extends Commande
* @param user User that input data * @param user User that input data
* @param date Date of reception * @param date Date of reception
* @param type Type of receipt * @param type Type of receipt
* @param comment Comment
*/ */
function Livraison($user, $date, $type, $comment) function Livraison($user, $date, $type, $comment)
{ {
@ -1388,7 +1394,8 @@ class CommandeFournisseur extends Commande
/** /**
* Cree la commande depuis une propale existante * Cree la commande depuis une propale existante
* @param user Utilisateur qui cree * @param user Utilisateur qui cree
* @param propale_id id de la propale qui sert de modele * @param idc Id de la propale qui sert de modele
* @param comclientid Id thirdparty
*/ */
function updateFromCommandeClient($user, $idc, $comclientid) function updateFromCommandeClient($user, $idc, $comclientid)
{ {
@ -1425,8 +1432,12 @@ class CommandeFournisseur extends Commande
/** /**
* Met a jour les notes * Update notes
* @return int <0 si ko, >=0 si ok * @param user
* @param note
* @param note_public
* @return int <0 if KO, >=0 if OK
* TODO Use instead update_note_public and update_note
*/ */
function UpdateNote($user, $note, $note_public) function UpdateNote($user, $note, $note_public)
{ {
@ -1457,10 +1468,8 @@ class CommandeFournisseur extends Commande
return $result ; return $result ;
} }
/* /**
* * Get list of user that can approve an order
*
*
*/ */
function ReadApprobators() function ReadApprobators()
{ {
@ -1500,6 +1509,7 @@ class CommandeFournisseur extends Commande
/** /**
* Tag order with a particular status * Tag order with a particular status
* @param user Object user that change status * @param user Object user that change status
* @param status New status
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function setStatus($user,$status) function setStatus($user,$status)

36
htdocs/lib/CMailFile.class.php
View File

@ -25,7 +25,7 @@
/** /**
* \file htdocs/lib/CMailFile.class.php * \file htdocs/lib/CMailFile.class.php
* \brief File of class to send emails (with attachments or not) * \brief File of class to send emails (with attachments or not)
* \version $Id: CMailFile.class.php,v 1.142 2011/07/02 16:48:31 eldy Exp $ * \version $Id: CMailFile.class.php,v 1.143 2011/07/04 09:36:29 eldy Exp $
* \author Dan Potter. * \author Dan Potter.
* \author Eric Seigne * \author Eric Seigne
* \author Laurent Destailleur. * \author Laurent Destailleur.
@ -86,20 +86,20 @@ class CMailFile
/** /**
* \brief CMailFile * CMailFile
* \param subject Topic/Subject of mail * @param subject Topic/Subject of mail
* \param to Recipients emails (RFC 2822: "Nom prenom <email>[, ...]" ou "email[, ...]" ou "<email>[, ...]") * @param to Recipients emails (RFC 2822: "Nom prenom <email>[, ...]" ou "email[, ...]" ou "<email>[, ...]")
* \param from Sender email (RFC 2822: "Nom prenom <email>[, ...]" ou "email[, ...]" ou "<email>[, ...]") * @param from Sender email (RFC 2822: "Nom prenom <email>[, ...]" ou "email[, ...]" ou "<email>[, ...]")
* \param msg Message * @param msg Message
* \param filename_list List of files to attach (full path of filename on file system) * @param filename_list List of files to attach (full path of filename on file system)
* \param mimetype_list List of MIME type of attached files * @param mimetype_list List of MIME type of attached files
* \param mimefilename_list List of attached file name in message * @param mimefilename_list List of attached file name in message
* \param addr_cc Email cc * @param addr_cc Email cc
* \param addr_bcc Email bcc * @param addr_bcc Email bcc
* \param deliveryreceipt Ask a delivery receipt * @param deliveryreceipt Ask a delivery receipt
* \param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection * @param msgishtml 1=String IS already html, 0=String IS NOT html, -1=Unknown need autodetection
* \param error_to Email errors * @param errors_to Email errors
* \param css Css option * @param css Css option
*/ */
function CMailFile($subject,$to,$from,$msg, function CMailFile($subject,$to,$from,$msg,
$filename_list=array(),$mimetype_list=array(),$mimefilename_list=array(), $filename_list=array(),$mimetype_list=array(),$mimefilename_list=array(),
@ -781,9 +781,8 @@ class CMailFile
/** /**
* Try to create a socket connection * Try to create a socket connection
* * @param $host Add ssl:// for SSL/TLS.
* @param $host. Add ssl:// for SSL/TLS. * @param $port Example: 25, 465
* @param $port. Example: 25, 465
* @return Socket id if ok, 0 if KO * @return Socket id if ok, 0 if KO
*/ */
function check_server_port($host,$port) function check_server_port($host,$port)
@ -939,7 +938,6 @@ class CMailFile
/** /**
* Return an address for SMTP protocol * Return an address for SMTP protocol
*
* @param adresses Example: 'John Doe <john@doe.com>' or 'john@doe.com' * @param adresses Example: 'John Doe <john@doe.com>' or 'john@doe.com'
* @param format 0=Auto, 1=emails with <>, 2=emails without <> * @param format 0=Auto, 1=emails with <>, 2=emails without <>
* @param encode 1=Encode name to RFC2822 * @param encode 1=Encode name to RFC2822

5
htdocs/lib/CSMSFile.class.php
View File

@ -25,7 +25,7 @@
/** /**
* \file htdocs/lib/CSMSFile.class.php * \file htdocs/lib/CSMSFile.class.php
* \brief File of class to send sms * \brief File of class to send sms
* \version $Id$ * \version $Id: CSMSFile.class.php,v 1.4 2011/07/04 09:36:29 eldy Exp $
* \author Laurent Destailleur. * \author Laurent Destailleur.
*/ */
@ -54,6 +54,9 @@ class CSMSFile
* @param from Sender SMS * @param from Sender SMS
* @param msg Message * @param msg Message
* @param deliveryreceipt Ask a delivery receipt * @param deliveryreceipt Ask a delivery receipt
* @param deferred Deferred or not
* @param priority Priority
* @param class Class
*/ */
function CSMSFile($to,$from,$msg,$deliveryreceipt=0,$deferred=0,$priority=3,$class=1) function CSMSFile($to,$from,$msg,$deliveryreceipt=0,$deferred=0,$priority=3,$class=1)
{ {