Framework

Méthode ModuleInterface::functionnality

Functionnality
Functionnality — Appelle la méthode de nom '$functionnality' du module.

Description

Code PHP :

$result Functionnality(string $functionnality, mixed $arg1, mixed $arg2, ...)

Cette méthode de la classe ModuleInterface exécute la fonctionnalité demandée sur le module courant et renvoie le résultat de la fonctionnalité appelée.

Dans le cas ou un des modules ne disposerait pas de la functionnalité sus-ci-nommée, l'appel de la fonctionnalité sur le module en question ne sera pas effectué et l'erreur FUNCTIONNALITIE_NOT_IMPLEMENTED sera positionné.

Liste de paramètres

$functionnality C'est le nom sous forme de string de la méthode à appelé pour chacun des modules passé en paramètre.

Exemple de $functionnality
Code PHP :
```
 
$functionnality = 'Search';
 
```

$argx Ces paramètres sont la liste des paramètres de la méthode de nom $functionnality appelée.

Exemple de $argx

Code PHP :

 
$arg1 = Array('val1', 0, true);
$arg2 = 42;
...

Valeur de retour

Cette fonction retourne le résultat de la fonctionnalité appelée

exemple de retour

Code PHP :

 
 
$result = $monModule->Functionnality('Search', $arguments_de_recherche);

Exemple d'utilisation

Ces exemples d'utilisation protège complètement l'appel des méthodes de toute erreur éventuelle!

Code PHP :

 
// Initialisation de l'objet
$modules = new Modules();
 
// Récupération du module wiki
$wiki = $modules->GetModule('wiki');
 
// Si le module a bien été crée
if ( $wiki->GetErrors() == 0 )
{
    // Teste l'existence de la méthode 'Search'
    if ( $wiki->HasFunctionnality('Search') )
    {
        // Appel de la méthode
        $results = $wiki->Functionnality('Search', $arguments_de_recherche);
        // traitement du $results
    }
}

ou bien

Code PHP :

 
// Initialisation de l'objet
$modules = new Modules();
 
// Récupération du module wiki
$wiki = $modules->GetModule('wiki');
 
// Si le module a bien été crée
if ( $wiki->GetErrors() == 0 )
{
    // Appel de la méthode
    $results = $wiki->Functionnality('Search', $arguments_de_recherche);
 
    // Teste l'existence de la méthode 'Search'
    if ( $wiki->GetErrors() == 0 )
    {
        // traitement du $results
    }
}

Remarque, on peut aussi condenser le dernier exemple comme ceci

Code PHP :

 
// Initialisation de l'objet
$modules = new Modules();
 
// Récupération du module wiki
$wiki = $modules->GetModule('wiki');
 
// Appel de la méthode
$results = $wiki->Functionnality('Search', $arguments_de_recherche);
 
// Teste l'existence de la méthode 'Search' et que le module est bien valide
if ( $wiki->GetErrors() == 0 )
{
    // traitement du $results
}