\LibMelanie\Api\MiMember

__construct()

__construct(string  $server = null,string  $itemName = null)

Constructeur de l'objet

Parameters

save()

save(): null

Enregistrement de l'objet Nettoie le cache du user

Returns

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

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Returns

authentification()

authentification(string  $password = null,boolean  $master = false,string  $user_dn = null,boolean  $gssapi = false,string  $itemName = null): boolean

Authentification sur le serveur LDAP

Parameters

Returns

load()

load(array  $attributes = null): boolean

Charge les données de l'utilisateur depuis l'annuaire (en fonction de l'uid ou l'email)

Parameters

Returns

true si l'objet existe dans l'annuaire false sinon

exists()

exists(array  $attributes = null): boolean

Est-ce que l'utilisateur existe dans l'annuaire (en fonction de l'uid ou l'email) Effectue un load cette méthode a donc peu d'intéret dans cet objet

Parameters

Returns

true si l'objet existe dans l'annuaire false sinon

asRight()

asRight(string  $username,string  $right): boolean

Est-ce que l'utilisateur a les droits demandés sur cette boite

Parameters

Returns

getObjectsShared()

getObjectsShared(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\ObjectShare>

Récupère la liste des objets de partage accessibles à l'utilisateur

Parameters

Returns

Liste d'objets

getShared()

getShared(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\User>

Récupère la liste des boites partagées à l'utilisateur

Parameters

Returns

Liste de boites

getObjectsSharedEmission()

getObjectsSharedEmission(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\ObjectShare>

Récupère la liste des objets de partage accessibles au moins en émission à l'utilisateur

Parameters

Returns

Liste d'objets

getSharedEmission()

getSharedEmission(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\User>

Récupère la liste des boites accessibles au moins en émission à l'utilisateur

Parameters

Returns

Liste d'objets

getObjectsSharedGestionnaire()

getObjectsSharedGestionnaire(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\ObjectShare>

Récupère la liste des objets de partage accessibles en tant que gestionnaire pour l'utilisateur

Parameters

Returns

Liste d'objets

getSharedGestionnaire()

getSharedGestionnaire(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\User>

Récupère la liste des boites accessibles en tant que gestionnaire pour l'utilisateur

Parameters

Returns

Liste d'objets

getGroups()

getGroups(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\Group>

Récupère la liste des groupes dont l'utilisateur est propriétaire

Parameters

Returns

Liste d'objets

getGroupsIsMember()

getGroupsIsMember(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\Group>

Récupère la liste des groupes dont l'utilisateur est membre

Parameters

Returns

Liste d'objets

getListsIsMember()

getListsIsMember(array  $attributes = null): array<mixed,\LibMelanie\Api\Defaut\Group>

Récupère la liste des listes de diffusion dont l'utilisateur est membre

Parameters

Returns

Liste d'objets

getPreference()

getPreference(string  $scope,string  $name): string

Récupère la préférence de l'utilisateur

Parameters

Returns

La valeur de la préférence si elle existe, null sinon

getDefaultPreference()

getDefaultPreference(string  $name): string

Récupération de la préférence avec un scope Default

Parameters

Returns

La valeur de la préférence si elle existe, null sinon

getCalendarPreference()

getCalendarPreference(string  $name): string

Récupération de la préférence avec un scope Calendar

Parameters

Returns

La valeur de la préférence si elle existe, null sinon

getTaskslistPreference()

getTaskslistPreference(string  $name): string

Récupération de la préférence avec un scope Taskslist

Parameters

Returns

La valeur de la préférence si elle existe, null sinon

getAddressbookPreference()

getAddressbookPreference(string  $name): string

Récupération de la préférence avec un scope Addressbook

Parameters

Returns

La valeur de la préférence si elle existe, null sinon

savePreference()

savePreference(string  $scope,string  $name,string  $value): boolean

Enregistre la préférence de l'utilisateur

Parameters

Returns

saveDefaultPreference()

saveDefaultPreference(string  $name,string  $value): boolean

Enregistre la préférence de l'utilisateur avec le scope Default

Parameters

Returns

saveCalendarPreference()

saveCalendarPreference(string  $name,string  $value): boolean

Enregistre la préférence de l'utilisateur avec le scope Calendar

Parameters

Returns

saveTaskslistPreference()

saveTaskslistPreference(string  $name,string  $value): boolean

Enregistre la préférence de l'utilisateur avec le scope Taskslist

Parameters

Returns

saveAddressbookPreference()

saveAddressbookPreference(string  $name,string  $value): boolean

Enregistre la préférence de l'utilisateur avec le scope Addressbook

Parameters

Returns

deletePreference()

deletePreference(string  $scope,string  $name): boolean

Supprime la préférence de l'utilisateur

Parameters

Returns

getUserWorkspaces()

getUserWorkspaces(string  $orderby = null,boolean  $asc = true,integer  $limit = null,integer  $offset = null): array<mixed,\LibMelanie\Api\Defaut\Workspace>

Retourne la liste des workspaces de l'utilisateur

Parameters

Returns

getSharedWorkspaces()

getSharedWorkspaces(string  $orderby = null,boolean  $asc = true,integer  $limit = null,integer  $offset = null): array<mixed,\LibMelanie\Api\Defaut\Workspace>

Retourne la liste des workspaces de l'utilisateur et ceux qui lui sont partagés

Parameters

Returns

cleanWorkspaces()

cleanWorkspaces()

Nettoyer les donnés en cache (appelé lors de la modification d'un workspace)

getUserNewsShares()

getUserNewsShares(): array<mixed,\LibMelanie\Api\Defaut\News\NewsShare>

Permet de lister les droits de l'utilisateur sur les news et les flux rss

Returns

cleanNewsShare()

cleanNewsShare()

Nettoyer les donnés en cache (appelé lors de la modification d'un NewsShare)

isNewsPublisher()

isNewsPublisher(  $news)

Permet de définir si l'utilisateur courant en est un publisher de la news

Parameters

getUserNews()

getUserNews(): array<mixed,\LibMelanie\Api\Defaut\News\News>

Retourne toutes les news de l'utilisateur liées à son service ou à ses droits

Returns

getUserLastNews()

getUserLastNews(): \LibMelanie\Api\Defaut\News\News

Retourne la dernière news de l'utilisateur liée à son service ou à ses droits

Returns

getUserLastTwoNews()

getUserLastTwoNews(): array

Récupère les deux dernières news associées à l'utilisateur Retourne la news la plus récente du service le plus éloigné de l'utilisateur (service national) et la news la plus récente du service le plus proche de l'utilisateur

Returns

2 news au maximum, la plus proche et la plus loin

cleanNews()

cleanNews()

Nettoyer les donnés en cache (appelé lors de la modification d'une news)

getUserRss()

getUserRss(): \LibMelanie\Api\Defaut\News\Rss

Retourne tous les rss de l'utilisateur liées à son service ou à ses droits

Returns

cleanRss()

cleanRss()

Nettoyer les donnés en cache (appelé lors de la modification d'un rss)

getNotifications()

getNotifications(integer  $last = null): array<mixed,\LibMelanie\Api\Defaut\Notification>

Récupération des notifications de l'utilisateur Si $last est positionné, récupère les notifications depuis le dernier timestamp

Parameters

Returns

Liste des notifications de l'utilisateur

readNotification()

readNotification(string|\LibMelanie\Api\Defaut\Notification  $notification,boolean  $read = true): boolean

Passe la notification de l'utilisateur en read (ou non si $read = false)

Parameters

Returns

deleteNotification()

deleteNotification(string|\LibMelanie\Api\Defaut\Notification  $notification): boolean

Supprime la notification de l'utilisateur

Parameters

Returns

addNotification()

addNotification(\LibMelanie\Api\Defaut\Notification  $notification): string|boolean

Ajoute la notification pour l'utilisateur

Parameters

Returns

Uid de la nouvelle notification si Ok, false sinon

getDefaultCalendar()

getDefaultCalendar(): \LibMelanie\Api\Defaut\Calendar

Retourne le calendrier par défaut

Returns

Calendrier par défaut de l'utilisateur, null s'il n'existe pas

setDefaultCalendar()

setDefaultCalendar(string|\LibMelanie\Api\Defaut\Calendar  $calendar): boolean

Modifie le calendrier par défaut de l'utilisateur

Parameters

Returns

createDefaultCalendar()

createDefaultCalendar(string  $calendarName = null): true

Création du calendrier par défaut pour l'utilisateur courant

Parameters

Returns

si la création est OK, false sinon

getUserCalendars()

getUserCalendars(): array<mixed,\LibMelanie\Api\Defaut\Calendar>

Retourne la liste des calendriers de l'utilisateur

Returns

getSharedCalendars()

getSharedCalendars(): array<mixed,\LibMelanie\Api\Defaut\Calendar>

Retourne la liste des calendriers de l'utilisateur et ceux qui lui sont partagés

Returns

cleanCalendars()

cleanCalendars()

Nettoyer les donnés en cache (appelé lors de la modification d'un calendrier)

getDefaultTaskslist()

getDefaultTaskslist(): \LibMelanie\Api\Defaut\Taskslist

Retourne la liste de tâches par défaut

Returns

setDefaultTaskslist()

setDefaultTaskslist(string|\LibMelanie\Api\Defaut\Taskslist  $taskslist): boolean

Modifie la liste de tâches par défaut de l'utilisateur

Parameters

Returns

createDefaultTaskslist()

createDefaultTaskslist(string  $taskslistName = null): true

Création de la liste de taches par défaut pour l'utilisateur courant

Parameters

Returns

si la création est OK, false sinon

getUserTaskslists()

getUserTaskslists(): array<mixed,\LibMelanie\Api\Defaut\Taskslist>

Retourne la liste des liste de tâches de l'utilisateur

Returns

getSharedTaskslists()

getSharedTaskslists(): array<mixed,\LibMelanie\Api\Defaut\Taskslist>

Retourne la liste des liste de taches de l'utilisateur et celles qui lui sont partagés

Returns

cleanTaskslists()

cleanTaskslists()

Nettoyer les donnés en cache (appelé lors de la modification d'un calendrier)

getDefaultAddressbook()

getDefaultAddressbook(): \LibMelanie\Api\Defaut\Addressbook

Retourne la liste de contacts par défaut

Returns

setDefaultAddressbook()

setDefaultAddressbook(string|\LibMelanie\Api\Defaut\Addressbook  $addressbook): boolean

Modifie le carnet d'adresses par défaut de l'utilisateur

Parameters

Returns

createDefaultAddressbook()

createDefaultAddressbook(string  $addressbookName = null): true

Création du carnet d'adresses par défaut pour l'utilisateur courant

Parameters

Returns

si la création est OK, false sinon

getUserAddressbooks()

getUserAddressbooks(): array<mixed,\LibMelanie\Api\Defaut\Addressbook>

Retourne la liste des liste de contacts de l'utilisateur

Returns

getSharedAddressbooks()

getSharedAddressbooks(): array<mixed,\LibMelanie\Api\Defaut\Addressbook>

Retourne la liste des liste de contacts de l'utilisateur et celles qui lui sont partagés

Returns

cleanAddressbooks()

cleanAddressbooks()

Nettoyer les donnés en cache (appelé lors de la modification d'un calendrier)

registerCache()

registerCache(  $app,  $callback)

Enregistrement des methodes de gestion du cache

Parameters

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

Returns

Array

getTimezone()

getTimezone(): string

[OSOLETE] Chargement du timezone de l'utilisateur

Returns

authentification()

authentification(mixed  $password,mixed  $master = false): boolean

Authentification de l'utilisateur sur l'annuaire Mélanie2

Parameters

Returns

save()

save(): boolean

Enregistrement de l'utilisateur dans l'annuaire

Returns

load()

load(): boolean

Charge les données de l'utilisateur depuis l'annuaire Mélanie2 (en fonction de l'uid ou l'email)

Returns

exists()

exists(): boolean

Est-ce que l'utilisateur existe dans l'annuaire Mélanie2 (en fonction de l'uid ou l'email)

Returns

authentification()

authentification(mixed  $password,mixed  $master = false): boolean

Authentification sur le serveur LDAP

Authentification de l'utilisateur sur l'annuaire MCE

Parameters

Returns

save()

save(): boolean

Enregistrement de l'objet Nettoie le cache du user

Enregistrement de l'utilisateur dans l'annuaire

Returns

save()

save(): boolean

Enregistrement de l'utilisateur dans l'annuaire

Returns

setMapShares()

setMapShares(array<mixed,\LibMelanie\Api\Mce\Users\Share>  $shares)

Mapping shares field

Parameters

getMapShares()

getMapShares(): array<mixed,\LibMelanie\Api\Defaut\Users\Share>

Mapping shares field

Returns

Liste des partages de l'objet

getMapOutofoffices()

getMapOutofoffices(): array<mixed,\LibMelanie\Api\Mce\Users\Outofoffice>

Récupération du champ out of offices

Returns

Tableau de d'objets Outofoffice

setMapOutofoffices()

setMapOutofoffices(  $outofoffices)

Positionnement du champ out of offices

Parameters

getMapIs_synchronisation_enable()

getMapIs_synchronisation_enable(): boolean

Mapping is_synchronisation_enable field

Returns

true si la synchronisation est activée pour l'utilisateur

getMapSynchronisation_profile()

getMapSynchronisation_profile(): string

Mapping synchronisation_profile field

Returns

Profil de synchronisation de l'utilisateur

getMapSupported_shares()

getMapSupported_shares(): array

Mapping shares field

Returns

Liste des partages supportés par cette boite ([Share::TYPE_*])

setMapUid()

setMapUid(string  $uid)

Mapping uid field

Parameters

getMapInternet_access_enable()

getMapInternet_access_enable(): boolean

Récupération du champ internet_access_enable

Returns

true si l'access internet de l'utilisateur est activé, false sinon

getMapServer_host()

getMapServer_host(): mixed|NULL

Récupération du champ server_host

Returns

Valeur du serveur host, null si non trouvé

getMapServer_user()

getMapServer_user(): mixed|NULL

Récupération du champ server_user

Returns

Valeur du serveur user, null si non trouvé

setMapSupported_shares()

setMapSupported_shares(): boolean

Mapping shares field

Returns

false non supporté

setMapFullname()

setMapFullname(string  $fullname)

Mapping fullname field

Parameters

getMapFullname()

getMapFullname()

Mapping fullname field

setMapName()

setMapName(string  $name)

Mapping name field

Parameters

getMapName()

getMapName()

Mapping name field

setMapStreet()

setMapStreet(string  $street)

Mapping street field

Parameters

getMapStreet()

getMapStreet()

Mapping street field

setMapLocality()

setMapLocality(string  $locality)

Mapping locality field

Parameters

getMapLocality()

getMapLocality()

Mapping locality field

setMapTitle()

setMapTitle(string  $title)

Mapping title field

Parameters

getMapTitle()

getMapTitle()

Mapping locality field

getObjectShareDelimiter()

getObjectShareDelimiter(): string

Récupère le délimiteur d'un objet de partage

Returns

ObjectShare::DELIMITER

_get_preferences()

_get_preferences()

Liste les préférences de l'utilisateur et les conserves en mémoire

_get_user_services()

_get_user_services(boolean  $sharedServices = true): array

Permet de lister les services associés à l'utilisateur

Parameters

Returns

Liste des services de l'utilisateur

_set_news_is_publisher()

_set_news_is_publisher(  $news)

Permet de parcourir les news et définir si l'utilisateur courant en est un publisher

Parameters

_is_in_services()

_is_in_services(string  $service,array  $servicesList): boolean

Parcours la liste des services pour déterminer si le service en fait parti Il peut également être un sous service d'un service de la liste et donc en faire partie

Parameters

Returns

getMapIs_objectshare()

getMapIs_objectshare(): boolean

Est-ce que l'utilisateur est en fait un objet de partage ?

Returns

true s'il s'agit d'un objet de partage, false sinon

getMapObjectshare()

getMapObjectshare(): \LibMelanie\Api\Defaut\ObjectShare

Récupère l'objet de partage associé à l'utilisateur courant si celui ci est bien un objet de partage

Returns

Objet de partage associé, null si pas d'objet de partage

setMapIs_synchronisation_enable()

setMapIs_synchronisation_enable(string  $is_synchronisation_enable): boolean

Mapping is_synchronisation_enable field

Parameters

Returns

false non supporté

setMapSynchronisation_profile()

setMapSynchronisation_profile(string  $synchronisation_profile): boolean

Mapping synchronisation_profile field

Parameters

Returns

false non supporté

getMapIs_individuelle()

getMapIs_individuelle(): boolean

Mapping is_individuelle field

Returns

true si la boite est individuelle

getMapIs_partagee()

getMapIs_partagee(): boolean

Mapping is_partagee field

Returns

true si la boite est partagée

getMapIs_fonctionnelle()

getMapIs_fonctionnelle(): boolean

Mapping is_fonctionnelle field

Returns

true si la boite est fonctionnelle

getMapIs_ressource()

getMapIs_ressource(): boolean

Mapping is_ressource field

Returns

true si la boite est une ressource

getMapIs_unite()

getMapIs_unite(): boolean

Mapping is_unite field

Returns

true si la boite est une unite

getMapIs_service()

getMapIs_service(): boolean

Mapping is_service field

Returns

true si la boite est un service

getMapIs_personne()

getMapIs_personne(): boolean

Mapping is_personne field

Returns

true si la boite est une personne

getMapIs_applicative()

getMapIs_applicative(): boolean

Mapping is_applicative field

Returns

true si la boite est une application

getMapIs_list()

getMapIs_list(): boolean

Mapping is_list field

Returns

true si la boite est une list

getMapList()

getMapList(): \LibMelanie\Api\Defaut\Group

Récupère l'objet de partage associé à l'utilisateur courant si celui ci est bien un objet de partage

Returns

Groupe associé, null si pas une liste

getMapIs_listab()

getMapIs_listab(): boolean

Mapping is_listab field

Returns

true si la boite est une listab

getMapIs_mailbox()

getMapIs_mailbox(): boolean

Mapping is_mailbox field

Returns

true s'il s'agit bien d'une boite (valeur par défaut pour la MCE)