Référence de la classe Bdu_Configuration

Classe contenant la configuration de l'api. Plus de détails...

Fonctions membres publiques
	setLogger (Bdu_Log_LoggerInterface $logger=null)
	Spécifie un logger.
	getLogger ()
	setCharset ($charset="UTF-8")
	Réglage de l'encodage.
	getCharset ()
	setCredentials ($bindlogin, $type, $credentials)
	Règle les paramètres de connexion de la classe.
	getCredentials ()

Attributs publics
const	TYPE_PEOPLE = 'people'
	Compte utilisateur standard.
const	TYPE_GROUP = 'groups'
	Compte de groupe (associations)
const	TYPE_APPLI = 'applications'
	Compte spécial (VIA, SdE...)
const	WEBSERVICE_HOST = "https://webservice.campus.ecp.fr/"
	Url du webservice.

Description détaillée

Classe contenant la configuration de l'api.

Auteur

Christophe Coevoet

Documentation des fonctions membres

Bdu_Configuration::getCharset

(

)

Renvoie

string

Bdu_Configuration::getCredentials

(

)

Renvoie

array

Exceptions

Bdu_Exception_UnsufficientConnectionParameters

Bdu_Configuration::getLogger

(

)

Renvoie

Bdu_Log_LoggerInterface

Bdu_Configuration::setCharset

(

$charset = "UTF-8"

)

Réglage de l'encodage.

Par défaut l'encoding est UTF-8. Si vous utilisez Latin9 vous devez appeler cette méthode pour modifier le réglage, sinon tous les caractères accentués dans les résultats de recherches seront erronés

Paramètres

string

$charset

"Latin9" ou "UTF-8" (défaut "UTF-8")

Bdu_Configuration::setCredentials	(		$bindlogin,
			$type,
			$credentials
	)

Règle les paramètres de connexion de la classe.

Ces paramètres ont du vous être donné par un administrateur du SdE. Il est impératif d'appeler cette méthode avant toute autre appel à une méthode de la classe.

Paramètres

string	$bindlogin	Login de connexion
string	$type	Type d'utilisateur: TYPE_PEOPLE, TYPE_GROUP ou TYPE_APPLI
string	$credentials	Credentials (mot de passe)

Exceptions

Bdu_Exception_InvalidCredentials

si le type est invalide

Bdu_Configuration::setLogger

(

Bdu_Log_LoggerInterface

$logger = null

)

Spécifie un logger.

Pour supprimer le logger, il suffit d'appeler la méthode sans argument

Paramètres

Bdu_Log_LoggerInterface

$logger

Documentation des données membres

const Bdu_Configuration::TYPE_APPLI = 'applications'

Compte spécial (VIA, SdE...)

const Bdu_Configuration::TYPE_GROUP = 'groups'

Compte de groupe (associations)

const Bdu_Configuration::TYPE_PEOPLE = 'people'

Compte utilisateur standard.

Exemples:

initialisation.php.

const Bdu_Configuration::WEBSERVICE_HOST = "https://webservice.campus.ecp.fr/"

Url du webservice.