Référence de la classe Bdu_Util_UnitOfWork

Classe implémentant la logique de l'api. Plus de détails...

Fonctions membres publiques
	__construct (Bdu_Configuration $configuration, Bdu_Util_Ldap $ldap, Bdu_Util_Http_Client $httpClient, Bdu_Util_Encoder $encoder)
	getStudent ($uid, $retrieve=false)
	Renvoie l'entité Bdu_Entity_Student pour le login donné
	getAssociation ($id)
	Renvoie l'association avec l'id donné ou null si elle n'existe pas dans l'UnitOfWork.
	createAssociation ($id, $name, $description, $siteUrl, $logoUrl)
	Crée une association dans l'UnitOfWork.
	getPosition ($id)
	Renvoie la fonction avec l'id donné ou null si elle n'existe pas dans l'UnitOfWork.
	createPosition ($id, $name, $standardPosition, $description, Bdu_Entity_Association $association)
	Crée une fonction dans l'UnitOfWork.
	isValidLogin ($login)
	Vérifie si un login est attribué
	search ($filter)
	Effectue la recherche dans le LDAP pour un filtre donné, instancie et retourne les élèves correpondant au résultat.
	rawSearch ($filter, $attrs=array())
	Effectue la recherche dans le LDAP pour un filtre donné et retourne le résultat.
	request ($url, $notFoundException= 'Bdu_Exception_NotFound')
	Méthode pour récupérer les données du membre depuis le webservice.

Fonctions membres protégées
	getUnserializer ()

Description détaillée

Classe implémentant la logique de l'api.

Avertissement

Cette classe n'est pas destinée à être utilisée directement. Il faut utiliser les méthodes de la classe Bdu_Api.

Auteur

Christophe Coevoet

Documentation des constructeurs et destructeur

Bdu_Util_UnitOfWork::__construct	(	Bdu_Configuration	$configuration,
		Bdu_Util_Ldap	$ldap,
		Bdu_Util_Http_Client	$httpClient,
		Bdu_Util_Encoder	$encoder
	)

Documentation des fonctions membres

Bdu_Util_UnitOfWork::createAssociation	(		$id,
			$name,
			$description,
			$siteUrl,
			$logoUrl
	)

Crée une association dans l'UnitOfWork.

Paramètres

integer	$id
string	$name
string	$description
string	$siteUrl
string	$logoUrl

Renvoie

Bdu_Entity_Association

Bdu_Util_UnitOfWork::createPosition	(		$id,
			$name,
			$standardPosition,
			$description,
		Bdu_Entity_Association	$association
	)

Crée une fonction dans l'UnitOfWork.

Paramètres

integer	$id
string	$name
string	$standardPosition
string	$description
Bdu_Entity_Association	$association

Renvoie

Bdu_Entity_Position

Bdu_Util_UnitOfWork::getAssociation

(

$id

)

Renvoie l'association avec l'id donné ou null si elle n'existe pas dans l'UnitOfWork.

Paramètres

integer

$id

Renvoie

Bdu_Entity_Association

Bdu_Util_UnitOfWork::getPosition

(

$id

)

Renvoie la fonction avec l'id donné ou null si elle n'existe pas dans l'UnitOfWork.

Paramètres

integer

$id

Renvoie

Bdu_Entity_Position

Bdu_Util_UnitOfWork::getStudent	(		$uid,
			$retrieve = false
	)

Renvoie l'entité Bdu_Entity_Student pour le login donné

Paramètres

string	$uid
boolean	$retrieve	Si true, récupère les données dans le ldap (utilisé pour vérifier la validité)

Renvoie

Bdu_Entity_Student

Bdu_Util_UnitOfWork::getUnserializer ( )

protected

Renvoie

Bdu_Util_Unserializer

Bdu_Util_UnitOfWork::isValidLogin

(

$login

)

Vérifie si un login est attribué

Paramètres

string

$login

Login

Renvoie

boolean

Bdu_Util_UnitOfWork::rawSearch	(		$filter,
			$attrs = array()
	)

Effectue la recherche dans le LDAP pour un filtre donné et retourne le résultat.

Paramètres

string	$filter	Filtre de recherche LDAP
array	$attrs	Liste des attributs à retourner

Renvoie

array Tableau des élèves trouvés (objets de type Bdu_Entity_Student)

Bdu_Util_UnitOfWork::request	(		$url,
			$notFoundException = 'Bdu_Exception_NotFound'
	)

Méthode pour récupérer les données du membre depuis le webservice.

Paramètres

string	$url	Url pour récupérer les données du webservice
string	$notFoundException	Exception levée pour une erreur 404

Renvoie

array

Exceptions

Bdu_Exception_WebserviceConnectionFailed	si le webservice n'est pas accessible
Bdu_Exception_NotFound	si une erreur 404 est retournée

Bdu_Util_UnitOfWork::search

(

$filter

)

Effectue la recherche dans le LDAP pour un filtre donné, instancie et retourne les élèves correpondant au résultat.

Paramètres

string

$filter

Filtre de recherche LDAP

Renvoie

array Tableau des élèves trouvés (objets de type Bdu_Entity_Student)