\LibMelanie\Api\DefautAddressbook

Classe de carnet d'adresses par defaut

Summary

Methods

Properties

Constants

registerCache()
executeCache()
getList()
__construct()
save()
delete()
getAllContacts()
getAllGroups()
getAllGroupsAndContacts()
load()
exists()
save()
delete()
getCTag()
asRight()

$id
$owner
$name
$perm
$ctag
$synctoken
$carddavurl

No constants found

getMapCarddavurl()

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Api/Defaut/Addressbook.php
Package: LibMCE\API/Defaut
Class hierarchy: \LibMelanie\Lib\MceObject

\LibMelanie\Api\Defaut\Addressbook

Properties

$id

$id :string

Identifiant unique du carnet d'adresses

Type

string

$owner

$owner :string

Identifiant du propriétaire du carnet d'adresses

Type

string

$name

$name :string

Nom complet du carnet d'adresses

Type

string

$perm

$perm :integer

Permission associée, utiliser asRight()

Type

integer

$ctag

$ctag :string

CTag du carnet d'adresses

Type

string

$synctoken

$synctoken :integer

SyncToken du carnet d'adresses

Type

integer

$carddavurl

$carddavurl :string

URL CardDAV pour le carnet d'adresses

Type

string

Methods

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)

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

__construct()

__construct(\LibMelanie\Api\Defaut\User|string  $user = null)

Constructeur de l'objet

Parameters

\LibMelanie\Api\Defaut\User|string

$user

ou $id

save()

save(): null

Enregistrement de l'objet Nettoie le cache du user

Returns

null —

si erreur, boolean sinon (true insert, false update)

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Returns

boolean

getAllContacts()

getAllContacts(): array<mixed,\LibMelanie\Api\Defaut\Contact>

Récupère la liste de tous les contacts need: $this->id

Returns

array<mixed,\LibMelanie\Api\Defaut\Contact>

getAllGroups()

getAllGroups(): array<mixed,\LibMelanie\Api\Defaut\Contact>

Récupère la liste de tous les groupes need: $this->id

Returns

array<mixed,\LibMelanie\Api\Defaut\Contact>

getAllGroupsAndContacts()

getAllGroupsAndContacts(): array<mixed,\LibMelanie\Api\Defaut\Contact>

Récupère la liste de tous les groupes et contacts need: $this->id

Returns

array<mixed,\LibMelanie\Api\Defaut\Contact>

load()

load(): boolean

Charge les données du carnet d'adresses depuis la base de données

Returns

boolean

exists()

exists(): boolean

Test dans la base de données si le carnet d'adresses existe déjà

Returns

boolean

save()

save(): boolean

Création ou modification du carnet d'adresses

Returns

boolean

delete()

delete(): boolean

Supprimer le carnet d'adresses et toutes ses données de la base de données

Returns

boolean

getCTag()

getCTag(): void

Charge la propriété ctag avec l'identifiant de modification du carnet d'adresses

asRight()

asRight(mixed  $action): boolean

Retourne un boolean pour savoir si les droits sont présents

Parameters

mixed

$action

Returns

boolean

getMapCarddavurl()

getMapCarddavurl()

Mapping carddavurl field