Référence de la classe MantisImportUserIHM

Cette classe à pour rôle de gérer l'IHM du plugin. Plus de détails...

Fonctions membres publiques

 __construct ($server_parameters, $search_parameters)
 Constructeur : nous permet d'initaliser nos différents attributs.
 display_search_form_ldap ($call_js, $title_search=MANTIS_IMPORTUSER_TITLE_DFT_SEARCH_FORM, $fieldset_color=MANTIS_IMPORTUSER_COLOR_DEFAULT_RGB, $label_server_parameters, $label_search_parameters, $button_label=MANTIS_IMPORTUSER_LABEL_DFT_BTN_FORM)
 Méthode permettant d'afficher le formulaire de recherche.
 display_link_select_search ($first_select, $second_select, $link_color=MANTIS_IMPORTUSER_COLOR_GREEN)
 Méthode permettant d'afficher deux liens permettant de dé/sélectionner tous les élements du résultat de la recherche.
 display_result_from_search ($result, $anchors, $already_exist, $label_button=MANTIS_IMPORTUSER_LABEL_DFT_BTN_FORM, $label_another_search=MANTIS_IMPORTUSER_LABEL_DFT_LINK_FORM)
 Méthode permettant d'afficher le résultat de la recherche.

Fonctions membres publiques statiques

static display_result_message ($szMessage, $iTitleLevel, $szColor='black')
 Méthode statique permettant d'afficher un lien vers le formulaire de recherche.
static display_link_back_search ($szLink, $szMessage, $szColor='black')
 Méthode statique permettant d'afficher un lien vers le formulaire de recherche.
static display_start_div_align ($szAlign)
 Méthode statique permettant d'afficher une balise HTML DIV accompagné d'un attribut d'alignement.
static display_end_div ()
 Méthode statique permettant d'afficher une balise HTML DIV fermante.

Attributs privés

 $ldap_server
 $ldap_port
 $ldap_bind_dn
 $ldap_pwd
 $ldap_dn
 $ldap_filter
 $aListMantisUsers

Description détaillée

Cette classe à pour rôle de gérer l'IHM du plugin.


Documentation des constructeurs et destructeur

__construct ( server_parameters,
search_parameters 
)

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

Paramètres:
$server_parameters Tableau de chaines de caractères contenant les paramètres serveurs (adresse du serveur, port, bind dn, mot de passe).
$search_parameters Tableau de chaines de caractères contenant les paramètres de recherche (dn, filtre).

Documentation des fonctions membres

display_end_div (  )  [static]

Méthode statique permettant d'afficher une balise HTML DIV fermante.

display_link_back_search ( szLink,
szMessage,
szColor = 'black' 
) [static]

Méthode statique permettant d'afficher un lien vers le formulaire de recherche.

Paramètres:
$szLink Chaine de caractères contenant le lien vers le formulaire de recherche.
$szMessage Chaine de caractères contenant le message associé au lien.
$szColor Chaine de caractères contenant la couleur du lien. Par défaut, cette couleur est noire.
display_link_select_search ( first_select,
second_select,
link_color = MANTIS_IMPORTUSER_COLOR_GREEN 
)

Méthode permettant d'afficher deux liens permettant de dé/sélectionner tous les élements du résultat de la recherche.

Paramètres:
$first_select Tableau de chaines de caractères contenant le nom du premier lien et le nom de la fonction javascript à exécutée.
$second_select Tableau de chaines de caractères contenant le nom du second lien et le nom de la fonction javascript à exécutée.
$link_color Chaine de caractères contenant le code de couleur des deux liens. Le format du code est le suivant : green. Par défaut, cette valeur est sélectionnée.
display_result_from_search ( result,
anchors,
already_exist,
label_button = MANTIS_IMPORTUSER_LABEL_DFT_BTN_FORM,
label_another_search = MANTIS_IMPORTUSER_LABEL_DFT_LINK_FORM 
)

Méthode permettant d'afficher le résultat de la recherche.

Paramètres:
$result Tableau contenant le résultat de la recherche.
$anchors Tableau de chaines de caractères contenant le nom des deux ancres et leur couleur. Le format du code est le suivant : blue.
$already_exist Chaine de caractères contenant un message spécifiant que l'utilisateur est déjà crée.
$label_button Chaine de caractères contenant le label du bouton de création d'utilisateurs.
$label_another_search Chaine de caractères contenant un message notifiant que la recherche n'a retourné aucun résultat.
display_result_message ( szMessage,
iTitleLevel = 3,
szColor = 'black' 
) [static]

Méthode statique permettant d'afficher un lien vers le formulaire de recherche.

Paramètres:
$szMessage Chaine de caractères contenant le message a afficher.
$iTitleLevel Entier contenant le niveau de titre (h1,h2,h3 etc...). Par défaut, le niveau est de 3.
$szColor Chaine de caractères contenant du titre. Par défaut, cette couleur est noire.
display_search_form_ldap ( call_js,
title_search = MANTIS_IMPORTUSER_TITLE_DFT_SEARCH_FORM,
fieldset_color = MANTIS_IMPORTUSER_COLOR_DEFAULT_RGB,
label_server_parameters,
label_search_parameters,
button_label = MANTIS_IMPORTUSER_LABEL_DFT_BTN_FORM 
)

Méthode permettant d'afficher le formulaire de recherche.

Paramètres:
$call_js Chaine de caractères contenant le nom d'une fonction javascript permettant de vérifier si certains champs obligatoires de la recherche sont bien spécifiés.
$title_search Chaine de caractères contenant le titre de notre module de recherche.
$fieldset_color Chaine de caractères contenant le code de couleur de la première zone du formulaire. Le format du code est le suivant : 255 255 240. Par défaut, cette valeur est sélectionnée.
$label_server_parameters Tableau de chaines de caractères contenant les différents labels de la première zone du formulaire.
$label_search_parameters Tableau de chaines de caractères contenant les différents labels de la seconde zone du formulaire.
$button_label Chaine de caractère contenant le label du bouton de validation.
display_start_div_align ( szAlign  )  [static]

Méthode statique permettant d'afficher une balise HTML DIV accompagné d'un attribut d'alignement.

Paramètres:
$szAlign Chaine de caractères contenant l'attribut d'alignement.

Documentation des champs

$aListMantisUsers [private]
$ldap_bind_dn [private]

Chaine de caractères contenant l'identifiant avec lequel on s'authentifie auprès du service LDAP.

$ldap_dn [private]

Chaine de caractères contenant un chemin valide de l'annuaire LDAP.

$ldap_filter [private]

Chaine de caractères contenant le filtre lié à la recherche LDAP.

$ldap_port [private]

Entier contenant le port du service LDAP.

$ldap_pwd [private]

Chaine de caractères contenant le mot de passe pour se connecter au service LDAP.

$ldap_server [private]

Chaine de caractères contenant l'adresse du serveur LDAP.


La documentation de cette classe a été générée à partir du fichier suivant :
 Tout Structures de données Fichiers Fonctions Variables Énumérations

Généré le Mon Sep 14 17:17:37 2009 pour MantisImportUser par  doxygen 1.6.1