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

Classe groupe LDAP pour Mel

Summary

Methods
Properties
Constants
__construct()
isOwner()
authentification()
load()
exists()
setMapMembers()
registerCache()
executeCache()
getList()
save()
$dn
$fullname
$type
$email
$email_list
$members
$members_email
$owners
$service
$is_dynamic
$dn
$fullname
$type
$email
$email_list
$members
$owners
MAPPING
getMapMembers()
getMapIs_dynamic()
setMapIs_dynamic()
$serializedProperties
N/A
No private methods found
No private properties found
N/A

Constants

MAPPING

MAPPING =array("dn" => 'dn', "rdn" => 'mcerdn', "gid" => 'gidnumber', "fullname" => 'cn', "name" => 'displayname', "lastname" => 'sn', "email" => 'mail', "email_list" => array(\LibMelanie\Config\MappingMce::name => 'mailalternateaddress', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "service" => 'departmentnumber', "type" => 'mcetypeentree', "members" => array(\LibMelanie\Config\MappingMce::name => 'memberuid', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "members_email" => array(\LibMelanie\Config\MappingMce::name => 'mcemelmembres', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "owners" => array(\LibMelanie\Config\MappingMce::name => 'owner', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap), "unique_identifier" => 'uniqueidentifier', "is_dynamic" => array(\LibMelanie\Config\MappingMce::name => 'objectclass', \LibMelanie\Config\MappingMce::type => \LibMelanie\Config\MappingMce::arrayLdap))

Configuration du mapping qui surcharge la conf

Properties

$dn

$dn :string

DN du groupe l'annuaire

Type

string

$fullname

$fullname :string

Nom complet du groupe LDAP

Type

string

$type

$type :string

Type de groupe (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

$members

$members :array<mixed,\LibMelanie\Api\Mce\User>

Liste des membres appartenant au groupe

Type

array<mixed,\LibMelanie\Api\Mce\User>

$members_email

$members_email :array

Liste des adresses e-mail de la liste

Type

array

$owners

$owners :array

Liste des propriétaires du groupe LDAP

Type

array

$service

$service :string

Service du groupe dans l'annuaire

Type

string

$is_dynamic

$is_dynamic :boolean

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

Type

boolean

$dn

$dn :string

DN du groupe l'annuaire

Type

string

$fullname

$fullname :string

Nom complet du groupe LDAP

Type

string

$type

$type :string

Type de groupe (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

$members

$members :array<mixed,\LibMelanie\Api\Defaut\User>

Liste des membres appartenant au groupe

Type

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

$owners

$owners :array

Liste des propriétaires du groupe LDAP

Type

array

$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

isOwner()

isOwner(\LibMelanie\Api\Defaut\User  $user): boolean

Est-ce que l'utilisateur fait parti des propriétaires du groupes ?

Parameters

\LibMelanie\Api\Defaut\User $user

Returns

boolean

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

load()

load(array  $attributes = null): boolean

Charge les données du groupe depuis l'annuaire (en fonction du dn)

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

Charge les données du groupe depuis l'annuaire (en fonction du dn)

Parameters

array $attributes

[Optionnal] List of attributes to load

Returns

boolean —

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

setMapMembers()

setMapMembers(  $members)

Mapping members field

Parameters

$members

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 du groupe dans l'annuaire

Returns

boolean

getMapMembers()

getMapMembers(): array<mixed,\LibMelanie\Api\Defaut\User>

Mapping members field

Returns

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

Liste d'objets User

getMapIs_dynamic()

getMapIs_dynamic(): boolean

Mapping is_dynamic field

Returns

boolean —

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

setMapIs_dynamic()

setMapIs_dynamic(boolean  $is_dynamic): boolean

Mapping is_dynamic field

Parameters

boolean $is_dynamic

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

Returns

boolean —

false non supporté