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

Classe utilisateur pour Mel

Summary

Methods
Properties
Constants
__construct()
save()
delete()
load()
exists()
getPreference()
getDefaultPreference()
getCalendarPreference()
savePreference()
saveDefaultPreference()
saveCalendarPreference()
deletePreference()
getDefaultCalendar()
setDefaultCalendar()
createDefaultCalendar()
getUserCalendars()
getSharedCalendars()
cleanCalendars()
registerCache()
executeCache()
getList()
save()
load()
delete()
save()
load()
delete()
$dn
$uid
$fullname
$name
$email
$email_list
$type
$service
$bal
$street
$postalcode
$locality
$description
$roomnumber
$title
$batiment
$etage
$capacite
$caracteristiques
$dn
$uid
$fullname
$name
$email
$email_list
$type
$service
$bal
$street
$postalcode
$locality
$description
$roomnumber
$title
$batiment
$etage
$capacite
$caracteristiques
PREF_SCOPE_DEFAULT
PREF_SCOPE_CALENDAR
TYPE_FLEX_OFFICE
TYPE_SALLE
TYPE_VEHICULE
TYPE_MATERIEL
MAPPING
DN
_get_preferences()
$serializedProperties
N/A
No private methods found
No private properties found
N/A

Constants

PREF_SCOPE_DEFAULT

PREF_SCOPE_DEFAULT =\LibMelanie\Config\ConfigMelanie::GENERAL_PREF_SCOPE

Scope de preference par defaut pour la ressource

PREF_SCOPE_CALENDAR

PREF_SCOPE_CALENDAR =\LibMelanie\Config\ConfigMelanie::CALENDAR_PREF_SCOPE

Scope de preference pour les calendriers de la ressource

TYPE_FLEX_OFFICE

TYPE_FLEX_OFFICE ='Flex Office'

Type de ressource : Flex office

TYPE_SALLE

TYPE_SALLE ='Salle'

Type de ressource : Salle

TYPE_VEHICULE

TYPE_VEHICULE ='Véhicule'

Type de ressource : Véhicule

TYPE_MATERIEL

TYPE_MATERIEL ='Matériel'

Type de ressource : Matériel

MAPPING

MAPPING =array("dn" => 'dn', "uid" => 'uid', "fullname" => 'cn', "name" => 'givenname', "type" => 'sn', "email" => 'mailpr', "email_list" => array(\LibMelanie\Config\MappingMce::name => 'mail', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "service" => 'departmentnumber', "bal" => 'mineqtypeentree', "street" => 'street', "postalcode" => 'postalcode', "locality" => 'l', "description" => 'description', "roomnumber" => 'roomnumber', "title" => 'title', "batiment" => array(\LibMelanie\Config\MappingMce::name => 'info', \LibMelanie\Config\MappingMce::prefixLdap => 'Ressource.Batiment: ', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "etage" => array(\LibMelanie\Config\MappingMce::name => 'info', \LibMelanie\Config\MappingMce::prefixLdap => 'Ressource.Etage: ', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "capacite" => array(\LibMelanie\Config\MappingMce::name => 'info', \LibMelanie\Config\MappingMce::prefixLdap => 'Ressource.Capacite: ', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "caracteristiques" => array(\LibMelanie\Config\MappingMce::name => 'info', \LibMelanie\Config\MappingMce::prefixLdap => 'Ressource.Caracteristiques: ', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "batiment" => array(\LibMelanie\Config\MappingMce::name => 'info', \LibMelanie\Config\MappingMce::prefixLdap => 'Ressource.Batiment: ', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::stringLdap), "modifiedtime" => 'mineqmodifiedtimestamp')

Configuration du mapping qui surcharge la conf

DN

DN ='ou=Ressources,ou=BNUM,ou=applications,ou=ressources,dc=equipement,dc=gouv,dc=fr'

DN a utiliser comme base pour les requetes

Properties

$dn

$dn :string

DN de la ressource dans l'annuaire

Type

string

$uid

$uid :string

Identifiant unique de la ressource

Type

string

$fullname

$fullname :string

Nom complet de la ressource

Type

string

$name

$name :string

Nom de la ressource

Type

string

$email

$email :string

Adresse email principale de la ressource

Type

string

$email_list

$email_list :array

Liste de toutes les adresses email de la ressource

Type

array

$type

$type :string

Type de ressource (voir Resource::TYPE_*)

Type

string

$service

$service :string

Service de la ressource

Type

string

$bal

$bal :string

Type de boite aux lettres

Type

string

$street

$street :string

Rue de la ressource

Type

string

$postalcode

$postalcode :string

Code postal de la ressource

Type

string

$locality

$locality :string

Ville de la ressource

Type

string

$description

$description :string

Description de la ressource

Type

string

$roomnumber

$roomnumber :string

Numéro de bureau de la ressource

Type

string

$title

$title :string

Titre de la ressource

Type

string

$batiment

$batiment :string

Batiment de la ressource

Type

string

$etage

$etage :string

Etage de la ressource

Type

string

$capacite

$capacite :string

Capacité de la ressource

Type

string

$caracteristiques

$caracteristiques :string

Caractéristiques de la ressource

Type

string

$dn

$dn :string

DN de la ressource dans l'annuaire

Type

string

$uid

$uid :string

Identifiant unique de la ressource

Type

string

$fullname

$fullname :string

Nom complet de la ressource

Type

string

$name

$name :string

Nom de la ressource

Type

string

$email

$email :string

Adresse email principale de la ressource

Type

string

$email_list

$email_list :array

Liste de toutes les adresses email de la ressource

Type

array

$type

$type :string

Type de ressource (voir Resource::TYPE_*)

Type

string

$service

$service :string

Service de la ressource

Type

string

$bal

$bal :string

Type de boite aux lettres

Type

string

$street

$street :string

Rue de la ressource

Type

string

$postalcode

$postalcode :string

Code postal de la ressource

Type

string

$locality

$locality :string

Ville de la ressource

Type

string

$description

$description :string

Description de la ressource

Type

string

$roomnumber

$roomnumber :string

Numéro de bureau de la ressource

Type

string

$title

$title :string

Titre de la ressource

Type

string

$batiment

$batiment :string

Batiment de la ressource

Type

string

$etage

$etage :string

Etage de la ressource

Type

string

$capacite

$capacite :string

Capacité de la ressource

Type

string

$caracteristiques

$caracteristiques :string

Caractéristiques de la ressource

Type

string

$serializedProperties

$serializedProperties :

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

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

load()

load(array  $attributes = null): boolean

Charge les données de la ressource 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 la ressource 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

getPreference()

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

Récupère la préférence de la ressource

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

savePreference()

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

Enregistre la préférence de la ressource

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 la ressource 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 la ressource 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

deletePreference()

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

Supprime la préférence de la ressource

Parameters

string $scope

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

Nom de la préférence

Returns

boolean

getDefaultCalendar()

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

Retourne le calendrier par défaut

Returns

\LibMelanie\Api\Defaut\Calendar —

Calendrier par défaut de la ressource, null s'il n'existe pas

setDefaultCalendar()

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

Modifie le calendrier par défaut de la ressource

Parameters

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

Calendrier à mettre par défaut pour la ressource

Returns

boolean

createDefaultCalendar()

createDefaultCalendar(string  $calendarName = null): true

Création du calendrier par défaut pour la ressource 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 la ressource

Returns

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

getSharedCalendars()

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

Retourne la liste des calendriers de la ressource 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)

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

save()

save(): boolean

Enregistrement de l'objet Nettoie le cache du user

Enregistrement de la ressource dans l'annuaire

Returns

boolean

load()

load(): boolean

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

Chargement de la ressource dans l'annuaire

Returns

boolean

delete()

delete(): boolean

Suppression de l'objet Nettoie le cache du user

Suppression de la ressource dans l'annuaire

Returns

boolean

save()

save(): boolean

Enregistrement de la ressource dans l'annuaire

Returns

boolean

load()

load(): boolean

Chargement de la ressource dans l'annuaire

Returns

boolean

delete()

delete(): boolean

Suppression de la ressource dans l'annuaire

Returns

boolean

_get_preferences()

_get_preferences()

Liste les préférences de la ressource et les conserves en mémoire