\LibMelanie\Api\EnsContact

Classe contact pour ENS, implémente les API de la librairie pour aller chercher les données dans la base de données Certains champs sont mappés directement ou passe par des classes externes

Summary

Methods
Properties
Constants
__construct()
getList()
registerCache()
executeCache()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
$id
$addressbook
$uid
$type
$modified
$members
$name
$alias
$freebusyurl
$firstname
$lastname
$middlenames
$nameprefix
$namesuffix
$birthday
$title
$company
$notes
$email
$email1
$email2
$cellphone
$fax
$category
$url
$homeaddress
$homephone
$homestreet
$homepob
$homecity
$homeprovince
$homepostalcode
$homecountry
$workaddress
$workphone
$workstreet
$workpob
$workcity
$workprovince
$workpostalcode
$workcountry
$pgppublickey
$smimepublickey
$photo
$phototype
$logo
$logotype
$timezone
$geo
$pager
$role
$vcard
$id
$addressbook
$uid
$type
$modified
$members
$name
$alias
$freebusyurl
$firstname
$lastname
$middlenames
$nameprefix
$namesuffix
$birthday
$title
$company
$notes
$email
$email1
$email2
$cellphone
$fax
$category
$url
$homeaddress
$homephone
$homestreet
$homepob
$homecity
$homeprovince
$homepostalcode
$homecountry
$workaddress
$workphone
$workstreet
$workpob
$workcity
$workprovince
$workpostalcode
$workcountry
$pgppublickey
$smimepublickey
$photo
$phototype
$logo
$logotype
$timezone
$geo
$pager
$role
$vcard
TYPE_CONTACT
TYPE_LIST
No protected methods found
$user
$addressbookmce
N/A
No private methods found
No private properties found
N/A

Constants

TYPE_CONTACT

TYPE_CONTACT ='Object'

TYPE_LIST

TYPE_LIST ='Group'

Properties

$id

$id :string

Identifiant unique du contact

Type

string

$addressbook

$addressbook :string

Identifiant de la liste de contacts associée

Type

string

$uid

$uid :string

UID du contact

Type

string

$type

$type :string

Type de l'objet

Type

string

$modified

$modified :integer

Timestamp de dernière modification du contact

Type

integer

$members

$members :string

Membres de la liste ? (TODO: Peut être faire un tableau de Contact ?)

Type

string

$name

$name :string

Nom du contact

Type

string

$alias

$alias :string

Surnom du contact

Type

string

$freebusyurl

$freebusyurl :string

URL de Freebusy pour ce contact

Type

string

$firstname

$firstname :string

Prénom du contact

Type

string

$lastname

$lastname :string

Nom de famille du contact

Type

string

$middlenames

$middlenames :string

Autres noms pour le contact

Type

string

$nameprefix

$nameprefix :string

Prefix du contact

Type

string

$namesuffix

$namesuffix :string

Suffix du contact

Type

string

$birthday

$birthday :string

Date d'anniversaire

Type

string

$title

$title :string

Titre du contact

Type

string

$company

$company :string

Entreprise du contact

Type

string

$notes

$notes :string

Notes associées au contact

Type

string

$email

$email :string

Adresse e-mail

Type

string

$email1

$email1 :string

Deuxième adresse e-mail

Type

string

$email2

$email2 :string

Troisième adresse e-mail

Type

string

$cellphone

$cellphone :string

Numéro de mobile

Type

string

$fax

$fax :string

Numéro de fax

Type

string

$category

$category :string

Categorie du contact

Type

string

$url

$url :string

URL associée au contact

Type

string

$homeaddress

$homeaddress :string

Adresse du domicile

Type

string

$homephone

$homephone :string

Numéro de téléphone du domicile

Type

string

$homestreet

$homestreet :string

Rue du domicile

Type

string

$homepob

$homepob :string

Boite aux lettres du domicile

Type

string

$homecity

$homecity :string

Ville du domicile

Type

string

$homeprovince

$homeprovince :string

Département du domicile

Type

string

$homepostalcode

$homepostalcode :string

Code postal du domicile

Type

string

$homecountry

$homecountry :string

Pays du domicile

Type

string

$workaddress

$workaddress :string

Adresse du bureau

Type

string

$workphone

$workphone :string

Numéro de téléphone du bureau

Type

string

$workstreet

$workstreet :string

Rue du bureau

Type

string

$workpob

$workpob :string

Boite aux lettres du bureau

Type

string

$workcity

$workcity :string

Ville du bureau

Type

string

$workprovince

$workprovince :string

Département du bureau

Type

string

$workpostalcode

$workpostalcode :string

Code postal du bureau

Type

string

$workcountry

$workcountry :string

Pays du bureau

Type

string

$pgppublickey

$pgppublickey :string

Clé publique du contact

Type

string

$smimepublickey

$smimepublickey :string

SMIME pour la clé publique

Type

string

$photo

$photo :string

Photo du contact

Type

string

$phototype

$phototype :string

Type du fichier photo

Type

string

$logo

$logo :string

Logo du contact

Type

string

$logotype

$logotype :string

Type du fichier logo

Type

string

$timezone

$timezone :string

Timezone du contact

Type

string

$geo

$geo :string

Geo

Type

string

$pager

$pager :string

Pager

Type

string

$role

$role :string

Role du contact

Type

string

$vcard

$vcard :string

VCard associé au contact courant, calculé à la volée en attendant la mise en base de données

Type

string

$id

$id :string

Identifiant unique du contact

Type

string

$addressbook

$addressbook :string

Identifiant de la liste de contacts associée

Type

string

$uid

$uid :string

UID du contact

Type

string

$type

$type :string

Type de l'objet

Type

string

$modified

$modified :integer

Timestamp de dernière modification du contact

Type

integer

$members

$members :string

Membres de la liste ? (TODO: Peut être faire un tableau de Contact ?)

Type

string

$name

$name :string

Nom du contact

Type

string

$alias

$alias :string

Surnom du contact

Type

string

$freebusyurl

$freebusyurl :string

URL de Freebusy pour ce contact

Type

string

$firstname

$firstname :string

Prénom du contact

Type

string

$lastname

$lastname :string

Nom de famille du contact

Type

string

$middlenames

$middlenames :string

Autres noms pour le contact

Type

string

$nameprefix

$nameprefix :string

Prefix du contact

Type

string

$namesuffix

$namesuffix :string

Suffix du contact

Type

string

$birthday

$birthday :string

Date d'anniversaire

Type

string

$title

$title :string

Titre du contact

Type

string

$company

$company :string

Entreprise du contact

Type

string

$notes

$notes :string

Notes associées au contact

Type

string

$email

$email :string

Adresse e-mail

Type

string

$email1

$email1 :string

Deuxième adresse e-mail

Type

string

$email2

$email2 :string

Troisième adresse e-mail

Type

string

$cellphone

$cellphone :string

Numéro de mobile

Type

string

$fax

$fax :string

Numéro de fax

Type

string

$category

$category :string

Categorie du contact

Type

string

$url

$url :string

URL associée au contact

Type

string

$homeaddress

$homeaddress :string

Adresse du domicile

Type

string

$homephone

$homephone :string

Numéro de téléphone du domicile

Type

string

$homestreet

$homestreet :string

Rue du domicile

Type

string

$homepob

$homepob :string

Boite aux lettres du domicile

Type

string

$homecity

$homecity :string

Ville du domicile

Type

string

$homeprovince

$homeprovince :string

Département du domicile

Type

string

$homepostalcode

$homepostalcode :string

Code postal du domicile

Type

string

$homecountry

$homecountry :string

Pays du domicile

Type

string

$workaddress

$workaddress :string

Adresse du bureau

Type

string

$workphone

$workphone :string

Numéro de téléphone du bureau

Type

string

$workstreet

$workstreet :string

Rue du bureau

Type

string

$workpob

$workpob :string

Boite aux lettres du bureau

Type

string

$workcity

$workcity :string

Ville du bureau

Type

string

$workprovince

$workprovince :string

Département du bureau

Type

string

$workpostalcode

$workpostalcode :string

Code postal du bureau

Type

string

$workcountry

$workcountry :string

Pays du bureau

Type

string

$pgppublickey

$pgppublickey :string

Clé publique du contact

Type

string

$smimepublickey

$smimepublickey :string

SMIME pour la clé publique

Type

string

$photo

$photo :string

Photo du contact

Type

string

$phototype

$phototype :string

Type du fichier photo

Type

string

$logo

$logo :string

Logo du contact

Type

string

$logotype

$logotype :string

Type du fichier logo

Type

string

$timezone

$timezone :string

Timezone du contact

Type

string

$geo

$geo :string

Geo

Type

string

$pager

$pager :string

Pager

Type

string

$role

$role :string

Role du contact

Type

string

$vcard

$vcard :string

VCard associé au contact courant, calculé à la volée en attendant la mise en base de données

Type

string

Methods

getList()

getList(array<mixed,String>  $fields = array(),String  $filter = "",array<mixed,String>  $operators = array(),String  $orderby = "",boolean  $asc = true,integer  $limit = null,integer  $offset = null,array<mixed,String>  $case_unsensitive_fields = array(),  $join = null,  $type_join = 'INNER',  $using = null,  $prefix = null,  $groupby = array(),  $groupby_count = null,  $subqueries = array()): array<mixed,\LibMelanie\Lib\MceObject>

Permet de récupérer la liste d'objet en utilisant les données passées (la clause where s'adapte aux données) Il faut donc peut être sauvegarder l'objet avant d'appeler cette méthode pour réinitialiser les données modifiées (propriété haschanged)

Parameters

array<mixed,String> $fields

Liste les champs à récupérer depuis les données

String $filter

Filtre pour la lecture des données en fonction des valeurs déjà passé, exemple de filtre : "((#description# OR #title#) AND #start#)"

array<mixed,String> $operators

Liste les propriétés par operateur (MappingMce::like, MappingMce::supp, MappingMce::inf, MappingMce::diff)

String $orderby

Tri par le champ

boolean $asc

Tri ascendant ou non

integer $limit

Limite le nombre de résultat (utile pour la pagination)

integer $offset

Offset de début pour les résultats (utile pour la pagination)

array<mixed,String> $case_unsensitive_fields

Liste des champs pour lesquels on ne sera pas sensible à la casse

$join
$type_join
$using
$prefix
$groupby
$groupby_count
$subqueries

Returns

array<mixed,\LibMelanie\Lib\MceObject> —

Array

registerCache()

registerCache(  $app,  $callback)

Enregistrement des methodes de gestion du cache

Parameters

$app
$callback

executeCache()

executeCache()

Lancement des methodes de gestion du cache (nouveau contenu)

load()

load(): boolean

Chargement le contact, en fonction de l'addressbook et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si le contact existe, en fonction de l'addressbook et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde le contact et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime le contact et met à jour l'historique dans la base de données

Returns

boolean

load()

load(): boolean

Chargement le contact, en fonction de l'addressbook et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si le contact existe, en fonction de l'addressbook et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde le contact et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime le contact et met à jour l'historique dans la base de données

Returns

boolean