dolibarr  20.0.0-alpha
Public Member Functions | List of all members
vCard Class Reference

Class to build vCard files. More...

Public Member Functions

 setPhoneNumber ($number, $type="")
 mise en forme du numero de telephone More...
 
 setPhoto ($type, $photo)
 mise en forme de la photo warning NON TESTE ! More...
 
 setFormattedName ($name)
 mise en forme du nom format More...
 
 setName ($family="", $first="", $additional="", $prefix="", $suffix="")
 mise en forme du nom complete More...
 
 setBirthday ($date)
 mise en forme de l'anniversaire More...
 
 setAddress ($postoffice="", $extended="", $street="", $city="", $region="", $zip="", $country="", $type="", $label="")
 Address. More...
 
 setLabel ($postoffice="", $extended="", $street="", $city="", $region="", $zip="", $country="", $type="HOME")
 Address (old standard) More...
 
 setEmail ($address, $type="")
 Add a e-mail address to this vCard. More...
 
 setNote ($note)
 mise en forme de la note More...
 
 setTitle ($title)
 mise en forme de la fonction More...
 
 setOrg ($org)
 mise en forme de la societe More...
 
 setProdId ($prodid)
 mise en forme du logiciel generateur More...
 
 setUID ($uid)
 mise en forme du logiciel generateur More...
 
 setURL ($url, $type="")
 mise en forme de l'url More...
 
 getVCard ()
 permet d'obtenir une vcard More...
 
 getFileName ()
 permet d'obtenir le nom de fichier More...
 
 buildVCardString ($object, $company, $langs, $urlphoto='')
 Return a VCARD string See RFC https://datatracker.ietf.org/doc/html/rfc6350. More...
 

Detailed Description

Class to build vCard files.

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

Member Function Documentation

◆ buildVCardString()

vCard::buildVCardString (   $object,
  $company,
  $langs,
  $urlphoto = '' 
)

Return a VCARD string See RFC https://datatracker.ietf.org/doc/html/rfc6350.

Parameters
Object$objectObject (User or Contact)
Societe | null$companyCompany. May be null
Translate$langsLang object
string$urlphotoFull public URL of photo
Returns
string String

Definition at line 393 of file vcard.class.php.

◆ getFileName()

vCard::getFileName ( )

permet d'obtenir le nom de fichier

Returns
string Filename

Definition at line 378 of file vcard.class.php.

◆ getVCard()

vCard::getVCard ( )

permet d'obtenir une vcard

Returns
string

Definition at line 358 of file vcard.class.php.

◆ setAddress()

vCard::setAddress (   $postoffice = "",
  $extended = "",
  $street = "",
  $city = "",
  $region = "",
  $zip = "",
  $country = "",
  $type = "",
  $label = "" 
)

Address.

Parameters
string$postofficePostoffice
string$extendedExtended
string$streetStreet
string$cityCity
string$regionRegion
string$zipZip
string$countryCountry
string$typeType
string$labelLabel
Returns
void

Definition at line 199 of file vcard.class.php.

◆ setBirthday()

vCard::setBirthday (   $date)

mise en forme de l'anniversaire

Parameters
integer$dateDate
Returns
void

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

◆ setEmail()

vCard::setEmail (   $address,
  $type = "" 
)

Add a e-mail address to this vCard.

Parameters
string$addressE-mail address
string$type(optional) The type of the e-mail (typical "PREF" or "INTERNET")
Returns
void

Definition at line 266 of file vcard.class.php.

◆ setFormattedName()

vCard::setFormattedName (   $name)

mise en forme du nom format

Parameters
string$nameName
Returns
void

Definition at line 147 of file vcard.class.php.

◆ setLabel()

vCard::setLabel (   $postoffice = "",
  $extended = "",
  $street = "",
  $city = "",
  $region = "",
  $zip = "",
  $country = "",
  $type = "HOME" 
)

Address (old standard)

Parameters
string$postofficePostoffice
string$extendedExtended
string$streetStreet
string$cityCity
string$regionRegion
string$zipZip
string$countryCountry
string$typeType
Returns
void
Deprecated:

Definition at line 231 of file vcard.class.php.

◆ setName()

vCard::setName (   $family = "",
  $first = "",
  $additional = "",
  $prefix = "",
  $suffix = "" 
)

mise en forme du nom complete

Parameters
string$familyFamily name
string$firstFirst name
string$additionalAdditional (e.g. second name, nick name)
string$prefixTitle prefix (e.g. "Mr.", "Ms.", "Prof.")
string$suffixSuffix (e.g. "sen." for senior, "jun." for junior)
Returns
void

Definition at line 162 of file vcard.class.php.

◆ setNote()

vCard::setNote (   $note)

mise en forme de la note

Parameters
string$noteNote
Returns
void

Definition at line 283 of file vcard.class.php.

◆ setOrg()

vCard::setOrg (   $org)

mise en forme de la societe

Parameters
string$orgOrg
Returns
void

Definition at line 306 of file vcard.class.php.

References encode().

◆ setPhoneNumber()

vCard::setPhoneNumber (   $number,
  $type = "" 
)

mise en forme du numero de telephone

Parameters
int$numbernumero de telephone
string$typeType ('cell')
Returns
void

Definition at line 113 of file vcard.class.php.

◆ setPhoto()

vCard::setPhoto (   $type,
  $photo 
)

mise en forme de la photo warning NON TESTE !

Parameters
string$typeType 'image/jpeg' or 'JPEG'
string$photoPhoto
Returns
void

Definition at line 133 of file vcard.class.php.

◆ setProdId()

vCard::setProdId (   $prodid)

mise en forme du logiciel generateur

Parameters
string$prodidProdid
Returns
void

Definition at line 318 of file vcard.class.php.

References encode().

◆ setTitle()

vCard::setTitle (   $title)

mise en forme de la fonction

Parameters
string$titleTitle
Returns
void

Definition at line 294 of file vcard.class.php.

◆ setUID()

vCard::setUID (   $uid)

mise en forme du logiciel generateur

Parameters
string$uidUid
Returns
void

Definition at line 330 of file vcard.class.php.

References encode().

◆ setURL()

vCard::setURL (   $url,
  $type = "" 
)

mise en forme de l'url

Parameters
string$urlURL
string$typeType
Returns
void

Definition at line 343 of file vcard.class.php.


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