Class to build vCard files. More...

Public Member Functions
	setPhoneNumber ($number, $type="")
	Format phone number.

	setPhoto ($type, $photo)
	Format photo.

	setFormattedName ($name)
	Format name.

	setName ($family="", $first="", $additional="", $prefix="", $suffix="")
	Format the name.

	setBirthday ($date)
	Format the birth date.

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

	setLabel ($postoffice="", $extended="", $street="", $city="", $region="", $zip="", $country="", $type="HOME")
	Address (old standard)

	setEmail ($address, $type="")
	Add a e-mail address to this vCard.

	setNote ($note)
	mise en forme de la note

	setTitle ($title)
	mise en forme de la fonction

	setOrg ($org)
	mise en forme de la societe

	setProdId ($prodid)
	mise en forme du logiciel generateur

	setUID ($uid)
	mise en forme du logiciel generateur

	setURL ($url, $type="")
	mise en forme de l'url

	getVCard ()
	Return string of a vcard.

	getFileName ()
	Return name of a file.

	buildVCardString ($object, $company, $langs, $urlphoto='', $outdir='')
	Return a VCARD string See RFC https://datatracker.ietf.org/doc/html/rfc6350.

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 = '',
		$outdir = '' )

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

Parameters

Object	$object	Object (User or Contact)
Societe \| null	$company	Company. May be null.
Translate	$langs	Lang object
string	$urlphoto	Full public URL of photo
string	$outdir	Directory where to store the temporary file

Returns: string String

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

References $object, dol_mimetype(), dol_trunc(), dolChmod(), getDolUserInt(), getVCard(), setAddress(), setBirthday(), setEmail(), setFormattedName(), setName(), setNote(), setOrg(), setPhoneNumber(), setPhoto(), setProdId(), setTitle(), setUID(), and setURL().

◆ getFileName()

vCard::getFileName ( )

Return name of a file.

Returns: string Filename

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

◆ getVCard()

vCard::getVCard ( )

Return string of a vcard.

Returns: string

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

Referenced by buildVCardString().

◆ setAddress()

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

Address.

Parameters

string	$postoffice	Postoffice
string	$extended	Extended
string	$street	Street
string	$city	City
string	$region	Region
string	$zip	Zip
string	$country	Country
string	$type	Type
string	$label	Label

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setBirthday()

vCard::setBirthday ( $date )

Format the birth date.

Parameters

integer $date Date

Returns: void

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

References dol_print_date().

Referenced by buildVCardString().

◆ setEmail()

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

Add a e-mail address to this vCard.

Parameters

string	$address	E-mail address
string	$type	(optional) The type of the e-mail (typical "PREF" or "INTERNET")

Returns: void

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

Referenced by buildVCardString().

◆ setFormattedName()

vCard::setFormattedName ( $name )

Format name.

Parameters

string $name Name

Returns: void

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

References encode().

Referenced by buildVCardString(), and setName().

◆ setLabel()

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

Address (old standard)

Parameters

string	$postoffice	Postoffice
string	$extended	Extended
string	$street	Street
string	$city	City
string	$region	Region
string	$zip	Zip
string	$country	Country
string	$type	Type

Returns: void

Deprecated

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

References encode().

◆ setName()

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

Format the name.

Set also the filename to use 'firstname lastname.vcf'

Parameters

string	$family	Family name
string	$first	First name
string	$additional	Additional (e.g. second name, nick name)
string	$prefix	Title prefix (e.g. "Mr.", "Ms.", "Prof.")
string	$suffix	Suffix (e.g. "sen." for senior, "jun." for junior)

Returns: void

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

References encode(), and setFormattedName().

Referenced by buildVCardString().

◆ setNote()

vCard::setNote ( $note )

mise en forme de la note

Parameters

string $note Note

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setOrg()

vCard::setOrg ( $org )

mise en forme de la societe

Parameters

string $org Org

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setPhoneNumber()

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

Format phone number.

Parameters

int	$number	numero de telephone
string	$type	Type ('cell')

Returns: void

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

Referenced by buildVCardString().

◆ setPhoto()

vCard::setPhoto	(		$type,
			$photo )

Format photo.

warning NON TESTE !

Parameters

string	$type	Type 'image/jpeg' or 'JPEG'
string	$photo	Photo

Returns: void

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

Referenced by buildVCardString().

◆ setProdId()

vCard::setProdId ( $prodid )

mise en forme du logiciel generateur

Parameters

string $prodid Prodid

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setTitle()

vCard::setTitle ( $title )

mise en forme de la fonction

Parameters

string $title Title

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setUID()

vCard::setUID ( $uid )

mise en forme du logiciel generateur

Parameters

string $uid Uid

Returns: void

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

References encode().

Referenced by buildVCardString().

◆ setURL()

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

mise en forme de l'url

Parameters

string	$url	URL
string	$type	Type

Returns: void

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

Referenced by buildVCardString().

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

dolibarr_20.0/htdocs/core/class/vcard.class.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ buildVCardString()

◆ getFileName()

◆ getVCard()

◆ setAddress()

◆ setBirthday()

◆ setEmail()

◆ setFormattedName()

◆ setLabel()

◆ setName()

◆ setNote()

◆ setOrg()

◆ setPhoneNumber()

◆ setPhoto()

◆ setProdId()

◆ setTitle()

◆ setUID()

◆ setURL()