API Documentation
\
LibMelanie
Api
Defaut
News
Posts
Comments
Resources
Users
Workspaces
Dgfip
News
Users
Ens
News
Users
Workspaces
Gn
News
Users
Mce
News
Users
Workspaces
Mel
News
Resources
Users
Workspaces
Melanie2
Mi
News
Users
Cache
Config
Exceptions
Interfaces
Ldap
Lib
Log
Mail
Objects
Sql

\LibMelanie\Api\Melanie2CalendarSync

Classe pour la gestion des Sync pour les calendriers Certains champs sont mappés directement ou passe par des classes externes

Summary

Methods
Properties
Constants
__construct()
save()
delete()
listCalendarSync()
registerCache()
executeCache()
getList()
load()
exists()
()
load()
exists()
()
load()
exists()
()
$token
$calendar
$uid
$action
$token
$calendar
$uid
$action
$token
$calendar
$uid
$action
RECURRENCE_ID
No protected methods found
No protected properties found
N/A
uidencode()
$actionMapper
N/A

Constants

RECURRENCE_ID

RECURRENCE_ID ='@RECURRENCE-ID'

Properties

$token

$token :integer

Numéro de token associé à l'objet Sync

Type

integer

$calendar

$calendar :string

Identifiant du calendrier associé à l'objet Sync

Type

string

$uid

$uid :string

UID de l'événement concerné par le Sync

Type

string

$action

$action :string

Action effectuée sur l'uid (add, mod, del)

Type

string

$token

$token :integer

Numéro de token associé à l'objet Sync

Type

integer

$calendar

$calendar :string

Identifiant du calendrier associé à l'objet Sync

Type

string

$uid

$uid :string

UID de l'événement concerné par le Sync

Type

string

$action

$action :string

Action effectuée sur l'uid (add, mod, del)

Type

string

$token

$token :integer

Numéro de token associé à l'objet Sync

Type

integer

$calendar

$calendar :string

Identifiant du calendrier associé à l'objet Sync

Type

string

$uid

$uid :string

UID de l'événement concerné par le Sync

Type

string

$action

$action :string

Action effectuée sur l'uid (add, mod, del)

Type

string

$actionMapper

$actionMapper :array

Mapping des actions entre la base et SabreDAV

Type

array

Methods

save()

save(): boolean

Ne pas implémenter la sauvegarde pour l'instant Le SyncToken est alimenté par le trigger

Returns

boolean

delete()

delete(): boolean

Ne pas implémenter la suppression pour l'instant Le SyncToken est alimenté par le trigger

Returns

boolean

listCalendarSync()

listCalendarSync(integer  $limit = null,string  $startDate = null)

Liste les actions par uid depuis le dernier token

Parameters

integer $limit

[Optionnel]
string $startDate

[Optionnel] Date de debut pour les événements retournés

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

load()

load(): boolean

Chargement du CalendarSync, en fonction du calendrier et du token

Returns

boolean

exists()

exists(): boolean

Test si le CalendarSync existe, en fonction du calendrier et du token

Returns

boolean

()

():

CalendarSync[] listCalendarSync($syncToken, $limit) Permet de lister les CalendarSync d'un calendrier

Returns

load()

load(): boolean

Chargement du CalendarSync, en fonction du calendrier et du token

Returns

boolean

exists()

exists(): boolean

Test si le CalendarSync existe, en fonction du calendrier et du token

Returns

boolean

()

():

CalendarSync[] listCalendarSync($syncToken, $limit) Permet de lister les CalendarSync d'un calendrier

Returns

load()

load(): boolean

Chargement du CalendarSync, en fonction du calendrier et du token

Returns

boolean

exists()

exists(): boolean

Test si le CalendarSync existe, en fonction du calendrier et du token

Returns

boolean

()

():

CalendarSync[] listCalendarSync($syncToken, $limit) Permet de lister les CalendarSync d'un calendrier

Returns

uidencode()

uidencode(string  $uid): string

Encodage d'un uid pour les uri (pour les / notamment)

Parameters

string $uid

Returns

string