\LibMelanie\Api\Defaut\ResourcesLocality

Classe locality pour les ressources par defaut

Summary

Methods

Properties

Constants

registerCache()
executeCache()
getList()
__construct()
save()
delete()
load()
exists()
listAllLocalities()
listResources()
save()
load()
delete()

$dn
$uid
$name

PREF_SCOPE_DEFAULT
PREF_SCOPE_CALENDAR
RIGHT_READ
RIGHT_WRITE
RIGHT_SEND
RIGHT_ADMIN
MAPPING
DN

No protected methods found

$serializedProperties

N/A

No private methods found

No private properties found

N/A

abstract

File: Api/Defaut/Resources/Locality.php
Package: LibMCE\API/Defaut
Class hierarchy: \LibMelanie\Lib\MceObject

\LibMelanie\Api\Defaut\Resources\Locality

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

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

MAPPING

MAPPING =array()

Configuration du mapping qui surcharge la conf

DN

DN =null

DN a utiliser comme base pour les requetes

Properties

$dn

$dn :string

DN de la localite dans l'annuaire

Type

string

$uid

$uid :string

Identifiant de la localite

Type

string

$name

$name :string

Nom de la localite

Type

string

$serializedProperties

$serializedProperties :

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

Type

Methods

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

__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

listAllLocalities()

listAllLocalities(): array

Récupération de la liste des locality

Returns

array —

Liste des localités

listResources()

listResources(string  $type = null,array  $listUids = null,array  $listEmails = null): array

Récupération de la liste des resources appartenant a une localité

Parameters

string	$type	Type de la resource
array	$listUids	Liste des uids des resources
array	$listEmails	Liste des emails des resources

Returns

array —

Liste des resources

save()

save(): boolean

Enregistrement de la localite dans l'annuaire

Returns

boolean

load()

load(): boolean

Chargement de la localite dans l'annuaire

Returns

boolean

delete()

delete(): boolean

Suppression de la localite dans l'annuaire

Returns

boolean