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

Classe utilisateur pour GN basé sur le User MCE

Summary

Methods
Properties
Constants
__construct()
save()
delete()
authentification()
load()
exists()
asRight()
getObjectsShared()
getShared()
getObjectsSharedEmission()
getSharedEmission()
getObjectsSharedGestionnaire()
getSharedGestionnaire()
getGroups()
getGroupsIsMember()
getListsIsMember()
getPreference()
getDefaultPreference()
getCalendarPreference()
getTaskslistPreference()
getAddressbookPreference()
savePreference()
saveDefaultPreference()
saveCalendarPreference()
saveTaskslistPreference()
saveAddressbookPreference()
deletePreference()
getUserWorkspaces()
getSharedWorkspaces()
cleanWorkspaces()
getUserNewsShares()
cleanNewsShare()
isNewsPublisher()
getUserNews()
getUserLastNews()
getUserLastTwoNews()
cleanNews()
getUserRss()
cleanRss()
getNotifications()
readNotification()
deleteNotification()
addNotification()
getDefaultCalendar()
setDefaultCalendar()
createDefaultCalendar()
getUserCalendars()
getSharedCalendars()
cleanCalendars()
getDefaultTaskslist()
setDefaultTaskslist()
createDefaultTaskslist()
getUserTaskslists()
getSharedTaskslists()
cleanTaskslists()
getDefaultAddressbook()
setDefaultAddressbook()
createDefaultAddressbook()
getUserAddressbooks()
getSharedAddressbooks()
cleanAddressbooks()
registerCache()
executeCache()
getList()
getTimezone()
authentification()
save()
load()
exists()
authentification()
save()
save()
$dn
$uid
$fullname
$name
$type
$email
$email_list
$email_send
$email_send_list
$shares
$away_response
$internet_access_admin
$internet_access_user
$server_routage
$supported_shares
$internet_access_enable
$server_host
$server_user
$is_objectshare
$objectshare
$is_synchronisation_enable
$synchronisation_profile
$dn
$uid
$fullname
$name
$type
$email
$email_list
$email_send
$email_send_list
$shares
$street
$postalcode
$locality
$title
$server_host
$outofoffices
$supported_shares
$internet_access_enable
$server_host
$server_user
$is_objectshare
$objectshare
$is_synchronisation_enable
$synchronisation_profile
$dn
$uid
$fullname
$name
$type
$email
$email_list
$email_send
$email_send_list
$shares
$supported_shares
$is_synchronisation_enable
$synchronisation_profile
$is_individuelle
$is_partagee
$is_fonctionnelle
$is_ressource
$is_unite
$is_service
$is_personne
$is_applicative
$is_list
$is_listab
MAPPING
PREF_SCOPE_DEFAULT
PREF_SCOPE_CALENDAR
PREF_SCOPE_ADDRESSBOOK
PREF_SCOPE_TASKSLIST
RIGHT_READ
RIGHT_WRITE
RIGHT_SEND
RIGHT_ADMIN
setMapUid()
getMapInternet_access_enable()
getMapServer_host()
getMapServer_user()
getMapOutofoffices()
setMapOutofoffices()
setMapShares()
getMapShares()
getMapSupported_shares()
setMapSupported_shares()
setMapFullname()
getMapFullname()
setMapName()
getMapName()
setMapStreet()
getMapStreet()
setMapLocality()
getMapLocality()
setMapTitle()
getMapTitle()
getObjectShareDelimiter()
_get_preferences()
_get_user_services()
_set_news_is_publisher()
_is_in_services()
getMapIs_objectshare()
getMapObjectshare()
getMapIs_synchronisation_enable()
setMapIs_synchronisation_enable()
getMapSynchronisation_profile()
setMapSynchronisation_profile()
getMapIs_individuelle()
getMapIs_partagee()
getMapIs_fonctionnelle()
getMapIs_ressource()
getMapIs_unite()
getMapIs_service()
getMapIs_personne()
getMapIs_applicative()
getMapIs_list()
getMapList()
getMapIs_listab()
getMapIs_mailbox()
$objectshare
$group
$otherldapobject
$_defaultAddressbook
$serializedProperties
$_sharesRead
$_sharesWrite
$_sharesSend
$_sharesAdmin
N/A
No private methods found
No private properties found
N/A

Constants

MAPPING

MAPPING =array("dn" => 'dn', "uid" => 'mail', "fullname" => 'cn', "name" => 'displayname', "lastname" => 'sn', "firstname" => 'givenname', "email" => 'mail', "email_list" => array(\LibMelanie\Config\MappingMce::name => 'mailalternateaddress', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "email_send" => 'mail', "email_send_list" => array(\LibMelanie\Config\MappingMce::name => 'mailalternateaddress', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "shares" => array(\LibMelanie\Config\MappingMce::name => 'mcedelegation', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "server_host" => array(\LibMelanie\Config\MappingMce::name => 'mailhost', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "type" => 'mcetypecompte', "street" => 'street', "postalcode" => 'postalcode', "locality" => 'l', "title" => 'title', "memberof" => array(\LibMelanie\Config\MappingMce::name => 'memberof', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "outofoffices" => array(\LibMelanie\Config\MappingMce::name => 'mcevacation', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "mcemailroutingaddress" => array(\LibMelanie\Config\MappingMce::name => 'mcemailroutingaddress', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "deliverymode" => array(\LibMelanie\Config\MappingMce::name => 'deliverymode', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "codeunite" => 'codeunite', "displayname" => 'displayname', "employeenumber" => 'employeenumber', "givenname" => 'givenname', "modifiedtime" => 'mcemodifiedtimestamp')

Configuration du mapping qui surcharge la conf

PREF_SCOPE_DEFAULT

PREF_SCOPE_DEFAULT =\LibMelanie\Config\ConfigMelanie::GENERAL_PREF_SCOPE

Scope de preference par defaut pour l'utilisateur

PREF_SCOPE_CALENDAR

PREF_SCOPE_CALENDAR =\LibMelanie\Config\ConfigMelanie::CALENDAR_PREF_SCOPE

Scope de preference pour les calendriers de l'utilisateur

PREF_SCOPE_ADDRESSBOOK

PREF_SCOPE_ADDRESSBOOK =\LibMelanie\Config\ConfigMelanie::ADDRESSBOOK_PREF_SCOPE

Scope de preference pour les carnets d'adresses de l'utilisateur

PREF_SCOPE_TASKSLIST

PREF_SCOPE_TASKSLIST =\LibMelanie\Config\ConfigMelanie::TASKSLIST_PREF_SCOPE

Scope de preference pour les listes de taches de l'utilisateur

RIGHT_READ

RIGHT_READ ='read'

Droit de lecture

RIGHT_WRITE

RIGHT_WRITE ='write'

Droit d'écriture

RIGHT_SEND

RIGHT_SEND ='send'

Droit d'émission

RIGHT_ADMIN

RIGHT_ADMIN ='admin'

Droit de gestion

Properties

$dn

$dn :string

DN de l'utilisateur dans l'annuaire

Type

string

$uid

$uid :string

Identifiant unique de l'utilisateur

Type

string

$fullname

$fullname :string

Nom complet de l'utilisateur

Type

string

$name

$name :string

Nom de l'utilisateur

Type

string

$type

$type :string

Type de boite (voir Mce\Users\Type::*)

Type

string

$email

$email :string

Adresse email principale de l'utilisateur

Type

string

$email_list

$email_list :array

Liste de toutes les adresses email de l'utilisateur

Type

array

$email_send

$email_send :string

Adresse email d'émission principale de l'utilisateur

Type

string

$email_send_list

$email_send_list :array

Liste de toutes les adresses email d'émission de l'utilisateur

Type

array

$shares

$shares :array<mixed,\LibMelanie\Api\Gn\Users\Share>

Liste des partages de la boite

Type

array<mixed,\LibMelanie\Api\Gn\Users\Share>

$away_response

$away_response :string

Message d'absence de l'utilisateur (TODO: Objet pour traiter la syntaxe)

Type

string

$internet_access_admin

$internet_access_admin :integer

Accés Internet positionné par l'administrateur

Type

integer

$internet_access_user

$internet_access_user :integer

Accés Internet positionné par l'utilisateur

Type

integer

$server_routage

$server_routage :array

Champ de routage pour le serveur de message de l'utilisateur

Type

array

$supported_shares

$supported_shares :array

Liste des droits supportés par cette boite

Type

array

$internet_access_enable

$internet_access_enable :boolean

Est-ce que l'accès Internet de l'utilisateur est activé

Type

boolean

$server_host

$server_host :string

Host du serveur de messagerie de l'utilisateur

Type

string

$server_user

$server_user :string

User du serveur de messagerie de l'utilisateur

Type

string

$is_objectshare

$is_objectshare :boolean

Est-ce que cet utilisateur est en fait un objet de partage

Type

boolean

$objectshare

$objectshare :\LibMelanie\Api\Gn\ObjectShare

Retourne l'objet de partage lié à cet utilisateur si s'en est un

Type

\LibMelanie\Api\Gn\ObjectShare

$is_synchronisation_enable

$is_synchronisation_enable :boolean

Est-ce que la synchronisation est activée pour l'utilisateur ?

Type

boolean

$synchronisation_profile

$synchronisation_profile :string

Profil de synchronisation positionné pour l'utilisateur (STANDARD ou SENSIBLE)

Type

string

$dn

$dn :string

DN de l'utilisateur dans l'annuaire

Type

string

$uid

$uid :string

Identifiant unique de l'utilisateur

Type

string

$fullname

$fullname :string

Nom complet de l'utilisateur

Type

string

$name

$name :string

Nom de l'utilisateur

Type

string

$type

$type :string

Type de boite (voir Mce\Users\Type::*)

Type

string

$email

$email :string

Adresse email principale de l'utilisateur

Type

string

$email_list

$email_list :array

Liste de toutes les adresses email de l'utilisateur

Type

array

$email_send

$email_send :string

Adresse email d'émission principale de l'utilisateur

Type

string

$email_send_list

$email_send_list :array

Liste de toutes les adresses email d'émission de l'utilisateur

Type

array

$shares

$shares :array<mixed,\LibMelanie\Api\Mce\Users\Share>

Liste des partages de la boite

Type

array<mixed,\LibMelanie\Api\Mce\Users\Share>

$street

$street :string

Adresse - Rue de l'utilisateur

Type

string

$postalcode

$postalcode :string

Adresse - Code postal de l'utilisateur

Type

string

$locality

$locality :string

Adresse - Ville de l'utilisateur

Type

string

$title

$title :string

Titre de l'utilisateur

Type

string

$server_host

$server_host :array

Champ de routage pour le serveur de message de l'utilisateur

Type

array

$outofoffices

$outofoffices :array<mixed,\LibMelanie\Api\Mce\Users\Outofoffice>

Tableau de gestionnaire d'absence pour l'utilisateur

Type

array<mixed,\LibMelanie\Api\Mce\Users\Outofoffice>

$supported_shares

$supported_shares :array

Liste des droits supportés par cette boite

Type

array

$internet_access_enable

$internet_access_enable :boolean

Est-ce que l'accès Internet de l'utilisateur est activé

Type

boolean

$server_host

$server_host :string

Host du serveur de messagerie de l'utilisateur

Type

string

$server_user

$server_user :string

User du serveur de messagerie de l'utilisateur

Type

string

$is_objectshare

$is_objectshare :boolean

Est-ce que cet utilisateur est en fait un objet de partage

Type

boolean

$objectshare

$objectshare :\LibMelanie\Api\Mce\ObjectShare

Objet de partage associé a l'utilisateur courant si nécessaire

Retourne l'objet de partage lié à cet utilisateur si s'en est un

Type

\LibMelanie\Api\Mce\ObjectShare

$is_synchronisation_enable

$is_synchronisation_enable :boolean

Est-ce que la synchronisation est activée pour l'utilisateur ?

Type

boolean

$synchronisation_profile

$synchronisation_profile :string

Profil de synchronisation positionné pour l'utilisateur (STANDARD ou SENSIBLE)

Type

string

$dn

$dn :string

DN de l'utilisateur dans l'annuaire

Type

string

$uid

$uid :string

Identifiant unique de l'utilisateur

Type

string

$fullname

$fullname :string

Nom complet de l'utilisateur

Type

string

$name

$name :string

Nom de l'utilisateur

Type

string

$type

$type :string

Type de boite (voir Mce\Users\Type::*)

Type

string

$email

$email :string

Adresse email principale de l'utilisateur

Type

string

$email_list

$email_list :array

Liste de toutes les adresses email de l'utilisateur

Type

array

$email_send

$email_send :string

Adresse email d'émission principale de l'utilisateur

Type

string

$email_send_list

$email_send_list :array

Liste de toutes les adresses email d'émission de l'utilisateur

Type

array

$shares

$shares :array<mixed,\LibMelanie\Api\Defaut\Users\Share>

Liste des partages de la boite

Type

array<mixed,\LibMelanie\Api\Defaut\Users\Share>

$supported_shares

$supported_shares :array

Liste des droits supportés par cette boite

Type

array

$is_synchronisation_enable

$is_synchronisation_enable :boolean

Est-ce que la synchronisation est activée pour l'utilisateur ?

Type

boolean

$synchronisation_profile

$synchronisation_profile :string

Profil de synchronisation positionné pour l'utilisateur (STANDARD ou SENSIBLE)

Type

string

$is_individuelle

$is_individuelle :boolean

Est-ce qu'il s'agit d'une boite individuelle ?

Type

boolean

$is_partagee

$is_partagee :boolean

Est-ce qu'il s'agit d'une boite partagée ?

Type

boolean

$is_fonctionnelle

$is_fonctionnelle :boolean

Est-ce qu'il s'agit d'une boite fonctionnelle ?

Type

boolean

$is_ressource

$is_ressource :boolean

Est-ce qu'il s'agit d'une boite de ressources ?

Type

boolean

$is_unite

$is_unite :boolean

Est-ce qu'il s'agit d'une boite d'unité ?

Type

boolean

$is_service

$is_service :boolean

Est-ce qu'il s'agit d'une boite de service ?

Type

boolean

$is_personne

$is_personne :boolean

Est-ce qu'il s'agit d'une boite personne ?

Type

boolean

$is_applicative

$is_applicative :boolean

Est-ce qu'il s'agit d'une boite applicative ?

Type

boolean

$is_list

$is_list :boolean

Est-ce qu'il s'agit d'une liste ?

Type

boolean

$is_listab

$is_listab :boolean

Est-ce qu'il s'agit d'une list a abonnement ?

Type

boolean

$serializedProperties

$serializedProperties :

Liste des propriétés à sérialiser pour le cache

Type

$_sharesRead

$_sharesRead :

Droits de lecture sur la boite

Type

$_sharesWrite

$_sharesWrite :

Droits d'écriture sur la boite

Type

$_sharesSend

$_sharesSend :

Droits d'envoi de messages sur la boite

Type

$_sharesAdmin

$_sharesAdmin :

Droits de niveau administrateur ou gestionnaire sur la boite

Type

Methods

__construct()

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

Constructeur de l'objet

Parameters

string $server

Serveur d'annuaire a utiliser en fonction de la configuration
string $itemName

Nom de l'objet associé dans la configuration LDAP

save()

save(): null

Enregistrement de l'objet Nettoie le cache du user

Returns

null —

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

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Returns

boolean

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

string $password
boolean $master

Utiliser le serveur maitre (nécessaire pour faire des modifications)
string $user_dn

DN de l'utilisateur si ce n'est pas le courant a utiliser
boolean $gssapi

Utiliser une authentification GSSAPI sans mot de passe
string $itemName

Nom de l'objet associé dans la configuration LDAP

Returns

boolean

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

array $attributes

[Optionnal] List of attributes to load

Returns

boolean —

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

array $attributes

[Optionnal] List of attributes to load

Returns

boolean —

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

string $username
string $right

Voir User::RIGHT_*

Returns

boolean

getObjectsShared()

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

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

Parameters

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

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

array $attributes

[Optionnal] List of attributes to load

Returns

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

Liste d'objets

getPreference()

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

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

Parameters

string $scope

Scope de la préférence, voir User::PREF_SCOPE*
string $name

Nom de la préférence

Returns

string —

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

string $name

Nom de la préférence

Returns

string —

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

string $name

Nom de la préférence

Returns

string —

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

string $name

Nom de la préférence

Returns

string —

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

string $name

Nom de la préférence

Returns

string —

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

string $scope

Scope de la préférence, voir User::PREF_SCOPE*
string $name

Nom de la préférence
string $value

Valeur de la préférence a enregistrer

Returns

boolean

saveDefaultPreference()

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

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

Parameters

string $name

Nom de la préférence
string $value

Valeur de la préférence a enregistrer

Returns

boolean

saveCalendarPreference()

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

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

Parameters

string $name

Nom de la préférence
string $value

Valeur de la préférence a enregistrer

Returns

boolean

saveTaskslistPreference()

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

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

Parameters

string $name

Nom de la préférence
string $value

Valeur de la préférence a enregistrer

Returns

boolean

saveAddressbookPreference()

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

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

Parameters

string $name

Nom de la préférence
string $value

Valeur de la préférence a enregistrer

Returns

boolean

deletePreference()

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

Supprime la préférence de l'utilisateur

Parameters

string $scope

Scope de la préférence, voir User::PREF_SCOPE*
string $name

Nom de la préférence

Returns

boolean

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

string $orderby

[Optionnel] nom du champ a trier
boolean $asc

[Optionnel] tri ascendant ?
integer $limit

[Optionnel] limite du nombre de résultats à retourner
integer $offset

[Optionnel] offset pour la pagination

Returns

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

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

string $orderby

[Optionnel] nom du champ a trier
boolean $asc

[Optionnel] tri ascendant ?
integer $limit

[Optionnel] limite du nombre de résultats à retourner
integer $offset

[Optionnel] offset pour la pagination

Returns

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

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

array<mixed,\LibMelanie\Api\Defaut\News\NewsShare>

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

$news

getUserNews()

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

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

Returns

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

getUserLastNews()

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

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

Returns

\LibMelanie\Api\Defaut\News\News

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

array —

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

\LibMelanie\Api\Defaut\News\Rss

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

integer $last

[Optionnel] Dernier timestamp de récupération des notifications

Returns

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

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

string|\LibMelanie\Api\Defaut\Notification $notification

Notification ou uid de la notification
boolean $read

Passer en lu ?

Returns

boolean

deleteNotification()

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

Supprime la notification de l'utilisateur

Parameters

string|\LibMelanie\Api\Defaut\Notification $notification

Notification ou uid de la notification

Returns

boolean

addNotification()

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

Ajoute la notification pour l'utilisateur

Parameters

\LibMelanie\Api\Defaut\Notification $notification

Notification

Returns

string|boolean —

Uid de la nouvelle notification si Ok, false sinon

getDefaultCalendar()

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

Retourne le calendrier par défaut

Returns

\LibMelanie\Api\Defaut\Calendar —

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

string|\LibMelanie\Api\Defaut\Calendar $calendar

Calendrier à mettre par défaut pour l'utilisateur

Returns

boolean

createDefaultCalendar()

createDefaultCalendar(string  $calendarName = null): true

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

Parameters

string $calendarName

[Optionnel] Nom du calendrier

Returns

true —

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

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

getSharedCalendars()

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

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

Returns

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

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

\LibMelanie\Api\Defaut\Taskslist

setDefaultTaskslist()

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

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

Parameters

string|\LibMelanie\Api\Defaut\Taskslist $taskslist

Liste de tâches à mettre par défaut pour l'utilisateur

Returns

boolean

createDefaultTaskslist()

createDefaultTaskslist(string  $taskslistName = null): true

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

Parameters

string $taskslistName

[Optionnel] Nom de la liste de taches

Returns

true —

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

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

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

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

cleanTaskslists()

cleanTaskslists()

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

setDefaultAddressbook()

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

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

Parameters

string|\LibMelanie\Api\Defaut\Addressbook $addressbook

Carnet d'adresses à mettre par défaut pour l'utilisateur

Returns

boolean

createDefaultAddressbook()

createDefaultAddressbook(string  $addressbookName = null): true

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

Parameters

string $addressbookName

[Optionnel] Nom du carnet d'adresses

Returns

true —

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

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

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

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

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

$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

getTimezone()

getTimezone(): string

[OSOLETE] Chargement du timezone de l'utilisateur

Returns

string

authentification()

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

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

Parameters

mixed $password
mixed $master

Returns

boolean

save()

save(): boolean

Enregistrement de l'utilisateur dans l'annuaire

Returns

boolean

load()

load(): boolean

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

Returns

boolean

exists()

exists(): boolean

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

Returns

boolean

authentification()

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

Authentification sur le serveur LDAP

Authentification de l'utilisateur sur l'annuaire MCE

Parameters

mixed $password
mixed $master

Utiliser le serveur maitre (nécessaire pour faire des modifications)

Returns

boolean

save()

save(): boolean

Enregistrement de l'objet Nettoie le cache du user

Enregistrement de l'utilisateur dans l'annuaire

Returns

boolean

save()

save(): boolean

Enregistrement de l'utilisateur dans l'annuaire

Returns

boolean

setMapUid()

setMapUid(string  $uid)

Mapping uid field

Parameters

string $uid

getMapInternet_access_enable()

getMapInternet_access_enable(): boolean

Récupération du champ internet_access_enable

Returns

boolean —

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

mixed|NULL —

Valeur du serveur host, null si non trouvé

getMapServer_user()

getMapServer_user(): mixed|NULL

Récupération du champ server_user

Returns

mixed|NULL —

Valeur du serveur user, null si non trouvé

getMapOutofoffices()

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

Récupération du champ out of offices

Returns

array<mixed,\LibMelanie\Api\Gn\Users\Outofoffice> —

Tableau de d'objets Outofoffice

setMapOutofoffices()

setMapOutofoffices(array<mixed,\LibMelanie\Api\Gn\Users\Outofoffice>  $OofObjects)

Positionnement du champ out of offices

Parameters

array<mixed,\LibMelanie\Api\Gn\Users\Outofoffice> $OofObjects

setMapShares()

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

Mapping shares field

Parameters

array<mixed,\LibMelanie\Api\Gn\Users\Share> $shares

getMapShares()

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

Mapping shares field

Returns

array<mixed,\LibMelanie\Api\Gn\Users\Share> —

Liste des partages positionnés sur cette boite

getMapSupported_shares()

getMapSupported_shares(): array

Mapping shares field

Returns

array —

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

setMapSupported_shares()

setMapSupported_shares(): boolean

Mapping shares field

Returns

boolean —

false non supporté

setMapFullname()

setMapFullname(string  $fullname)

Mapping fullname field

Parameters

string $fullname

getMapFullname()

getMapFullname()

Mapping fullname field

setMapName()

setMapName(string  $name)

Mapping name field

Parameters

string $name

getMapName()

getMapName()

Mapping name field

setMapStreet()

setMapStreet(string  $street)

Mapping street field

Parameters

string $street

getMapStreet()

getMapStreet()

Mapping street field

setMapLocality()

setMapLocality(string  $locality)

Mapping locality field

Parameters

string $locality

getMapLocality()

getMapLocality()

Mapping locality field

setMapTitle()

setMapTitle(string  $title)

Mapping title field

Parameters

string $title

getMapTitle()

getMapTitle()

Mapping locality field

getObjectShareDelimiter()

getObjectShareDelimiter(): string

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

Returns

string —

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

boolean $sharedServices

[Optionnal] Permet de lister les services associés aux droits de l'utilisateurs

Returns

array —

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

$news

_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

string $service
array $servicesList

Returns

boolean

getMapIs_objectshare()

getMapIs_objectshare(): boolean

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

Returns

boolean —

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

\LibMelanie\Api\Defaut\ObjectShare —

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

getMapIs_synchronisation_enable()

getMapIs_synchronisation_enable(): boolean

Mapping is_synchronisation_enable field

Returns

boolean —

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

setMapIs_synchronisation_enable()

setMapIs_synchronisation_enable(string  $is_synchronisation_enable): boolean

Mapping is_synchronisation_enable field

Parameters

string $is_synchronisation_enable

Si la synchronisation de l'utilisateur est activée

Returns

boolean —

false non supporté

getMapSynchronisation_profile()

getMapSynchronisation_profile(): string

Mapping synchronisation_profile field

Returns

string —

Profil de synchronisation de l'utilisateur

setMapSynchronisation_profile()

setMapSynchronisation_profile(string  $synchronisation_profile): boolean

Mapping synchronisation_profile field

Parameters

string $synchronisation_profile

Profil de synchronisation de l'utilisateur

Returns

boolean —

false non supporté

getMapIs_individuelle()

getMapIs_individuelle(): boolean

Mapping is_individuelle field

Returns

boolean —

true si la boite est individuelle

getMapIs_partagee()

getMapIs_partagee(): boolean

Mapping is_partagee field

Returns

boolean —

true si la boite est partagée

getMapIs_fonctionnelle()

getMapIs_fonctionnelle(): boolean

Mapping is_fonctionnelle field

Returns

boolean —

true si la boite est fonctionnelle

getMapIs_ressource()

getMapIs_ressource(): boolean

Mapping is_ressource field

Returns

boolean —

true si la boite est une ressource

getMapIs_unite()

getMapIs_unite(): boolean

Mapping is_unite field

Returns

boolean —

true si la boite est une unite

getMapIs_service()

getMapIs_service(): boolean

Mapping is_service field

Returns

boolean —

true si la boite est un service

getMapIs_personne()

getMapIs_personne(): boolean

Mapping is_personne field

Returns

boolean —

true si la boite est une personne

getMapIs_applicative()

getMapIs_applicative(): boolean

Mapping is_applicative field

Returns

boolean —

true si la boite est une application

getMapIs_list()

getMapIs_list(): boolean

Mapping is_list field

Returns

boolean —

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

\LibMelanie\Api\Defaut\Group —

Groupe associé, null si pas une liste

getMapIs_listab()

getMapIs_listab(): boolean

Mapping is_listab field

Returns

boolean —

true si la boite est une listab

getMapIs_mailbox()

getMapIs_mailbox(): boolean

Mapping is_mailbox field

Returns

boolean —

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