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\EnsException

Classe exception pour ENS, étend sur la class Event 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()
setEventParent()
getEventParent()
getList()
getUserMelanie()
getCalendarMelanie()
getAttribute()
setAttribute()
setAttributes()
deleteAttribute()
createOrganizerException()
keepNeedActionFieldsEvent()
move()
useJsonData()
clearAttendees()
addException()
registerCache()
executeCache()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
load()
exists()
save()
delete()
$ics_freebusy
$ics_attachments
$id
$calendar
$uid
$owner
$keywords
$title
$description
$category
$location
$status
$class
$alarm
$attendees
$start
$end
$modified
$recurrence
$deleted
$recurrence_id
$realuid
$id
$calendar
$uid
$owner
$keywords
$title
$description
$category
$location
$status
$class
$alarm
$attendees
$start
$end
$modified
$recurrence
$deleted
$recurrence_id
$dtrecurrence_id
$realuid
$id
$calendar
$uid
$owner
$creator_email
$creator_name
$keywords
$title
$description
$category
$location
$status
$class
$transparency
$priority
$sequence
$alarm
$attendees
$hasattendees
$start
$end
$dtstart
$dtend
$timezone
$all_day
$created
$modified
$recurrence
$organizer
$exceptions
$attachments
$deleted
$ics
$move
$version
$dtstart_utc
$dtend_utc
$realuid
$vcalendar
RECURRENCE_ID
FORMAT_ID
FORMAT_REC_ID
FORMAT_STR
VERSION
DB_DATE_FORMAT
CLASS_PRIVATE
CLASS_PUBLIC
CLASS_CONFIDENTIAL
STATUS_TENTATIVE
STATUS_CONFIRMED
STATUS_CANCELLED
STATUS_NONE
STATUS_TELEWORK
STATUS_VACATION
TRANS_TRANSPARENT
TRANS_OPAQUE
PRIORITY_NO
PRIORITY_VERY_HIGH
PRIORITY_HIGH
PRIORITY_NORMAL
PRIORITY_LOW
PRIORITY_VERY_LOW
setMapRecurrence()
getMapRecurrence()
setMapRecurrence_id()
getMapRecurrence_id()
getMapDtrecurrence_id()
setMapUid()
getMapUid()
getMapOrganizer()
setAttributeJson()
attributesToJson()
saveAttendees()
setExternalOrganizer()
listEventsByUid()
userIsOrganizer()
saveNeedAction()
attendeeList()
attendeeEventNeedAction()
copyEventNeedAction()
deleteNeedAction()
deleteAttachments()
saveAttributes()
loadAttributes()
deleteAttributes()
deleteOldOccurrences()
updateOccurrences()
updateOccurrenceAttendees()
setMapModified()
getMapTimezone()
getMapAll_day()
setMapStart()
setMapDtstart()
getMapDtstart()
getMapDtstart_utc()
getMapOlddtstart()
setMapEnd()
setMapDtend()
getMapDtend()
getMapDtend_utc()
getMapOlddtend()
setMapClass()
getMapClass()
setMapStatus()
getMapStatus()
setMapTransparency()
getMapTransparency()
setMapPriority()
getMapPriority()
setMapOrganizer()
setMapAttendees()
getMapAttendees()
attendeeIsList()
mergeAttendees()
getMapHasAttendees()
getMapRealUid()
setMapDeleted()
getMapDeleted()
setMapCreator_email()
getMapCreator_email()
issetMapCreator_email()
setMapCreator_name()
getMapCreator_name()
issetMapCreator_name()
$_dtrecurrence_id
$user
$calendarmce
$organizer
$deleted
$_attendees
$attributes
$attributes_loaded
$attachments
$_dtstart
$_olddtstart
$_dtstart_utc
$_dtend
$_olddtend
$_dtend_utc
$move
N/A
loadExceptions()
isAttendee()
notException()
checkRecurrence()
useNewMode()
$eventParent
$recurrence
$exceptions
$deleted_exceptions
$vcalendar
N/A

Constants

RECURRENCE_ID

RECURRENCE_ID ='@RECURRENCE-ID'

FORMAT_ID

FORMAT_ID ='Ymd'

FORMAT_REC_ID

FORMAT_REC_ID ='Y-m-d H:i:s'

FORMAT_STR

FORMAT_STR ='YYYYmmdd'

VERSION

VERSION =2

Version du schéma pour les events

DB_DATE_FORMAT

DB_DATE_FORMAT ='Y-m-d H:i:s' :string

Format de datetime pour la base de données

CLASS_PRIVATE

CLASS_PRIVATE =\LibMelanie\Config\DefaultConfig::PRIV

CLASS_PUBLIC

CLASS_PUBLIC =\LibMelanie\Config\DefaultConfig::PUB

CLASS_CONFIDENTIAL

CLASS_CONFIDENTIAL =\LibMelanie\Config\DefaultConfig::CONFIDENTIAL

STATUS_TENTATIVE

STATUS_TENTATIVE =\LibMelanie\Config\DefaultConfig::TENTATIVE

STATUS_CONFIRMED

STATUS_CONFIRMED =\LibMelanie\Config\DefaultConfig::CONFIRMED

STATUS_CANCELLED

STATUS_CANCELLED =\LibMelanie\Config\DefaultConfig::CANCELLED

STATUS_NONE

STATUS_NONE =\LibMelanie\Config\DefaultConfig::NONE

STATUS_TELEWORK

STATUS_TELEWORK =\LibMelanie\Config\DefaultConfig::TELEWORK

STATUS_VACATION

STATUS_VACATION =\LibMelanie\Config\DefaultConfig::VACATION

TRANS_TRANSPARENT

TRANS_TRANSPARENT =\LibMelanie\Lib\ICS::TRANSP_TRANSPARENT

TRANS_OPAQUE

TRANS_OPAQUE =\LibMelanie\Lib\ICS::TRANSP_OPAQUE

PRIORITY_NO

PRIORITY_NO =0

PRIORITY_VERY_HIGH

PRIORITY_VERY_HIGH =1

PRIORITY_HIGH

PRIORITY_HIGH =2

PRIORITY_NORMAL

PRIORITY_NORMAL =3

PRIORITY_LOW

PRIORITY_LOW =4

PRIORITY_VERY_LOW

PRIORITY_VERY_LOW =5

Properties

$ics_freebusy

$ics_freebusy :boolean

La génération de l'ICS doit elle retourner des freebusy Il n'y aura donc pas de participants, pièces jointes et informations supplémentaires

Type

boolean

$ics_attachments

$ics_attachments :boolean

La génération de l'ICS doit elle retourner les pièces jointes ?

Type

boolean

$id

$id :string

Identifiant unique de l'évènement

Type

string

$calendar

$calendar :string

Identifiant du calendrier de l'évènement

Type

string

$uid

$uid :string

UID de l'évènement

Type

string

$owner

$owner :string

Créateur de l'évènement

Type

string

$keywords

$keywords :string

Keywords

Type

string

$title

$title :string

Titre de l'évènement

Type

string

$description

$description :string

Description de l'évènement

Type

string

$category

$category :string

Catégorie de l'évènment

Type

string

$location

$location :string

Lieu de l'évènement

Type

string

$status

$status :\LibMelanie\Api\Ens\Event::STATUS_*

Statut de l'évènement

Type

\LibMelanie\Api\Ens\Event::STATUS_*

$class

$class :\LibMelanie\Api\Ens\Event::CLASS_*

Class de l'évènement (privé/public)

Type

\LibMelanie\Api\Ens\Event::CLASS_*

$alarm

$alarm :integer

Alarme en minute (TODO: class Alarm)

Type

integer

$attendees

$attendees :array<mixed,\LibMelanie\Api\Ens\Attendee>

Tableau d'objets Attendee

Type

array<mixed,\LibMelanie\Api\Ens\Attendee>

$start

$start :string

String au format compatible DateTime, date de début

Type

string

$end

$end :string

String au format compatible DateTime, date de fin

Type

string

$modified

$modified :integer

Timestamp de la modification de l'évènement

Type

integer

$recurrence

$recurrence :\LibMelanie\Api\Ens\Recurrence

Inaccessible depuis une exception

Type

\LibMelanie\Api\Ens\Recurrence

$deleted

$deleted :boolean

Défini si l'exception est un évènement ou juste une suppression

Type

boolean

$recurrence_id

$recurrence_id :string

Défini la date de l'exception pour l'occurrence (nouvelle version)

Type

string

$realuid

$realuid :string

UID réellement stocké dans la base de données (utilisé pour les exceptions) (Lecture seule)

Type

string

$id

$id :string

Identifiant unique de l'évènement

Type

string

$calendar

$calendar :string

Identifiant du calendrier de l'évènement

Type

string

$uid

$uid :string

UID de l'évènement

Type

string

$owner

$owner :string

Créateur de l'évènement

Type

string

$keywords

$keywords :string

Keywords

Type

string

$title

$title :string

Titre de l'évènement

Type

string

$description

$description :string

Description de l'évènement

Type

string

$category

$category :string

Catégorie de l'évènment

Type

string

$location

$location :string

Lieu de l'évènement

Type

string

$status

$status :\LibMelanie\Api\Defaut\Event::STATUS_*

Statut de l'évènement

Type

\LibMelanie\Api\Defaut\Event::STATUS_*

$class

$class :\LibMelanie\Api\Defaut\Event::CLASS_*

Class de l'évènement (privé/public)

Type

\LibMelanie\Api\Defaut\Event::CLASS_*

$alarm

$alarm :integer

Alarme en minute (TODO: class Alarm)

Type

integer

$attendees

$attendees :array<mixed,\LibMelanie\Api\Defaut\Attendee>

Tableau d'objets Attendee

Type

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

$start

$start :string

String au format compatible DateTime, date de début

Type

string

$end

$end :string

String au format compatible DateTime, date de fin

Type

string

$modified

$modified :integer

Timestamp de la modification de l'évènement

Type

integer

$recurrence

$recurrence :\LibMelanie\Api\Defaut\Recurrence

Recurrence liée à l'objet

Inaccessible depuis une exception

Type

\LibMelanie\Api\Defaut\Recurrence

$deleted

$deleted :boolean

L'évènement est supprimé

Défini si l'exception est un évènement ou juste une suppression

Type

boolean

$recurrence_id

$recurrence_id :string

Défini la date de l'exception pour l'occurrence (nouvelle version)

Type

string

$dtrecurrence_id

$dtrecurrence_id :\Datetime

Défini la date de l'exception pour l'occurrence (nouvelle version) en Datetime

Type

\Datetime

$realuid

$realuid :string

UID réellement stocké dans la base de données (utilisé pour les exceptions) (Lecture seule)

Type

string

$id

$id :string

Identifiant unique de l'évènement

Type

string

$calendar

$calendar :string

Identifiant du calendrier de l'évènement

Type

string

$uid

$uid :string

UID de l'évènement

Type

string

$owner

$owner :string

Créateur de l'évènement

Type

string

$creator_email

$creator_email :string

Email du créateur de l'évènement

Type

string

$creator_name

$creator_name :string

Nom du créateur de l'évènement

Type

string

$keywords

$keywords :string

Keywords

Type

string

$title

$title :string

Titre de l'évènement

Type

string

$description

$description :string

Description de l'évènement

Type

string

$category

$category :string

Catégorie de l'évènment

Type

string

$location

$location :string

Lieu de l'évènement

Type

string

$status

$status :\LibMelanie\Api\Defaut\Event::STATUS_*

Statut de l'évènement

Type

\LibMelanie\Api\Defaut\Event::STATUS_*

$class

$class :\LibMelanie\Api\Defaut\Event::CLASS_*

Class de l'évènement (privé/public)

Type

\LibMelanie\Api\Defaut\Event::CLASS_*

$transparency

$transparency :\LibMelanie\Api\Defaut\Event::TRANSP_*

Etat de transparence de l'événement

Type

\LibMelanie\Api\Defaut\Event::TRANSP_*

$priority

$priority :\LibMelanie\Api\Defaut\Event::PRIORITY_*

Priorité de l'événement

Type

\LibMelanie\Api\Defaut\Event::PRIORITY_*

$sequence

$sequence :integer

Séquence de l'événement

Type

integer

$alarm

$alarm :integer

Alarme en minute (TODO: class Alarm)

Type

integer

$attendees

$attendees :array<mixed,\LibMelanie\Api\Defaut\Attendee>

Tableau d'objets Attendee

Type

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

$hasattendees

$hasattendees :boolean

Est-ce que cette instance de l'événement a des participants

Type

boolean

$start

$start :string

String au format compatible DateTime, date de début

Type

string

$end

$end :string

String au format compatible DateTime, date de fin

Type

string

$dtstart

$dtstart :\DateTime

DateTime basée sur le champ $start

Type

\DateTime

$dtend

$dtend :\DateTime

DateTime basée sur le champ $end

Type

\DateTime

$timezone

$timezone :string

Timezone de l'événement

Type

string

$all_day

$all_day :boolean

Est-ce que c'est un événement journée entière

Type

boolean

$created

$created :integer

Timestamp de création de l'évènement

Type

integer

$modified

$modified :integer

Timestamp de la modification de l'évènement

Type

integer

$recurrence

$recurrence :\LibMelanie\Api\Defaut\Recurrence

objet Recurrence

Type

\LibMelanie\Api\Defaut\Recurrence

$organizer

$organizer :\LibMelanie\Api\Defaut\Organizer

objet Organizer

Type

\LibMelanie\Api\Defaut\Organizer

$exceptions

$exceptions :array<mixed,\LibMelanie\Api\Defaut\Exception>

Liste d'exception

Type

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

$attachments

$attachments :array<mixed,\LibMelanie\Api\Defaut\Attachment>

Liste des pièces jointes associées à l'évènement (URL ou Binaire)

Type

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

$deleted

$deleted :boolean

Défini si l'exception est un évènement ou juste une suppression

Type

boolean

$ics

$ics :string

ICS associé à l'évènement courant, calculé à la volée en attendant la mise en base de données

Type

string

$move

$move :boolean

Il s'ajout d'un MOVE, les participants sont conservés

Type

boolean

$version

$version :integer

Version de schéma pour l'événement

Type

integer

$dtstart_utc

$dtstart_utc :\DateTime

DateTime basée sur le champ $start au timezone UTC

Type

\DateTime

$dtend_utc

$dtend_utc :\DateTime

DateTime basée sur le champ $end au timezone UTC

Type

\DateTime

$realuid

$realuid :string

UID réellement stocké dans la base de données (utilisé pour les exceptions) (Lecture seule)

Type

string

$vcalendar

$vcalendar :\LibMelanie\Api\Defaut\VObject\Component\VCalendar

Object VCalendar associé à l'évènement, peut permettre des manipulations sur les récurrences

Type

\LibMelanie\Api\Defaut\VObject\Component\VCalendar

$_dtrecurrence_id

$_dtrecurrence_id :\DateTime

DateTime basée sur le recurrence_id

Type

\DateTime

$organizer

$organizer :string

Organisateur de l'évènement

Type

string

$deleted

$deleted :boolean

L'évènement est supprimé

Type

boolean

$attributes

$attributes :\LibMelanie\Api\Defaut\array[$attribute]

Tableau d'attributs pour l'évènement

Type

\LibMelanie\Api\Defaut\array[$attribute]

$attributes_loaded

$attributes_loaded :boolean

Permet de savoir si les attributs ont déjà été chargés depuis la base

Type

boolean

$attachments

$attachments :array<mixed,\LibMelanie\Api\Defaut\Attachment>

Tableau contenant les pièces jointes de l'évènement

Type

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

$_dtstart

$_dtstart :\DateTime

DateTime basée sur le champ $start

Type

\DateTime

$_olddtstart

$_olddtstart :\DateTime

DateTime basée sur l'ancien champ $start

Type

\DateTime

$_dtstart_utc

$_dtstart_utc :\DateTime

DateTime basée sur le champ $start au timezone UTC

Type

\DateTime

$_dtend

$_dtend :\DateTime

DateTime basée sur le champ $end

Type

\DateTime

$_olddtend

$_olddtend :\DateTime

DateTime basée sur l'ancien champ $end

Type

\DateTime

$_dtend_utc

$_dtend_utc :\DateTime

DateTime basée sur le champ $end au timezone UTC

Type

\DateTime

$move

$move :boolean

Défini s'il s'agit d'un move qui nécessite de conserver les participants Dans ce cas les participants doivent être doublés

Type

boolean

$exceptions

$exceptions :array<mixed,\LibMelanie\Api\Defaut\Exception>

Tableau d'exceptions pour la récurrence

Type

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

$deleted_exceptions

$deleted_exceptions :array<mixed,\LibMelanie\Api\Defaut\Exception>

Tableau d'exceptions a supprimer au moment du save

Type

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

$vcalendar

$vcalendar :\LibMelanie\Api\Defaut\VCalendar

Object VCalendar disponible via le VObject

Type

\LibMelanie\Api\Defaut\VCalendar

Methods

setEventParent()

setEventParent(\LibMelanie\Api\Defaut\Event  $eventParent)

Défini l'évènement parent de l'exception

Parameters

\LibMelanie\Api\Defaut\Event $eventParent

getEventParent()

getEventParent(): \LibMelanie\Api\Defaut\Event

Retourne l'évènement parent de l'exception

Returns

\LibMelanie\Api\Defaut\Event

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

getAttribute()

getAttribute(string  $name): string|NULL

Retourne un attribut supplémentaire pour l'évènement

Parameters

string $name

Nom de l'attribut

Returns

string|NULL —

valeur de l'attribut, null s'il n'existe pas

setAttribute()

setAttribute(string  $name,string  $value)

Met à jour ou ajoute l'attribut

Parameters

string $name

Nom de l'attribut
string $value

Valeur de l'attribut

setAttributes()

setAttributes(array  $attributes)

Method permettant de définir directement la liste des attributs de l'évènement

Parameters

array $attributes

deleteAttribute()

deleteAttribute(string  $name)

Suppression d'un attribut

Parameters

string $name

createOrganizerException()

createOrganizerException(\LibMelanie\Api\Defaut\Event  $organizer_event)

Créer l'exception dans l'agenda de l'organisateur

Parameters

\LibMelanie\Api\Defaut\Event $organizer_event

keepNeedActionFieldsEvent()

keepNeedActionFieldsEvent(  $event,  $organizer_event)

Conserver les champs de l'organisateur pour les champs déterminants du en attente

Parameters

$event
$organizer_event

move()

move(string  $calendar_id)

Déplacement d'un évènement d'un calendrier à un autre

Parameters

string $calendar_id

Identifiant du calendrier source

useJsonData()

useJsonData(): boolean

Détermine si les nouvelles données en JSON peuvent être utilisés

Returns

boolean

clearAttendees()

clearAttendees()

Cas ou les participants ont été changée dans les data Réinitialise la variable temporaire _attendees pour faire un recalcul au prochain appel

addException()

addException(\LibMelanie\Api\Defaut\Exception  $exception)

Ajoute une nouvelle exception à la liste sans avoir à recharger toutes les exceptions

Parameters

\LibMelanie\Api\Defaut\Exception $exception

Throws

\LibMelanie\Exceptions\ObjectMelanieUndefinedException

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 l'évènement, en fonction du calendar et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si l'évènement existe, en fonction du calendar et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde l'évènement et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime l'évènement et met à jour l'historique dans la base de données

Returns

boolean

load()

load(): boolean

Chargement l'évènement, en fonction du calendar et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si l'évènement existe, en fonction du calendar et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde l'évènement et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime l'évènement et met à jour l'historique dans la base de données

Returns

boolean

load()

load(): boolean

Chargement l'évènement, en fonction du calendar et de l'uid

Returns

boolean

exists()

exists(): boolean

Test si l'évènement existe, en fonction du calendar et de l'uid

Returns

boolean

save()

save(): boolean

Sauvegarde l'évènement et l'historique dans la base de données

Returns

boolean

delete()

delete(): boolean

Supprime l'évènement et met à jour l'historique dans la base de données

Returns

boolean

setMapRecurrence()

setMapRecurrence(\LibMelanie\Api\Defaut\Recurrence  $recurrence)

Mapping recurrence field

Parameters

\LibMelanie\Api\Defaut\Recurrence $recurrence

getMapRecurrence()

getMapRecurrence()

Mapping recurrence field

setMapRecurrence_id()

setMapRecurrence_id(string  $recurrence_id)

Mapping recurrence_id field

Parameters

string $recurrence_id

getMapRecurrence_id()

getMapRecurrence_id()

Mapping recurrence_id field

getMapDtrecurrence_id()

getMapDtrecurrence_id()

Mapping dtrecurrence_id field

setMapUid()

setMapUid(string  $uid)

Mapping uid field

Parameters

string $uid

getMapUid()

getMapUid()

Mapping uid field

getMapOrganizer()

getMapOrganizer()

Mapping organizer field

setAttributeJson()

setAttributeJson(  $name,  $value)

Positionne un attribut uniquement en json le temps que lightning attributes est toujours utilisée en écriture

Parameters

$name
$value

attributesToJson()

attributesToJson()

Converti la liste des attributs en une valeur json exploitable

saveAttendees()

saveAttendees()

Nouvelle version de l'enregistrement des participants

setExternalOrganizer()

setExternalOrganizer(\LibMelanie\Api\Defaut\Organizer  $organizer): boolean

L'organisateur est un externe

Parameters

\LibMelanie\Api\Defaut\Organizer $organizer

Returns

boolean —

false

listEventsByUid()

listEventsByUid(string  $uid,string  $owner = null): array<mixed,\LibMelanie\Api\Defaut\Event>

Lister les événements associés à un uid et un owner

Parameters

string $uid

Uid a rechercher
string $owner

[Optionnel] owner associé

Returns

array<mixed,\LibMelanie\Api\Defaut\Event> —

Liste des Events

userIsOrganizer()

userIsOrganizer(string  $organizer_uid,string  $user_uid): boolean

Est-ce que l'utilisateur est l'organisateur en se basant sur l'uid

Parameters

string $organizer_uid

Uid de l'organisateur
string $user_uid

Uid de l'utilisateur

Returns

boolean

saveNeedAction()

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()

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

Parameters

\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()

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

Parameters

\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()

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

Parameters

\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

Returns

boolean —

L'événement doit il être enregistré

deleteNeedAction()

deleteNeedAction()

L'événement est supprimé dans l'agenda de l'organisateur On passe tous les participants Mélanie2 en événement annulé

deleteAttachments()

deleteAttachments()

Suppression de la liste des pièces jointes liées à l'évènement

saveAttributes()

saveAttributes()

Sauvegarde les attributs dans la base de données

loadAttributes()

loadAttributes()

Charge les attributs en mémoire

deleteAttributes()

deleteAttributes()

Supprime les attributs

deleteOldOccurrences()

deleteOldOccurrences()

Lors d'un changement de date de fin de récurrence supprime toutes les occurrences modifiées après la nouvelle date

updateOccurrences()

updateOccurrences()

Actualise toutes les occurrences avec les nouvelles valeurs si elles n'avaient pas changées

updateOccurrenceAttendees()

updateOccurrenceAttendees(\LibMelanie\Api\Defaut\Exception  $exception)

Mise a jour des participants de l'occurrence à partir de la récurrence

Parameters

\LibMelanie\Api\Defaut\Exception $exception

setMapModified()

setMapModified(integer  $modified)

Mapping modified field

Parameters

integer $modified

getMapTimezone()

getMapTimezone()

Mapping timezone field

getMapAll_day()

getMapAll_day()

Mapping all_day field

setMapStart()

setMapStart(string  $start)

Mapping start field

Parameters

string $start

setMapDtstart()

setMapDtstart(\DateTime  $dtstart)

Mapping dtstart field

Parameters

\DateTime $dtstart

getMapDtstart()

getMapDtstart()

Mapping dtstart field

getMapDtstart_utc()

getMapDtstart_utc()

Mapping dtstart_utc field

getMapOlddtstart()

getMapOlddtstart()

Mapping olddtstart field

setMapEnd()

setMapEnd(string  $end)

Mapping end field

Parameters

string $end

setMapDtend()

setMapDtend(\DateTime  $dtend)

Mapping dtend field

Parameters

\DateTime $dtend

getMapDtend()

getMapDtend()

Mapping dtend field

getMapDtend_utc()

getMapDtend_utc()

Mapping dtend_utc field

getMapOlddtend()

getMapOlddtend()

Mapping olddtend field

setMapClass()

setMapClass(\LibMelanie\Api\Defaut\Event::CLASS_*  $class)

Mapping class field

Parameters

\LibMelanie\Api\Defaut\Event::CLASS_* $class

getMapClass()

getMapClass()

Mapping class field

setMapStatus()

setMapStatus(\LibMelanie\Api\Defaut\Event::STATUS_*  $status)

Mapping status field

Parameters

\LibMelanie\Api\Defaut\Event::STATUS_* $status

getMapStatus()

getMapStatus()

Mapping status field

setMapTransparency()

setMapTransparency(\LibMelanie\Api\Defaut\Event::TRANSP_*  $transparency)

Mapping transparency field

Parameters

\LibMelanie\Api\Defaut\Event::TRANSP_* $transparency

getMapTransparency()

getMapTransparency()

Mapping transparency field

setMapPriority()

setMapPriority(\LibMelanie\Api\Defaut\Event::PRIORITY_*  $priority)

Mapping priority field

Parameters

\LibMelanie\Api\Defaut\Event::PRIORITY_* $priority

getMapPriority()

getMapPriority()

Mapping priority field

setMapAttendees()

setMapAttendees(array<mixed,\LibMelanie\Api\Defaut\Attendee>  $attendees)

Mapping attendees field

Parameters

array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees

getMapAttendees()

getMapAttendees()

Mapping attendees field

attendeeIsList()

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

Parameters

\LibMelanie\Api\Defaut\Attendee $attendee
array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees

[In/Out]
string $Attendee
boolean $attendeeFound

[In/Out]

mergeAttendees()

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

Parameters

array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees
array<mixed,\LibMelanie\Api\Defaut\Attendee> $newAttendees

Returns

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

getMapHasAttendees()

getMapHasAttendees(): boolean

Mapping hasattendees field

Returns

boolean

getMapRealUid()

getMapRealUid()

Mapping real uid field

setMapDeleted()

setMapDeleted(boolean  $deleted)

Mapping deleted field

Parameters

boolean $deleted

getMapDeleted()

getMapDeleted()

Mapping deleted field

setMapCreator_email()

setMapCreator_email(boolean  $creator_email)

Mapping creator_email field

Parameters

boolean $creator_email

getMapCreator_email()

getMapCreator_email()

Mapping creator_email field

issetMapCreator_email()

issetMapCreator_email()

Mapping creator_email field

setMapCreator_name()

setMapCreator_name(boolean  $creator_name)

Mapping creator_name field

Parameters

boolean $creator_name

getMapCreator_name()

getMapCreator_name()

Mapping creator_name field

issetMapCreator_name()

issetMapCreator_name()

Mapping creator_name field

loadExceptions()

loadExceptions(): boolean

Charge les exceptions en mémoire Doit être utilisé quand l'évènement n'existe pas, donc que le load retourne false

Returns

boolean

isAttendee()

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

Parameters

string $email
array<mixed,\LibMelanie\Api\Defaut\Attendee> $attendees

Returns

boolean

notException()

notException(): boolean

Test pour savoir si on est dans une exception ou un évènement maitre

Returns

boolean

checkRecurrence()

checkRecurrence(): boolean

MANTIS 0005125: Bloquer les répétitions "récursives" Vérifier que la durée de l'événement est plus courte que la durée de l'événement

Returns

boolean —

True si tout est OK, false sinon

useNewMode()

useNewMode(): boolean

Détermine si on est dans le nouveau schéma de l'ORM

Returns

boolean