Access : Modules de classes

En encapsulant votre code dans des objets vous masquez l'implémentation. C'est à dire que les utilisateurs de vos classes n'ont pas besoin d'en connaitre l'implémentation. Ces objets sont des boites noires, une fois developpés, il nous suffit de savoir ce qui entre ou sort de la boite. Par exemple, vous utilisez souvent des objets Recordset, peut-être que par curiosité vous aimeriez connaitre l'implémentation utilisée, mais reconnaissez que cela n'a aucune utilité pour vos developpements.
Tout ce dont vous avez besoin c'est de savoir comment utiliser cet objet
Les classes peuvent aussi permettre de masquer des procéssus complexes derrière une interface simplifié. Une des utilisatation peut être d'encapsulé les API pour les rendre plus convivial.

Les classes sont des types évolués. Contrairement aux types simples (entiers, flotant, chaine de caractères ...) qui ne contiennent que des données, les objets contiennent à la fois les données et les méthodes qui permettent de manipuler ces données.
Il est facile de faire une confusion entre objets et classes, pour faire une analogie culinaire, nous dirons que si les objets sont des gateaux, les classes sont les recettes qui permettent de faire ces gâteaux. La recette n'est pas un gâteaux mais elle permet de faire autant de gâteaux que l'on désire. Dans cette image les ingrédients seraient les propriétés et les manipulations (mélanger, cuire) les méthodes.
Quand on crée un objet à partir d'une classe, on dit que l'on instancie un objet. Les differents objets instanciés à partir d'une classe, sont appelés instances.
Les objets ont des propriétés, qui contiennent les données, et des méthodes qui permettent de les manipuler. Dans certains langages, les propriétés sont appelées champs. Quant aux méthodes ce ne sont que des procédures ou des fonctions qui peuvent retourner une valeur et recevoir des paramètres.

Nous ne parlons pas ici d'interface graphique. L'interface est la partie visible d'une classe. Le créateur de la classe n'est pas forcement l'utilisateur de celle-ci, il est donc indispensable de définir une interface et de s'y tenir. Le créateur de la classe définit l'interface et met en place l'implémentation. Peu importe que l'implémentation change du moment que l'interface ne change pas. En gros, une mise à jour de la classe doit rester compatible avec le code existant des utilisateurs de cette classe. Il est donc très simple d'ajouter des propriétés et des méthodes mais pratiquement impossible d'en supprimer. Dans la réalité, cela se produit, dans ce cas on ne supprime pas tout de suite la méthode, propriété ou même la classe mais on dit que cet élément est "deprecated" pour indiquer qu'il ne faut plus l'utiliser qu'il sera supprimés dans les versions futures. En java, le compilateur émet un avertissement indiquant qu'il utilise une méthode deprecated, il n'y a pas, à ma connaissance, de processus similaire en VB.
Dans certains des langages orientés objet, comme Java, il existe un mot clé interface, il n'existe pas en VBA. Par contre, il est possible créer une interface en créant une classe ne contenant que les prototypes des méthodes et propriétés.

Nous allons faire ici un petit rappel sur les objets. Lorsque vous déclarez un objet vous créez un pointeur vers cet objet. Plusieurs pointeurs peuvent pointer sur le même objet. Lorsque vous utilisez le code suivant :

set Objet1 = Objet2

Vous ne faites pas une copie de l'objet comme c'est le cas avec les types simples mais vous créez un deuxième pointeur vers votre objet. Lorsque vous passez un objet en paramètre d'une fonction ou procédure vous ne passez en fait qu'un pointeur vers l'objet. On dit que les objets sont passés par référence (c'est aussi le cas des types simple dans Visual Basic, bien que ces derniers puissent être passé en tant que valeur).
La création des objets :

Dim obj1 as new Object				'création du pointeur vers l'objet1 
Dim obj2 as object					'création du pointeur vers l'objet2
	
	'Dans cette partie du code obj2 est réellement instancié
	'mais obj1 ne l'est pas 
	
	' Maintenant si on utilise une propriété de obj1 cela provoque la création de l'objet
	obj1.SomePrp = "What Ever"  'création de l'objet1 

	' On libère les pointeurs 
	set obj1 = Nothing
	set obj2 = Nothing
	'On ne peut plus accéder aux objets grâce aux pointeurs obj1 et obj2

Maintenant que nous savons quand nos objets sont effectivement créés, voyons comment se passe la destruction des objets :
Un objet est détruit quand il n'existe plus de pointeur lui faisant référence. Cette définition est simple mais l'on a souvent l'impression que lorsque le code suivant est executé :

Set objA = Nothing

l'objet est détruit, alors que ce n'est vrai que si objA est le dernier pointeur vers l'objet. Il est très important de prendre la précautions de bien "nettoyer" derrière soit et de ne pas laisser traîner de pointeurs.
Comme nous le verrons plus loin nous pouvons executer du code lors de la destruction d'un objet encore faut-il être certains que ce code s'executera.

Commençons par définir l'interface de la classe que nous allons créer. Celle-ci sera simple afin de mettre en relief le fonctionnement des modules de classes sans risquer de s'égarer avec une implémentation obscure.
Notre classe aura 4 propriétés :

• Nom : Une chaîne de caractères contenant le nom de la personne
• Prenom : Une chaîne de caractères contenant le prénom de la personne
• DateNaissance
• NomComplet : Une chaîne de caractère contenant le prénom suivi du nom séparés par un espace. Cette propriété prend les valeurs des propriétés Nom et Prenom sépar elle est en lecture seule.

et une méthode :

• age : renvoie l'âge de la personne.

Puisque notre classe n'existe pas encore, nous devons commencer par créer un module de classe. Pour cela, dans l'éditeur VB, cliquer sur Insertion/Module de classe. Enregistrons le module. Ce nom ne doit pas être choisi au hasard car il s'agit du nom du type que vous allez créer. Notre classe s'appelle Person.

2-2-1. Implémentation des propriétés utilisant des variables publiques▲

Public Nom As String            'Nom de la personne
Public Prenom As String         'Prénom de la personne
Public DateNaissance As Date    'Date de naissance de la personne

Sub testPerson()
Dim objperson  As New Person            'création du pointeur vers l'objet
Dim strNom     As String
Dim strPrenom  As String
Dim dtmNaissance As String

    strNom = "Blavin"
    strPrenom = "Michel"
    dtmNaissance = #9/14/1969#
    With objperson
        .Nom = strNom                       'provoque la création de l'objet
        .Prenom = strPrenom
        .DateNaissance = dtmNaissance
        Debug.Print "La méthode age renvoie : "; .Age; _
                    " ans, pour "; .NomComplet; " né le : "; _
                    Format(.DateNaissance, "dddd d mmmm yyyy")
    End With
    Set objperson = Nothing
End Sub

Michel Blavin est né le dimanche 14 septembre 1969

2-2-2. Implémentation des propriétés utilisant les Procédures Property▲

Private mstrNom As String                'Nom de la personne
Private mstrPrenom As String             'Prénom de la personne
Private mdtmDateNaissance As Date        'Date de naissance de la personne

' Propriété Nom 
Property Let Nom(strNom As String)
   mstrNom = strNom
End Property
Property Get Nom() As String
    Nom = mstrNom
End Property

' Propriété Prenom
Property Let Prenom(strPrenom As String)
    mstrPrenom = strPrenom
End Property
Property Get Prenom() As String
    Prenom = mstrPrenom
End Property

' Propriété DateNaissance
Property Let DateNaissance(dtmDateNaissance As Date)
    mdtmDateNaissance = dtmDateNaissance
End Property
Property Get DateNaissance() As Date
    DateNaissance = mdtmDateNaissance
End Property

' Propriété Nom
Property Let Nom(strNom As String)
    If Len(strNom) = 0 Then
        MsgBox "Le nom ne peut pas être vide."
    Else
        mstrNom = strNom
    End If
End Property

Property Get Nom() As String
    Nom = mstrNom
End Property

' Propriété Prenom
Property Let Prenom(strPrenom As String)
    If Len(strPrenom) = 0 Then
        MsgBox "Le prénom ne peut pas être vide."
    Else
        mstrPrenom = strPrenom
    End If
End Property

Property Get Prenom() As String
    Prenom = mstrPrenom
End Property

' Propriété DateNaissance
Property Let DateNaissance(dtmDateNaissance As Date)
    If dtmDateNaissance > Now Then
        MsgBox "Une date de naissance ne peut pas être dans le futur."
    Else
        mdtmDateNaissance = dtmDateNaissance
    End If
End Property

Property Get DateNaissance() As Date
    DateNaissance = mdtmDateNaissance
End Property

' Propriété NomComplet en lecture seule
Property Get NomComplet() As String
    NomComplet = Me.Prenom & " " & Me.Nom
End Property

Comme dans un module simple les méthodes peuvent, soit ne pas renvoyer de valeur (procédure Sub), soit comme dans le cas de la méthode Age que nous allons implémenter, renvoyer une valeur (une fonction).

Public Function Age() As Integer
    'on calcule le nombre d'années entre l'année de naissance et aujourd'hui
    Age = DateDiff("yyyy", DateNaissance, Now, vbMonday, vbFirstFourDays)
    'si la jour de l'anniversaire n'est pas passé on retire 1 an
    If DateAdd("yyyy", Age, Me.DateNaissance) > Now Then
        Age = Age - 1
    End If
End Function

Nous avons maintenant une classe totalement fonctionnelle.

Sub testPerson()
    Dim objPerson As New Person        'création du pointeur vers l'objet
    Dim strNom As String
    Dim strPrenom As String
    Dim dtmNaissance As String

    strNom = "Blavin"
    strPrenom = "Michel"
    dtmNaissance = #9/14/1969#
    objPerson.Nom = strNom        'provoque la création de l'objet
    objPerson.Prenom = strPrenom
    objPerson.DateNaissance = dtmNaissance

    Debug.Print "La méthode age renvoie : "; objPerson.age; _
            " ans, pour "; objPerson.NomComplet; " née le : "; _
            Format(objPerson.DateNaissance, "dddd d mmmm yyyy")

    Set objPerson = Nothing
End Sub

La méthode age renvoie : 35  ans, pour Michel Blavin né le :  dimanche 14 septembre 1969

En plus des propriétés et des méthodes, les modules de classes savent gérer des événements. Les modules de classes simples en implémentent 2, l'événement Initialize et l'événement Terminate.

Il n'est pas ici question de constructeur ou de destructeur comme ils existent dans les langages comme java ou C++.

L'événement Initialize se produit lors de la création de l'objet et l'événement Terminate se produit lors de sa destruction. Il est indispensable de savoir quand un objet est créé et quand il est détruit car si, à première vue, cela à l'air évident mais si les pointeurs ne sont pas bien libéré il se peut qu'un objet ne soit pas détruit et donc que le code de l'événement Terminate ne soit jamais exécuté.
Pour prendre conscience du moment exact ou ces événements se produisent, nous allons ajouter le code suivant à notre classe :

Private Sub class_Initialize()
    Debug.Print "Evénement Initialize - Création d'un objet Person"
End Sub

Private Sub class_Terminate()
    Debug.Print "Evénement Terminate - destruction d'un objet Person : " & Me.NomComplet
End Sub

Ainsi, la fenêtre de debug nous informera à chaque fois que l'un de ces événements se produira. Pendant la phase d'apprentissage, je vous conseille fortement d'implémenter systématiquement ce genre de code, cela vous évitera probablement quelques heures de debug. Maintenant notre procédure de test donne :

Evénement Initialize - Création d'un objet Person
La méthode age renvoie :  35  ans, pour Michel Blavin né le :  dimanche 14 septembre 1969 
Evénement Terminate - destruction d'un objet Person : Michel Blavin

Vous pouvez aussi ajouter à vos classes des événements personnalisés (à partir de Office 2000 seulement). Nous allons ajouter un événement que l'on appelera Completed qui se produira lorsque les propriétés Nom, Prenom et DateNaissance auront été renseignés. Commençons par ajouter la déclaration de l'événement :

Public Event Completed()                    ' Evénement qui se produit lorsque les propriétés
                                            'Nom, Prenom et DateNaissance auront été renseignées
                                            ' Cette déclaration provoque une erreur à la compilation 
                                            ' sous Access 97.

Pour qu'un événement se produise, il faut utiliser la méthode RaiseEvent.
Dans notre cas, nous allons créer une méthode privée IsCompleted dans notre module de classe, qui va vérifier si toutes les propriétés concernées sont renseignées.

Private mblnNom As Boolean                  'est à vrai lorsque le nom a été renseigné
Private mblnPrenom As Boolean               'est à vrai lorsque le prénom a été renseigné
Private mblndateNaissance As Boolean        'est à vrai lorsque la date de naissance a été renseignée

C'est 3 variables seront initialisées à False dans l'événement Initialize et nous allons transformer les procédures Let pour qu'elles appellent la procédure IsCompleted qui provoquera l'événement Completed si les trois propriétés on été renseignées.

Private Sub IsCompleted()
    If mblnNom And mblnPrenom And mblndateNaissance Then
        'Si les 3 propriétés privées sont vrai alors l'événement se produit
		RaiseEvent Completed
    End If
End Sub

Comme me l'a fait remarquer un de mes relecteurs cette procédure aurait pu être publique ce qui aurait permis aux l'utilisateurs de la classe d'interroger cette méthode plutot que de lever un évenement, mais cela nous permet de implémenter une méthode privée.

Property Let Nom(strNom As String)
    If Len(strNom) = 0 Then
        MsgBox "Le nom ne peut pas être vide."
        Exit Property
    Else
        mstrNom = strNom
        mblnNom = True
    End If
    IsCompleted
End Property

Property Let Prenom(ByVal strPrenom As String)
    If Len(strPrenom) = 0 Then
        MsgBox "Le prénom ne peut pas être vide."
        Exit Property
    Else
        mstrPrenom = strPrenom
        mblnPrenom = True
    End If
    IsCompleted
End Property

Property Let DateNaissance(ByVal dtmDateNaissance As Date)
    If dtmDateNaissance > Now Then
        MsgBox "Une date de naissance ne peut être dans le futur."
        Exit Property
    Else
        mdtmDateNaissance = dtmDateNaissance
        mblndateNaissance = True
    End If
    IsCompleted
End Property

Maintenant il ne nous reste plus qu'à tester. Créons un nouveau formulaire et ajoutons les blocs de code suivant, pour la gestion de l'événement. Remarquez l'usage d'un nouveau mot clé WithEvents, qui, comme son nom l'indique signale lors de la déclaration de l'objet que nous allons utiliser tout ou partie des événements de l'objet instancié. La méthode exécutée lorsque l'événement se produit a un nom particulier composé du nom de l'objet concerné et du nom de l'événement, séparés par un underscore ("_").

Le mot clé WithEvents ne peut pas etre utiliser en même temps que le mot clé new.

Private WithEvents mobjPerson As Person 'Provoque une erreur si placé ailleurs que
										'dans un module de classe

Private Sub mobjPerson_Completed()
    Debug.Print "l'Evénement Completed vient de se produire !"
End Sub

Private Sub Form_Load()
    Debug.Print "chargement du formulaire frmPerson"
    Set mobjPerson = New Person
    With mobjPerson
        .Nom = "Blavin"
        .Prenom = "Michel"
        .DateNaissance = #9/14/1969#
        'ici se produit l'événement completed
        'Et ensuite seulement on affiche la msgbox suivante
        Debug.Print .Prenom & " " & .Nom & " a " & .Age & " ans."
    End With
End Sub

Private Sub Form_Unload(Cancel As Integer)
    Debug.Print "Libération du formulaire frmPerson"
    Set mobjPerson = Nothing
End Sub

chargement du formulaire frmPerson
Evénement Initialize - Création d'un objet Person
l'Evénement Completed vient de se produire !
Michel Blavin a 35 ans.
Libération du formulaire frmPerson
Evénement Terminate - destruction d'un objet Person : Michel Blavin

Comme vous le voyez, l'événement est déclenché par l'objet Person, par contre, l'action à effectuer lorsque cet événement se produit n'est pas contenu dans la classe Person mais dans le formulaire qui utilise la classe. C'est l'utilisateur de l'objet qui décide ce qu'il veut faire lorsque cet événement ce produit.

Lorsque vous créez une hiérarchie entre vos objets, il peut être interessant de pouvoir remonter la hiérarchie, c'est le rôle de la propriété Parent. Vous pouvez d'ailleurs l'appeler autrement mais ce serait juste totalement stupide car cela rendrait votre code un peu plus obscur.

Property Set Parent(ByRef objPersons As Persons)
    If objPersons Is Nothing Then
        mobjParent = objPersons
    End If
End Property

Property Get Parent() As Persons
    Parent = mobjParent
End Property

Vous remarquerez que la propriété Parent ne peut être affectée qu'une seule fois (write once).
Pour renseigner cette propriété, il nous faudra, dans l'objet Parent, ajouter la ligne de code suivante :

Set mobjPerson.Parent = Me

Dans certains cas, on peut utiliser tout simplement utiliser l'objet Collection, mais il accepte tous les objets. Vous risquez d'utiliser dans votre code des méthodes ou des propriétés absentes de certains objets, ce qui provoquera des erreurs d'exécution pas belles (Ugly runtime error;)).
Autre avantage de taille, nous pouvons choisir d'implémenter tout ou partie des méthode de l'objet Collection, voir même, comme nous allons le voir, d'en ajouter.

3-2-1. Généralités▲

3-2-2. Interface▲

Private mcolPersons As Collection

Private Sub class_Initialize()
    Debug.Print "Evénement Initialize - collection Persons"
    Set mcolPersons = New Collection
End Sub

Private Sub class_Terminate()
    Debug.Print "Evénement Initialize - collection Persons"
    If Not (mcolPersons Is Nothing) Then Set mcolPersons = Nothing
End Sub

3-2-3. Implémentation▲

Property Get Count as Long
	Count = mcolPersons.Count
End Property
	
Public Sub Add(ByRef objperson As Person, _
                    Optional ByVal Key As String = "")
'Si aucune clé key n'est fournit on en génère une automatiquement
    If Len(Key) = 0 Then
        Key = objperson.NomComplet & Format(objperson.DateNaissance, "yyyymmdd")
    End If
    mcolPersons.Add objperson, Key
    'l'objet est inséré dans la collection on automatiquement renseigne la propriété Parent
    Set objperson.Parent = Me
    Set objperson = Nothing
End Function

Public Sub Remove(ByVal Index As Variant)
    mcolPersons.Remove (Index)
End Function

Public Function Item(ByVal Index As Variant) As Person
    Set Item = mcolPersons.Item(Index)
End Function

Public Function CreatePerson(strNom As String, _
                             strPrenom As String, _
                             dtmNaissance As Date) As Person
Dim objPerson  As Person

    Set objPerson = New Person
    With objPerson
        .Nom = strNom
        .Prenom = strPrenom
        .DateNaissance = dtmNaissance
    End With

    Set CreatePerson = objPerson

    If Not (objPerson Is Nothing) Then Set objPerson = Nothing
End Function

Sub testCollection()
Dim colPersons As Persons
Dim i          As Long
    Set colPersons = New Persons
    With colPersons
        .Add .CreatePerson("Blavin", "Michel", #9/14/1969#)
        Debug.Print "Nombre d'element(s) dans la collection : "; .Count
        .Add .CreatePerson("Hendrix", "Jimmy", #9/14/1969#)
        Debug.Print "Nombre d'element(s) dans la collection : "; .Count
        .Add .CreatePerson("Joplin", "Janis", #9/14/1969#)
        Debug.Print "Nombre d'element(s) dans la collection : "; .Count
        .Add .CreatePerson("Morisson", "Jim", #9/14/1969#)
        Debug.Print "Nombre d'element(s) dans la collection : "; .Count

        Debug.Print "on fait defiler la colection : "
        For i = 1 To .Count
            Debug.Print .Item(i).NomComplet
        Next

        Debug.Print "suppression d'un élément"
        .Remove 2
        Debug.Print "Nombre d'element(s) dans la collection : "; .Count

        For i = 1 To .Count
            Debug.Print .Item(i).NomComplet
        Next
    End With
    Set colPersons = Nothing
End Sub

Evénement Initialize - Création d'une collection Persons
Evénement Initialize - Création d'un objet Person
Nombre d'element(s) dans la collection :  1 
Evénement Initialize - Création d'un objet Person
Nombre d'element(s) dans la collection :  2 
Evénement Initialize - Création d'un objet Person
Nombre d'element(s) dans la collection :  3 
Evénement Initialize - Création d'un objet Person
Nombre d'element(s) dans la collection :  4 
on fait defiler la colection : 
Michel Blavin
Jimmy Hendrix
Janis Joplin
Jim Morisson
suppression d'un élément
Evénement Terminate - destruction d'un objet Person : Jimmy Hendrix
Nombre d'element(s) dans la collection :  3 
Michel Blavin
Janis Joplin
Jim Morisson
Evénement Terminate - destruction d'une collection Persons
Evénement Terminate - destruction d'un objet Person : Michel Blavin
Evénement Terminate - destruction d'un objet Person : Janis Joplin
Evénement Terminate - destruction d'un objet Person : Jim Morisson

3-2-4. Que manque-t-il aux collections personnalisées ?▲

colPersons.Item(i).NomComplet			' Correct
colPersons(i).NomComplet			' Incorrect renvoie une erreur.

For i = 1 To colPersons.Count
   	Debug.Print colPersons.Item(i).NomComplet
Next