Référence de la classe CMantisUser

Cette classe à pour rôle de modéliser un utilisateur Mantis. Plus de détails...

Liste de tous les membres

Fonctions membres publiques
	__construct ($szLdapUserName, $szRealName, $iNbLetters_Mask_Right=MANTIS_IMPORTUSER_LANT_DFT_NBLETTERS_MASK_RIGHT, $iNbLetters_Mask_Left=MANTIS_IMPORTUSER_LANG_DFT_NBLETTERS_MASK_LEFT, $iAccessLevel=MANTIS_IMPORTUSER_LANG_DFT_LEVEL, $szEmail=MANTIS_IMPORTUSER_LANG_DFT_USEREMAIL, $szMotdePasse=MANTIS_IMPORTUSER_LANG_DFT_USERMDP, $bProtected=MANTIS_IMPORTUSER_LANG_DFT_USERPROTECTED, $bEnabled=MANTIS_IMPORTUSER_LANG_DFT_USERENABLED, $szAdminName=MANTIS_IMPORTUSER_LANG_DFT_USERADMINNAME)
	Constructeur : Nous permet d'initaliser nos différents attributs.
	CreateMantisUser ()
	Méthode permettant de créer un utilisateur Mantis.
	getName ()
	Méthode d'accès permettant de retourner l'attribut szName.
	setEmail ($szEmail)
	Méthode d'altération permettant d'assigner une valeur à l'attribut $szEmail.
	setAccessLevel ($iAccessLevel)
	Méthode d'altération permettant d'assigner une valeur à l'attribut $szEmail.
	setPassword ($szPassword)
	Méthode d'altération permettant d'assigner une valeur à l'attribut $szMotdePasse.
Fonctions membres publiques statiques
static	getAllAccessLevels ()
	Méthode statique permettant retourner tous les niveaux d'accès possibles d'un utilisateur.
Fonctions membres privées
	Initialize_Name ()
	Méthode permettant de formater le nom de l'utilisateur.
Attributs privés
	$szName
	$szRealName
	$szEmail
	$iAccessLevel
	$bProtected
	$bEnabled
	$szAdminName
	$szMotdePasse
	$szLdapUserName
	$iNbLetters_Mask_Right
	$iNbLetters_Mask_Left

---

Description détaillée

Cette classe à pour rôle de modéliser un utilisateur Mantis.

---

Documentation des constructeurs et destructeur

function CMantisUser::__construct	(	$	szLdapUserName,
		$	szRealName,
		$	iNbLetters_Mask_Right = MANTIS_IMPORTUSER_LANT_DFT_NBLETTERS_MASK_RIGHT,
		$	iNbLetters_Mask_Left = MANTIS_IMPORTUSER_LANG_DFT_NBLETTERS_MASK_LEFT,
		$	iAccessLevel = MANTIS_IMPORTUSER_LANG_DFT_LEVEL,
		$	szEmail = MANTIS_IMPORTUSER_LANG_DFT_USEREMAIL,
		$	szMotdePasse = MANTIS_IMPORTUSER_LANG_DFT_USERMDP,
		$	bProtected = MANTIS_IMPORTUSER_LANG_DFT_USERPROTECTED,
		$	bEnabled = MANTIS_IMPORTUSER_LANG_DFT_USERENABLED,
		$	szAdminName = MANTIS_IMPORTUSER_LANG_DFT_USERADMINNAME
	)

Constructeur : Nous permet d'initaliser nos différents attributs.

Paramètres:

	$szLdapUserName	Chaine de caractères contenant l'identifiant complet d'un utilisateur de l'annuaire.
	$szRealName	Chaine de caractères contenant le vrai nom de l'utilisateur.
	$iNbLetters_Mask_Right	Entier contenant le nombre de lettres à supprimer à partir de la fin du mot. Par défaut, cette valeur est à zéro.
	$iNbLetters_Mask_Left	Entier contenant le nombre de lettres à supprimer à partir du début du mot. Par défaut, cette variable est à zéro.
	$iAccessLevel	Entier contenant le niveau d'accès de l'utilisateur. Par défaut, cette variable à 10 (niveau le plus bas).
	$szMotdePasse	Chaine de caractère contenant le mot de passe de l'utilisateur. Par défaut, cette variable est une chaine vide.
	$szEmail	Chaine de caractères contenant l'adresse e-mail de l'utilisateur. Par défaut, cette variable est uen chaine vide.
	$bProtected	Booléen indiquant si le compte de l'utilisateur devra être protégé. Par défaut, cette variable est à false (protégé).
	$bEnabled	Booléen indiquant si le compte de l'utilisateur devra être activé dès sa création. Par défaut, cette variable est à true.
	$szAdminName	Chaine de caractères contenant le nom de l'administrateur ayant crée le compte utilisateur. Par défaut, cette variable est une chaine vide.

---

Documentation des fonctions membres

CMantisUser::CreateMantisUser

(

)

Méthode permettant de créer un utilisateur Mantis.

CMantisUser::getAllAccessLevels

(

)

[static]

Méthode statique permettant retourner tous les niveaux d'accès possibles d'un utilisateur.

Renvoie:

$AccessLevels Tableau composé de deux tableaux. Le premier tableau contient la liste des noms des différents niveaux d'accès. Le deuxième contient la liste des différentes valeurs des différents niveaux d'accès.

CMantisUser::getName

(

)

Méthode d'accès permettant de retourner l'attribut szName.

CMantisUser::Initialize_Name

(

)

[private]

Méthode permettant de formater le nom de l'utilisateur.

CMantisUser::setAccessLevel

(

$

iAccessLevel

)

Méthode d'altération permettant d'assigner une valeur à l'attribut $szEmail.

CMantisUser::setEmail

(

$

szEmail

)

Méthode d'altération permettant d'assigner une valeur à l'attribut $szEmail.

function CMantisUser::setPassword

(

$

szPassword

)

Méthode d'altération permettant d'assigner une valeur à l'attribut $szMotdePasse.

---

Documentation des données membres

CMantisUser::$bEnabled [private]

Booléen indiquant si le compte de l'utilisateur devra être activé dès sa création.

CMantisUser::$bProtected [private]

Booléen indiquant si le compte de l'utilisateur devra être protégé.

CMantisUser::$iAccessLevel [private]

Entier contenant le niveau d'accès de l'utilisateur.

CMantisUser::$iNbLetters_Mask_Left [private]

Entier contenant le nombre de lettres à supprimer à partir du début du mot.

CMantisUser::$iNbLetters_Mask_Right [private]

Entier contenant le nombre de lettres à supprimer à partir de la fin du mot.

CMantisUser::$szAdminName [private]

Chaine de caractères contenant le nom de l'administrateur ayant crée le compte utilisateur.

CMantisUser::$szEmail [private]

Chaine de caractères contenant l'adresse e-mail de l'utilisateur.

CMantisUser::$szLdapUserName [private]

Chaine de caractères contenant l'identifiant complet d'un utilisateur de l'annuaire.

CMantisUser::$szMotdePasse [private]

Chaine de caractère contenant le mot de passe de l'utilisateur.

CMantisUser::$szName [private]

Chaine de caractères contenant le nom tronqué de l'utilisateur.

CMantisUser::$szRealName [private]

Chaine de caractères contenant le vrai nom de l'utilisateur.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• D:/wamp/www/mantisbt-1.2.0rc1/plugins/MantisImportUser/pages/classes/CMantisUser.php