\LibMelanie\LibEventToICS

Class de génération de l'ICS en fonction de l'objet évènement Méthodes Statiques

Summary

Methods

Properties

Constants

Convert()
getVCalendar()

$USE_ATTACH_URL

PRODID
VERSION

No protected methods found

No protected properties found

N/A

__construct()
getVeventFromEvent()
generationTimezone()
formatAlarm()
cleanUTF8String()
convertStatusToFR()

No private properties found

N/A

File: Lib/EventToICS.php
Package: LibMCE\Lib
Class hierarchy: \LibMelanie\Lib\EventToICS

Constants

PRODID

PRODID ='-//Groupe Messagerie MTES/ORM LibMCE' :string

Identifiant de l'outil utilisant l'ICS (pour la génération)

VERSION

VERSION ='2.0' :string

Version ICalendar utilisé pour la génération de l'ICS

Properties

$USE_ATTACH_URL

$USE_ATTACH_URL :boolean

Variable configurable depuis l'extérieur pour définir si les pièces jointes sont proposées via une URL ou directement en binaire (encodage base64)

Type

boolean

Methods

Convert()

Convert(\LibMelanie\Api\Defaut\Event  $event,\LibMelanie\Api\Defaut\Calendar  $calendar = null,\LibMelanie\Api\Defaut\User  $user = null,\Sabre\VObject\Component\VCalendar  $vcalendar = null,boolean  $useattachments = true,boolean  $isfreebusy = false): string

Génére un ICS en fonction de l'évènement passé en paramètre L'évènement doit être de type Event de la librairie LibM2 Gère également les exceptions, peut donc retourner plusieurs composant VEVENT

Parameters

\LibMelanie\Api\Defaut\Event	$event
\LibMelanie\Api\Defaut\Calendar	$calendar
\LibMelanie\Api\Defaut\User	$user
\Sabre\VObject\Component\VCalendar	$vcalendar
boolean	$useattachments	Si l'ics doit inclure les pièces jointes
boolean	$isfreebusy	Si on ne retourne que les freebusy (pas de pièce jointe ou de participants)

Returns

string —

$ics

getVCalendar()

getVCalendar(\LibMelanie\Api\Defaut\Event  $event,\LibMelanie\Api\Defaut\Calendar  $calendar = null,\LibMelanie\Api\Defaut\User  $user = null,boolean  $useattachments = true,boolean  $isfreebusy = false,  $vcalendar = null): \Sabre\VObject\Component\VCalendar

Génére un VObject\Component\VCalendar en fonction de l'évènement passé en paramètre L'évènement doit être de type Event de la librairie LibM2 Gère également les exceptions, peut donc retourner plusieurs composant VEVENT

Parameters

\LibMelanie\Api\Defaut\Event	$event
\LibMelanie\Api\Defaut\Calendar	$calendar
\LibMelanie\Api\Defaut\User	$user
boolean	$useattachments	Si l'ics doit inclure les pièces jointes
boolean	$isfreebusy	Si on ne retourne que les freebusy (pas de pièce jointe ou de participants)
	$vcalendar

Returns

\Sabre\VObject\Component\VCalendar —

$vcalendar

__construct()

__construct()

Constructeur privé pour ne pas instancier la classe

getVeventFromEvent()

getVeventFromEvent(\Sabre\VObject\Component  $vevent,\LibMelanie\Api\Defaut\Event  $event,\LibMelanie\Api\Defaut\Calendar  $calendar = null,\LibMelanie\Api\Defaut\User  $user = null,boolean  $useattachments = true,boolean  $isfreebusy = false): \Sabre\VObject\Component

Méthode permettant de générer l'objet VEVENT à partir des données de l'évènement Cette méthode est séparée pour être appelé plusieurs fois, dans le cas où l'évènement a des exceptions

Parameters

\Sabre\VObject\Component	$vevent
\LibMelanie\Api\Defaut\Event	$event
\LibMelanie\Api\Defaut\Calendar	$calendar
\LibMelanie\Api\Defaut\User	$user
boolean	$useattachments	Si l'ics doit inclure les pièces jointes
boolean	$isfreebusy	Si on ne retourne que les freebusy (pas de pièce jointe ou de participants)

Returns

\Sabre\VObject\Component —

$vevent

generationTimezone()

generationTimezone(\Sabre\VObject\Component  $vcalendar,string  $timezone)

Ajoute le timezone au VCalendar

Parameters

\Sabre\VObject\Component	$vcalendar
string	$timezone

formatAlarm()

formatAlarm(integer  $alarm): string

Formatte l'alarme en minutes en un trigger ICS

Parameters

integer

$alarm

En minutes

Returns

string

cleanUTF8String()

cleanUTF8String(string  $string): mixed

Nettoyage UTF8 des données Utilisé pour éviter le bloquage des synchros par Lightning

Parameters

string

$string

Returns

mixed

convertStatusToFR()

convertStatusToFR(string  $status): string

Retourne la traduction francaise du status ICS

Parameters

string

$status

Returns

string