VERSION
VERSION =2
Version du schéma pour les events
Classe evenement pour GN, 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
$user :\LibMelanie\Api\Defaut\User
Utilisateur associé à l'objet
$calendarmce :\LibMelanie\Api\Defaut\Calendar
Calendrier associé à l'objet
$_attendees :array<mixed,\LibMelanie\Api\Defaut\Attendee>
Tableau des participants
$attachments :array<mixed,\LibMelanie\Api\Defaut\Attachment>
Tableau contenant les pièces jointes de l'évènement
$recurrence :\LibMelanie\Api\Defaut\Recurrence
Recurrence liée à l'objet
$exceptions :array<mixed,\LibMelanie\Api\Defaut\Exception>
Tableau d'exceptions pour la récurrence
$deleted_exceptions :array<mixed,\LibMelanie\Api\Defaut\Exception>
Tableau d'exceptions a supprimer au moment du save
__construct(\LibMelanie\Api\Defaut\User $user = null,\LibMelanie\Api\Defaut\Calendar $calendar = null)
Constructeur de l'objet
\LibMelanie\Api\Defaut\User | $user | |
\LibMelanie\Api\Defaut\Calendar | $calendar |
getUserMelanie(): \LibMelanie\Api\Defaut\User
Retourne l'utilisateur MCE
getCalendarMelanie(): \LibMelanie\Api\Defaut\Calendar
Retourne le calendrier MCE
createOrganizerException(\LibMelanie\Api\Defaut\Event $organizer_event)
Créer l'exception dans l'agenda de l'organisateur
\LibMelanie\Api\Defaut\Event | $organizer_event |
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)
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 |
Array
addException(\LibMelanie\Api\Defaut\Exception $exception)
Ajoute une nouvelle exception à la liste sans avoir à recharger toutes les exceptions
\LibMelanie\Api\Defaut\Exception | $exception |
setExternalOrganizer(\LibMelanie\Api\Defaut\Organizer $organizer): boolean
L'organisateur est un externe
\LibMelanie\Api\Defaut\Organizer | $organizer |
false
listEventsByUid(string $uid,string $owner = null): array<mixed,\LibMelanie\Api\Defaut\Event>
Lister les événements associés à un uid et un owner
string | $uid | Uid a rechercher |
string | $owner | [Optionnel] owner associé |
Liste des Events
saveNeedAction()
Enregistrer l'événement en attente dans l'agenda des participants Vérifie dans un premier temps que l'événement a besoin de RAZ les participants (en attente) Parcours la liste des participants, si le participant est sur Mélanie2 et qu'il a le mode en attente chercher l'événement dans la bdd si l'événement existe on reprend les modifications (date/heure, titre, location, description, récurrence) et on repasse en en attente si l'événement n'existe pas, on le crée dans l'agenda du participant avec les éléments de base (date/heure, titre, location, description, récurrence)
attendeeList(\LibMelanie\Api\Defaut\Attendee $attendee,array $attendees_uid,string $Attendee,string $User,string $Calendar,string $Event,array $copyFieldsList,array $needActionFieldsList,array $attendees,string $attendee_key,boolean $is_list_saved)
Gérer les participants d'une liste pour le en attendee Méthode récursive pour les listes de listes
\LibMelanie\Api\Defaut\Attendee | $attendee | |
array | $attendees_uid | [In/Out] |
string | $Attendee | |
string | $User | |
string | $Calendar | |
string | $Event | |
array | $copyFieldsList | |
array | $needActionFieldsList | |
array | $attendees | |
string | $attendee_key | |
boolean | $is_list_saved |
attendeeEventNeedAction(\LibMelanie\Api\Defaut\Attendee $attendee,string $User,string $Calendar,string $Event,array $copyFieldsList,array $needActionFieldsList,array $attendees,integer $attendee_key,boolean $is_saved)
Enregistre l'événement dans l'agenda du participant
\LibMelanie\Api\Defaut\Attendee | $attendee | Participant |
string | $User | Classe User |
string | $Calendar | Classe Calendar |
string | $Event | Classe Event |
array | $copyFieldsList | |
array | $needActionFieldsList | |
array | $attendees | |
integer | $attendee_key | |
boolean | $is_saved |
copyEventNeedAction(\LibMelanie\Api\Defaut\Event $event,\LibMelanie\Api\Defaut\Event $attendee_event,string $attendee_uid,array $copyFieldsList,array $needActionFieldsList,array $attendees,integer $attendee_key,boolean $isException,boolean $eventExists): boolean
Copie l'événement dans ceux des participants pour le need action
\LibMelanie\Api\Defaut\Event | $event | |
\LibMelanie\Api\Defaut\Event | $attendee_event | |
string | $attendee_uid | |
array | $copyFieldsList | |
array | $needActionFieldsList | |
array | $attendees | |
integer | $attendee_key | |
boolean | $isException | |
boolean | $eventExists |
L'événement doit il être enregistré
updateOccurrenceAttendees(\LibMelanie\Api\Defaut\Exception $exception)
Mise a jour des participants de l'occurrence à partir de la récurrence
\LibMelanie\Api\Defaut\Exception | $exception |
setMapRecurrence(\LibMelanie\Api\Defaut\Recurrence $recurrence)
Mapping recurrence field
\LibMelanie\Api\Defaut\Recurrence | $recurrence |
setMapOrganizer(\LibMelanie\Api\Defaut\Organizer $organizer)
Mapping organizer field
\LibMelanie\Api\Defaut\Organizer | $organizer |
setMapAttendees(array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees)
Mapping attendees field
array<mixed,\LibMelanie\Api\Defaut\Attendee> | $attendees |
attendeeIsList(\LibMelanie\Api\Defaut\Attendee $attendee,array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees,string $Attendee,boolean $attendeeFound)
Traiter la liste des participants pour sortir l'utilisateur courant s'il est présent
\LibMelanie\Api\Defaut\Attendee | $attendee | |
array<mixed,\LibMelanie\Api\Defaut\Attendee> | $attendees | [In/Out] |
string | $Attendee | |
boolean | $attendeeFound | [In/Out] |
mergeAttendees(array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees,array<mixed,\LibMelanie\Api\Defaut\Attendee> $newAttendees): array<mixed,\LibMelanie\Api\Defaut\Attendee>
Merge les nouveaux attendees avec les attendees existants Ne prend pas en compte les participants déjà présents
array<mixed,\LibMelanie\Api\Defaut\Attendee> | $attendees | |
array<mixed,\LibMelanie\Api\Defaut\Attendee> | $newAttendees |
isAttendee(string $email,array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees): boolean
Est-ce que cette adresse email fait déjà partie de la liste des participants
string | ||
array<mixed,\LibMelanie\Api\Defaut\Attendee> | $attendees |