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

Gestion de groupe MCE

Summary

Methods
Properties
Constants
__construct()
serialize()
unserialize()
load()
exists()
setData()
authentification()
getBalp()
getBalpEmission()
getBalpGestionnaire()
getGroups()
getGroupsIsMember()
getListsIsMember()
getUserWorkspaces()
getSharedWorkspaces()
getDefaultCalendar()
getUserCalendars()
getSharedCalendars()
getDefaultTaskslist()
getUserTaskslists()
getSharedTaskslists()
getDefaultAddressbook()
getUserAddressbooks()
getSharedAddressbooks()
getTimezone()
get_mapping_attributes()
getOldData()
fieldsHasChanged()
fieldHasChanged()
setFieldHasChanged()
anyFieldHasChanged()
getFieldValueFromData()
setFieldValueToData()
setIsLoaded()
getIsLoaded()
setIsExist()
getIsExist()
__get_data()
__set_data()
__copy_from()
__toString()
$timezone
SERVER_MAPPING_PREF
OBJECT_TYPE
Init()
getMappingName()
$server
$mapping
$unchangeableProperties
$isInit
$data
$oldData
$haschanged
$isExist
$isLoaded
$objectType
$primaryKeys
$get_class
N/A
getEntry()
getCreationEntry()
generateFilter()
readItemConfiguration()
explodeParts()
No private properties found
N/A

Constants

SERVER_MAPPING_PREF

SERVER_MAPPING_PREF ='mapping_resource'

Nom de la configuration du mapping dans les preferences serveur

OBJECT_TYPE

OBJECT_TYPE ='ResourceMelanie'

Type d'objet pour la gestion du mapping

Properties

$timezone

$timezone :string

Timezone de l'utilisateur

Type

string

$server

$server :string

Quel serveur LDAP utiliser pour la lecture des données

Type

string

$mapping

$mapping :array

Mapping des données

Type

array

$unchangeableProperties

$unchangeableProperties :array

Liste des propriétés qui ne peuvent pas être modifiées

Type

array—Valeur static

$isInit

$isInit :boolean

Est-ce que l'objet a déjà été initialisé

Type

boolean

$data

$data :array

Stockage des données cachées

Type

array

$oldData

$oldData :array

Stockage des anciennes données lors d'un changement

Type

array

$haschanged

$haschanged :array

Défini si les propriété ont changé pour les requêtes SQL

Type

array

$isExist

$isExist :boolean

Est-ce que l'objet existe

Type

boolean

$isLoaded

$isLoaded :boolean

Est-ce que l'objet est chargé

Type

boolean

$objectType

$objectType :string

Type d'objet, lié au mapping

Type

string

$primaryKeys

$primaryKeys :mixed

Les clés primaires de l'objet

Type

mixed

$get_class

$get_class :string

Classe courante

Type

string

Methods

__construct()

__construct(string  $server = null,array  $unchangeableProperties = null,array  $mapping = null,string  $itemName = null,string  $baseDN = null)

Constructeur de la class

Parameters

string $server

Serveur d'annuaire a utiliser en fonction de la configuration
array $unchangeableProperties

Liste des propriétés qui ne peut pas être modifiées
array $mapping

Données de mapping
string $itemName

Nom de l'objet associé dans la configuration LDAP
string $baseDN

Base DN de l'objet

serialize()

serialize(): string

String representation of object

Returns

string

unserialize()

unserialize(string  $serialized): void

Constructs the object

Parameters

string $serialized

load()

load(array  $attributes = null,string  $filter = null,string  $filterFromEmail = null): boolean

Chargement de l'objet UserMelanie need: $this->dn need: $this->uid need: $this->email

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data
string $filterFromEmail

[Optionnal] Filter to load data

Returns

boolean —

isExist

exists()

exists(array  $attributes = null,string  $filter = null,string  $filterFromEmail = null): boolean

Détermine si l'objet existe dans Melanie2 need: $this->dn need: $this->uid need: $this->email

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data
string $filterFromEmail

[Optionnal] Filter to load data

Returns

boolean

setData()

setData(array  $data)

Positionne les data pour le UserMelanie

Parameters

array $data

authentification()

authentification(string  $password,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

getBalp()

getBalp(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

Récupère la liste des BALP accessibles à l'utilisateur

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getBalpEmission()

getBalpEmission(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

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

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getBalpGestionnaire()

getBalpGestionnaire(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

Récupère la liste des BALP accessibles en gestionnaire à l'utilisateur

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getGroups()

getGroups(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

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

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getGroupsIsMember()

getGroupsIsMember(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

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

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getListsIsMember()

getListsIsMember(array  $attributes = null,string  $filter = null): array<mixed,\LibMelanie\Objects\UserMelanie>

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

Parameters

array $attributes

[Optionnal] List of attributes to load
string $filter

[Optionnal] Filter to load data

Returns

array<mixed,\LibMelanie\Objects\UserMelanie> —

Liste d'objet UserMelanie

getUserWorkspaces()

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

Récupère la liste des workspaces dont l'utilisateur est owner

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\Objects\WorkspaceMelanie>

getSharedWorkspaces()

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

Récupère la liste des workspaces auxquels l'utilisateur accède

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\Objects\WorkspaceMelanie>

getUserCalendars()

getUserCalendars(): array<mixed,\LibMelanie\Objects\CalendarMelanie>

Récupère la liste des calendriers appartenant à l'utilisateur

Returns

array<mixed,\LibMelanie\Objects\CalendarMelanie>

getSharedCalendars()

getSharedCalendars(): array<mixed,\LibMelanie\Objects\CalendarMelanie>

Récupère la liste des calendriers appartenant à l'utilisateur ainsi que ceux qui lui sont partagés

Returns

array<mixed,\LibMelanie\Objects\CalendarMelanie>

getUserTaskslists()

getUserTaskslists(): array<mixed,\LibMelanie\Objects\TaskslistMelanie>

Récupère la liste des listes de tâches appartenant à l'utilisateur

Returns

array<mixed,\LibMelanie\Objects\TaskslistMelanie>

getSharedTaskslists()

getSharedTaskslists(): array<mixed,\LibMelanie\Objects\TaskslistMelanie>

Récupère la liste des listes de tâches appartenant à l'utilisateur ainsi que ceux qui lui sont partagés

Returns

array<mixed,\LibMelanie\Objects\TaskslistMelanie>

getUserAddressbooks()

getUserAddressbooks(): array<mixed,\LibMelanie\Objects\AddressbookMelanie>

Récupère la liste des listes de contacts appartenant à l'utilisateur

Returns

array<mixed,\LibMelanie\Objects\AddressbookMelanie>

getSharedAddressbooks()

getSharedAddressbooks(): array<mixed,\LibMelanie\Objects\AddressbookMelanie>

Récupère la liste des listes de contacts appartenant à l'utilisateur ainsi que ceux qui lui sont partagés

Returns

array<mixed,\LibMelanie\Objects\AddressbookMelanie>

getTimezone()

getTimezone()

Recupère le timezone par défaut pour le need: $this->uid

get_mapping_attributes()

get_mapping_attributes(array  $attributes): array

Génère un tableau d'attribut mappés

Parameters

array $attributes

Liste des attributs a mapper

Returns

array —

$attributesmapping

getOldData()

getOldData(string  $name): mixed

Retourne les données avant la modification

Parameters

string $name

Returns

mixed

fieldsHasChanged()

fieldsHasChanged(): array

Retourne la liste de tous les champs qui ont changé

Returns

array

fieldHasChanged()

fieldHasChanged(string  $name): boolean

Détermine si le champ a changé

Parameters

string $name

Returns

boolean

setFieldHasChanged()

setFieldHasChanged(string  $name,boolean  $haschanged = true)

Positionne si le champ a changé

Parameters

string $name
boolean $haschanged

anyFieldHasChanged()

anyFieldHasChanged(): boolean

Détermine si au moins un champ a changé

Returns

boolean

getFieldValueFromData()

getFieldValueFromData(string  $name): mixed

Récupère la valeur du champ dans data Nécessaire pour effectuer des comparaisons bruts

Parameters

string $name

Returns

mixed

setFieldValueToData()

setFieldValueToData(string  $name,string  $value)

Positionne la valeur du champ dans data

Parameters

string $name
string $value

setIsLoaded()

setIsLoaded(boolean  $isLoaded = true)

Positionne la valeur de isLoaded

Parameters

boolean $isLoaded

getIsLoaded()

getIsLoaded(): boolean

Retourne la valeur de isLoaded

Returns

boolean —

$isLoaded

setIsExist()

setIsExist(boolean  $isExist = true)

Positionne la valeur de isExist

Parameters

boolean $isExist

getIsExist()

getIsExist(): boolean

Retourne la valeur de isExist

Returns

boolean —

$isExist

__get_data()

__get_data(): array

Return data array

Returns

array

__set_data()

__set_data(  $data)

Set data array

Parameters

$data

__copy_from()

__copy_from(\LibMelanie\Lib\MagicObject  $object,boolean  $initilizeHasChanged = false,array  $ignores = array()): boolean

Copy l'objet depuis un autre

Parameters

\LibMelanie\Lib\MagicObject $object
boolean $initilizeHasChanged
array $ignores

Returns

boolean

__toString()

__toString(): string

Méthode toString pour afficher le contenu des données de la classe

Returns

string

Init()

Init(array  $mapping = array(),  $server = null): boolean

Appel l'initialisation du mapping

Parameters

array $mapping

Données de mapping
$server

Returns

boolean

getMappingName()

getMappingName(string  $name): string

Retourne le nom du champ dans le mapping

Parameters

string $name

Returns

string

getEntry()

getEntry(): array

Récupère l'entrée générée suite au changement de valeur

Returns

array

getCreationEntry()

getCreationEntry(): array

Récupère l'entrée à créer à partir de toutes les données

Returns

array

generateFilter()

generateFilter(string  $filter): string

Génération du filtre ldap en fonction des attributs du user

Parameters

string $filter

Filtre à traiter

Returns

string —

Filtre généré

readItemConfiguration()

readItemConfiguration(string  $itemName,string  $server)

Lire la configuration LDAP de l'item si elle existe supporte également des configurations par partie : objet.item.name

Parameters

string $itemName

Nom de l'objet dans la configuration
string $server

Serveur ou chercher la configuration

explodeParts()

explodeParts(string  $itemName): array

Transforme un itemName en parts pour les retrouver dans la conf

Parameters

string $itemName

Returns

array