dolibarr  9.0.0
Public Member Functions | List of all members
Address Class Reference

Class to manage addresses. More...

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($socid, $user='')
 Create address into database. More...
 
 verify ()
 Verification lors de la modification de l'adresse. More...
 
 update ($id, $socid, $user='')
 Mise a jour des parametres de l'adresse. More...
 
 fetch_lines ($socid, $user=null)
 Charge depuis la base toutes les adresses d'une societe. More...
 
 fetch_address ($id, $user=null)
 Charge depuis la base l'objet adresse. More...
 
 delete ($id, $socid)
 Suppression d'une adresse. More...
 
 getNomUrl ($withpicto=0, $option='')
 Return name of address with link (and eventually picto) Use $this->id, $this->label, $this->socid. More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet societe. More...
 

Detailed Description

Class to manage addresses.

Deprecated:
This class is dedicated to a not supported and deprecated feature.

Definition at line 32 of file address.class.php.

Constructor & Destructor Documentation

◆ __construct()

Address::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler
Deprecated:

Definition at line 76 of file address.class.php.

Member Function Documentation

◆ create()

Address::create (   $socid,
  $user = '' 
)

Create address into database.

Parameters
int$socidCompany socid
User$userObject user making creation
Returns
int 0 if OK, < 0 if KO

Definition at line 88 of file address.class.php.

◆ delete()

Address::delete (   $id,
  $socid 
)

Suppression d'une adresse.

Parameters
int$idid de la societe a supprimer
int$socidid third party
Returns
<0 KO >0 OK

Definition at line 418 of file address.class.php.

References dol_syslog().

◆ fetch_address()

Address::fetch_address (   $id,
  $user = null 
)

Charge depuis la base l'objet adresse.

Parameters
int$idId de l'adresse a charger en memoire
User$userObjet de l'utilisateur
Returns
int >0 si ok, <0 si ko

Definition at line 349 of file address.class.php.

◆ fetch_lines()

Address::fetch_lines (   $socid,
  $user = null 
)

Charge depuis la base toutes les adresses d'une societe.

Parameters
int$socidId de la societe a charger en memoire
User$userObjet de l'utilisateur
Returns
int >0 si ok, <0 si ko

Definition at line 254 of file address.class.php.

◆ getNomUrl()

Address::getNomUrl (   $withpicto = 0,
  $option = '' 
)

Return name of address with link (and eventually picto) Use $this->id, $this->label, $this->socid.

Parameters
int$withpictoInclude picto with link
string$optionWhere the link point to
Returns
string String with URL

Definition at line 443 of file address.class.php.

◆ info()

Address::info (   $id)

Charge les informations d'ordre info dans l'objet societe.

Parameters
int$idid de la societe a charger
Returns
void

Definition at line 465 of file address.class.php.

◆ update()

Address::update (   $id,
  $socid,
  $user = '' 
)

Mise a jour des parametres de l'adresse.

Parameters
int$idid address
int$socidid third party
User$userUtilisateur qui demande la mise a jour
Returns
int <0 if KO, >=0 if OK

Definition at line 178 of file address.class.php.

◆ verify()

Address::verify ( )

Verification lors de la modification de l'adresse.

Returns
int 0 if OK, <0 if KO

Definition at line 156 of file address.class.php.

References label, and name.


The documentation for this class was generated from the following file: